Deploying the Retail Pattern

Prerequisites

1. An OpenShift cluster (Go to the OpenShift console). Cluster must have a dynamic StorageClass to provision PersistentVolumes. See also sizing your cluster.

2. (Optional) A second OpenShift cluster for a second store environment, “raleigh”.

3. A GitHub account

4. (Optional) A quay account that can update images; this is if you want to use the pipelines to customize the applications

5. (Optional) A quay account with the following repositories set as public, and which you can write to:

   • quarkuscoffeeshop-barista
   • quarkuscoffeeshop-counter
   • quarkuscoffeeshop-customerloyalty
   • quarkuscoffeeshop-customermocker
   • quarkuscoffeeshop-inventory
   • quarkuscoffeeshop-kitchen
   • quarkuscoffeeshop-majestic-monolith
   • quarkuscoffeeshop-web

   These repos comprise the microservices that are in the demo. The public repos (quay.io/hybrid-cloud-patterns/*) contain pre-built images which will be downloaded and used by default; so the demo will run regardless of whether you choose to rebuild the apps or not. This mechanism is provided for transparency purposes (so you can reproduce the same results); or if you want to customize or change the apps themselves in some way.

The use of this pattern depends on having at least one running Red Hat OpenShift cluster. All of the apps will run on a single cluster; optionally you can use RHACM to apply the store apps to a second cluster.

If you do not have a running Red Hat OpenShift cluster you can start one on a public or private cloud by using Red Hat’s cloud service.

Prerequisite Tools

Install the installation tooling dependencies. You will need:

{% include prerequisite-tools.md %}

How to deploy

1. Fork the retail repository on GitHub.

2. Clone the forked copy of the retail repo. Use branch `v1.0'.

   git clone git@github.com:{your-username}/retail.git
   cd retail
   git checkout v1.0
   

3. You could create your own branch where you specific values will be pushed to:

   git checkout -b my-branch
   

4. A values-secret.yaml file is used to automate setup of secrets needed for:

   • A container image registry (E.g. Quay)

   DO NOT COMMIT THIS FILE. You do not want to push personal credentials to GitHub.

   cp values-secret.yaml.template ~/values-secret.yaml
   vi ~/values-secret.yaml
   

5. Customize the deployment for your cluster. Change the appropriate values in values-global.yaml

   vi values-global.yaml
   git add values-global.yaml
   git commit values-global.yaml
   git push origin my-branch
   

In particular, the values that you need to change are under the imageregistry key, to use your own account and hostname. If you like, you can change the git settings (account, email, hostname to reflect your own account settings).

If you plan to customize the build of the applications themselves, there revision and imageTag settings for each of them. The defaults should suffice if you just want to see the apps running.

1. You can deploy the pattern using the validated pattern operator. If you do use the operator then skip to Validating the Environment below.

2. Preview the changes

   ./pattern.sh make show
   

3. Login to your cluster using oc login or exporting the KUBECONFIG

   oc login
   

   or

   export KUBECONFIG=~/my-ocp-env/retail-hub
   

4. Apply the changes to your cluster

   ./pattern-util.sh make install
   

This will execute make install in the team’s container, which will take a bit to load the first time. It contains ansible and other dependencies so that you do not need to install them on your workstation.

The default install target will:

1. Install the pattern via the operator
2. Load the imageregistry secret into the vault
3. Start the application build pipelines

If you chose not to put in your registry credential, make install cannot complete successfully because it waits for the secret to be populated before starting the pipelines.

If you do not want to run the (optional) components, another install target is provided:

./common/scripts/pattern-util.sh make install-no-pipelines

This skips the vault setup and the pipeline builds, but still installs both Vault and the Pipelines operator, so if you want to run those in your installation later, you can run make install to enable them.

For more information on secrets management see here. For information on Hashicorp’s Vault see here

Validating the Environment

Check the operators have been installed

UI -> Installed Operators

The OpenShift console menu should look like this. We will use it to validate that the pattern is working as expected:

Check on the pipelines, if you chose to run them. They should all complete successfully:

Ensure that the Hub ArgoCD instance shows all of its apps in Healthy and Synced status once all of the images have been built:

We will go to the Landing Page, which will present the applications in the pattern:

Clicking on the Store Web Page will place us in the Quarkus Coffeeshop Demo:

Clicking on the TEST Store Web Page will place us in a separate copy of the same demo.

Clicking on the respective Kafdrop links will go to a Kafdrop instance that allows inspection of each of the respective environments.

Next Steps

Help & Feedback{: .btn .fs-5 .mb-4 .mb-md-0 .mr-2 } Report Bugs{: .btn .btn-red .fs-5 .mb-4 .mb-md-0 .mr-2 }