Agile Integration Best Practices Using an IBM GitOps Automation Framework

Agile Integration Best Practices Using an IBM GitOps Automation Framework

• Lab Overview
• Prerequisites
• Business Context
• Automation Framework Introduction
• Lab Environment
• 0 - Preparation
• 1 - Clone Repositories
• 2 - Explore the Environment
• 3 - Prepare the Subscription
• 4 - Deploy ACE and ES instances
• 5 - Activate MQ Queue Manager
• 6 - Customize Event Streams
• 7 - Configure ACE
• 8 - Customize APIC
• 9 - Check the Demo Assets
• Summary

Lab Overview

• the IBM opinionated point of view regarding a GitOps centric method to manage RHOCP infrastructure, IBM integration software and application workload code (three tier GitOps architecture).
• how to develop, review, and extend an IBM GitOps automation repository that incapsulate key software components within the IBM Integration portfolio.
• how to position a GitOps automation framework as a key boot-strapping and operational mechanism supporting a Client PoC activity and Client adoption.

Prerequisites

• You need to have an OpenShift environment with GitOps operators. For this session, your proctor will provide you a pre-installed environment, with admin access (more details below). If you want to create your personal environment, check this video or follow the preparation section from this documentation.
• You need to have installed in your machine:
  • oc CLI v4.6+.
  • github CLI
  • Bash Shell
  • JAVA v8+
  • jq CLI
• You need to have a SalesForce account. This should have been completed as part of the Tech Academy pre-requisite work.
• You need to have a mailtrap account. This too should have been completed as part of the Tech Academy pre-requisite work.
• You have access to GitHub Organization with all repositories. Your proctor will provide that for you.

Business Context

• API Connect Cluster
• Event Streams Cluster
• Queue Manager
• App Connect Enterprise Integration Servers

• Platform UI (formerly known as Platform Navigator)
• Automation Foundation Assets (formerly known as Asset Repository)
• Operations Dashboard

Automation Framework Introduction

What are the Production Deployment Guides?

Production Deployment Guide objectives

• Provide opinionated, validated Production topologies
• Provide a GitOps driven automation framework
• Enable IBMers to setup Production topologies

What is GitOps?

Lab Environment

0 - Preparation

1. Log in IBM Cloud.

2. Open the Notifications page (click on top right ring bell icon).

   

3. On the Notifications page, you should have an Account notification informing you that “You are invited to join an account in IBM Cloud”. Select this notification and click the Join now link.

   

4. Follow the steps to accept the invitation.

5. Now back to the IBM Cloud dashboard, change your IBM Cloud account to 2543884 - itztsglenablement05.

   

6. Now you have two possibilities, you can open the Team Environment page on the left of this menu and click to open your Cluster page (it is easy, isn’t?) or you can open the Openshift page on the IBM Cloud menu and look for your cluster in the Clusters’ list.

7. On your cluster’s page, click OpenShift web console.

8. Great, you are almost ready for the lab. Last but not least important, let’s copy login command to access the cluster by CLI. On the top right, click your username and select Copy login command.

   

9. Click Display Token.

10. Copy the Login with this token command and paste on a terminal window.

11. You should have received an invitation for the GitHub Organization of your team. Don’t forget to accept it in your Github account email.

    That is it! Now you are ready for the lab. Take a breath and enjoy your lab!

1 - Clone Repositories

1. As explained before, you already have Github repositories for your team. On the left navigator menu, check the name of your cluster and GitHub organization. As soon as you have the name, let’s clone the repositories in your local machine. Use the command below to define your GIT_ORG variable.

export GIT_ORG={REPLACE_WITH_YOUR_GIT_ORG}
Copy to clipboardCopied!

2. Now let’s clone the repositories to your local machine.

mkdir ${GIT_ORG}
cd ${GIT_ORG}
git clone https://github.com/${GIT_ORG}/multi-tenancy-gitops
git clone https://github.com/${GIT_ORG}/multi-tenancy-gitops-infra
git clone https://github.com/${GIT_ORG}/multi-tenancy-gitops-services
git clone https://github.com/${GIT_ORG}/multi-tenancy-gitops-apps
Copy to clipboardCopied!

3. You are welcome to explore all the four repositories of the GitOps Automation framework.

2 - Explore the Environment

1. Let’s start by exploring the GitOps Automation Framework YAML files. First, let’s check the kustomization.yaml in infra layer (/multi-tenancy-gitops/0-bootstrap/single-cluster/1-infra/).

   Challenge 2.1: what namespaces are enabled? openshift console - check namespaces (tools ibm-common-services)

2. Let’s explore the kustomization.yaml in services layer (/multi-tenancy-gitops/0-bootstrap/single-cluster/2-services/)

   Challenge 2.2: what are the instances enabled? How can you check Platform navigator and API Connect?

3. Let’s check the installed operators in your Cluster Web Console (there is a URL available in the Team Environments page).

   Challenge 2.3: how do I see the Installed Operators in OpenShift web console?

4. Now, let’s open the ArgoCD UI. Don’t forget to find the ArgoCD URL and admin’s password. Tip: ArgoCD is installed in the openshift-gitops namespace, just look for an opaque (type) openshift-gitops-cntk in Secrets and an openshift-gitops-cntk Routes.

   Challenge 2.4: Where do I see the ArgoCD URL? Where do I get the ArgoCD admin password?

5. In ArgoCD UI check all applications available. Check the application’s healthy status.

6. Let’s open the Platform navigator. Tip: All CP4I services are installed in the tools namespace. And secret name is ibm-iam-bindinfo-platform-auth-idp-credentials.

   Challenge 2.5: Where do I see the Platform navigator URL? How do I get the CP4i admin’s password?

7. Check what the Integration’s Instances are available.

   Challenge 2.6: What are the instances available?

3 - Prepare the Subscription

1. Edit multi-tenancy-gitops/0-bootstrap/single-cluster/2-services/kustomization.yaml.

2. Uncomment the lines below.

- argocd/operators/ibm-ace-operator.yaml
- argocd/operators/ibm-eventstreams-operator.yaml
- argocd/operators/ibm-mq-operator.yaml
Copy to clipboardCopied!

3. In the multi-tenancy-gitops folder: Add, Commit and Push the changes to multi-tenancy-gitops repository.

git add .
git commit -m "adding new operators"
git push origin
Copy to clipboardCopied!

4. Back to the argoCD console, refresh the 02-Services application. Maybe you need to wait few minutes to make sure that all the status are Sync and Healthy, before progressing.

   Challenge 3.1: What are the new applications available in ArgoCD?

5. Back to the OpenShift Web console, check if there are new operators available.

   Challenge 3.2: What are the new operators? How to check them?

4 - Deploy ACE and ES instances

1. Edit multi-tenancy-gitops/0-bootstrap/single-cluster/2-services/kustomization.yaml.

2. Uncomment the lines below.

- argocd/instances/es-demo.yaml
- argocd/instances/ace-infra.yaml
Copy to clipboardCopied!

3. In the multi-tenancy-gitops folder: Add, Commit and Push the changes to multi-tenancy-gitops repository.

git add .
git commit -m "deploying ace and es"
git push origin
Copy to clipboardCopied!

4. Back to the argoCD console, refresh the 02-Services application. Maybe you need to wait few minutes to make sure that all the status are Sync and Healthy, before progressing.

   Challenge 4.1: What are the new applications available in ArgoCD?

5. Back to the OpenShift Web console, check if there are new operators available.

   Challenge 4.2: What are the new operators?

6. Back to CP4i Platform Navigator, check if the new instances are available and ready.

   Challenge 4.3: How to check if the instances are available in Platform Navigator?

5 - Activate MQ Queue Manager

1. Edit multi-tenancy-gitops/0-bootstrap/single-cluster/3-apps/kustomization.yaml.

2. Uncomment the line below.

- argocd/sko-sample/mqmgr.yaml

Copy to clipboardCopied!

3. In the multi-tenancy-gitops folder: Add, Commit and Push the changes to multi-tenancy-gitops repository.

git add .
git commit -m "mq queue manager"
git push origin
Copy to clipboardCopied!

4. Back to the argoCD console, refresh the 03-Application application. Maybe you need to wait few minutes to make sure that all the status are Sync and Healthy, before progressing.

   Challenge 5.1: What are the new applications available in ArgoCD?

5. On the OpenShift Web Console page, check the qmgr-demo are running.

6. On the CP4i Platform Navigator page, check the Queue Managers.

   Challenge 5.2: How many Queue Managers are available? How do you check them?

6 - Customize Event Streams

1. Edit multi-tenancy-gitops/0-bootstrap/single-cluster/3-apps/kustomization.yaml.

2. Uncomment the line below.

- argocd/sko-sample/eventstream.yaml

Copy to clipboardCopied!

3. In the multi-tenancy-gitops folder: Add, Commit and Push the changes to multi-tenancy-gitops repository.

git add .
git commit -m "customize ES"
git push origin
Copy to clipboardCopied!

4. Back to the argoCD console, refresh the 03-Application application. Maybe you need to wait few minutes to make sure that all the status are Sync and Healthy, before progressing.

5. Open the eventstream application and check the log of es-demo-setup-job-??? pod.

6. You should see a failure that statefulsets.apps is forbidden. Let’s fix it! Edit multi-tenancy-gitops-apps/sko-sample/eventstream/es-demo-setup-job-sa-role.yaml.

7. In the Rules section, create a new rule with the content below and save the new YAML file.

- apiGroups: ["apps"]
  resources: ["statefulsets"]
  verbs: ["get", "watch", "list"]
Copy to clipboardCopied!

8. In the multi-tenancy-gitops-apps folder: Add, Commit and Push the changes to multi-tenancy-gitops-apps repository.

git add .
git commit -m "apps statefulsets permission"
git push origin
Copy to clipboardCopied!

9. Back to the argoCD console, refresh the eventstream application. Maybe you need to wait few minutes to make sure that all the status are Sync and Healthy.

10. Now you need to delete es-demo-setup-job to re-run the pod.

11. Now let’s check the log of es-demo-setup-job-??? pod again.

12. Wow, another failure!! Now with route. Follow the same approach of the previous error, but now include a rule to resources routes in the apiGroups route.openshift.io and repeat the same verbs of the previous rule.

13. Repeat steps 8 to 11, to deploy the changes.

7 - Configure ACE

1. Open the multi-tenancy-gitops-apps/sko-sample/ace-00-configs folder.

2. Execute the commands below to generate the configuration YAML files.

   • SF_USER is [Email addess used to log into Salesforce]
   • SF_PWD is [Password used to log in][token received in email]
   • SF_CLIENT_ID is [Consumer Key]
   • SF_CLIENT_SECRET is [Consumer Secret]
   • MAILTRAP_USER is [Mailtrap SMTP User]
   • MAILTRAP_PWD is [Mailtrap SMTP Password]

./06-ace-config-barauth-github.sh
./07-ace-config-policy-mq.sh
SF_USER=<my-sf-user> SF_PWD=<my-sf-pwd> SF_CLIENT_ID=<my-sf-client-id> SF_CLIENT_SECRET=<my-sf-client-secret> SF_LOGIN_URL="https://login.salesforce.com" ./08-ace-config-accounts-sf.sh
./10-ace-config-policy-es-scram.sh
./11-ace-config-setdbparms-es-scram.sh
./12-ace-config-truststore-es.sh
./13-ace-config-policy-udp.sh
./14-ace-config-policy-email.sh
MAILTRAP_USER=<user> MAILTRAP_PWD=<pwd> ./15-ace-config-setdbparms-email.sh
Copy to clipboardCopied!

3. Verify that there are 9 YAML files generated in the ace-00-configs folder.

4. Edit multi-tenancy-gitops-apps/sko-sample/ace-00-configs/kustomization.yaml file.

5. Uncomment the lines below (all the content).

- ace-config-accounts-designer.yaml

- ace-config-policy-es-scram.yaml
- ace-config-setdbparms-es-scram.yaml
- ace-config-truststore.yaml

- ace-config-policy-udp.yaml
- ace-config-policy-email.yaml
- ace-config-setdbparms-email.yaml
Copy to clipboardCopied!

6. In the multi-tenancy-gitops-apps folder: Add, Commit and Push the changes to multi-tenancy-gitops-apps repository.

git add .
git commit -m "ace config"
git push origin
Copy to clipboardCopied!

7. Edit multi-tenancy-gitops/0-bootstrap/single-cluster/3-apps/kustomization.yaml file.

8. Uncomment the lines below (all the content).

- argocd/sko-sample/ace-00-configs.yaml
- argocd/sko-sample/ace-backend.yaml
- argocd/sko-sample/ace-evnt2mail.yaml
- argocd/sko-sample/ace-fwdmqevnt.yaml
- argocd/sko-sample/ace-mqapidflt.yaml
- argocd/sko-sample/ace-mqapiprem.yaml
- argocd/sko-sample/ace-sflead.yaml
Copy to clipboardCopied!

9. In the multi-tenancy-gitops folder: Add, Commit and Push the changes to multi-tenancy-gitops-apps repository.

git add .
git commit -m "ace config"
git push origin
Copy to clipboardCopied!

10. Back to the argoCD console, refresh the 03-Application application. Maybe you need to wait few minutes to make sure that all the status are Sync and Healthy, before progressing.

11. Back to Platform Navigator, open App Connect Dashboard (Run > Integration) and check the Integration servers.

8 - Customize APIC

1. Go to the folder multi-tenancy-gitops-apps/sko-sample/apic-cust.

2. Now let’s configure APIC to submit emails when necessary (e.g.: Portal Users registration). Run the script to generate the APIC mail secret using Mailtrap.

   • MAILTRAP_USER is [Mailtrap SMTP User]
   • MAILTRAP_PWD is [Mailtrap SMTP Password]

MAILTRAP_USER=<user> MAILTRAP_PWD=<pwd> ./apic-user-mail-secret.sh
Copy to clipboardCopied!

3. Check that you have a Secret YAML file in your folder.

4. In the multi-tenancy-gitops-apps folder: Add, Commit and Push the changes to multi-tenancy-gitops repository.

git add .
git commit -m "apic user mail secret"
git push origin
Copy to clipboardCopied!

5. Edit multi-tenancy-gitops/0-bootstrap/single-cluster/3-apps/kustomization.yaml.

6. Uncomment the line below.

- argocd/sko-sample/apic-cust.yaml

Copy to clipboardCopied!

7. In the multi-tenancy-gitops folder: Add, Commit and Push the changes to multi-tenancy-gitops repository.

git add .
git commit -m "apic customization"
git push origin
Copy to clipboardCopied!

8. Back to the argoCD console, refresh the 03-Application application. Maybe you need to wait few minutes to make sure that all the status are Sync and Healthy, before progressing.

9. Open the apic-cust application. Check if the apic-setup job is successful (look at the pod’s logs).

10. Great, now you are ready to publish your API. Back to the OpenShift Console, open the Pods page (Workloads > Pods), on the tools namespace, filter by the word publish.

11. Open the pod, and go to the Terminal tab.

12. In the Terminal session, run ./apic-publish-api.sh.

13. Feel free to accept or not the limited usage tracking.

14. You need to authenticate in APIC to publish the API. Let’s do it! Open the URL provided in a different browser session.

15. If necessary log in APIC with your admin and password.

16. Copy the code to the Terminal tab to continue the publish process.

17. Great, your API is published successfully.

9 - Check the Demo Assets

1. Back to ArgoCD page, go to the main page, and check all the 35 applications are healthy.

   SCREENSHOT 1 - Take a screenshot of the main ArgoCD page showing 35 applications healthy. Please include your browser adddres bar showing your cluster URL.

2. Now, let’s test your demo. Open the Platform Navigator page and go to the Integration Instances view.

3. Here you should see all the integrations as Ready.

   SCREENSHOT 2 - Take a screenshot of the Integration Instances page with all instances as ready. Please include your browser adddres bar showing your cluster URL.

4. Then, open the API Manager (Run > API).

5. Click Develop APIs and products. And select JGRMQAPI.

6. Put your API online.

7. Now, let’s try it! Open the Explorer tab.

8. Click on POST /contacts.

9. Open Try it.

10. On the Body section, click Generate to create a request body sample.

11. Click Send.

12. If you received 200 response, your request has been processed (success). Note: if you receive a CORS issue. Open the URL, accept the risks and try again.

13. Now, let’s check the Integration Trace page (Operate > Integration Trace).

14. Close the What’s New dialog and accept the license.

15. Open the Traces view.

16. Select the entry that has all APIC ACE and MQ components in the services column.

17. Great, here you should have the integrated trace graph with 10 nodes, including all the demo components.

    SCREENSHOT 3 - Take a screenshot of the Integrated Tracepage showing all the demo components (10 nodes). Please include your browser adddres bar showing your cluster URL.

Summary

• the IBM opinionated point of view regarding a GitOps centric method to manage RHOCP infrastructure, IBM integration software and application workload code (three tier GitOps architecture).
• how to develop, review, and extend an IBM GitOps automation repository that incapsulate key software components within the IBM Integration portfolio.
• how to position a GitOps automation framework as a key boot-strapping and operational mechanism supporting a Client PoC activity and Client adoption.