IBM Process Mining Quickstart¶
The instructions in this section will walk you through the steps necessary for setting up a demo environment that can be quickly shown to customers to showcase the art of the possible.
This demo in no way removes the need for following the tutorial style instructions that are documented in other sections of this guide. The instructions below will set up a pre-canned application demo environment to show to the customers.
Create a custom Git Organization¶
Create a new Git Organization to host the different GitOps repositories.
Make sure you do not populate your GitHub organization with cloned repositories. The GitHub organization must be empty and will be populated automatically by the environment provisioning.
Log in to http://github.com and select the option to create a New organization.
Create a free organizationplan.
Complete the wizard by filling in the
Organization account nameand
Contact emailfields. Select the
My personal accountbullet and complete the verification step and click Next.
Skip the step to add members to the Organization.
Welcome to GitHubquestionnaire and click Submit.
Congratulations, you have successfully created a new Github Organization.
Please ensure your GitHub organization is Public and not Private.
Create a Git Personal Access Token (PAT)¶
Create a new Git Personal Access Token with the appropriate scopes. This will be required to run the application pipelines or to set up webhooks.
Log in to http://github.com and click on Settings.
Select Developer settings and click on Personal access tokens.
Provide a name for the token, set the
Expirationto 90 days ,set the following scopes and click Generate token.
GitHub Personal Access Token scopes
Copy and save the Personal Access Token. You will not be able to retrieve this value again later.
Red Hat OpenShift on IBM Cloud cluster with GitOps Configuration¶
Create the cluster¶
Provision a Red Hat OpenShift on IBM Cloud cluster with GitOps Configuration from IBM Technology Zone. Select the
ROKS Cluster with GitOps Configurationtile.
Click the Reserve now radio button.
Provide a name for the cluster, select Practice / Self-Education for the purpose and choose the region to provision the cluster.
Once a Preferred Geography has been selected, provide the GitHub Access API Token and GitHub Organization created from the Pre-requisites section. For the sizing parameters, such as Worker Node Count and Worker Node Flavor, do not use the values shown in the screen shot below. Instead, scroll down to use the values based on the requirements for this quickstart, listed in the Note below. Finally, click Submit.
Ensure that you enter just the name of your GitHub Public Organization (for instance gitops-magic-2022) and not the full URL.
For this IBM Process Mining Quickstart we recommend you to request the Red Hat OpenShift on IBM Cloud cluster with GitOps Configuration with the following size:
- Worker Node Count = 3
- Worker Node Flavor = 16 CPU x 64 GB
Use the cluster¶
You will receive an email once the cluster provisioning is complete. The email will contain details on the cluster including the ArgoCD Console URL and admin credentials. This same information can also be found on the My reservations from IBM Technology Zone.
Once your cluster is ready, proceed to the next step to select resources to deploy.
Install required CLIs¶
- Install the Github CLI (version 1.14.0+)
Install the OpenShift CLI
oc(version 4.7 or 4.8)
Log into your OCP cluster, substituting the
--serverparameters with your values:
oc login --token=<token> --server=<server>
If you are unsure of these values, click your user ID in the OpenShift web console and select
Copy login command.
Install the kubeseal CLI
The kubeseal utility uses asymmetric crypto to encrypt secrets that only the controller can decrypt. These encrypted secrets are encoded in a SealedSecret resource which can safely be checked into your gitops repo. The controller will decrypt the secretes and install into your cluster.
Select resources to deploy¶
By now, you should already have a Red Hat OpenShift on IBM Cloud cluster with GitOps Configuration bootstrapped for you.
If you open ArgoCD, which is the GitOps tool being installed by the Red Hat OpenShift GitOps Operator, using the Argo CD URL provided in the email shown in the previous section, you will see that your ArgoCD GitOps application has been bootstrapped to monitor the
multi-tenancy-gitops repository that has been forked into the GitHub organization you provided when requesting the quickstart environment.
As a result, anything you want to apply/do to your quickstart environment will be done through code changes on the aforementioned forked GitHub repository.
You can see in the image above of your ArgoCD web console that the profile within the
multi-tenancy-gitops repository ArgoCD has been bootstrapped with is the
single-cluster. As a result, anything you want to apply/do to your quickstart environment will be done within that GitOps profile.
You can also see that the ArgoCD applications for the
applications layers are already created so that these will pick up any changes done, through code, at their respective layers.
You can execute the following steps either locally by cloning the
multi-tenancy-gitopsGitHub repository the IBM Technology Zone environment request automation has forked into the GitHub organization you created in the Pre-requisites section above to your local workstation (and then make changes from you local workstation and commit and deliver those) or by using the new VSCode extension of GitHub Codespaces capability straight from your web browser (just open the
multi-tenancy-gitopsrepository in your Git Organization in your browser and press the
- Review the
Infrastructurelayer kustomization.yaml and un-comment the resources to deploy to match the IBM Process Mining recipe.
- Review the
Serviceslayer kustomization.yaml and un-comment the resources to deploy to match the IBM Process Mining recipe.
- Commit and push changes to your git repository (the following code refers to the commands when you cloned the
multi-tenancy-gitopsrepository locally on your workstation)
git add . git commit -m "initial bootstrap setup" git push origin
- Review the
You can go to the Deploy Process Mining section of the in-depth IBM Process Mining tutorial here to make sure your IBM Process Mining quickstart deployment is successful and see the instructions for accessing the IBM Process Mining User Interface.