Merge pull request #471 from deniseschannon/re-org-create-clusters
Re org create clusters
@@ -0,0 +1,72 @@
|
||||
---
|
||||
title: Creating Kubernetes Clusters
|
||||
weight: 2000
|
||||
aliases:
|
||||
- /rancher/v2.x/en/concepts/clusters/
|
||||
- /rancher/v2.x/en/concepts/clusters/cluster-providers/
|
||||
- /rancher/v2.x/en/tasks/clusters/
|
||||
- /rancher/v2.x/en/tasks/clusters/creating-a-cluster/
|
||||
---
|
||||
|
||||
## What's a Kubernetes Cluster?
|
||||
|
||||
A cluster is a group of computing resources that work as a team to accomplish a goal. Each individual computer in a cluster is called a _node_.
|
||||
|
||||
## Cluster Creation
|
||||
|
||||
Rancher simplifies creation of Kubernetes clusters by allowing you to create them with the Rancher UI rather than a config file.
|
||||
|
||||
### Node Components
|
||||
|
||||
A Kubernetes cluster contains 3 types of nodes: etcd nodes, control plane nodes, and worker nodes.
|
||||
|
||||
#### etcd Nodes
|
||||
|
||||
The etcd nodes are used to run the etcd database. etcd is a key value store used as Kubernetes’ backing store for all cluster data. Even though you can run etcd on a single node, you need 3, 5, or 7 nodes for redundancy.
|
||||
|
||||
#### Control Plane Nodes
|
||||
|
||||
The control plane nodes are used to run the Kubernetes API server, scheduler, and controller manager. Control plane nodes are stateless since all cluster data are stored on etcd nodes. You can run control plane on 1 node, although 2 or more nodes are required for redundancy. You can also run control plane on etcd nodes.
|
||||
|
||||
#### Worker Nodes
|
||||
|
||||
Worker nodes are used to run the kubelet and the workload. It also runs the storage and networking drivers and ingress controllers when required. You create as many worker nodes as needed for your workload needs.
|
||||
|
||||
|
||||
Using Rancher, you can create Kubernetes clusters using a variety of options. Use the option that best fits your use case.
|
||||
|
||||
## Hosted Kubernetes Providers
|
||||
|
||||
By integrating with cloud APIs, Rancher lets you create new Kubernetes clusters through hosted providers, all within the Rancher UI. You can create clusters using either:
|
||||
|
||||
- A hosted Kubernetes provider, such as Google GKE, Amazon EKS, or Microsoft AKS.
|
||||
- An IaaS provider, using nodes provided from Amazon EC2, Microsoft Azure, or DigitalOcean.
|
||||
|
||||
## Rancher-Launched Kubernetes
|
||||
|
||||
Alternatively, you can use Rancher to create a cluster from your own existing nodes, using RKE. RKE is Rancher’s own lightweight Kubernetes installer. It works with any bare metal server, cloud provider, or virtualization platform. It integrates with node drivers to automatically provision nodes on AWS, Azure, DigitalOcean, vSphere, OpenStack, etc. Users can add custom nodes to the cluster by running the Rancher agent on these nodes.
|
||||
|
||||
## Kubernetes Importation
|
||||
|
||||
Finally, you also have the option of importing an existing Kubernetes cluster that you're already using into Rancher.
|
||||
|
||||
|
||||
Using Rancher, you can create Kubernetes clusters using a variety of options. Use the option that best fits your use case.
|
||||
|
||||
## Hosted Kubernetes Providers
|
||||
|
||||
If you already have a cluster hosted by a Kubernetes provider such as Google GKE, Rancher can integrate with its cloud APIs, allowing you to manage your hosted cluster from the Rancher UI.
|
||||
|
||||
## Infrastructure Providers
|
||||
|
||||
Using Rancher, you can leverage APIs from major IaaS providers to create nodes and provision a new Kubernetes cluster.
|
||||
|
||||
## From Existing Nodes
|
||||
|
||||
Use Rancher to create a Kubernetes cluster on your on-premise bare metal servers. This option creates a cluster using RKE, which is Rancher's own lightweight Kubernetes installer.
|
||||
|
||||
In addition to bare metal servers, RKE can also create clusters on less popular IaaS providers by integrating with node drivers.
|
||||
|
||||
## Import Existing Clusters
|
||||
|
||||
Users can import an existing Kubernetes cluster into Rancher. Rancher does not automate the provisioning, scaling, and upgrade of imported Kubernetes clusters. All other cluster management, policy management, and workload management capabilities of Rancher apply to imported clusters.
|
||||
@@ -0,0 +1,6 @@
|
||||
---
|
||||
title: Creating a Custom Cluster
|
||||
shortTitle: Custom Cluster
|
||||
weight: 2400
|
||||
|
||||
---
|
||||
@@ -0,0 +1,54 @@
|
||||
---
|
||||
title: Hosted Kubernetes Providers
|
||||
weight: 2100
|
||||
---
|
||||
|
||||
If you already have a cluster hosted by a Kubernetes provider, Rancher can integrate with its cloud APIs, allowing you to manage your hosted cluster from the Rancher UI.
|
||||
|
||||
Rancher supports the following Kubernetes providers:
|
||||
|
||||
<!-- TOC -->
|
||||
|
||||
- [Google GKE (Google Container Engine)](#google-gke-google-container-engine)
|
||||
- [Amazon EKS (Elastic Container Service)](#amazon-eks-elastic-container-service)
|
||||
- [Microsoft AKS (Azure Container Service)](#microsoft-aks-azure-container-service)
|
||||
|
||||
<!-- /TOC -->
|
||||
|
||||
When setting up management of your hosted Kubernetes cluster in the Rancher UI, you are prompted for parameters required in all cluster creation scenarios: cluster name, user membership, how many nodes to create, and so on. However, each provider also requires information unique to the vendor. See more information about the information required for each provider below.
|
||||
|
||||
## Google GKE (Google Container Engine)
|
||||
|
||||
Before Rancher can manage a Google GKE cluster, you must create a service account with Google. This account also requires you to assign it the appropriate roles.
|
||||
|
||||
Create a service account using [Google Cloud Platform](https://console.cloud.google.com/projectselector/iam-admin/serviceaccounts). GKE uses this account to operate your cluster. Creating this account also generates a private key used for authentication.
|
||||
|
||||
The service account requires the following roles:
|
||||
|
||||
- `project/viewer`
|
||||
- `kubernetes-engine/admin`
|
||||
- `service-account/user`
|
||||
|
||||
For full instructions on how to complete these actions, see [Creating and Enabling Service Accounts](https://cloud.google.com/compute/docs/access/create-enable-service-accounts-for-instances).
|
||||
|
||||
After you create a service account, enter your service account private key into Rancher.
|
||||
|
||||
## Amazon EKS (Elastic Container Service)
|
||||
|
||||
Before Rancher can manage an Amazon EKS cluster, you must provide it with an Amazon access key that has the appropriate permissions assigned to it.
|
||||
|
||||
Log into the [Amazon AWS Management Console](https://aws.amazon.com/console/) to assign yourself the appropriate IAM permissions and create an access key. Complete the actions below.
|
||||
|
||||
- Assign the account you're using the IAM permissions to create clusters, modify clusters, and use the required API actions. For more information, see the official [EKS documentation](https://docs.aws.amazon.com/eks/latest/userguide/IAM_policies.html).
|
||||
|
||||
- Create an Amazon access key and secret key. For more information, see [Managing Access Keys for IAM Users](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html)
|
||||
|
||||
After you complete the two actions above, enter your access key and secret key in Rancher.
|
||||
|
||||
## Microsoft AKS (Azure Container Service)
|
||||
|
||||
Before Rancher can manage a Microsoft AKS cluster, you must provide it with information from your Azure Active Directory Service Principal (here after, _service principal_). Rancher uses this service principal to interact with the Azure API.
|
||||
|
||||
For instruction on how to create a service principal, see [Service Principals with Azure Kubernetes Service (AKS)](https://docs.microsoft.com/en-us/azure/aks/kubernetes-service-principal).
|
||||
|
||||
After you complete the action above, enter the information from your service principal in Rancher.
|
||||
@@ -1,7 +1,9 @@
|
||||
---
|
||||
title: Creating an AKS Cluster
|
||||
shortTitle: Azure Container Service
|
||||
weight: 3350
|
||||
weight: 2115
|
||||
aliases:
|
||||
- /rancher/v2.x/en/tasks/clusters/creating-a-cluster/create-cluster-azure-container-service/_index.md
|
||||
---
|
||||
|
||||
You can use Rancher to create a cluster using Microsoft Azure Container Service.
|
||||
@@ -1,7 +1,9 @@
|
||||
---
|
||||
title: Creating an EKS Cluster
|
||||
shortTitle: Amazon EKS
|
||||
weight: 3325
|
||||
weight: 2110
|
||||
aliases:
|
||||
- /rancher/v2.x/en/tasks/clusters/creating-a-cluster/create-cluster-eks/_index.md
|
||||
---
|
||||
## Objectives
|
||||
|
||||
@@ -1,7 +1,9 @@
|
||||
---
|
||||
title: Creating a GKE Cluster
|
||||
shortTitle: Google Container Engine
|
||||
weight: 3325
|
||||
weight: 2105
|
||||
aliases:
|
||||
- /rancher/v2.x/en/tasks/clusters/creating-a-cluster/create-cluster-gke/_index.md
|
||||
---
|
||||
## Objectives
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
---
|
||||
title: Importing a Cluster
|
||||
weight: 3400
|
||||
title: Importing Kubernetes Clusters
|
||||
weight: 2300
|
||||
aliases:
|
||||
- /rancher/v2.x/en/tasks/clusters/import-cluster/
|
||||
---
|
||||
|
||||
You can import an existing Kubernetes cluster and then manage it using Rancher.
|
||||
@@ -31,4 +33,4 @@ You can import an existing Kubernetes cluster and then manage it using Rancher.
|
||||
{{< result_create-cluster >}}
|
||||
|
||||
> **Note:**
|
||||
> You can not re-import a cluster that is currently active in a Rancher setup.
|
||||
> You can not re-import a cluster that is currently active in a Rancher setup.
|
||||
@@ -0,0 +1,55 @@
|
||||
---
|
||||
title: Adding Users to Clusters
|
||||
weight: 2500
|
||||
aliases:
|
||||
- /rancher/v2.x/en/tasks/clusters/adding-managing-cluster-members/
|
||||
---
|
||||
|
||||
If you want to provide a user with access and permissions to _all_ projects, nodes, and resources within a cluster, assign the user a cluster membership.
|
||||
|
||||
>**Tip:** Want to provide a user with access to a _specific_ project within a cluster? See [Adding Project Members]({{< baseurl >}}/rancher/v2.x/en/tasks/projects/add-project-members/) instead.
|
||||
|
||||
There are two contexts where you can add cluster members:
|
||||
|
||||
- [Adding Members to a New Cluster]({{< baseurl >}}/rancher/v2.x/en/tasks/clusters/creating-a-cluster)
|
||||
|
||||
You can add members to a cluster as you create it (recommended if possible).
|
||||
|
||||
- [Adding Members to an Existing Cluster](#adding-members-to-an-existing-cluster)
|
||||
|
||||
You can always add members to a cluster later. See below.
|
||||
|
||||
### Adding Members to an Existing Cluster
|
||||
|
||||
Following cluster creation, you can add users as cluster members so that they can access its resources.
|
||||
|
||||
1. From the **Global** view, open the cluster that you want to add members to.
|
||||
|
||||
2. From the main menu, select **Members**. Then click **Add Member**.
|
||||
|
||||
3. Search for the user or group that you want to add to the cluster.
|
||||
|
||||
If external authentication is configured:
|
||||
|
||||
- Rancher returns users from your [external authentication]({{< baseurl >}}/rancher/v2.x/en/concepts/global-configuration/authentication/) source as you type.
|
||||
|
||||
>**Using AD but can't find your users?**
|
||||
>There may be an issue with your search attribute configuration. See [Configuring Active Directory Authentication: Step 5]({{< baseurl >}}/rancher/v2.x/en/tasks/global-configuration/authentication/active-directory/).
|
||||
|
||||
- A drop-down allows you to add groups instead of individual users. The drop-down only lists groups that you, the logged in user, are part of.
|
||||
|
||||
>**Note:** If you are logged in as a local user, external users do not display in your search results. For more information, see [External Authentication Configuration and Principal Users]({{< baseurl >}}/rancher/v2.x/en/concepts/global-configuration/authentication/#external-authentication-configuration-and-principal-users).
|
||||
|
||||
4. Assign the user or group **Cluster** roles.
|
||||
|
||||
[What are Cluster Roles?]({{< baseurl >}}/rancher/v2.x/en/concepts/global-configuration/users-permissions-roles/#cluster-roles)
|
||||
|
||||
>**Tip:** For Custom Roles, you can modify the list of individual roles available for assignment.
|
||||
>
|
||||
> - To add roles to the list, [Add a Custom Role]({{< baseurl >}}/rancher/v2.x/en/tasks/global-configuration/roles/#adding-a-custom-role).
|
||||
> - To remove roles from the list, [Lock/Unlock Roles]({{< baseurl >}}/rancher/v2.x/en/tasks/global-configuration/roles/#locking-unlocking-roles).
|
||||
|
||||
**Result:** The chosen users are added to the cluster.
|
||||
|
||||
- To revoke cluster membership, select the user and click **Delete**. This action deletes membership, not the user.
|
||||
- To modify a user's roles in the cluster, delete them from the cluster, and then re-add them with modified roles.
|
||||
@@ -0,0 +1,25 @@
|
||||
---
|
||||
title: Rancher Launched Kubernetes
|
||||
weight: 2200
|
||||
---
|
||||
|
||||
## Infrastructure Providers
|
||||
|
||||
Using Rancher, you can leverage APIs from major IaaS providers to create nodes and provision a new Kubernetes cluster, all from the Rancher UI. There's no need to log directly into your infrastructure providers's portal.
|
||||
|
||||
You can create provider-hosted nodes from the Rancher UI by creating a node template. After providing Rancher with an access token from the vendor you're using, Rancher prompts you for specifications that it will send to your provider by API. The provider than provisions your nodes based on the template.
|
||||
|
||||
Out-of-the-box, Rancher supports the following infrastructure providers:
|
||||
|
||||
- Amazon EC2
|
||||
- Microsoft Azure
|
||||
- DigitalOcean
|
||||
- VMWare Vsphere
|
||||
|
||||
Each vendor requires specific information that's used to authenticate with the provider API. Read more below to learn about the information required for each provider.
|
||||
|
||||
## From Existing Nodes
|
||||
|
||||
Use Rancher to create a Kubernetes cluster on your on-premise bare metal servers. This option creates a cluster using RKE, which is Rancher's own lightweight Kubernetes installer. In addition to bare metal servers, RKE can also create clusters on _any_ IaaS providers by integrating with node drivers.
|
||||
|
||||
To use this option you'll need access to servers you intend to use as your Kubernetes cluster. Provision each server according to Rancher requirements, which includes some hardware specifications and Docker. After you install Docker on each server, run the command provided in the Rancher UI to turn each server into a Kubernetes node.
|
||||
@@ -1,7 +1,9 @@
|
||||
---
|
||||
title: Creating a Custom Cluster
|
||||
shortTitle: Custom Cluster
|
||||
weight: 3225
|
||||
title: Creating a Cluster with Custom Nodes
|
||||
shortTitle: Custom Nodes
|
||||
weight: 2225
|
||||
aliases:
|
||||
- /rancher/v2.x/en/tasks/clusters/creating-a-cluster/create-cluster-custom/
|
||||
---
|
||||
|
||||
## Objectives
|
||||
@@ -0,0 +1,47 @@
|
||||
---
|
||||
title: Nodes hosted in an Infrastructure Provider
|
||||
weight: 2205
|
||||
aliases:
|
||||
- /rancher/v2.x/en/concepts/global-configuration/node-drivers/
|
||||
- /rancher/v2.x/en/tasks/global-configuration/node-drivers/
|
||||
- /rancher/v2.x/en/concepts/global-configuration/node-templates/
|
||||
---
|
||||
|
||||
### Node Drivers
|
||||
|
||||
|
||||
Out-of-the-box, Rancher provides support for creating clusters using many popular cloud providers: Amazon EC2, Azure, DigitalOcean, and so on. However, you may want to create a cluster using another cloud provider. In these scenarios, you can create a custom node driver for the cloud provider and point Rancher toward it.
|
||||
|
||||
For more information on creating node drivers, see [https://github.com/rancher/ui-driver-skel](https://github.com/rancher/ui-driver-skel).
|
||||
|
||||
#### Managing Node Drivers
|
||||
|
||||
>**Prerequisites:** To create, edit, or delete drivers, you need _one_ of the following permissions:
|
||||
>
|
||||
>- [Administrator Global Permissions]({{< baseurl >}}/rancher/v2.x/en/concepts/global-configuration/users-permissions-roles/#global-permissions)
|
||||
>- [Custom Global Permissions]({{< baseurl >}}/rancher/v2.x/en/concepts/global-configuration/users-permissions-roles/#custom-global-permissions) with the [Manage Node Drivers]({{< baseurl >}}/rancher/v2.x/en/concepts/global-configuration/users-permissions-roles/#global-permissions-reference) role assigned.
|
||||
|
||||
## Adding Custom Node Drivers
|
||||
|
||||
If you create a cluster using a cloud provider that {{< product >}} doesn't support out-of-the-box, you may need to add the provider's drivers (or create them yourself) so that your nodes function properly.
|
||||
|
||||
1. From the **Global** view, select **Node Drivers** from the main menu.
|
||||
|
||||
2. Click **Add Node Driver**.
|
||||
|
||||
3. Complete the **Add Node Driver** form. Then click **Create**.
|
||||
|
||||
## Activating Node Drivers
|
||||
|
||||
Using the **Custom** option, you can create a cluster using virtually any cloud provider. However, by default, {{< product >}} only activates drivers for the most popular cloud providers. If you want to use another provider, you'll have to activate their drivers.
|
||||
|
||||
1. From the **Global** view, select **Node Drivers** from the main menu.
|
||||
|
||||
2. Select the inactive drivers that you want to use. Then click **Add Node Driver**.
|
||||
|
||||
|
||||
### Node templates
|
||||
|
||||
You can create new clusters within Rancher using _node templates_. A node template is a virtual machine image used to create a Kubernetes cluster. While creating a cluster, Rancher will prompt you for an image to use as a template. Follow the directions on screen to create the template. During cluster creation, Rancher clones the template and installs different Kubernetes components.
|
||||
|
||||
After you add a node template to Rancher, its stored by the system so that you can use it when creating another cluster later. Node templates are bound to your login. After you add a template, you can remove them from your user profile.
|
||||
@@ -1,7 +1,9 @@
|
||||
---
|
||||
title: Creating an Azure Cluster
|
||||
shortTitle: Azure
|
||||
weight: 3300
|
||||
weight: 2220
|
||||
aliases:
|
||||
- /rancher/v2.x/en/tasks/clusters/creating-a-cluster/create-cluster-azure/
|
||||
---
|
||||
|
||||
Use {{< product >}} to create a Kubernetes cluster in Azure.
|
||||
@@ -1,7 +1,9 @@
|
||||
---
|
||||
title: Creating a DigitalOcean Clusters
|
||||
title: Creating a DigitalOcean Cluster
|
||||
shortTitle: DigitalOcean
|
||||
weight: 3275
|
||||
weight: 2215
|
||||
aliases:
|
||||
- /rancher/v2.x/en/tasks/clusters/creating-a-cluster/create-cluster-digital-ocean/
|
||||
---
|
||||
Use {{< product >}} to create a Kubernetes cluster using DigitalOcean.
|
||||
|
||||
@@ -1,7 +1,9 @@
|
||||
---
|
||||
title: Creating an Amazon EC2 Cluster
|
||||
shortTitle: Amazon EC2
|
||||
weight: 3250
|
||||
weight: 2210
|
||||
aliases:
|
||||
- /rancher/v2.x/en/tasks/clusters/creating-a-cluster/create-cluster-amazon-ec2/
|
||||
---
|
||||
Use {{< product >}} to create a Kubernetes cluster in Amazon EC2.
|
||||
|
||||
@@ -1,7 +1,9 @@
|
||||
---
|
||||
title: Creating a vSphere Cluster
|
||||
shortTitle: vSphere
|
||||
weight: 3375
|
||||
weight: 2225
|
||||
aliases:
|
||||
- /rancher/v2.x/en/tasks/clusters/creating-a-cluster/create-cluster-vsphere/
|
||||
---
|
||||
Use {{< product >}} to create a Kubernetes cluster in vSphere.
|
||||
|
||||
|
Before Width: | Height: | Size: 886 KiB After Width: | Height: | Size: 886 KiB |
|
Before Width: | Height: | Size: 879 KiB After Width: | Height: | Size: 879 KiB |
|
Before Width: | Height: | Size: 886 KiB After Width: | Height: | Size: 886 KiB |
|
Before Width: | Height: | Size: 823 KiB After Width: | Height: | Size: 823 KiB |
|
Before Width: | Height: | Size: 878 KiB After Width: | Height: | Size: 878 KiB |
|
Before Width: | Height: | Size: 801 KiB After Width: | Height: | Size: 801 KiB |
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: Cluster Options
|
||||
weight: 2250
|
||||
---
|
||||
@@ -1,6 +1,8 @@
|
||||
---
|
||||
title: Cloud Providers
|
||||
weight: 2110
|
||||
title: Selecting Cloud Providers
|
||||
weight: 2255
|
||||
aliases:
|
||||
- /rancher/v2.x/en/concepts/clusters/cloud-providers/
|
||||
---
|
||||
A _cloud provider_ is a module in Kubernetes that provides an interface for managing nodes, load balancers, and networking routes. You can configure a cloud provider to automatically provision load balancers or persistent storage devices when launching Kubernetes definitions, provided that the cloud provider you're using supports such automation.
|
||||
|
||||
@@ -25,7 +27,7 @@ When using the `Amazon` cloud provider, you can leverage the following capabilit
|
||||
- Create/configure an IAM role
|
||||
- Configuring the ClusterID
|
||||
|
||||
> **Note:** When you create an [Amazon EC2 Cluster]({{< baseurl >}}/rancher/v2.x/en/tasks/clusters/creating-a-cluster/create-cluster-amazon-ec2/#create-the-amazon-ec2-cluster), the `ClusterID` is automatically configured.
|
||||
> **Note:** When you create an [Amazon EC2 Cluster]({{< baseurl >}}/rancher/v2.x/en/clusters/rke-clusters/node-pools/ec2/#create-the-amazon-ec2-cluster), the `ClusterID` is automatically configured.
|
||||
|
||||
#### Create/Configure an IAM Role
|
||||
|
||||
@@ -33,8 +35,8 @@ All nodes added to the cluster must be able to interact with EC2 so that they ca
|
||||
|
||||
[EC2 documentation: Creating an IAM Role](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html#create-iam-role)
|
||||
|
||||
- While creating an [Amazon EC2 cluster]({{< baseurl >}}/rancher/v2.x/en/tasks/clusters/creating-a-cluster/create-cluster-amazon-ec2/#create-the-amazon-ec2-cluster), you must insert the name of the IAM role when creating the **Node Template**.
|
||||
- While creating a [Custom cluster]({{< baseurl >}}/rancher/v2.x/en/tasks/clusters/creating-a-cluster/create-cluster-custom/), you must manually attach the IAM role to the instance(s).
|
||||
- While creating an [Amazon EC2 cluster]({{< baseurl >}}/rancher/v2.x/en/clusters/rke-clusters/node-pools/ec2/#create-the-amazon-ec2-cluster), you must insert the name of the IAM role when creating the **Node Template**.
|
||||
- While creating a [Custom cluster]({{< baseurl >}}/rancher/v2.x/en/clusters/custom-clusters/), you must manually attach the IAM role to the instance(s).
|
||||
|
||||
The following IAM role can be created:
|
||||
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: Pod Security Policies
|
||||
weight: 2260
|
||||
---
|
||||
@@ -62,7 +62,7 @@ The following commands are available for use in Rancher CLI.
|
||||
|
||||
- `clusters, [cluster]`
|
||||
|
||||
Performs operations on your [clusters]({{< baseurl >}}/rancher/v2.x/en/concepts/clusters).
|
||||
Performs operations on your [clusters]({{< baseurl >}}/rancher/v2.x/en/clusters/).
|
||||
|
||||
- `context`
|
||||
|
||||
|
||||
@@ -1,28 +0,0 @@
|
||||
---
|
||||
title: Clusters
|
||||
weight: 2100
|
||||
---
|
||||
|
||||
## What's a Cluster?
|
||||
|
||||
A cluster is a group of computing resources that work as a team to accomplish a goal. Each individual computer in a cluster is called a _node_.
|
||||
|
||||
## Cluster Creation
|
||||
|
||||
Rancher simplifies creation of Kubernetes clusters by allowing you to create them with the Rancher UI rather than a config file.
|
||||
|
||||
### Node Components
|
||||
|
||||
A Kubernetes cluster contains 3 types of nodes: etcd nodes, control plane nodes, and worker nodes.
|
||||
|
||||
#### etcd Nodes
|
||||
|
||||
The etcd nodes are used to run the etcd database. etcd is a key value store used as Kubernetes’ backing store for all cluster data. Even though you can run etcd on a single node, you need 3, 5, or 7 nodes for redundancy.
|
||||
|
||||
#### Control Plane Nodes
|
||||
|
||||
The control plane nodes are used to run the Kubernetes API server, scheduler, and controller manager. Control plane nodes are stateless since all cluster data are stored on etcd nodes. You can run control plane on 1 node, although 2 or more nodes are required for redundancy. You can also run control plane on etcd nodes.
|
||||
|
||||
#### Worker Nodes
|
||||
|
||||
Worker nodes are used to run the kubelet and the workload. It also runs the storage and networking drivers and ingress controllers when required. You create as many worker nodes as needed for your workload needs.
|
||||
@@ -1,22 +0,0 @@
|
||||
---
|
||||
title: Cluster Providers
|
||||
weight: 2105
|
||||
---
|
||||
|
||||
## Rancher Kubernetes Engine (RKE)
|
||||
|
||||
RKE is Rancher’s own lightweight Kubernetes installer. It works with any cloud providers, virtualization platforms, or bare metal servers. It integrates with node drivers to automatically provision nodes on AWS, Azure, DigitalOcean, vSphere, OpenStack, etc. Users can add custom nodes to the cluster by running the Rancher agent on these nodes.
|
||||
|
||||
<!-- ### RKE Clusters and Kubeconfig Files
|
||||
|
||||
Craig! Fill me in!
|
||||
|
||||
-->
|
||||
|
||||
## Cloud-Managed Kubernetes Clusters
|
||||
|
||||
Rancher integrates with cloud APIs so users can provision GKE, EKS, and AKS clusters directly from Rancher. New cloud managed Kubernetes clusters will be added as they become available.
|
||||
|
||||
## Imported Clusters
|
||||
|
||||
Users can import an existing Kubernetes cluster into Rancher. Rancher does not automate the provisioning, scaling, and upgrade of imported Kubernetes clusters. All other cluster management, policy management, and workload management capabilities of Rancher apply to imported clustered.
|
||||
@@ -1,13 +0,0 @@
|
||||
---
|
||||
title: Node Drivers
|
||||
weight: 100
|
||||
---
|
||||
|
||||
Out-of-the-box, Rancher provides support for creating clusters using many popular cloud providers: Amazon EC2, Azure, DigitalOcean, and so on. However, you may want to create a cluster using another cloud provider. In these scenarios, you can create a custom node driver for the cloud provider and point Rancher toward it.
|
||||
|
||||
For more information on creating node drivers, see [https://github.com/rancher/ui-driver-skel](https://github.com/rancher/ui-driver-skel).
|
||||
|
||||
|
||||
## Related Links
|
||||
|
||||
- [Configuring Node Drivers]({{< baseurl >}}/rancher/v2.x/en/tasks/global-configuration/node-drivers)
|
||||
@@ -1,12 +0,0 @@
|
||||
---
|
||||
title: Node Templates
|
||||
weight: 125
|
||||
---
|
||||
|
||||
You can create new clusters within Rancher using _node templates_. A node template is a virtual machine image used to create a Kubernetes cluster. While creating a cluster, Rancher will prompt you for an image to use as a template. Follow the directions on screen to create the template. During cluster creation, Rancher clones the template and installs different Kubernetes components.
|
||||
|
||||
After you add a node template to Rancher, its stored by the system so that you can use it when creating another cluster later. Node templates are bound to your login. After you add a template, you can remove them from your user profile.
|
||||
|
||||
## Related Links
|
||||
|
||||
- [Creating a Cluster]({{< baseurl >}}/rancher/v2.x/en/tasks/clusters/creating-a-cluster)
|
||||
@@ -1,4 +0,0 @@
|
||||
---
|
||||
title: Clusters
|
||||
weight: 3175
|
||||
---
|
||||
@@ -1,6 +0,0 @@
|
||||
---
|
||||
title: Adding Users to a Cluster
|
||||
weight: 3425
|
||||
draft: true
|
||||
---
|
||||
Coming Soon
|
||||
@@ -1,5 +0,0 @@
|
||||
---
|
||||
title: Creating a Cluster
|
||||
weight: 3200
|
||||
---
|
||||
Rancher includes a variety of options for getting a Kubernetes cluster up and running using a single Linux node as a temple. Choose from one of the options below to get started!
|
||||
@@ -1,5 +0,0 @@
|
||||
---
|
||||
title: Cluster Options—Edit as YAML
|
||||
weight: 5000
|
||||
draft: true
|
||||
---
|
||||
@@ -1,11 +1,11 @@
|
||||
---
|
||||
title: Adding Project Members
|
||||
weight:
|
||||
weight:
|
||||
---
|
||||
|
||||
If you want to provide a user with access and permissions to _specific_ projects and resources within a cluster, assign the user a project membership.
|
||||
|
||||
>**Tip:** Want to provide a user with access to _all_ projects within a cluster? See [Adding Cluster Members]({{< baseurl >}}/rancher/v2.x/en/tasks/clusters/adding-managing-cluster-members) instead.
|
||||
>**Tip:** Want to provide a user with access to _all_ projects within a cluster? See [Adding Cluster Members]({{< baseurl >}}/rancher/v2.x/en/clusters/adding-users) instead.
|
||||
|
||||
There are two contexts where you can add project members:
|
||||
|
||||
@@ -28,9 +28,9 @@ Following project creation, you can add users as project members so that they ca
|
||||
3. Search for the user or group that you want to add to the project.
|
||||
|
||||
If external authentication is configured:
|
||||
|
||||
|
||||
- Rancher returns users from your external authentication source as you type.
|
||||
|
||||
|
||||
- A drop-down allows you to add groups instead of individual users. The dropdown only lists groups that you, the logged in user, are included in.
|
||||
|
||||
>**Note:** If you are logged in as a local user, external users do not display in your search results.
|
||||
|
||||
@@ -1,5 +0,0 @@
|
||||
---
|
||||
title: Managing Node Templates
|
||||
weight: 3727
|
||||
draft: true
|
||||
---
|
||||
@@ -26,7 +26,7 @@ Deploy a workload to run an application in one or more containers.
|
||||
Use this section to either specify environment variables for your workload to consume on the fly, or to pull them from another source, such as a secret or [ConfigMap]({{< baseurl >}}/rancher/v2.x/en/tasks/projects/add-configmaps/).
|
||||
|
||||
- **Node Scheduling**
|
||||
- **Health Check**
|
||||
- **Health Check**
|
||||
- **Volumes**
|
||||
|
||||
Use this section to add storage for your workload. You can manually specify the volume that you want to add, use a persistent volume claim to dynamically create a volume for the workload, or read data for a volume to use from a file such as a [ConfigMap]({{< baseurl >}}/rancher/v2.x/en/tasks/projects/add-configmaps/).
|
||||
@@ -39,7 +39,7 @@ Deploy a workload to run an application in one or more containers.
|
||||
>
|
||||
>- In [Amazon AWS](https://aws.amazon.com/), the nodes must be in the same Availability Zone and possess IAM permissions to attach/unattach volumes.
|
||||
>
|
||||
>- The cluster must be using the [AWS cloud provider](https://kubernetes.io/docs/concepts/cluster-administration/cloud-providers/#aws) option. For more information on enabling this option see [Creating an Amazon EC2 Cluster]({{< baseurl >}}/rancher/v2.x/en/tasks/clusters/creating-a-cluster/create-cluster-amazon-ec2/) or [Creating a Custom Cluster]({{< baseurl >}}/rancher/v2.x/en/tasks/clusters/creating-a-cluster/create-cluster-custom/).
|
||||
>- The cluster must be using the [AWS cloud provider](https://kubernetes.io/docs/concepts/cluster-administration/cloud-providers/#aws) option. For more information on enabling this option see [Creating an Amazon EC2 Cluster]({{< baseurl >}}/rancher/v2.x/en/clusters/rke-clusters/node-pools/ec2/) or [Creating a Custom Cluster]({{< baseurl >}}/rancher/v2.x/en/clusters/custom-clusters/).
|
||||
|
||||
|
||||
1. Click **Show Advanced Options** and configure:
|
||||
@@ -51,4 +51,4 @@ Deploy a workload to run an application in one or more containers.
|
||||
|
||||
1. Click **Launch**.
|
||||
|
||||
**Result:** The workload is deployed to the chosen namespace. You can view the workload's status from the project's **Workloads** view.
|
||||
**Result:** The workload is deployed to the chosen namespace. You can view the workload's status from the project's **Workloads** view.
|
||||
|
||||