第 4 章 Configuring identity providers
4.1. Configuring an HTPasswd identity provider 复制链接链接已复制到粘贴板!
By default, only a kubeadmin user exists on your cluster. To specify an identity provider, you must create a Custom Resource (CR) that describes that identity provider and add it to the cluster.
OpenShift Container Platform user names containing /, :, and % are not supported.
To define an HTPasswd identity provider you must perform the following steps:
-
Create an
htpasswdfile to store the user and password information. Instructions are provided for Linux and Windows. -
Create an OpenShift Container Platform secret to represent the
htpasswdfile. - Define the HTPasswd identity provider resource.
- Apply the resource to the default OAuth configuration.
4.1.2. Creating an HTPasswd file using Linux 复制链接链接已复制到粘贴板!
To use the HTPasswd identity provider, you must generate a flat file that contains the user names and passwords for your cluster by using htpasswd.
Prerequisites
-
Have access to the
htpasswdutility. On Red Hat Enterprise Linux this is available by installing thehttpd-toolspackage.
Procedure
Create or update your flat file with a user name and hashed password:
$ htpasswd -c -B -b </path/to/users.htpasswd> <user_name> <password>The command generates a hashed version of the password.
For example:
$ htpasswd -c -B -b users.htpasswd user1 MyPassword!Example output
Adding password for user user1Continue to add or update credentials to the file:
$ htpasswd -B -b </path/to/users.htpasswd> <user_name> <password>
4.1.3. Creating an HTPasswd file using Windows 复制链接链接已复制到粘贴板!
To use the HTPasswd identity provider, you must generate a flat file that contains the user names and passwords for your cluster by using htpasswd.
Prerequisites
-
Have access to
htpasswd.exe. This file is included in the\bindirectory of many Apache httpd distributions.
Procedure
Create or update your flat file with a user name and hashed password:
> htpasswd.exe -c -B -b <\path\to\users.htpasswd> <user_name> <password>The command generates a hashed version of the password.
For example:
> htpasswd.exe -c -B -b users.htpasswd user1 MyPassword!Example output
Adding password for user user1Continue to add or update credentials to the file:
> htpasswd.exe -b <\path\to\users.htpasswd> <user_name> <password>
4.1.4. Creating the HTPasswd Secret 复制链接链接已复制到粘贴板!
To use the HTPasswd identity provider, you must define a secret that contains the HTPasswd user file.
Prerequisites
- Create an HTPasswd file.
Procedure
Create an OpenShift Container Platform
Secretobject that contains the HTPasswd users file.$ oc create secret generic htpass-secret --from-file=htpasswd=</path/to/users.htpasswd> -n openshift-config注意The secret key containing the users file for the
--from-fileargument must be namedhtpasswd, as shown in the above command.
4.1.5. Sample HTPasswd CR 复制链接链接已复制到粘贴板!
The following custom resource (CR) shows the parameters and acceptable values for an HTPasswd identity provider.
HTPasswd CR
apiVersion: config.openshift.io/v1
kind: OAuth
metadata:
name: cluster
spec:
identityProviders:
- name: my_htpasswd_provider
mappingMethod: claim
type: HTPasswd
htpasswd:
fileData:
name: htpass-secret
Additional resources
-
See Identity provider parameters for information on parameters, such as
mappingMethod, that are common to all identity providers.
4.1.6. Adding an identity provider to your clusters 复制链接链接已复制到粘贴板!
After you install your cluster, add an identity provider to it so your users can authenticate.
Prerequisites
- Create an OpenShift Container Platform cluster.
- Create the custom resource (CR) for your identity providers.
- You must be logged in as an administrator.
Procedure
Apply the defined CR:
$ oc apply -f </path/to/CR>注意If a CR does not exist,
oc applycreates a new CR and might trigger the following warning:Warning: oc apply should be used on resources created by either oc create --save-config or oc apply. In this case you can safely ignore this warning.Log in to the cluster as a user from your identity provider, entering the password when prompted.
$ oc login -u <username>Confirm that the user logged in successfully, and display the user name.
$ oc whoami
4.1.7. Updating users for an HTPasswd identity provider 复制链接链接已复制到粘贴板!
You can add or remove users from an existing HTPasswd identity provider.
Prerequisites
-
You have created a
Secretobject that contains the HTPasswd user file. This procedure assumes that it is namedhtpass-secret. -
You have configured an HTPasswd identity provider. This procedure assumes that it is named
my_htpasswd_provider. -
You have access to the
htpasswdutility. On Red Hat Enterprise Linux this is available by installing thehttpd-toolspackage. - You have cluster administrator privileges.
Procedure
Retrieve the HTPasswd file from the
htpass-secretSecretobject and save the file to your file system:$ oc get secret htpass-secret -ojsonpath={.data.htpasswd} -n openshift-config | base64 --decode > users.htpasswdAdd or remove users from the
users.htpasswdfile.To add a new user:
$ htpasswd -bB users.htpasswd <username> <password>Example output
Adding password for user <username>To remove an existing user:
$ htpasswd -D users.htpasswd <username>Example output
Deleting password for user <username>
Replace the
htpass-secretSecretobject with the updated users in theusers.htpasswdfile:$ oc create secret generic htpass-secret --from-file=htpasswd=users.htpasswd --dry-run=client -o yaml -n openshift-config | oc replace -f -If you removed one or more users, you must additionally remove existing resources for each user.
Delete the
Userobject:$ oc delete user <username>Example output
user.user.openshift.io "<username>" deletedBe sure to remove the user, otherwise the user can continue using their token as long as it has not expired.
Delete the
Identityobject for the user:$ oc delete identity my_htpasswd_provider:<username>Example output
identity.user.openshift.io "my_htpasswd_provider:<username>" deleted
Configure your identity provider (IDP) through the web console instead of the CLI.
Prerequisites
- You must be logged in to the web console as a cluster administrator.
Procedure
-
Navigate to Administration
Cluster Settings. - Under the Global Configuration tab, click OAuth.
- Under the Identity Providers section, select your identity provider from the Add drop-down menu.
You can specify multiple IDPs through the web console without overwriting existing IDPs.