openshift-cs / ostoy

A simple Node.js app to help explore OpenShift deployments

OSToy

v1.7.0

A simple Node.js application that deploys to OpenShift. It is used to help explore the functionality of Kubernetes. This toy application has a user interface which you can:

• write messages to the log (stdout / stderr)
• intentionally crash the application to view auto repair
• toggle a liveness probe and monitor OpenShift behavior
• if provided; read config maps, secrets, and env variables
• if connected to shared storage, read and write files
• check network connectivity, intra-cluster DNS, and intra-communication with an included microservice
• increase the load to test out Horizontal Pod Autoscaler
• if deployed to AWS, use the app to read the contents of an S3 bucket
• if deployed to Azure, use the app to read the contents of a Blob storage container

Configuration

Environment Variables

• PORT (default: 8080): The port to expose the application on
• MICROSERVICE_NAME (default: none): The upper-cased name of the Service object associated with the microservice application (be sure to also replace any - with _)
• MICROSERVICE_IP (default: <MICROSERVICE_NAME>_SERVICE_HOST): The static IP of the Service object associated with the microservice application. This will be looked up from automatic OpenShift environment variables if MICROSERVICE_NAME is provided
• MICROSERVICE_PORT (default: <MICROSERVICE_NAME>_SERVICE_PORT): The exposed port of the Service object associated with the microservice application. This will be looked up from automatic OpenShift environment variables if MICROSERVICE_NAME is provided
• CONFIG_FILE (default: /var/config/config.json): The fully-qualified path to the file created by the ConfigMap object
• SECRET_FILE (default: /var/secret/secret.txt): The fully-qualified path to the file created by the Secret object
• PERSISTENT_DIRECTORY (default: /var/demo_files): The fully-qualified path to the directory mounted with the PersistentVolume
• AZURE_CONNECTION_STRING_LOCATION (default: /mnt/secrets-store/connectionsecret): The fully-qualified path to the mounted connection string secret

Deployment

Using oc commands

# Add Secret to OpenShift
# The example emulates a `.env` file and shows how easy it is to move these directly into an
# OpenShift environment. Files can even be renamed in the Secret
$ oc create -f https://raw.githubusercontent.com/openshift-cs/ostoy/master/deployment/yaml/secret.yaml

secret/ostoy-secret created

# Add ConfigMap to OpenShift
# The example emulates an HAProxy config file, and is typically used for overriding
# default configurations in an OpenShift application. Files can even be renamed in the ConfigMap
$ oc create -f https://raw.githubusercontent.com/openshift-cs/ostoy/master/deployment/yaml/configmap.yaml

configmap/ostoy-config created

# Deploy microservice
# We deploy the microservice first to ensure that the SERVICE environment variables
# will be available from the UI application. `--context-dir` is used here to only
# build the application defined in the `microservice` directory in the git repo.
# Using the `app` label allows us to ensure the UI application and microservice
# are both grouped in the OpenShift UI
$ oc new-app https://github.com/openshift-cs/ostoy \
    --context-dir=microservice \
    --name=ostoy-microservice \
    --labels=app=ostoy

Creating resources with label app=ostoy ...
  imagestream.image.openshift.io "ostoy-microservice" created
  buildconfig.build.openshift.io "ostoy-microservice" created
  deployment.apps "ostoy-microservice" created
  service "ostoy-microservice" created
Success
  Build scheduled, use 'oc logs -f bc/ostoy-microservice' to track its progress.
  Application is not exposed. You can expose services to the outside world by executing one or more of the commands below:
   'oc expose svc/ostoy-microservice'
  Run 'oc status' to view your app.

# Deploy the UI Application
# The applicaiton has been architected to rely on several environment variables to define
# external settings. We will attach the previously created Secret and ConfigMap afterward,
# along with creating a PersistentVolume
$ oc new-app https://github.com/openshift-cs/ostoy \
    --env=MICROSERVICE_NAME=OSTOY_MICROSERVICE

Creating resources ...
  imagestream.image.openshift.io "ostoy" created
  buildconfig.build.openshift.io "ostoy" created
  deployment.apps "ostoy" created
  service "ostoy" created
Success
  Build scheduled, use 'oc logs -f bc/ostoy' to track its progress.
  Application is not exposed. You can expose services to the outside world by executing one or more of the commands below:
   'oc expose svc/ostoy'
  Run 'oc status' to view your app.

# Update Deployment to use a "Recreate" deployment strategy for consistent deployments
# with persistent volumes
$ oc patch deployment ostoy --type=json -p \
    '[{"op": "replace", "path": "/spec/strategy/type", "value": "Recreate"}, {"op": "remove", "path": "/spec/strategy/rollingUpdate"}]'

deployment.apps/ostoy patched

# Set a Liveness probe on the Deployment to ensure the pod is restarted if something
# isn't healthy within the application
$ oc set probe deployment ostoy --liveness --get-url=http://:8080/health

deployment.apps/ostoy probes updated

# Attach Secret, ConfigMap, and PersistentVolume to deployment
# We are using the default paths defined in the application, but these paths
# can be overriden in the application via environment variables
# Attach Secret
$ oc set volume deployment ostoy --add \
    --secret-name=ostoy-secret \
    --mount-path=/var/secret

info: Generated volume name: volume-jtn5v
deployment.apps/ostoy volume updated

# Attach ConfigMap (using shorthand commands)
$ oc set volume deployment ostoy --add \
    --configmap-name=ostoy-config \
    -m /var/config

info: Generated volume name: volume-2ct8f
deployment.apps/ostoy updated

# Create and attach PersistentVolume
$ oc set volume deployment ostoy --add \
    --type=pvc \
    --claim-size=1G \
    -m /var/demo_files

info: Generated volume name: volume-rlbvv
deployment.apps/ostoy updated

# Finally expose the UI application as an OpenShift Route
# Using OpenShift Dedicated's included TLS wildcard certicates, we can easily
# deploy this as an HTTPS application
$ oc create route edge --service=ostoy --insecure-policy=Redirect

route.route.openshift.io/ostoy created

# Browse to your application!
$ python -m webbrowser "$(oc get route ostoy -o template --template='https://{{.spec.host}}')"

Changes from KubeToy

• Remove IBM CoS integration
• Remove references to IBM Private Cloud
• Include OpenShift specific styles and logos
• Remove unused packages and misc clean up
• Redesigned with PatternFly
• Rearchitected in a cleaner format
• Include intra-cluster communication from Networking page
  • Adds a separate microservice sub-deployment
• Add function to increase load to test HPA
• Add S3 integration
• Add Azure Blob storage integration

ostoy's Issues

OSToy front end UI looks like you are still inside the OCP console

A participant of the workshop said they were very confused at first and took a while to realise that the UI of OSToy was not actually another part of the OCP console but in fact a seperate application. I agreed - actually i was a bit confused when I first tried it, and I am an OCP SME.

Perhaps changing the CSS to make it more obvious it is a new application not part of the console. Maybe use patternfly light and remove the logo from the top left corner?