Kubernetes can be configured while creating or editing environment templates. If you start with a Cattle environment, you can configure and launch Kubernetes from the Catalog -> Library. If you choose the catalog route, you can skip step 1.
Note: We recommend starting your Kubernetes environments with the correct configuration, if you want to change the configuration of an existing Kubernetes setup, you can click on Up to Date button to upgrade the Kubernetes setup to your new one.
In the dropdown of environments, click on the Manage Environments. To create a new environment, click on Add Environment, provide a Name, Description (Optional), and select an environment template that has Kubernetes as the orchestration configured as you’d like. If access control is turned on, you can add members and select their membership role. Anyone added to the membership list would have access to your environment.
After a Kubernetes environment has been created, you can navigate to the environment by either selecting the name of the environment in the environment’s dropdown in the upper left hand corner or by selecting Switch to this Environment in the specific environment’s drop down.
Note: As Rancher adds support for multiple container orchestration frameworks, Rancher currently does not support the ability to switch between environments that already have services running in it.
After a Kubernetes environment has been created, the infrastructure services will not be started until you add at least one host to your environment. The process of adding hosts is the same steps for all container orchestration types. Once the first host has been added, Rancher will automatically start the deployment of the infrastructure services including the Kubernetes services (i.e. master, kubelet, etcd, proxy, etc.). You can see the progress of the deployment by accessing the Kubernetes -> Infrastructure Stacks tab.
Hosts that will be used as Kubernetes nodes will require the following TCP ports to be open for
10255. To access any exposed services, the ports used for the NodePort will also need to be opened. The default ports used by NodePort are TCP ports
orchestration=true. You can get away with 1 host, but you sacrifice high availability. In the event of this host failing, some K8s features such as the API, rescheduling pods in the event of failure, etc. will not occur until a new host is provisioned.
Note: Only admins of Rancher or owners of the environment will be able to view the infrastructure services.
When adding hosts to Kubernetes, the hostnames are used as unique identifiers for Kubernetes nodes when using
kubectl get nodes.
Once the setup has completed, you can begin to create or manage your own Kubernetes applications via the following ways:
Rancher supports the capability of hosting a catalog of Kubernetes templates. To use a template, click on the Catalog tab. Select the template that you want to launch and click View Details. Review and edit the stack name, stack description, and configuration options and click on Launch.
If you want to add your own templates to Kubernetes, you add them to the Rancher catalog and place your templates in a
To configure your own kubectl to talk to your newly created Kubernetes cluster, go to Kubernetes -> kubectl. Click on Generate Config to generate the necessary
kube/config_file that you can download and add to your local directory.
In the config file, it provides the necessary information for your local machine so that anything you launch using
kubectl will be displayed in Rancher.
Rancher provides a convenient shell access to a managed kubectl instance that can be used to manage Kubernetes clusters and applications.
Private registries can be used with Kubernetes services by adding your private registry in your Kubernetes environment.