Quickstart #

The Riser demo allows you to easily experiment with Riser using a local Kubernetes cluster.

Prerequisites #

Ensure that you have a recent version of the following:

• Docker (Note: just for client tooling - the Docker daemon does not need to be running)
• Minikube
• Git CLI
• Kubectl

You must also have a GitHub account for the state repo. Riser will support other git providers in the future.

ℹ️ These dependencies are specifically for running a local demo of a full Riser stack. A typical app developer only needs the Riser client binary.

⚠️ Windows Users: A Windows release is available but has not yet been tested. It’s recommended that you use the Windows Subsystem for Linux for the Riser CLI.

Demo Installation #

• Enable the minikube ingress addon: minikube addons enable ingress
• Create a minikube cluster. For the best results use the recommended settings: minikube start --cpus=4 --memory=6144 --kubernetes-version=1.17.11.
• Create a GitHub repo for Riser’s state (e.g. https://github.com/your-name/riser-state).
  • Riser requires write access to the repo. It is recommended that you use SSH with a GitHub deploy key with write access. Riser supports using HTTPS git URLs with authentication such as GitHub personal access token’s as well.
• Download the latest Riser CLI for your platform and put it in your path.
• Ensure that your minikube is started. In a new terminal window, run minikube tunnel. Ensure it establishes the tunnel and let it run in the background.
• Run riser demo install and follow the instructions.

Things to try #

• Use riser apps init to create a minimal app config.
• Check out the annotated app config for a full list of configuration options.
• Review the emojivoto microservices example
• Use riser help or check out the table of contents to explore other help topics.