To use Airlock Microgateway, a valid license is required. Airlock Microgateway is available in a Premium and a free Community edition. The available editions are compared in the article Airlock Microgateway license editions and support.
Configure and change the license
- Store the license in the Microgateway Operator namespace, in a Kubernetes secret with the name
airlock-microgateway-license
and the keymicrogateway-license.txt
. Use the following command: - To change a license (e.g. when upgrading from Community to Premium), use
kubectl apply
to apply the new license to the airlock-microgateway-license secret in the airlock-microgateway-system namespace.
There is no need to restart the Airlock Microgateway Operator. Kubernetes Secrets are updated at intervals of about one minute. Wait for the new license to become active.
Monitor license information with metrics and logs
Apart from the Community edition license, you should always order a Premium edition license that covers your (calendar-based) monthly request count.
We have implemented a set of license-related metrics. Use them to monitor if your current Airlock Microgateway license is still sufficient and to update/change your license in time.
- Metrics:
- License-related metrics with explanations are listed below in this article.
For a detailed list of available metrics with a short description, see available metrics in Prometheus format.
- Operator logs:
- License information on a daily base for
- license expiration due date,
- on expired license,
- when license is missing or invalid.
- License details at every start of the Microgateway Operator or after license exchange/upgrade.
Behavior with invalid or expired licenses
Licenses are treated either as valid, invalid or expired. Differences between invalid and expired licenses are shown in the following table.
- Corresponding metrics:
microgateway_license_valid
microgateway_license_expiry_timestamp_seconds
License validity | Definition and behavior |
---|---|
Valid license |
|
Invalid license |
|
Expired license |
|
- Operator and Pods are not affected by the license status:
- The Airlock Microgateway Operator runs normally.
- Based on the label for injection, the Airlock Microgateway Operator​ injects the Microgateway Engine container into Pod. Therefore, only these Pods are affected. See also the article Labels and annotations for Airlock Microgateway.
Further information and links
- Internal links:
- Airlock Microgateway license editions and support
- Labels and annotations for Airlock Microgateway
- Airlock Microgateway license editions and support
- External links:
- Request a community license: https://airlock.com/en/microgateway-community
- Request a premium license: https://airlock.com/en/microgateway-premium