rancher-docs/assets/js/962d7cf4.1ee3ee52.js

"use strict";(self.webpackChunkrancher_docs=self.webpackChunkrancher_docs||[]).push([[3266],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>m});var a=r(67294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function s(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?s(Object(r),!0).forEach((function(t){n(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):s(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function i(e,t){if(null==e)return{};var r,a,n=function(e,t){if(null==e)return{};var r,a,n={},s=Object.keys(e);for(a=0;a<s.length;a++)r=s[a],t.indexOf(r)>=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);for(a=0;a<s.length;a++)r=s[a],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var l=a.createContext({}),u=function(e){var t=a.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},c=function(e){var t=u(e.components);return a.createElement(l.Provider,{value:t},e.children)},p={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},d=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,s=e.originalType,l=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),d=u(r),m=n,h=d["".concat(l,".").concat(m)]||d[m]||p[m]||s;return r?a.createElement(h,o(o({ref:t},c),{},{components:r})):a.createElement(h,o({ref:t},c))}));function m(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var s=r.length,o=new Array(s);o[0]=d;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i.mdxType="string"==typeof e?e:n,o[1]=i;for(var u=2;u<s;u++)o[u]=r[u];return a.createElement.apply(null,o)}return a.createElement.apply(null,r)}d.displayName="MDXCreateElement"},59865:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>p,frontMatter:()=>s,metadata:()=>i,toc:()=>u});var a=r(87462),n=(r(67294),r(3905));const s={title:"Adding Users to Clusters"},o=void 0,i={unversionedId:"how-to-guides/new-user-guides/manage-clusters/access-clusters/add-users-to-clusters",id:"how-to-guides/new-user-guides/manage-clusters/access-clusters/add-users-to-clusters",title:"Adding Users to Clusters",description:"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.",source:"@site/docs/how-to-guides/new-user-guides/manage-clusters/access-clusters/add-users-to-clusters.md",sourceDirName:"how-to-guides/new-user-guides/manage-clusters/access-clusters",slug:"/how-to-guides/new-user-guides/manage-clusters/access-clusters/add-users-to-clusters",permalink:"/how-to-guides/new-user-guides/manage-clusters/access-clusters/add-users-to-clusters",draft:!1,editUrl:"https://github.com/rancher/rancher-docs/edit/main/docs/how-to-guides/new-user-guides/manage-clusters/access-clusters/add-users-to-clusters.md",tags:[],version:"current",lastUpdatedAt:1666730466,formattedLastUpdatedAt:"Oct 25, 2022",frontMatter:{title:"Adding Users to Clusters"},sidebar:"tutorialSidebar",previous:{title:"How the Authorized Cluster Endpoint Works",permalink:"/how-to-guides/new-user-guides/manage-clusters/access-clusters/authorized-cluster-endpoint"},next:{title:"Cluster Autoscaler",permalink:"/pages-for-subheaders/install-cluster-autoscaler"}},l={},u=[{value:"Editing Cluster Membership",id:"editing-cluster-membership",level:2}],c={toc:u};function p(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,"If you want to provide a user with access and permissions to ",(0,n.kt)("em",{parentName:"p"},"all")," projects, nodes, and resources within a cluster, assign the user a cluster membership."),(0,n.kt)("admonition",{type:"tip"},(0,n.kt)("p",{parentName:"admonition"},"Want to provide a user with access to a ",(0,n.kt)("em",{parentName:"p"},"specific")," project within a cluster? See ",(0,n.kt)("a",{parentName:"p",href:"/how-to-guides/new-user-guides/add-users-to-projects"},"Adding Project Members")," instead.")),(0,n.kt)("p",null,"There are two contexts where you can add cluster members:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},"Adding Members to a New Cluster"),(0,n.kt)("p",{parentName:"li"},"  You can add members to a cluster as you create it (recommended if possible).")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"#editing-cluster-membership"},"Adding Members to an Existing Cluster")),(0,n.kt)("p",{parentName:"li"},"  You can always add members to a cluster after a cluster is provisioned."))),(0,n.kt)("h2",{id:"editing-cluster-membership"},"Editing Cluster Membership"),(0,n.kt)("p",null,"Cluster administrators can edit the membership for a cluster, controlling which Rancher users can access the cluster and what features they can use."),(0,n.kt)("ol",null,(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},"Click ",(0,n.kt)("strong",{parentName:"p"},"\u2630 > Cluster Management"),".")),(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},"Go to the cluster you want to add members to and click ",(0,n.kt)("strong",{parentName:"p"},"\u22ee > Edit Config"),".")),(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},"In the ",(0,n.kt)("strong",{parentName:"p"},"Member Roles")," tab, click ",(0,n.kt)("strong",{parentName:"p"},"Add Member"),".")),(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},"Search for the user or group that you want to add to the cluster."),(0,n.kt)("p",{parentName:"li"},"If external authentication is configured:"),(0,n.kt)("ul",{parentName:"li"},(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},"Rancher returns users from your ",(0,n.kt)("a",{parentName:"p",href:"/pages-for-subheaders/authentication-config"},"external authentication")," source as you type."),(0,n.kt)("admonition",{parentName:"li",title:"Using AD but can't find your users?",type:"note"},(0,n.kt)("p",{parentName:"admonition"},"There may be an issue with your search attribute configuration. See ",(0,n.kt)("a",{parentName:"p",href:"/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config/configure-active-directory"},"Configuring Active Directory Authentication: Step 5"),"."))),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},"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."),(0,n.kt)("admonition",{parentName:"li",type:"note"},(0,n.kt)("p",{parentName:"admonition"},"If you are logged in as a local user, external users do not display in your search results. For more information, see ",(0,n.kt)("a",{parentName:"p",href:"/pages-for-subheaders/authentication-config#external-authentication-configuration-and-principal-users"},"External Authentication Configuration and Principal Users"),"."))))),(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},"Assign the user or group ",(0,n.kt)("strong",{parentName:"p"},"Cluster")," roles."),(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/cluster-and-project-roles"},"What are Cluster Roles?")),(0,n.kt)("admonition",{parentName:"li",type:"tip"},(0,n.kt)("p",{parentName:"admonition"},"For Custom Roles, you can modify the list of individual roles available for assignment."),(0,n.kt)("ul",{parentName:"admonition"},(0,n.kt)("li",{parentName:"ul"},"To add roles to the list, ",(0,n.kt)("a",{parentName:"li",href:"/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/custom-roles"},"Add a Custom Role"),"."),(0,n.kt)("li",{parentName:"ul"},"To remove roles from the list, ",(0,n.kt)("a",{parentName:"li",href:"/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/locked-roles"},"Lock/Unlock Roles"),"."))))),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},"Result:")," The chosen users are added to the cluster."),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},"To revoke cluster membership, select the user and click ",(0,n.kt)("strong",{parentName:"li"},"Delete"),". This action deletes membership, not the user."),(0,n.kt)("li",{parentName:"ul"},"To modify a user's roles in the cluster, delete them from the cluster, and then re-add them with modified roles.")))}p.isMDXComponent=!0}}]);