Skip to content

Commit

Permalink
OSDOCS-959 cluster-admin documentation added
Browse files Browse the repository at this point in the history
additional content created

corrections

additional changes

updated with feedback review
  • Loading branch information
sheriff-rh committed May 18, 2020
1 parent 495236b commit 833e77c
Show file tree
Hide file tree
Showing 4 changed files with 54 additions and 0 deletions.
2 changes: 2 additions & 0 deletions _topic_map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,8 @@ Distros: openshift-dedicated
Topics:
- Name: The dedicated-admin role
File: dedicated-admin-role
- Name: The cluster-admin role
File: cluster-admin-role
---
Name: Installing
Dir: installing
Expand Down
11 changes: 11 additions & 0 deletions administering_a_cluster/cluster-admin-role.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
[id="cluster-administrator-role"]
= The cluster-admin role
include::modules/common-attributes.adoc[]
:context: cluster-administrator
toc::[]

As an administrator of {product-title} with Customer Cloud Subscriptions (link:https://www.openshift.com/dedicated/ccs[CCS]), you can request additional permissions and access to the *cluster-admin* role within your organization's cluster. While logged into an account with the cluster-admin role, users have increased permissions to run privileged security contexts and install additional Operators for their environment.

include::modules/dedicated-cluster-admin-enable.adoc[leveloffset=+1]

include::modules/dedicated-cluster-admin-grant.adoc[leveloffset=+1]
15 changes: 15 additions & 0 deletions modules/dedicated-cluster-admin-enable.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
// Module included in the following assemblies:
//
// administering_a_cluster/cluster-admin-role.adoc

[id="dedicated-cluster-admin-enable"]
= Enabling the cluster-admin role for your cluster

The cluster-admin role must be enabled at the cluster level before it can be assigned to a user.

.Prerequisites
. Open a technical support case with Red Hat to request that `cluster-admin` be enabled for your cluster.

.Procedure
. In the OpenShift Cluster Manager, select the cluster you want to assign cluster-admin privileges.
. Under the *Actions* dropdown menu, select *Allow cluster-admin access*.
26 changes: 26 additions & 0 deletions modules/dedicated-cluster-admin-grant.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
// Module included in the following assemblies:
//
// administering_a_cluster/cluster-admin-role.adoc

[id="dedicated-cluster-admin-grant"]
= Granting the cluster-admin role to users

After enabling cluster-admin rights on your cluster, you can assign the role to users.

.Prerequisites
* Cluster access with cluster owner permissions

.Procedure
. In the OpenShift Cluster Manager, select the cluster you want to assign cluster-admin privileges.
. Under the *Access Control* tab, locate the *Cluster Administrative Users* section. Click *Add user*.
. After determining an appropriate User ID, select *cluster-admin* from the *Group* selection, then click *Add user*.
+
[NOTE]
====
Cluster-admin user creation can take several minutes to complete.
====
+
[NOTE]
====
Existing dedicated-admin users cannot elevate their role to cluster-admin. Users must be deleted and added as a new user with the correct permissions assigned.
====

0 comments on commit 833e77c

Please sign in to comment.