Access control and user management
Configuring user authentication and access controls for users and namespaces
Abstract
Chapter 1. Configuring Argo CD RBAC Copy linkLink copied to clipboard!
By default, if you are logged into Argo CD using Red Hat SSO (RH SSO), you are a read-only user. You can change and manage the user level access.
1.1. Configuring user level access Copy linkLink copied to clipboard!
To manage and modify the user level access, configure the role-based access control (RBAC) section in the Argo CD custom resource (CR).
Procedure
Edit the
argocd
CR:oc edit argocd [argocd-instance-name] -n [namespace]
$ oc edit argocd [argocd-instance-name] -n [namespace]
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Output
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Add the
policy
configuration to therbac
section and add thename
,email
and therole
of the user:Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Currently, RHSSO cannot read the group information of Red Hat OpenShift GitOps users. Therefore, configure the RBAC at the user level.
1.2. Modifying RHSSO resource requests/limits Copy linkLink copied to clipboard!
By default, the RHSSO container is created with resource requests and limitations. You can change and manage the resource requests.
Resource | Requests | Limits |
---|---|---|
CPU | 500 | 1000m |
Memory | 512 Mi | 1024 Mi |
Procedure
- Modify the default resource requirements patching the Argo CD custom resource (CR):
oc -n openshift-gitops patch argocd openshift-gitops --type='json' -p='[{"op": "add", "path": "/spec/sso", "value": {"provider": "keycloak", "resources": {"requests": {"cpu": "512m", "memory": "512Mi"}, "limits": {"cpu": "1024m", "memory": "1024Mi"}} }}]'
$ oc -n openshift-gitops patch argocd openshift-gitops --type='json' -p='[{"op": "add", "path": "/spec/sso", "value": {"provider": "keycloak", "resources": {"requests": {"cpu": "512m", "memory": "512Mi"}, "limits": {"cpu": "1024m", "memory": "1024Mi"}} }}]'
RHSSO created by the Red Hat OpenShift GitOps only persists the changes that are made by the operator. If the RHSSO restarts, any additional configuration created by the Admin in RHSSO is deleted.
Chapter 2. Configuring SSO for Argo CD using Dex Copy linkLink copied to clipboard!
After the Red Hat OpenShift GitOps Operator is installed, Argo CD automatically creates a user with admin
permissions. To manage multiple users, cluster administrators can use Argo CD to configure Single Sign-On (SSO).
The spec.dex
parameter in the ArgoCD CR is no longer supported from Red Hat OpenShift GitOps v1.10.0 onwards. Consider using the .spec.sso
parameter instead.
2.1. Configuration to enable the Dex OpenShift OAuth Connector Copy linkLink copied to clipboard!
Dex is installed by default for all the Argo CD instances created by the Operator. You can configure Red Hat OpenShift GitOps to use Dex as the SSO authentication provider by setting the .spec.sso
parameter.
Dex uses the users and groups defined within OpenShift Container Platform by checking the OAuth
server provided by the platform.
Procedure
To enable Dex, set the
.spec.sso.provider
parameter todex
in the YAML resource of the Operator:Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- The
openShiftOAuth
property triggers the Operator to automatically configure the built-in OpenShift Container PlatformOAuth
server when the value is set totrue
.
2.1.1. Mapping users to specific roles Copy linkLink copied to clipboard!
Argo CD cannot map users to specific roles if they have a direct ClusterRoleBinding
role. You can manually change the role as role:admin
on SSO through OpenShift.
Procedure
Create a group named
cluster-admins
.oc adm groups new cluster-admins
$ oc adm groups new cluster-admins
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Add the user to the group.
oc adm groups add-users cluster-admins USER
$ oc adm groups add-users cluster-admins USER
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Apply the
cluster-admin
ClusterRole
to the group:oc adm policy add-cluster-role-to-group cluster-admin cluster-admins
$ oc adm policy add-cluster-role-to-group cluster-admin cluster-admins
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
2.2. Disabling Dex by replacing .spec.sso Copy linkLink copied to clipboard!
-
To disable dex, either remove the
spec.sso
element from the Argo CD custom resource or specify a different SSO provider.
Chapter 3. Configuring SSO for Argo CD using Keycloak Copy linkLink copied to clipboard!
After the Red Hat OpenShift GitOps Operator is installed, Argo CD automatically creates a user with admin
permissions. To manage multiple users, cluster administrators can use Argo CD to configure Single Sign-On (SSO).
3.1. Prerequisites Copy linkLink copied to clipboard!
- Red Hat SSO is installed on the cluster.
- Red Hat OpenShift GitOps Operator is installed on the cluster.
- Argo CD is installed on the cluster.
3.2. Configuring a new client in Keycloak Copy linkLink copied to clipboard!
Dex is installed by default for all the Argo CD instances created by the Operator. However, you can delete the Dex configuration and add Keycloak instead to log in to Argo CD using your OpenShift credentials. Keycloak acts as an identity broker between Argo CD and OpenShift.
Procedure
To configure Keycloak, follow these steps:
Delete the Dex configuration by removing the
.spec.sso.dex
parameter from the Argo CD custom resource (CR), and save the CR:Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
Set the value of the
provider
parameter tokeycloak
in the Argo CD CR. Configure Keycloak by performing one of the following steps:
For a secure connection, set the value of the
rootCA
parameter as shown in the following example:Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- A custom certificate used to verify the Keycloak’s TLS certificate.
The Operator reconciles changes in the
.spec.sso.keycloak.rootCA
parameter and updates theoidc.config
parameter with the PEM encoded root certificate in theargocd-cm
configuration map.For an insecure connection, leave the value of the
rootCA
parameter empty and use theoidc.tls.insecure.skip.verify
parameter as shown below:Copy to Clipboard Copied! Toggle word wrap Toggle overflow
The Keycloak instance takes 2-3 minutes to install and run.
3.3. Logging in to Keycloak Copy linkLink copied to clipboard!
Log in to the Keycloak console to manage identities or roles and define the permissions assigned to the various roles.
Prerequisites
- The default configuration of Dex is removed.
- Your Argo CD CR must be configured to use the Keycloak SSO provider.
Procedure
Get the Keycloak route URL for login:
oc -n argocd get route keycloak
$ oc -n argocd get route keycloak NAME HOST/PORT PATH SERVICES PORT TERMINATION WILDCARD keycloak keycloak-default.apps.ci-ln-******.origin-ci-int-aws.dev.**.com keycloak <all> reencrypt None
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Get the Keycloak pod name that stores the user name and password as environment variables:
oc -n argocd get pods
$ oc -n argocd get pods NAME READY STATUS RESTARTS AGE keycloak-1-2sjcl 1/1 Running 0 45m
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Get the Keycloak user name:
oc -n argocd exec keycloak-1-2sjcl -- "env" | grep SSO_ADMIN_USERNAME
$ oc -n argocd exec keycloak-1-2sjcl -- "env" | grep SSO_ADMIN_USERNAME SSO_ADMIN_USERNAME=Cqid54Ih
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Get the Keycloak password:
oc -n argocd exec keycloak-1-2sjcl -- "env" | grep SSO_ADMIN_PASSWORD
$ oc -n argocd exec keycloak-1-2sjcl -- "env" | grep SSO_ADMIN_PASSWORD SSO_ADMIN_PASSWORD=GVXxHifH
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
On the login page, click LOG IN VIA KEYCLOAK.
NoteYou only see the option LOGIN VIA KEYCLOAK after the Keycloak instance is ready.
Click Login with OpenShift.
NoteLogin using
kubeadmin
is not supported.- Enter the OpenShift credentials to log in.
Optional: By default, any user logged in to Argo CD has read-only access. You can manage the user level access by updating the
argocd-rbac-cm
config map:policy.csv: <name>, <email>, role:admin
policy.csv: <name>, <email>, role:admin
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
3.4. Uninstalling Keycloak Copy linkLink copied to clipboard!
You can delete the Keycloak resources and their relevant configurations by removing the SSO
field from the Argo CD Custom Resource (CR) file. After you remove the SSO
field, the values in the file look similar to the following:
A Keycloak application created by using this method is currently not persistent. Additional configurations created in the Argo CD Keycloak realm are deleted when the server restarts.