Documentation

For full documentation, check out the Github Pages Site: quarkuscoffeeshop.github.io.

QuarkusCoffeeshop Installation

NOTE: Make sure you have Ansible installed. You can find the installation guide here.

The QuarkusCoffeeshop Ansible Role sets up a basic installation that includes the microservices for a coffee shop, the Crunchy PostgreSQL database, and AMQ Streams (Kafka).

This role will deploy a demo application that is event-driven, built with Quarkus, AMQ Streams (Kafka), and MongoDB. The application is deployed on OpenShift (Kubernetes). You can find the source code for the quarkuscoffeeshop on GitHub, along with support documentation here.

Requirements

• An OpenShift Cluster version 4.12 or higher
• Docker or Podman

Currently tested on:

• OpenShift 4.12.2
• OpenShift Pipelines: 1.9.0
• AMQ Streams: 2.3.0-0odm
• Postgres Operator: v5.3.0
• OpenShift Quay: v3.8.1
• OpenShift GitOps: v1.7.1

Quick Start

Set Environment Variables for Standard Deployment

Run this command to deploy the application on a single cluster with the services listed below:

• AMQ Streams
• Postgres Operator configuration
• Quarkus Coffeeshop Helm deployment

$ cat >source.env<<EOF
CLUSTER_DOMAIN_NAME=clustername.example.com
TOKEN=sha256~XXXXXXXXXXXX
ACM_WORKLOADS=n
AMQ_STREAMS=y
CONFIGURE_POSTGRES=y
MONGODB_OPERATOR=n
MONGODB=n
HELM_DEPLOYMENT=y
DELETE_DEPLOYMENT=false
DEBUG=-v
EOF
$ podman run -it --env-file=./source.env quay.io/quarkuscoffeeshop/quarkuscoffeeshop-ansible:v4.12.1

Set Environment Variables for ACM Workloads

Services included:

• Gogs server
• OpenShift Pipelines
• OpenShift GitOps
• Quay.io
• AMQ Streams
• Postgres Template deployment
• homeoffice Tekton pipelines
• quarkus-coffeeshop Tekton pipelines

$ cat >source.env<<EOF
CLUSTER_DOMAIN_NAME=clustername.example.com
TOKEN=sha256~XXXXXXXXXXXX
ACM_WORKLOADS=y
AMQ_STREAMS=y
CONFIGURE_POSTGRES=y
HELM_DEPLOYMENT=n
DELETE_DEPLOYMENT=false
DEBUG=-v
EOF
$ podman run -it --env-file=./source.env quay.io/quarkuscoffeeshop/quarkuscoffeeshop-ansible:v4.12.1

Optional: Change Namespace for Helm Deployments

Default is quarkuscoffeeshop-demo.

$ cat >source.env<<EOF
CLUSTER_DOMAIN_NAME=clustername.example.com
TOKEN=sha256~XXXXXXXXXXXX
ACM_WORKLOADS=n
AMQ_STREAMS=y
CONFIGURE_POSTGRES=y
MONGODB_OPERATOR=n
MONGODB=n
HELM_DEPLOYMENT=y
NAMESPACE=changeme
DELETE_DEPLOYMENT=false
DEBUG=-v
EOF
$ podman run -it --env-file=./source.env quay.io/quarkuscoffeeshop/quarkuscoffeeshop-ansible:v4.12.1

Screenshots

Visit: quarkuscoffeeshop Web App Example

Usage

• Default web page 5.0.1-SNAPSHOT:
  http://quarkuscoffeeshop-web-quarkus-cafe-demo.apps.example.com/ - View events coming into the cluster.

• Default web page v3.3.1:
  http://quarkuscoffeeshop-web-quarkus-cafe-demo.apps.example.com/cafe - View events coming into the cluster.

• Deploying skip_quarkus_cafe_customermock will push events automatically to the Quarkus cafe dashboard.

• To manually push events to AMQ, use this command:

export ENDPOINT="quarkuscoffeeshop-web-quarkus-cafe-demo.apps.ocp4.example.com"
curl --request POST http://${ENDPOINT}/order \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
-d '{
    "beverages": [
        {"item": "COFFEE_WITH_ROOM", "name": "Mickey"},
        {"item": "CAPPUCCINO", "name": "Minnie"}
    ],
    "kitchenOrders": [
        {"item": "CAKEPOP", "name": "Mickey"},
        {"item": "CROISSANT", "name": "Minnie"}
    ]
}'

Developer Notes

To develop and modify the code, ensure you have:

• An OpenShift Cluster version 4.10 or higher
• Ansible installed on your machine
• oc CLI installed
• Ansible community.kubernetes module installed via ansible-galaxy collection install community.kubernetes
• Helm binary installed
• Postgres Operator for Quarkus CoffeeShop 5.0.1-SNAPSHOT Deployments
• pip3 installed

Role Variables

Download the Deployment Script

To download the deploy-quarkuscoffeeshop-ansible.sh script:

$ curl -OL https://raw.githubusercontent.com/quarkuscoffeeshop/quarkuscoffeeshop-ansible/master/files/deploy-quarkuscoffeeshop-ansible.sh
$ chmod +x deploy-quarkuscoffeeshop-ansible.sh
$ ./deploy-quarkuscoffeeshop-ansible.sh -d ocp4.example.com -t sha-123456789 -p 123456789 -s ATLANTA

To Build Container Image

podman build -t quarkuscoffeeshop-ansible:v0.0.2 -f Dockerfile

Test Container

podman run -it --env-file=./source.env quarkuscoffeeshop-ansible:v0.0.2 bash

or

podman run -it --env-file=./source.env localhost/quarkuscoffeeshop-ansible:v0.0.2

Delete Old Containers

podman rm $(podman ps -a | grep Exited | awk '{print $1}')
podman rmi localhost/quarkuscoffeeshop-ansible:v0.0.2 

Troubleshooting

To force delete Kafka CRDs after a bad install:

oc get crds -o name | grep '.*\.strimzi\.io' | xargs -r -n 1 oc delete

To-Do

• Manage Kubernetes (K8s) objects deployment example using Ansible.

License

This project is licensed under GPLv3.

Author Information

This role was created in 2020 by Tosin Akinosho.