Tutorials

The table below provides an overview of the different exercises and their main goal.

Exercise	Goal
Getting started	Deploy the Microgateway and get familiar with its components.
Protecting a backend service	Configure the Microgateway to protect a simple backend service.
Readiness and Liveness Probes	Configure Readiness and Liveness Probes of Microgateway correctly.
Deny rules	The protected backend has some text fields in HTML forms where user input could lead to false-positives. Because of that, the Microgateway configuration must be extended with deny rule exceptions.
OpenAPI	Configure the Microgateway to protect a backend service by enforcing an OpenAPI spec.
Metrics	Configure the Microgateway to publish metrics. Prometheus scrapes those metrics and Grafana will visualize them.
Session handling	Configure the Microgateway to protect a simple backend service with session handling enabled.
Access control with Airlock IAM	Configure the Microgateway to enforce upfront authentication for a backend service.

How are the tutorials organized

The tutorials are intended to show different aspects of running and configuring the Airlock Microgateway. They are independent of each other and can be done in any order.

Each tutorial consists of

an exercise folder. The exercise is accompanied by a guide with detailed instructions and hints (see corresponding subchapter Exercises). In most cases, Kubernetes resource files have to be updated and deployed in order to solve the exercise.
a solution folder containing a potential solution for the exercise.

The Kubernetes resources created for the exercises have the labels purpose: microgateway-tutorial. Therefore, it is easy to distinguish which resources have been created during the exercises.

The command within the exercises assumes that you are in the root directory of the checked-out Tutorial repository.

Skills

Airlock Microgateway is designed to run in Kubernetes distributions, like OpenShift, AKS, Rancher, etc. In order to be successful during the deployment or operational tasks, Kubernetes knowledge on CKA/CKAD level is suggested.

Other vendors like OpenShift have their equivalent certification courses which also satisfy this requirement.

Setup

The graphic illustrates the setup being used in the exercises:

You need a Kubernetes cluster to run this tutorial. You can use Minikube to create one if you do not have a cluster available.

The kubectl command-line tool has to be configured for the cluster you intended to use.

The exercises have been tested with the following versions:

Component	Version	Link	Comments
Minikube	v1.22.0	https://minikube.sigs.k8s.io/docs/start/	Follow the installation steps.
Airlock-Microgateway-Tutorials	v2.5.0	https://github.com/ergon/airlock-microgateway-tutorials	Check out the Git repo to a local working directory.