hpgrahsl / rht-summit-2023-sample-application

Red Hat Summit 2023 GitOps Sample Application

This repository contains a simple Node.js application that renders a web page containing a randomly chosen meme.

Overview

The k8s directory contains a set of Kubernetes/OpenShift resources that can be used to deploy the Node.js application on an OpenShift cluster.

The memes displayed by the application are chosen at random from the application/images.json file. It's possible to use a different file by setting the IMAGES_JSON_FILEPATH environment variable to point to a different file. When deployed on OpenShift using the resources in the k8s/ folder, the application mounts a ConfigMap containing the memes that should be used.

GitHub Actions is used for CI (Continuous Integration). Modifying the code in the application/ directory will trigger an Action to build and push a new container image to https://quay.io/evanshortiss/random-meme. Similarly, changes to the k8s/config-map.yaml will trigger an Action that verifies that the image URLs in the ConfigMap actually resolve to images.

Local Development

Requires Node.js v18. The following commands will start a local development server that automatically detects file changes and restarts the Node.js server:

cd application
npm ci
npm run dev

Contributing Memes

The basic process for adding a meme is:

1. Sign into your GitHub Account.
2. Open the k8s/config-map.yaml in your browser, and click on the edit (pencil) icon.
3. Add the URL to your meme to the images.json array.
4. Save the change and click on the Create pull request button that appears.
5. Wait for the repository owner to merge your pull request.