Skip to content

Latest commit

 

History

History
105 lines (75 loc) · 4.26 KB

README.md

File metadata and controls

105 lines (75 loc) · 4.26 KB
Raw

SpringOne Tour 2021 - Workshop 3

This repo contains a hands-on workshop covering the following topics:

  • Spring Boot application testing
    • Unit testing
    • Integration testing using contracts
    • Database schema testing using Flyay and Testcontainers
  • Automated deployment to Kubernetes
    • GitHub Actions
    • kpack
    • ArgoCD
    • ArgoCD-Image-Updater

The workshop can be run using educates, a system for hosting interactive workshop environments. Educates can run on any Kubernetes cluster.

Run locally

Prerequisites:

To start the workshop, clone this repo and run:

sh local-eduk8s-start.sh

This command will start minikube, install the Educates operator, and deploy the workshop files.

When startup is complete, the console will show a link to the training portal. You can also retrieve the link by running:

kubectl get trainingportal

Click on the link, then click on the Start workshop button in your browser, and you will find yourself in the hands-on training environment where you will be guided through the workshop.

See below for instructions to "Run on existing Kubernetes cluster"

Contributing to the workshop

Setup

Educates loads the workshop content from a git repo specified in the file resources/workshop.yaml, under the path spec.content.files. In order to test your workshop contributions before submitting a pull request to merge your changes into the main branch, you can change this value to point to your own branch or fork of this repo. In this way, you can run the workshop locally as many times as you need, pulling the workshop files from your own branch or fork.

Assuming you are working off of a branch in this repo:

  1. Clone the repo
  2. Create your development branch git checkout -b <my-branch>
  3. Open the file resources/workshop.yaml and follow the YAML path to spec.content.files. The value will be the url to the workshop files, something like:
files: github.com/springone-tour-2021/lab-workshop-3?ref=main
  1. Change the last part of the url ?ref=main to ?ref=<your-branch-name>

Now, you can iterate locally using Minikube, pulling files with your workshop contributions from your branch, until you are ready to merge your changes into the main branch.

Note: This change only needs to be made on your local machine. Avoid pushing this change to GitHub, and in particular, avoid pushing this change to the main branch of the repo.

Development

  1. Instructions - written in markdown and stored under workshop/content/exercises

One of the core features of educates is clickable actions. These are actions the user clicks in the instructions that will be automatically executed for them. Clickable actions should be used for every step possible. This for many reasons but mainly to reduce user error.

  1. After adding new files, you are required to update workshop/modules.yaml and [workshop/workshop.yaml](workshop/workshop.yaml.

These config files tell educates:

  • The order of the instructions from your markdown in workshop/workshop.yaml by specifying the filepath without ending in .yaml.
  • Similarly, in workshop/modules.yaml the filepath is used as well to order and specify the instruction. The name field will appear as the title of the instruction and the exit_sign is the text on the button to click next.

More information

Workshop content uses Markdown formatting for pages.

For more detailed information on how to create and deploy workshops, consult the documentation for eduk8s at:

Run on existing Kubernetes cluster

If you already have the Educates operator installed and configured on a Kubernetes cluster, you can simply run:

kubectl apply -f ./resources/workshop.yaml
kubectl apply -f ./resources/training-portal.yaml

This will deploy a training portal hosting just this workshop. To get the URL for accessing the training portal run:

kubectl get trainingportal

The training portal is configured to allow anonymous access. For your own workshop content you should consider removing anonymous access.