OpenShift Lessons Learned

OpenShift provides ways to observe and monitor cluster health. When we have more clusters, we want to monitor all clusters from a centralized location. We can use Red Hat Advanced Cluster Management (RHACM) helps to manage and control all the clusters from a single console. Also, we can enable observability from ACM to observe all clusters from RHACM.

The biggest complaint I got is that we are getting so many alerts. How do we really know when and how to react to the alerts that my organization cares about?

This is my example of how I will start tackling the issue. I am going to share the steps here on how I set up my OpenShift environment to try to solve the problem.

Environment:

• OpenShift 4.11
• Red Hat Advanced Cluster Management Operator 2.7

My test environment

• Install OpenShift 4.11
• Install Red Hat Advanced Cluster Management Operator 2.7

Click the OperatorHub from the OpenShift console left menu -> click on “Advanced Cluster Management for Kubernetes” Tile -> click install

• Once RHACM is installed and create “MultiClusterHub” customer resource (CR)

Enable the Observability

• Prepare an S3 bucket. In my case, I used AWS for my object storage.

aws s3 mb s3://shchan-acm

• Create “open-cluster-management-observability” namespace

oc create namespace open-cluster-management-observability 

• Create “pull-secret” in the namespace

DOCKER_CONFIG_JSON=`oc extract secret/pull-secret -n openshift-config --to=-`

oc create secret generic multiclusterhub-operator-pull-secret \
    -n open-cluster-management-observability \
    --from-literal=.dockerconfigjson="$DOCKER_CONFIG_JSON" \
    --type=kubernetes.io/dockerconfigjson

• Create a YAML file as below and name it “thanos-object-storage.yaml.” The credential will need to have proper permission to access the bucket. I am using an IAM user that has full access to the bucket. See the reference section for permission details.

apiVersion: v1
kind: Secret
metadata:
  name: thanos-object-storage
  namespace: open-cluster-management-observability
type: Opaque
stringData:
  thanos.yaml: |
    type: s3
    config:
      bucket: shchan-acm
      endpoint: s3.us-east-2.amazonaws.com
      insecure: true
      access_key: xxxxxxxxxxxxxxxxx
      secret_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

• Create the secret for object storage

oc create -f thanos-object-storage.yaml -n open-cluster-management-observability

• Create MultiClusterObservability customer resource in a YAML file, multiclusterobservability_cr.yaml.

apiVersion: observability.open-cluster-management.io/v1beta2
kind: MultiClusterObservability
metadata:
  name: observability
spec:
  observabilityAddonSpec: {}
  storageConfig:
    metricObjectStorage:
      name: thanos-object-storage
      key: thanos.yaml

• Run the following command to create the CR

oc apply -f multiclusterobservability_cr.yaml

Create custom rule

The use case here is to get a notification for a given issue when it happens. Since every alert is sent to the same notifier. It is not easy to react to the important alert.

• Create a “kube-node-health” group for alerting when any node is down for any reason. Create a Configmap “thanos-ruler-custom-rules” with the following rules in the open-cluster-management-observability namespace. Add “custom_rules.yaml” in the data section of the YAML file. Noted that I added “tag: kubenode” in the labels section. Note that it can be any label. This is just an example.

data:
 custom_rules.yaml: |
   groups:
     - name: kube-node-health
       rules:
       - alert: NodeNotReady
         annotations:
           summary: Notify when any node on a cluster is in NotReady state
           description: "One of the node of the cluster is down: Cluster {{ $labels.cluster }} {{ $labels.clusterID }}."
         expr: kube_node_status_condition{condition="Ready",job="kube-state-metrics",status="true"} != 1
         for: 5s
         labels:
           instance: "{{ $labels.instance }}"
           cluster: "{{ $labels.cluster }}"
           clusterID: "{{ $labels.clusterID }}"
           tag: kubenode
           severity: critical

• You can view the logs from one of the alert manager pods to monitor if the rules are applied correctly. You can check if the log has any errors.

To test the alert from the ACM console

• Shut down one worker node
• Go to ACM

• Click Infrastucture -> Cluster -> Grafana

• Login the grafana dashboard
• Click “Explore”

• Click “Metrics browser to expand
• Select “alertname” and all the and “NodeNotReady” alert shows up under the list

• Here the alert was fired because one of the nodes was down.

Let’s configure the alert manager

We want to send this “NodeNotReady” alert to a specific Slack channel.

• Extract the data from the “alertmanager-config secret.

oc -n open-cluster-management-observability get secret alertmanager-config --template='{{ index .data "alertmanager.yaml" }}' |base64 -d > alertmanager.yaml

• Edit the alert-manager.yaml file as the following example. Note that I have 2 Slack channels for 2 receivers, respectively. One for the specific “tag: kubenode” alert and the other one for all the rest alerts.

"global":
  "slack_api_url": "https://hooks.slack.com/services/TDxxxx3S6/B0xxxxZLE2D/BN35PToxxxxmRTRxxxxN6R4"

"route":
  "group_by":
  - "alertname"
  "group_interval": "5m"
  "group_wait": "30s"
  "repeat_interval": "12h"
  "receiver": "my-team"
  "routes":
  - "match":
      "tag": "kubenode"
    "receiver": "slack-notification"

"receivers":
- "name": "slack-notification"
  "slack_configs":
  - "api_url": "https://hooks.slack.com/services/TDxxxx3S6/B0xxxxUK7B7/vMtVpxxxx4kESxxxxeDSYu3"
    "channel": "#kubenode"
    "text": "{{ range .Alerts }}<!channel> {{ .Annotations.summary }}\n{{ .Annotations.description }}\n{{ end }}"


- "name": "my-team"
  "slack_configs":
  - "api_url": "https://hooks.slack.com/services/TDxxxx3S6/B0xxxxZLE2D/BN35PToxxxxmRTRxxxxN6R4"
    "channel": "#critical-alert"
    "text": "{{ .GroupLabels.alertname }}"

• Save the alertmanager.yaml and replace the secret.

oc -n open-cluster-management-observability create secret generic alertmanager-config --from-file=alertmanager.yaml --dry-run=client -o=yaml |  oc -n open-cluster-management-observability replace secret --filename=-

• When the Node is shut down, a message should show in the slack channel like the one below.

• You will also see many alerts show up on the other channel, like the one below.

The idea here is to get meaningful alerts to the team and know what to do with the alerts.

The next is to continue to refine the customer rules and alert manager configuration per the needs.

Reference

• Observability documentation: https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.7/html/observability/index

Something I recently learned from testing the EUS to EUS process, and I like to share the steps here. Starting OpenShift Container Platform (OCP) 4.12, Red hat is adding an additional 6 months of Extended Update Support (EUS) on even-numbered OCP release for the x86_64 architecture.

We can upgrade from a EUS version to the next EUS version with only a single reboot of non-control plane hosts. There are caveats that are listed in the reference section below.

Steps to upgrade from 4.10.x to 4.12 using the EUS-to-EUS upgrade

• Verify that all machine config pools display a status of Up to date and that no machine config pool displays a status of “UPDATING.”

• Set your channel to eus-<4.y+2>

• The channel is set to eus-4.12

• Pause all worker machine pools except for the master machine pool

• Update 4+1 only with Partial cluster update

• Wait for the partial upgrade to complete

• Make sure the partial update is completed

• No reboot for workers as noted that workers are paused on the K8S v 1.23

• Check the OCP console

• Check the KCS ​​https://access.redhat.com/articles/6955381. Review the k8s API version update and ensure the workloads are working properly and will be using the newly updated K8S API version.
• Execute the following command:
  oc -n openshift-config patch cm admin-acks --patch '{"data":{"ack-4.11-kube-1.25-api-removals-in-4.12":"true"}}' --type=merge
• OCP console shows

• Click resume all updates
• Double-check all machine pools. If updating, please wait for it to complete.

• Upgrade completed and now showing OCP 4.12 (K8S v1.25)

Reference:

• OpenShift Upgrade: https://docs.openshift.com/container-platform/4.12/updating/updating-cluster-prepare.html
• Prepare for EUS to EUS upgrade: https://docs.openshift.com/container-platform/4.12/updating/preparing-eus-eus-upgrade.html
• Red Hat OpenShift Extended Update Support (EUS): https://access.redhat.com/support/policy/updates/openshift-eus

Prerequisites

• An OpenShift 4 cluster
• Compliance Operator installed

Overview

Steps to Generate OpenSCAP Evaluation Report

• Log in OpenShift Cluster

# oc login -u <username> https://api.<clusterid>.<subdomain>

• Assuming you have already installed the OpenShift Compliance Operator. Next, check the access to the OpenShift Compliance project using the command shown below.

# oc project openshift-compliance

• The default compliance profiles will be available once the operator is installed. The command below lists out all compliance profiles Custom Resource Definition (CRD) profiles.compliance.openshift.io.

# oc get profiles.compliance.openshift.io

• To get custom resource ScanSetting via the below command. It shows two default scan settings.

# oc get ScanSetting
NAME                 AGE
default              2d10h
default-auto-apply   2d10h

• Check out the “default” ScanSetting

Name:         default
Namespace:    openshift-compliance
Labels:       <none>
Annotations:  <none>
API Version:  compliance.openshift.io/v1alpha1
Kind:         ScanSetting
Metadata:
  Creation Timestamp:  2021-10-19T16:22:18Z
  Generation:          1
  Managed Fields:
...
  Resource Version:  776981
  UID:               f453726d-665a-432e-88a9-a4ad60176ac7
Raw Result Storage:
  Pv Access Modes:
    ReadWriteOnce
  Rotation:  3
  Size:      1Gi
Roles:
  worker
  master
Scan Tolerations:
  Effect:    NoSchedule
  Key:       node-role.kubernetes.io/master
  Operator:  Exists
Schedule:    0 1 * * *
Events:      <none>

• Create ScanSettingBinding as shown in scan-setting-binding-example.yaml below.

# cat scan-setting-binding-example.yaml
apiVersion: compliance.openshift.io/v1alpha1
kind: ScanSettingBinding
metadata:
  name: cis-compliance
profiles:
  - name: ocp4-cis-node
    kind: Profile
    apiGroup: compliance.openshift.io/v1alpha1
  - name: ocp4-cis
    kind: Profile
    apiGroup: compliance.openshift.io/v1alpha1
settingsRef:
  name: default
  kind: ScanSetting
  apiGroup: compliance.openshift.io/v1alpha1

• Create the above sample ScanSettingBinding custom resource.

# oc create -f scan-setting-binding-example.yaml

• Verify the creation of the ScanSettingBinding

# oc get scansettingbinding

• Custom resource ComplianceSuites is to help tracking the state of the scans. The following command is to check the state of the scan you defined in your ScanSettingBinding.

# oc get compliancesuite
NAME             PHASE     RESULT
cis-compliance   RUNNING   NOT-AVAILABLE

• ComplianceScan custom resource needs all the parameters to run OpenSCAP, such as profile id, image to get the content from, and data stream file path. It also can constain operational parameter.

# oc get compliancescan
NAME                   PHASE   RESULT
ocp4-cis               DONE    NON-COMPLIANT

• While the custom resource ComplianceCheckResult shows the aggregate result of the scan, it is useful to review the raw result from the scanner. The raw results are produced in the ARF format and can be large. Therefore, Compliance Operator creates a persistent volume (PV) for the raw result from the scan. Let’s take a look if the PVC is created for the scan.

# oc get pvc
NAME                   STATUS   VOLUME                                     CAPACITY   ACCESS MODES   STORAGECLASS   AGE
ocp4-cis               Bound    pvc-5ee57b02-2f6b-4997-a45c-3c4df254099d   1Gi        RWO            gp2            27m
ocp4-cis-node-master   Bound    pvc-57c7c411-fc9f-4a4d-a713-de91c934af1a   1Gi        RWO            gp2            27m
ocp4-cis-node-worker   Bound    pvc-7266404a-6691-4f3d-9762-9e30e50fdadb   1Gi        RWO            gp2            28m

• Once we know the raw result is created, we need the oc-compliance tool to get the raw result XML file. You will need to login to the registry.redhat.io.

# podman login -u <user> registry.redhat.io

• Download the oc-compliance tool

podman run --rm --entrypoint /bin/cat registry.redhat.io/compliance/oc-compliance-rhel8 /usr/bin/oc-compliance > ~/usr/bin/oc-compliance

• Fetch the raw results to a temporary location (/tmp/cis-compliance)

# oc-compliance fetch-raw scansettingbindings cis-compliance -o /tmp/cis-compliance
Fetching results for cis-compliance scans: ocp4-cis-node-worker, ocp4-cis-node-master, ocp4-cis
Fetching raw compliance results for scan 'ocp4-cis-node-worker'.....
The raw compliance results are available in the following directory: /tmp/cis-compliance/ocp4-cis-node-worker
Fetching raw compliance results for scan 'ocp4-cis-node-master'.....
The raw compliance results are available in the following directory: /tmp/cis-compliance/ocp4-cis-node-master
Fetching raw compliance results for scan 'ocp4-cis'...........
The raw compliance results are available in the following directory: /tmp/cis-compliance/ocp4-cis

• Inspect the output filesystem and extract the *.bzip2 file

# cd /tmp/cis-compliance/ocp4-cis
# ls
ocp4-cis-api-checks-pod.xml.bzip2

# bunzip2 -c  ocp4-cis-api-checks-pod.xml.bzip2  > /tmp/cis-compliance/ocp4-cis/ocp4-cis-api-checks-pod.xml

# ls /tmp/cis-compliance/ocp4-cis/ocp4-cis-api-checks-pod.xml
/tmp/cis-compliance/ocp4-cis/ocp4-cis-api-checks-pod.xml

• Convert ARF XML to html

# oscap xccdf generate report ocp4-cis-api-checks-pod.xml > report.html

• View the HTML as shown below.

Reference

• OpenShift Compliance Operator
• Compliance as Code

Thank you Juan Antonio Osorio Robles for sharing the diagram!

• Go to Administrator Console
• Create a new project called keycloak

• Click Operator
• Click OperatorHub
• Click on the Red Hat Single Sign-On Operator

• Click Install

• Click Install

• Click “Create instance” in the Keycloak tile

• The Keycloak CR is shown below

apiVersion: keycloak.org/v1alpha1
kind: Keycloak
metadata:
  name: keycloak-dev
  labels:
    app: keycloak-dev
  namespace: keycloak
spec:
  externalAccess:
    enabled: true
  instances: 1

• Click Create
• Go to Workloads > Pods

• Click the keycload-dev creation and return “true”

$ oc get keycloak keycloak-dev -n keycloak -o jsonpath='{.status.ready}'
true

• Operators > Installed Operators > Red Hat Single Sign-On Operator
• Click Create instance

• Enter the KeycloakRealm as shown below

apiVersion: keycloak.org/v1alpha1
kind: KeycloakRealm
metadata:
  name: keycloakrealm
  labels:
    realm: keycloakrealm
  namespace: keycloak
spec:
  instanceSelector:
    matchLabels:
      app: keycloak-dev
  realm:
    enabled: true
    displayName: "Keycloak-dev Realm"
    realm: keycloakrealm

• Click Create

• Make sure it returns true

$ oc get keycloakrealm keycloakrealm -n keycloak -o jsonpath='{.status.ready}'
true

• Get the Keycloak Admin user secret name

$ oc get keycloak keycloak-dev --output="jsonpath={.status.credentialSecret}"
credential-keycloak-dev

• Get the Admin username and password

$ oc get secret credential-keycloak-dev -o go-template='{{range $k,$v := .data}}{{printf "%s: " $k}}{{if not $v}}{{$v}}{{else}}{{$v | base64decode}}{{end}}{{"\n"}}{{end}}'

• Run the following to find out the URLs of Keycloak:

KEYCLOAK_URL=https://$(oc get route keycloak --template='{{ .spec.host }}')/auth &&
echo "" &&
echo "Keycloak:                 $KEYCLOAK_URL" &&
echo "Keycloak Admin Console:   $KEYCLOAK_URL/admin" &&
echo "Keycloak Account Console: $KEYCLOAK_URL/realms/myrealm/account" &&
echo ""

• Open a browser with the Admin URL

• Login with the admin username and password
• Click Client on the left nav

• Click Create on the right top corner

• Enter the Argocd URL and the name of the client as ‘argocd’

• Click Save
• Set Access Type to confidential
• Set Valid Redirect URIs to <argocd-url>/auth/callback
• Set Base URL to /applications

• Click Save
• Scroll up and click “Credential” tab

• IMPORTANT: Copy the secret and you will need this later

• Configure the Group claim
• Click Client Scope on the left nav

• Click Create on the right

• Set Name as group
• Set Protocol as openid-connecgt
• Display On Content Scope: on
• Include to Token Scope: on

• Click save
• Click “Mappers” tab

• Click Create on the top right
• Set name as groups
• Set Mapper Type as Group Membership
• Set Token Claim Name as groups`

• Click Clients on the left nav
• Click argocd

• Click “Client Scopes” tab
• Select groups > Add selected

• Click Groups on left nav
• Click Create

• Set the name as ArgoCDAdmins
• Click Save

• Encode the argocd credential you saved before

echo -n '<argocd credential>' | base64

• Edit the argocd-secret

oc edit secret argocd-secret -n openshift-gitops

• add the “oidc.keycloak.clientSecret: <encoded credential> as shown below.

apiVersion: v1
kind: Secret
metadata:
  name: argocd-secret
data:
  oidc.keycloak.clientSecret: <encoded credential>

• Edit argocd Custom Resource

oc edit argocd -n openshift-gitops

• Add the following into the yaml. Make sure update the issuer to make your settings

oidcConfig: |
    name: OpenShift Single Sign-On
    issuer: https://keycloak-keycloak.apps.cluster-72c5r.72c5r.sandbox1784.opentlc.com/auth/realms/keycloakrealm
    clientID: argocd
    clientSecret: $oidc.keycloak.clientSecret
    requestedScopes: ["openid", "profile", "email", "groups"]

• From OpenShift Console top right corner, click About

• Copy the API URL from the following screen

• Go back to Keycloak, click Identity Providers on left nav
• Select OpenShift v4 from the dropdown list

• Set Display Name: Login with Openshift
• Set Client ID: keycload-broker
• Set Client Secret: <anything that you can remember>
• Set Base URL: API URL
• Set Default Scopes: user:full

• Click Save
• Add an Oauth Client

oc create -f <(echo '
kind: OAuthClient
apiVersion: oauth.openshift.io/v1
metadata:
 name: keycloak-broker 
secret: "12345" 
redirectURIs:
- "https://keycloak-keycloak.apps.cluster-72c5r.72c5r.sandbox1784.opentlc.com/auth/realms/keycloakrealm/broker/openshift-v4/endpoint" 
grantMethod: prompt 
')

• Configure the RBAC

oc edit configmap argocd-rbac-cm -n openshift-gitops

• Modify the data as shown below

apiVersion: v1
kind: ConfigMap
metadata:
  name: argocd-rbac-cm
data:
  policy.csv: |
    g, ArgoCDAdmins, role:admin

• Go to the Argocd URL, you will see the SSO icon. Click “LOG IN VIA OPENSHIFT”

• Click Log in Openshift

I have an opportunity to try out the pre-GA ROSA. ROSA is a fully managed Red Hat OpenShift Container Platform (OCP) as a service and sold by AWS. I am excited to share my experience on ROSA. It installs OCP 4 from soup to nuts without configuring hosted zone and domain sever. As a developer, you may want to get the cluster up and running, so you can start doing the real work :). There are customization options with ROSA, but I am going to leave it for later exploration.

I am going to show you the steps I took to create OCP via ROSA. There are more use cases to test. I hope this blog will give you a taste of ROSA.

Creating OpenShift Cluster using ROSA Command

Since it is a pre-GA version, I download the ROSA command line tool from the here and have aws-cli available where I run the ROSA installation.

• I am testing from my MacBook. I just move the “rosa” command line tool to /usr/local/bin/.

• Verify that your AWS account if it has the necessary permissions using rosa verify permissions:

• Verify that your AWS account has the necessary quota to deploy an Red Hat OpenShift Service on AWS cluster via rosa verify quota --region=<region>:

• You will need an account to log in to cloud.redhat.com. If you don’t have a user name created, please register as a user for free.
• After login to cloud.redhat.com, go to https://cloud.redhat.com/openshift/token/rosa

• Log in your Red Hat account with ROSA command using rosa login --token=<token from cloud.redhat.com>:

• Verify the AWS setup using rosa whoami:

• Initialize the AWS for the cluster deploy via rosa init:

•  Since I have OpenShift Client command line installed, it shows the existing OpenShift Client version. If you don’t have it, you can download the OpenShift Client command line via rosa download oc and make it available from your PATH. 
• Create ROSA via rosa create cluster command below: 

Note: rosa create cluster -i with the interactive option, it provides customization for ROSA installation, such as multiple AZ, existing VPC, subnets, etc…

• Copy the URL from Details Page to a browser and you can view the status for your ROSA installation. 

• If you click View logs, you can watch the log from here until the cluster is completed.

• When you see this screen, it means the cluster is created:

• Now, you need to have a way to log into the OCP cluster. I created an organization called sc-rosa-idp on Github via rosa create idp --cluster=sc-rosa-test --interactive as show below.

• Log into the OCP console via the URL from the output from last step:

• Click github-1 –> redirect to authorize to the organization from Github -> log in Github.

• Once you log in with your Github credential, we will see the OCP developer console: 

• Grant cluster-admin role to the github user using rosa grant user cluster-admin --user <github user in your organization> --cluster <name of your rosa cluster>.
• Click Administrator on the top left and access the OCP admin console with Admin access as shown below:

Delete ROSA

• Go to the cluster from cloud.redhat.com, from Action –> select Delete cluster:

• Enter the name of the cluster and click Delete:

• The cluster shows as Uninstalling: 

Although it is a pre-GA without AWS console integration, I found it very easy to get my cluster up and running. If you cannot wait for GA, you can always request the preview access from here. Get a head start with ROSA!

References

• Official Red Hat OpenShift on AWS documentation
• ROSA upstream project
• Configure Customize Application Domains 
• https://aws.amazon.com/rosa/
• https://www.openshift.com/products/amazon-openshift

In my last post on ARO 4, I have already walk through the steps to set up the Azure environment for creating ARO 4. My 2nd round testing requires the following specific requirements:

• Use only one app registration
• Not to use pull secret

Create ARO 4 Cluster with existing service principal

Create a service principal

$ az ad sp create-for-rbac --role Contributor --name all-in-one-sp

Adding API permission to the service principal

1. Login to Azure Portal
2. Go to Azure Active Directory
3. Click App registrations
4. Click “All applications”
5. Search for “app-in-one-sp”
6. Click “View API permission”
7. Click “Add a permission”
8. Click “Azure Active Directory Graph”
9. Click “Delegated Permissions”
10. Check “User.Read”
11. Click “Add permission” button at the bottom.
12. Click “Grant admin consent …”
13. A green check mark is shown under Status as shown below

Create ARO with existing service principal without pull secret

az aro create \
--resource-group $RESOURCEGROUP \
--name $CLUSTER \
--client-id <service principal application id> \
--client-secret <service principal password> \
--vnet aro-vnet \
--master-subnet master-subnet \
--worker-subnet worker-subnet \
--domain aro.ocpdemo.online

No --pull-secret provided: cluster will not include samples or operators from Red Hat or from certified partners.

Adding api and ingress A record to the DNS zone

Test out the ARO cluster

az aro list-credentials \ 
--name $CLUSTER \ 
--resource-group $RESOURCEGROUP

https://console-openshift-console.apps.<DNS domain>/

Integrate Azure Active Directory

$ oc login -u kubeadmin -p <password> https://api.<DNS domain>:6443/ 
$ oauthCallBack=`oc get route oauth-openshift -n openshift-authentication -o jsonpath='{.spec.host}'` 
$ oauthCallBackURL=https://$oauthCallBack/oauth2callback/AAD
$ echo $oauthCallBackURL

Add the OAuth call back URL to the same service principal

• Go to Azure Active Directory
• Click App registration
• Click on “all-in-one-sp” under all applications
• Under Overview, click right top corner link for “Add a Redirect URI”
• Click “Add a platform”
• Click Web Application from the list of Configure platforms
• Enter the value of the oauthCallBackURL from the previous step to the “Redirect URIs”
• Click configure

Create a manifest file

cat > manifest.json<< EOF 
[{ "name": "upn", 
"source": null, 
"essential": false, 
"additionalProperties": [] 
}, 
{ "name": "email", 
"source": null, 
"essential": false, 
"additionalProperties": [] 
}] 
EOF

Update service principal with the manifest

$ az ad app update \
 --set optionalClaims.idToken=@manifest.json \
 --id <Service Principal appId>

Create secret to store service principal’s password

oc create secret generic openid-client-secret-azuread \
--namespace openshift-config \
--from-literal=clientSecret=<service principal password>

Create OAuth configuration

apiVersion: config.openshift.io/v1
kind: OAuth
metadata:
  name: cluster
spec:
  identityProviders:
  - name: AAD
    mappingMethod: claim
    type: OpenID
    openID:
      clientID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
      clientSecret:
        name: openid-client-secret-azuread
      extraScopes:
      - email
      - profile
      extraAuthorizeParameters:
        include_granted_scopes: "true"
      claims:
        preferredUsername:
        - email
        - upn
        name:
        - name
        email:
        - email
      issuer: https://login.microsoftonline.com/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Apply the OAuth YAML

oc apply -f openid.yaml

Login openshift console via AAD

Reference

• My previous ARO 4 blog
• Azure ARO documentation

I happened to test out ARO 4 with Azure Active Directory integration. The Azure documentation is good, but I had to change a few while testing the steps. I am sharing my experience here and hope someone will find it useful.

Setting the requirements

Install or update Azure CLI

brew update && brew install azure-cli

Setup the environment variables

$ cat aro-env
LOCATION=centralus. # the location of your cluster
RESOURCEGROUP=aro-rg # the name of the resource group where you want to create your cluster
CLUSTER=poc #cluster-id of the ARO 4 cluster
$ source aro-env

Log in Azure

az login

Create a Resource Group

az group create \
--name $RESOURCEGROUP \
--location $LOCATION

Add DNS zone

1. Login Azure Portal
2. Type: “DNS Zones” in the search box on the top and click on “DNS Zones”
3. Click “+Add” on the top
4. Select the newly created resource group
5. Enter your domain
6. Select the location
7. Create “Review+Create”

Notes:

• I am using a domain name outside of the Azure. You will need to add the NS records from the overview page of the DNS zone to your domain.
• Request increase of quota from Azure portal. ARO requires a minimum of 40 cores.

Register Resource Provider

az account set --subscription
az provider register -n Microsoft.RedHatOpenShift --wait
az provider register -n Microsoft.Compute --wait
az provider register -n Microsoft.Storage --wait

Create a Virtual Network

az network vnet create \
--resource-group $RESOURCEGROUP \
--name aro-vnet \
--address-prefixes 10.0.0.0/22

Create an empty subnet for master nodes

az network vnet subnet create \
--resource-group $RESOURCEGROUP \
--vnet-name aro-vnet \
--name master-subnet \
--address-prefixes 10.0.0.0/23 \
--service-endpoints Microsoft.ContainerRegistry

Create an empty subnet for worker nodes

az network vnet subnet create \
--resource-group $RESOURCEGROUP \
--vnet-name aro-vnet \
--name worker-subnet \
--address-prefixes 10.0.2.0/23 \
--service-endpoints Microsoft.ContainerRegistry

Disable private endpoint policy

az network vnet subnet update \
--name master-subnet \
--resource-group $RESOURCEGROUP \
--vnet-name aro-vnet \
--disable-private-link-service-network-policies true

Create Cluster

Please make sure you log in to Azure and environment variables are set.

Information that we need for creating a cluster

• Get a copy of the pull secret from cloud.redhat.com. If you don’t have a user name created, please just register as a user for free.
• Create an ARO cluster using the following command. Please apply to appropriate values.
  Some values were used in the example are explained as shown below.
  • aro-vnet – the name of virtual network
  • master-subnet – the name of master subnet
  • worker subnet – the name of worker subnet
  • ./pull-secret.txt – the path and pull secret where is located
  • aro.ocpdemo.online – custom domain for the cluster

az aro create \
--resource-group $RESOURCEGROUP \
--name $CLUSTER \
--vnet aro-vnet \
--master-subnet master-subnet \
--worker-subnet worker-subnet \
--pull-secret @./pull-secret.txt \
--domain aro.ocpdemo.online

The information from the JSON output of the above command can be useful if you are not familiar with OpenShift 4. You can find your API server IP, API URL, OpenShift console URL and ingress IP. You will need the API, and ingress IP for the next step.

{- Finished ..
"apiserverProfile": {
"ip": "x.x.x.x",
"url": "https://api.aro.ocpdemo.online:6443/",
"visibility": "Public"
...
},
"consoleProfile": {
"url": "https://console-openshift-console.apps.aro.ocpdemo.online/"
},
....
"ingressProfiles": [
{
"ip": "x.x.x.x",
"name": "default",
"visibility": "Public"
}
....

Post ARO Installation

Adding two A records for api and *.apps in the DNS zone

1. Login to Azure portal
2. Go to DNS zone
3. Click onto the domain for the ARO cluster
4. Click “+ Record Set” on the top menu to create an A record and add values to Name and IP. You will need to repeat this step for both api and *.apps A records.
   • Name: api or *.apps
   • IP: the *.apps/ingress IP is from the output of the creation of the ARO
5. The below screenshot shows the DNS zone configuration and adding 2 A records.

Test ARO Cluster

Getting Kubeadmin credential

az aro list-credentials \
--name $CLUSTER \
--resource-group $RESOURCEGROUP

Log in OpenShift Console

https://console-openshift-console.apps.<DNS domain>/

Azure Active Directory Integration

Getting oauthCallBackURL

• Download OpenShift command line tool from console.

• Login to ARO via OC CLI

$ oc login -u kubeadmin -p <password> https://api.<DNS domain>:6443/

$ oauthCallBack=`oc get route oauth-openshift -n openshift-authentication -o jsonpath='{.spec.host}'`

$ oauthCallBackURL=https://$oauthCallBack/oauth2callback/AAD

Creating Application on Azure Active Directory

az ad app create \
  --query appId -o tsv \
  --display-name poc-aro-auth \
  --reply-urls $oauthCallBackURL \
  --password '<ClientSecret>'

Get tenant Id

az account show --query tenantId -o tsv

Create manifest file

cat > manifest.json<< EOF
[{
"name": "upn",
"source": null,
"essential": false,
"additionalProperties": []
},
{
"name": "email",
"source": null,
"essential": false,
"additionalProperties": []
}]
EOF

Update the Azure Active Directory with a manifest

az ad app update \
--set optionalClaims.idToken=@manifest.json \
--id <AppId>

Update Application permission scope

az ad app permission add \
--api 00000002-0000-0000-c000-000000000000 \
--api-permissions 311a71cc-e848-46a1-bdf8-97ff7156d8e6=Scope \ 
--id <AppId>

Grant admin consent

1. login Azure portal
2. Go to Azure Active Directory
3. Click App Registrations
4. Click “All Application” and search for newly create application name
5. Click onto the display name of the application
6. Click view API permissions
7. Click on the “check” to grant admin consent for directory

Add service principal

$ az ad sp create-for-rbac --role Contributor --name poc-aro-sp

$az role assignment create --role "User Access Administrator" \
--assignee-object-id $(az ad sp list --filter "appId eq '<service-principal-appid>'" \
| jq '.[0].objectId' -r)

$az ad app permission add --id <appId> \ 
--api 00000002-0000-0000-c000-000000000000 \ 
--api-permissions 824c81eb-e3f8-4ee6-8f6d-de7f50d565b7=Role

$az ad app permission grant --id <appid> --api 00000002-0000-0000-c000-000000000000

Create secret for identity provider on OpenShift

oc create secret generic openid-client-secret-azuread \
--namespace openshift-config \
--from-literal=clientSecret=<your password>

Create YAML for identity provider for AAD

apiVersion: config.openshift.io/v1
kind: OAuth
metadata:
  name: cluster
spec:
  identityProviders:
  - name: AAD
    mappingMethod: claim
    type: OpenID
    openID:
      clientID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
      clientSecret:
        name: openid-client-secret-azuread
      extraScopes:
      - email
      - profile
      extraAuthorizeParameters:
        include_granted_scopes: "true"
      claims:
        preferredUsername:
        - email
        - upn
        name:
        - name
        email:
        - email
      issuer: https://login.microsoftonline.com/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

• The clientID is the AppId of your registered application.
• Issuer URL is https://login.microsoftonline.com/<tenant id>.
• The clientSecret is using the secret (openid-client-secret-azuread) that you created from the previous step.

• Login Azure Portal
• Click Home
• Click Azure Active Directory
• Click App registrations on the left menu
• Click all applications tab
• Type the application that you just created in the search area
• Click onto the application (my application is poc-aro-auth)
• Under Overview, the information is shown as “Application (client) ID” and Directory (tenant) ID” as in the image below.

Update OpenShift OAuth Configuration

oc apply -f openid.yaml

Login OpenShift console via AAD

Troubeshoot

Reference

Azure OpenShift 4 documentation

ARO and Azure Active Directory integration