rancher-docs/assets/js/3d8c8dcf.e2c7aa74.js

"use strict";(self.webpackChunkrancher_docs=self.webpackChunkrancher_docs||[]).push([[16152],{3905:(e,r,t)=>{t.d(r,{Zo:()=>c,kt:()=>v});var i=t(67294);function n(e,r,t){return r in e?Object.defineProperty(e,r,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[r]=t,e}function a(e,r){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);r&&(i=i.filter((function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable}))),t.push.apply(t,i)}return t}function o(e){for(var r=1;r<arguments.length;r++){var t=null!=arguments[r]?arguments[r]:{};r%2?a(Object(t),!0).forEach((function(r){n(e,r,t[r])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):a(Object(t)).forEach((function(r){Object.defineProperty(e,r,Object.getOwnPropertyDescriptor(t,r))}))}return e}function s(e,r){if(null==e)return{};var t,i,n=function(e,r){if(null==e)return{};var t,i,n={},a=Object.keys(e);for(i=0;i<a.length;i++)t=a[i],r.indexOf(t)>=0||(n[t]=e[t]);return n}(e,r);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(i=0;i<a.length;i++)t=a[i],r.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(n[t]=e[t])}return n}var l=i.createContext({}),u=function(e){var r=i.useContext(l),t=r;return e&&(t="function"==typeof e?e(r):o(o({},r),e)),t},c=function(e){var r=u(e.components);return i.createElement(l.Provider,{value:r},e.children)},d={inlineCode:"code",wrapper:function(e){var r=e.children;return i.createElement(i.Fragment,{},r)}},p=i.forwardRef((function(e,r){var t=e.components,n=e.mdxType,a=e.originalType,l=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),p=u(t),v=n,g=p["".concat(l,".").concat(v)]||p[v]||d[v]||a;return t?i.createElement(g,o(o({ref:r},c),{},{components:t})):i.createElement(g,o({ref:r},c))}));function v(e,r){var t=arguments,n=r&&r.mdxType;if("string"==typeof e||n){var a=t.length,o=new Array(a);o[0]=p;var s={};for(var l in r)hasOwnProperty.call(r,l)&&(s[l]=r[l]);s.originalType=e,s.mdxType="string"==typeof e?e:n,o[1]=s;for(var u=2;u<a;u++)o[u]=t[u];return i.createElement.apply(null,o)}return i.createElement.apply(null,t)}p.displayName="MDXCreateElement"},37147:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>l,contentTitle:()=>o,default:()=>d,frontMatter:()=>a,metadata:()=>s,toc:()=>u});var i=t(87462),n=(t(67294),t(3905));const a={title:"Cluster Drivers"},o=void 0,s={unversionedId:"how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers",id:"version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers",title:"Cluster Drivers",description:"Cluster drivers are used to create clusters in a hosted Kubernetes provider, such as Google GKE. 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.",source:"@site/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md",sourceDirName:"how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers",slug:"/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers",permalink:"/v2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers",draft:!1,editUrl:"https://github.com/rancher/rancher-docs/edit/main/versioned_docs/version-2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md",tags:[],version:"2.6",lastUpdatedAt:1668452187,formattedLastUpdatedAt:"Nov 14, 2022",frontMatter:{title:"Cluster Drivers"},sidebar:"tutorialSidebar",previous:{title:"Provisioning Drivers",permalink:"/v2.6/pages-for-subheaders/about-provisioning-drivers"},next:{title:"Node Drivers",permalink:"/v2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-node-drivers"}},l={},u=[{value:"Managing Cluster Drivers",id:"managing-cluster-drivers",level:3},{value:"Activating/Deactivating Cluster Drivers",id:"activatingdeactivating-cluster-drivers",level:2},{value:"Adding Custom Cluster Drivers",id:"adding-custom-cluster-drivers",level:2},{value:"Developing your own Cluster Driver",id:"developing-your-own-cluster-driver",level:3}],c={toc:u};function d(e){let{components:r,...t}=e;return(0,n.kt)("wrapper",(0,i.Z)({},c,t,{components:r,mdxType:"MDXLayout"}),(0,n.kt)("p",null,"Cluster drivers are used to create clusters in a ",(0,n.kt)("a",{parentName:"p",href:"/v2.6/pages-for-subheaders/set-up-clusters-from-hosted-kubernetes-providers"},"hosted Kubernetes provider"),", such as Google GKE. The availability of which cluster driver to display when creating clusters is defined by the cluster driver's status. Only ",(0,n.kt)("inlineCode",{parentName:"p"},"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."),(0,n.kt)("p",null,"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."),(0,n.kt)("h3",{id:"managing-cluster-drivers"},"Managing Cluster Drivers"),(0,n.kt)("admonition",{title:"Prerequisites:",type:"note"},(0,n.kt)("p",{parentName:"admonition"},"To create, edit, or delete cluster drivers, you need ",(0,n.kt)("em",{parentName:"p"},"one")," of the following permissions:"),(0,n.kt)("ul",{parentName:"admonition"},(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/v2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions"},"Administrator Global Permissions")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/v2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions#custom-global-permissions"},"Custom Global Permissions")," with the ",(0,n.kt)("a",{parentName:"li",href:"/v2.6/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions"},"Manage Cluster Drivers")," role assigned."))),(0,n.kt)("h2",{id:"activatingdeactivating-cluster-drivers"},"Activating/Deactivating Cluster Drivers"),(0,n.kt)("p",null,"By default, Rancher only activates drivers for the most popular cloud providers, Google GKE, Amazon EKS and Azure AKS. If you want to show or hide any node driver, you can change its status."),(0,n.kt)("ol",null,(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},"In the upper left corner, click ",(0,n.kt)("strong",{parentName:"p"},"\u2630 > Cluster Management"),".")),(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},"In the left navigation menu, click ",(0,n.kt)("strong",{parentName:"p"},"Drivers"),".")),(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},"On the ",(0,n.kt)("strong",{parentName:"p"},"Cluster Drivers")," tab, select the driver that you wish to activate or deactivate and click ",(0,n.kt)("strong",{parentName:"p"},"\u22ee > Activate")," or ",(0,n.kt)("strong",{parentName:"p"},"\u22ee > Deactivate"),"."))),(0,n.kt)("h2",{id:"adding-custom-cluster-drivers"},"Adding Custom Cluster Drivers"),(0,n.kt)("p",null,"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 ",(0,n.kt)("em",{parentName:"p"},"hosted")," kubernetes clusters."),(0,n.kt)("ol",null,(0,n.kt)("li",{parentName:"ol"},"In the upper left corner, click ",(0,n.kt)("strong",{parentName:"li"},"\u2630 > Cluster Management"),"."),(0,n.kt)("li",{parentName:"ol"},"In the left navigation menu, click ",(0,n.kt)("strong",{parentName:"li"},"Drivers"),"."),(0,n.kt)("li",{parentName:"ol"},"On the ",(0,n.kt)("strong",{parentName:"li"},"Cluster Drivers")," tab, click ",(0,n.kt)("strong",{parentName:"li"},"Add Cluster Driver"),"."),(0,n.kt)("li",{parentName:"ol"},"Complete the ",(0,n.kt)("strong",{parentName:"li"},"Add Cluster Driver")," form. Then click ",(0,n.kt)("strong",{parentName:"li"},"Create"),".")),(0,n.kt)("h3",{id:"developing-your-own-cluster-driver"},"Developing your own Cluster Driver"),(0,n.kt)("p",null,"In order to develop cluster driver to add to Rancher, please refer to our ",(0,n.kt)("a",{parentName:"p",href:"https://github.com/rancher-plugins/kontainer-engine-driver-example"},"example"),"."))}d.isMDXComponent=!0}}]);