diff --git a/content/rancher/v2.x/en/admin-settings/rbac/global-permissions/_index.md b/content/rancher/v2.x/en/admin-settings/rbac/global-permissions/_index.md index 4322fcd314b..1263a405b79 100644 --- a/content/rancher/v2.x/en/admin-settings/rbac/global-permissions/_index.md +++ b/content/rancher/v2.x/en/admin-settings/rbac/global-permissions/_index.md @@ -43,6 +43,7 @@ The following table lists each custom global permission available and whether it | ---------------------------------- | ------------- | ------------- | | Manage Authentication | ✓ | | | Manage Catalogs | ✓ | | +| Manage Cluster Drivers | ✓ | | | Manage Node Drivers | ✓ | | | Manage PodSecurityPolicy Templates | ✓ | | | Manage Roles | ✓ | | diff --git a/content/rancher/v2.x/en/drivers/_index.md b/content/rancher/v2.x/en/drivers/_index.md index 8921c93897d..9ab7caf6690 100644 --- a/content/rancher/v2.x/en/drivers/_index.md +++ b/content/rancher/v2.x/en/drivers/_index.md @@ -3,13 +3,31 @@ title: Drivers weight: 3500 --- -NEED SOME GENERAL CONTENT ON DRIVERS: +Drivers in Rancher allow you to manage clusters and nodes across a variety of infrastructure types within the Rancher UI. -* flexibility to make your own and add in to Rancher -* high level diff between cluster driver vs. node driver +### Rancher drivers enable +* The flexibility to create your own driver for your infrastructure needs +* Easily adopt new infrastructure into your existing Rancher workflow -## Cluster Drivers +\ +There are two types of drivers within Rancher +## [Cluster Drivers]({{< baseurl >}}rancher/v2.x/en/drivers/cluster-drivers/) -_Available as of v2.2_ +_Available as of v2.2_ \ +Cluster drivers allow the provisioning of [hosted kubernetes clusters]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/hosted-kubernetes-clusters/) with cloud providers, such as GKE, or [Rancher launched kubernetes]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/) with RKE. \ +Rancher supports several hosted kubernetes cloud providers out-of-the-box including: + +* Amazon EKS +* Google GKE +* Azure AKS + +## [Node Drivers]({{< baseurl >}}rancher/v2.x/en/drivers/node-drivers/) + +Node drivers are used for the remote provisioning of hosts. Rancher supports several major cloud providers out-of-the-box including: \ + + +* Amazon EC2 +* Azure +* Digital Ocean +* vSphere -## Node Drivers diff --git a/content/rancher/v2.x/en/drivers/cluster-drivers/_index.md b/content/rancher/v2.x/en/drivers/cluster-drivers/_index.md index 2ec2e091611..adcb104c94e 100644 --- a/content/rancher/v2.x/en/drivers/cluster-drivers/_index.md +++ b/content/rancher/v2.x/en/drivers/cluster-drivers/_index.md @@ -3,3 +3,44 @@ title: Cluster Drivers weight: 1 aliases: --- +_Available as of v2.2_ + +Cluster drivers are used to create clusters in a [hosted Kubernetes provider]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/hosted-kubernetes-clusters/), such as Google GKE or [Rancher launched Kubernetes]({{< baseurl >}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/) + +A cluster driver is similar to a node driver but for provisioning kubernetes clusters. Rancher uses the cluster driver to provision and manage the cluster. The availability of which cluster driver to display when creating clusters is defined by the cluster driver's status. Only `active` cluster drivers will be displayed as an option for creating clusters. By default, Rancher is packaged with several existing cloud provider cluster drivers but you can also add custom cluster drivers to Rancher. + +If there are specific cluster drivers that you do not want to show your users, you may deactivate those cluster drivers within Rancher and they will not appear as an option for cluster creation. + +### Managing Cluster Drivers +>**Prerequisites:** To create, edit, or delete drivers, you need _one_ of the following permissions: +> +>- [Administrator Global Permissions]({{< baseurl >}}/rancher/v2.x/en/admin-settings/rbac/global-permissions/) +>- [Custom Global Permissions]({{< baseurl >}}/rancher/v2.x/en/admin-settings/rbac/global-permissions/#custom-global-permissions) with the [Manage Cluster Drivers]({{< baseurl >}}/rancher/v2.x/en/admin-settings/rbac/global-permissions/#global-permissions-reference) role assigned. + +## Activating/Deactivating Cluster Drivers + +By default, Rancher activates drivers for some common Kubernetes providers. If you want to activate or deactivate additional drivers follow these steps: + +1. From the **Global** view, choose **Tools > Drivers** in the navigation bar. In version prior to v2.2.0, you can select **Drivers** directly in the navigation bar. + +2. From the **Drivers** page, select the **Cluster Drivers** tab. + +3. Select the driver that you wish to **Activate** or **Deactivate** and select the appropriate icon. + + + +## Adding Custom Cluster Drivers + +If you want to use a cluster driver that Rancher doesn't support out-of-the-box, you can add the provider's driver in order to start using them to create _hosted_ kubernetes clusters. + +1. From the **Global** view, choose **Tools > Drivers** in the navigation bar. In version prior to v2.2.0, you can select **Drivers** directly in the navigation bar. + +2. From the **Drivers** page select the **Cluster Drivers** tab + +3. Click **Add Cluster Driver**. + +4. Complete the **Add Cluster Driver** form. Then click **Create** + + +### Developing your own cluster driver +To develop your own pluggable cluster driver please see this [example](https://github.com/rancher-plugins/kontainer-engine-driver-example) diff --git a/content/rancher/v2.x/en/drivers/node-drivers/_index.md b/content/rancher/v2.x/en/drivers/node-drivers/_index.md index a15f40cb05c..a7318e308e3 100644 --- a/content/rancher/v2.x/en/drivers/node-drivers/_index.md +++ b/content/rancher/v2.x/en/drivers/node-drivers/_index.md @@ -3,3 +3,40 @@ title: Node Drivers weight: 2 aliases: --- + +Node drivers are used to provision hosts. The availability of which node driver to display when creating node templates is defined based on the node driver's status. Only `active` node drivers will be displayed as an option for creating node templates. By default, Rancher is packaged with many existing Docker Machine drivers, but you can also create custom node drivers to add to Rancher. + +If there are specific node drivers that you don't want to show to your users, you would need to de-activate these node drivers. + +#### 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/admin-settings/rbac/global-permissions/) +>- [Custom Global Permissions]({{< baseurl >}}/rancher/v2.x/en/admin-settings/rbac/global-permissions/#custom-global-permissions) with the [Manage Node Drivers]({{< baseurl >}}/rancher/v2.x/en/admin-settings/rbac/global-permissions/#global-permissions-reference) role assigned. + +## Activating/Deactivating Node Drivers + +By default, Rancher only activates drivers for the most popular cloud providers, Amazon EC2, Azure, DigitalOcean and vSphere. If you want to show or hide any node driver, you can change it's status. + +1. From the **Global** view, choose **Tools > Drivers** in the navigation bar. In version prior to v2.2.0, you can select **Drivers** directly in the navigation bar. + +2. From the **Drivers** page, select the **Node Drivers** tab. + +3. Select the driver that you wish to **Activate** or **Deactivate** and select the appropriate icon. + + +## Adding Custom Node Drivers + +If you want to use a node driver that Rancher doesn't support out-of-the-box, you can add the provider's drivers in order to start using them to create node templates and eventually node pools. + +1. From the **Global** view, choose **Tools > Drivers** in the navigation bar. In version prior to v2.2.0, you can select **Drivers** directly in the navigation bar. + +2. From the **Drivers** page, select the **Node Drivers** tab + +3. Click **Add Node Driver**. + +4. Complete the **Add Node Driver** form. Then click **Create**. + +### Developing your own node driver +Node drivers are implemented with [Docker Machine](https://docs.docker.com/machine/). \ No newline at end of file