Skip to content

Latest commit

 

History

History
193 lines (140 loc) · 6.82 KB

README.md

File metadata and controls

193 lines (140 loc) · 6.82 KB
Raw

Red Hat Arcade: Shipwars Deployment

This repository contains instructions and files to deploy the Shipwars game on an OpenShift 4.x cluster, or via Docker Compose.



Shipwars running in a web browser.

Architecture

The Shipwars game has 4 core components:

  • UI (WebApp): Served using NGINX.
  • Game Server (Node.js): Clients connect to this via WebSocket. Executes game logic and uses in-memory storage. Integrates with Kafka to propogate game events.
  • Bot Server (Node.js): Creates in-memory "Agents" that connect to the Game Server via WebSocket. Uses a State Machines to manage Agent behaviour.
  • Move Server (Python): Exposes a REST API that Agents call to retrieve their next move.

An set of extended demo components that require Apache Kafka are also available:

Using with OpenShift Streams for Apache Kafka

NOTE: This is optional and not required to run the core game services.

If you'd like to experiment with the Kafka and Kafka Streams portitions of this application you'll need a cloud.redhat.com account - it's free!

You'll also need the RHOAS CLI installed in your development environment.

Once you have an account and the CLI installed, run the following commands from the root of this repository. This configures a Kafka instance on cloud.redhat.com:

# Login using the browser based flow
rhoas login

# Create a kafka cluster named "shipwars"
rhoas kafka create --name shipwars

# Create the topics required by the applications
./configure-rhosak.sh

Deployment on OpenShift

Deployment is separated into two distinct sections:

  1. [Reqiured] Deploy the core game services
  2. [Optional] Deploy the managed Kafka and Kafka Streams services

Core Game Services

Requirements:

  • OpenShift 4.x cluster or OpenShift Sandbox.
  • OpenShift CLI (oc) 4.x.
  • Account with permission to create a project and deploy resources into it.
# Login to your cluster using a token, or username and password
oc login

# Run the deploy script
cd openshift/

# Set the target namespace (created if it doesn't exist) and deploy into it.
# This deploys the primary game components, without Kafka integrations
./deploy.game.sh

# Print the route to the game UI that you can access in your web browser over HTTPS
oc get route shipwars-client -n shipwars -o jsonpath='{.spec.host}'

Notes on the default configuration:

  • Deploys the game services into a project named "shipwars".
  • Requests 500 millicores and 768MB memory from the cluster.
  • Supports at least 100 conncurrent players.

The deployment creates a topology similar to the following screenshot:



Shipwars OpenShift Topology.

Kafka Services and Integration

Follow the "Using with OpenShift Streams for Apache Kafka" section, then run the following scripts:

# Login using the browser based flow
rhoas login

# Create a kafka cluster named "shipwars"
rhoas kafka create --name shipwars

# Create the topics required by the applications
./configure-rhosak.sh

# Create a KafkaConnection and ServiceBinding in the project
# that connects the Node.js application to managed Kafka
./openshift/deploy.kafka-bind.sh

# Deploy Quarkus and Kafka Streams images, and use the KafkaConnection
# secrets and information to connect them to managed Kafka
./openshift/deploy.kafka-streams.sh

This will:

  • Create the following resources to link your OpenShift Streams instance with the project:
    • KafkaConnection CR.
    • rh-cloud-services-accesstoken-cli Secret.
    • rh-cloud-services-service-account Secret.
  • Mount OpenShift Streams Kafka connection details to shipwars-game-server Deployment.
  • Deploy a Quarkus Kafka Streams application to process player attacks.
  • Build and deploy an NGINX container with a UI to visualise the player attacks.


Shipwars OpenShift Topology with OpenShift Streams.

Docker Compose

Run the following commands from the root of this repository to start the pre-built containers that are hosted on quay.io:

# Change into the directory with the local dev docker-compose file
cd shipwars-deployment/docker/

# Define OpenShift Streams connection details and start the containers. You must
# have completed the "Using with OpenShift Streams for Apache Kafka" section of
# this README first. Use "rhoas serviceaccount create" or the UI at
# cloud.redhat.com/beta/application-services/streams to obtain user/pass
KAFKACONNECTION_BOOTSTRAPSERVERS=$(rhoas kafka describe | jq .bootstrapServerHost -r) \
KAFKACONNECTION_SSL=true \
KAFKACONNECTION_USER=replace_with_sasl_client_id \
KAFKACONNECTION_PASSWORD=replace_with_sasl_client_secret \
docker-compose up

Once the containers have started the game will become available at http://localhost:8484/.

Docker/Podman Local Development Mode

NOTE: Only the Node.js containers support local development with live reload at present. Other images will need to be built and pushed to see changes reflected.

Clone the repositories from redhat-gamedev in the structure outlined below:

workspace/
├── shipwars-bots/
├── shipwars-client/
├── shipwars-deployment/
├── shipwars-streams/
├── shipwars-game-server/
└── shipwars-move-server/

Docker Compose

# Change into the directory with the local dev docker-compose file
cd shipwars-deployment/docker-local-dev/

# Define OpenShift Streams connection details and start the containers. You must
# have completed the "Using with OpenShift Streams for Apache Kafka" section of
# this README first. Use "rhoas serviceaccount create" or the UI at
# cloud.redhat.com/beta/application-services/streams to obtain user/pass
KAFKACONNECTION_BOOTSTRAPSERVERS=$(rhoas kafka describe | jq .bootstrapServerHost -r) \
KAFKACONNECTION_SSL=true \
KAFKACONNECTION_USER=replace_with_sasl_client_id \
KAFKACONNECTION_PASSWORD=replace_with_sasl_client_secret \
docker-compose up --build --force-recreate