Set up the identity subsystem

Set up the identity subsystem, based on Keycloak

読み終わるまでの所要時間 1 分

最終更新 1ヶ月前

Unity Virtual Private Cloud includes an identity provider and broker component based on Keycloak. Keycloak includes these major capabilities:

Authentication and authorization
Storage of information about users and service accounts keys

Keycloak is included in the above deployment, but you must perform customer-specific postdeployment and administration tasks.

1. Access Keycloak

To access the Keycloak admin console from a browser, enter a URL in this format:


https://<domain_name>/auth/admin/master/console/

The default user is admin. To retrieve the password, run this command:


kubectl get -n asset-solutions secret keycloak -o jsonpath="{.data.admin-password}" | base64 --decode

Change the default admin credentials

The keycloak admin credentials are static and aren't tied to any identity provider.

When you sign in for the first time, change the default admin credentials:

In the Keycloak admin console, switch to the default realm, that is, the master realm.
Go to Users, and then select the
```
admin
```
user.
On the Credentials tab, select Reset password.
Enter a new password.
Turn off Temporary.
Record the credentials somewhere secure.

2. Complete the setup of the identity subsystem

To complete the setup of the identity subsystem, ensure that you are signed in to Keycloak, and then go to the unity realm.

2.1 Regenerate the secret for the

mini-usf

client

To regenerate the secret, complete these steps:

In the Keycloak admin console, switch to the unity realm.
Go to Manage > Clients, and then select the mini-usf client.
On the Credentials tab, select Regenerate next to the client secret.
Copy the secret to the clipboard.
Save the secret:
1. Use the copied secret to redefine the keycloak_mini_usf_clientsecret variable in the directory
```
aws/terraform/tfvars/{region}.tfvars
```
  .
2. From the directory
```
aws/terraform
```
  , run this command:
```
make apply-us-east-1
```
To restart the mini-usf pods in Kubernetes and apply the new secret, run this command:
```
kubectl rollout restart deployment -n asset-solutions mini-usf
```

2.2 Set up the URI properties for the dashboard client

To redirect the browser back to the frontend after a successful sign-in, add a valid redirect URI.

Go to Manage > Clients, and then select the dashboard client.
On the Settings tab, modify these values:
- Set Root URI to
```
https://<solution-domain-name>
```
  .
- Set Valid redirect URIs to
```
https://<solution-domain-name>/*
```
  .
Select Save.

3. Perform administration tasks

Complete the initial solution onboarding.
If required, set up single sign-on (SSO) for the identity subsystem.
If you don't use SSO, then create users in Keycloak.
Grant user access to the organization.
Optionally, configure monitoring integration in parallel or later.

After you have completed these steps, users can access the application.

Set up the identity subsystem

Set up the identity subsystem, based on Keycloak

読み終わるまでの所要時間 1 分

最終更新 1ヶ月前

Unity Virtual Private Cloud includes an identity provider and broker component based on Keycloak. Keycloak includes these major capabilities:

Authentication and authorization
Storage of information about users and service accounts keys

Keycloak is included in the above deployment, but you must perform customer-specific postdeployment and administration tasks.

1. Access Keycloak

To access the Keycloak admin console from a browser, enter a URL in this format:


https://<domain_name>/auth/admin/master/console/

The default user is admin. To retrieve the password, run this command:


kubectl get -n asset-solutions secret keycloak -o jsonpath="{.data.admin-password}" | base64 --decode

Change the default admin credentials

The keycloak admin credentials are static and aren't tied to any identity provider.

When you sign in for the first time, change the default admin credentials:

In the Keycloak admin console, switch to the default realm, that is, the master realm.
Go to Users, and then select the
```
admin
```
user.
On the Credentials tab, select Reset password.
Enter a new password.
Turn off Temporary.
Record the credentials somewhere secure.

2. Complete the setup of the identity subsystem

To complete the setup of the identity subsystem, ensure that you are signed in to Keycloak, and then go to the unity realm.

2.1 Regenerate the secret for the

mini-usf

client

To regenerate the secret, complete these steps:

In the Keycloak admin console, switch to the unity realm.
Go to Manage > Clients, and then select the mini-usf client.
On the Credentials tab, select Regenerate next to the client secret.
Copy the secret to the clipboard.
Save the secret:
1. Use the copied secret to redefine the keycloak_mini_usf_clientsecret variable in the directory
```
aws/terraform/tfvars/{region}.tfvars
```
  .
2. From the directory
```
aws/terraform
```
  , run this command:
```
make apply-us-east-1
```
To restart the mini-usf pods in Kubernetes and apply the new secret, run this command:
```
kubectl rollout restart deployment -n asset-solutions mini-usf
```

2.2 Set up the URI properties for the dashboard client

To redirect the browser back to the frontend after a successful sign-in, add a valid redirect URI.

Go to Manage > Clients, and then select the dashboard client.
On the Settings tab, modify these values:
- Set Root URI to
```
https://<solution-domain-name>
```
  .
- Set Valid redirect URIs to
```
https://<solution-domain-name>/*
```
  .
Select Save.

3. Perform administration tasks

Complete the initial solution onboarding.
If required, set up single sign-on (SSO) for the identity subsystem.
If you don't use SSO, then create users in Keycloak.
Grant user access to the organization.
Optionally, configure monitoring integration in parallel or later.

After you have completed these steps, users can access the application.

ドキュメント

Development

User Acquisition

Monetization

産業

Self-Hosted Deployment

Amazon Web Services

Microsoft Azure

On premises

vpctl

Self-Hosted Deployment

Set up the identity subsystem

1. Access Keycloak

Change the default admin credentials

2. Complete the setup of the identity subsystem

2.1 Regenerate the secret for the
`mini-usf`
client

2.2 Set up the URI properties for the dashboard client

3. Perform administration tasks

ドキュメント

Development

User Acquisition

Monetization

産業

Self-Hosted Deployment

Amazon Web Services

Microsoft Azure

On premises

vpctl

Self-Hosted Deployment

Set up the identity subsystem

1. Access Keycloak

Change the default admin credentials

2. Complete the setup of the identity subsystem

2.1 Regenerate the secret for the
`mini-usf`
client

2.2 Set up the URI properties for the dashboard client

3. Perform administration tasks