This repository was archived on 2023-07-28. It is no longer maintained. As a replacement we offer a growing number of Airlock Microgateway labs that are designed to be easy-to-follow tutorials.
This repository contains deployment examples for Airlock on Minikube. It shows how to protect a backend application with Airlock Microgateway and how to authenticate users using Airlock IAM. The source code is available under the MIT license.
The different components in the example are described below:
- The Ingress controller is accepting the external traffic and forwards it to the designated Microgateway service.
- A specific Airlock Microgateway protects each of the following services:
- Airlock IAM, which is accessible for unauthenticated users. Filters, OpenAPI specifications and other security features protects IAM against attacks.
- Echoserver, which is only accessible for authenticated users and restrictive deny rules are enabled.
- Grafana, which is only accessible for authenticated users.
- Kibana, which is only accessible for authenticated users.
- Airlock IAM authenticates users for services with authentication enforcement configured in the Microgateway.
- For the Echoserver, the authenticated user is federated through a JWT token in a cookie.
- For Grafana, the IAM and Grafana Microgateway share the same Redis instance and therefore hold the same session data.
- For Kibana, the IAM and Kibana Microgateway share the same Redis instance and therefore hold the same session data.
- ArgoCD is the GitOps tool to deploy and bootstrap the desired scenario.
- Airlock Minikube Example
Airlock Microgateway is available as community and premium edition. The differences between these two editions are documented here.
The Airlock Minikube Example can be deployed in the following scenarios:
- Community Edition: Airlock Microgateway is deployed without a license and without Airlock IAM.
- Premium Edition: Airlock Microgateway is deployed with a valid license but without Airlock IAM.
- Premium Edition with IAM: Airlock Microgateway is deployed with Airlock IAM. Both products have a valid license.
Starting the example as community edition might be useful to get familiar with the product and understand the benefit of Airlock Microgateway. Nevertheless, for best security a licensed Airlock Microgateway with Airlock IAM is recommended.
- Install Minikube.
- Install kubectl.
- Access to the Docker Hub repositories:
- For Airlock Microgateway (public repository):
hub.docker.com/r/ergon/airlock-microgateway-configbuilderhub.docker.com/r/ergon/airlock-microgateway
- For Airlock IAM (private repository):
hub.docker.com/r/ergon/airlock-iam
- For Airlock Microgateway (public repository):
- ❗ Since Docker has rate limits in place for anonymous users, it is recommended to use an account to have higher rate limits.
Start Minikube and configure ingress by running the following command:
minikube start --vm=true --memory=10g --kubernetes-version=v1.20.2 --addons=ingressThis deployment example requires:
- at least 10GB memory (
--memory=10g). --vm=truein order to use--addons=ingress.
To deploy the Airlock Minikube Example in a certain scenario, the GitOps tool ArgoCD is being used. Therefore, before proceeding with the deployment, ArgoCD must be deployed first:
# Install ArgoCD
kubectl apply -k apps/argo-cd/
# Wait until all pods are ready
kubectl -n argocd wait --for=condition=ready --timeout=600s pod -l app=argoThe Airlock Minikube Example has been made available in different scenarios. The difference is whether you have a license and access to the private Docker Hub repository of Airlock IAM or not. Choose the scenario which suits best for you and which prerequisites you fulfill.
To deploy the example in the scenario, run the following command:
kubectl apply -f example/community.yamlWait until all pods have been deployed and are ready. This takes usually 5-15 minutes but could vary, depending on your internet connectivity to pull the images and your computer to start the pods.
This scenario requires the following in addition to the general prerequisites:
- Valid license for Airlock Microgateway
❗ Please contact order@airlock.com to get a temporary license.
Before deploying the scenario, do the following:
- Copy the Airlock Microgateway license file to
secrets/microgateway.lic. - Create the secret
microgateway-license:
The instructions below explain the steps to fulfill the prerequisites:
# Create the Kubernetes manifest file for the secret microgateway-license
kubectl create secret generic microgateway-license \
--from-file=license=secrets/microgateway.lic \
--dry-run=client \
-o yaml > secrets/microgateway-license.yaml
# Create the secret
kubectl apply -f secrets/To deploy the example in the scenario, run the following command:
kubectl apply -f example/premium.yamlWait until all pods have been deployed and are ready. This takes usually 5-15 minutes but could vary, depending on your internet connectivity to pull the images and your computer to start the pods.
This scenario requires the following in addition to the general prerequisites:
- Valid license for Airlock Microgateway
- Valid license for Airlock IAM
- A Docker Hub account with access to the private Docker Hub repository of Airlock IAM
❗ Please contact order@airlock.com to get a temporary licenses or grant your Docker Hub account for the Airlock IAM repository.
Before deploying the scenario, do the following:
- Copy the Airlock Microgateway license file to
secrets/microgateway.lic. - Copy the Airlock IAM license file to
secrets/iam.lic. - Create the secret
microgateway-license. - Create the secret
iam-license. - Create the secret
dockerregcred.
The instructions below explain the steps to fulfill the prerequisites:
# Create the Kubernetes manifest file for the secret microgateway-license
kubectl create secret generic microgateway-license \
--from-file=license=secrets/microgateway.lic \
--dry-run=client \
-o yaml > secrets/microgateway-license.yaml
# Create the Kubernetes manifest file for the secret iam-license
kubectl create secret generic iam-license \
--from-file=license.txt=secrets/iam.lic \
--dry-run=client \
-o yaml > secrets/iam-license.yaml
# Create the Kubernetes manifest file for the secret dockerregcred
kubectl create secret docker-registry dockerregcred \
--docker-server='https://index.docker.io/v1/' \
--docker-username=<DOCKER_USER> \
--docker-password=<DOCKER_PASSWORD> \
--docker-email=<DOCKER_EMAIL> \
--dry-run=client \
-o yaml > secrets/dockerhub-secret.yaml
# Create the secrets
kubectl apply -f secrets/To deploy the example in the scenario, run the following command:
kubectl apply -f example/premium-with-iam.yamlWait until all pods have been deployed and are ready. This takes usually 5-15 minutes but could vary, depending on your internet connectivity to pull the images and your computer to start the pods.
Get the Minikube IP address:
minikube ipOpen a browser to navigate to the different web applications. Use user as the username and password as the password to authenticate.
- Echoserver URL:
https://<MINIKUBE_IP>/echo/ - Grafana URL:
https://<MINIKUBE_IP>/grafana/ - Kibana URL:
https://<MINIKUBE_IP>/kibana/
Use the Airlock IAM Adminapp to administer users and their login factors (only for Premium Edition with IAM).
- Airlock IAM Adminapp URL:
https://<MINIKUBE_IP>/auth-admin/- Username:
admin - Password:
password
- Username:
To delete the deployment example, run the following command:
# To cleanup the scenario "Community"
kubectl delete -f example/community.yaml
# To cleanup the scenario "Premium"
kubectl delete -f example/premium.yaml
# To cleanup the scenario "Premium with IAM"
kubectl delete -f example/premium-with-iam.yamlIf Minikube is not needed anymore or to restart from scratch, run this command:
minikube deleteThe Airlock Minikube Example provides helpful saved searches and reports to get quickly an overview. Additionally, Prometheus metrics provide further information. Nevertheless, without traffic it's difficult to get an impression about the reporting and monitoring solution we provide. Therefore, a load generator can be started which creates traffic optimized for the scenario Premium Edition with IAM.
To start the load generator, run the following command:
kubectl apply -k apps/artillery/To stop the load generator, run the following command:
kubectl delete -k apps/artillery/The Airlock Minikube Example uses the GitOps tool ArgoCD to bootstrap the setup. Therefore, it does not work to simply adapt and re-deploy the Kubernetes manifest files. ArgoCD periodically checks that the desired state is what is defined in the Git repository. In order to have a customized setup, do the following:
- Fork this Git repository
- Change the
repoURLto match your fork in the following files:example/community.yamlexample/premium-with-iam.yamlexample/premium.yaml
- Push the changes in your fork
- Customize your fork to your desire
- Run the example by using the adapted
example/*.yamlfiles in your fork.
To check whether ArgoCD had issues during the deployment of the example, a look into the Web UI could help.
# Retrieve the admin password
echo $(kubectl -n argocd get secret argocd-initial-admin-secret -o jsonpath="{.data.password}" | base64 -d)
# Start port forwarding for the ArgoCD Web UI
kubectl port-forward svc/argocd-server -n argocd 8080:443Afterwards #: https://localhost:8080/
- Username:
admin - Password:
<From the command described above>
- Introduction: Airlock Microgateway
- Documentation: Airlock Microgateway Manual
- Community Support: Airlock Community Forum
- Helm Charts: Airlock Helm Charts
Airlock is a registered trademark of Ergon. Ergon is a Swiss leader in leveraging digitalisation to create unique and effective client benefits, from conception to market, the result of which is the international distribution of globally revered products.