Secure API Gateway Deployment - SecureApiGateway/SecureApiGateway GitHub Wiki
These files are a version of SAPI-G, but do not hold any specific deployment configuration. Installing these files alone will not work. You must have the deployment specification repository or folders created before you deploy. This allows you to potentially install different versions of SAPI-G.
This repository contains an umbrella chart and a Kustomize folder. The umbrella chart will install the core components that comprise SAPI-G. The Kustomize folder has the base files required for deploying IG.
Kustomize
Kustomize can be used with overlays to create an overall manifest. The files in this repository represent the base files, and therefore need an overlay in the deployment specification for the individual configuration.
You can install IG as follows:
- Ensure you are within the Kustomize folder within the deployment specification repository or folder, rather than in the base Kustomize files within the secure-api-gateway-releases repository.
- Run the following command:
kustomize build > deployment.yaml
kubectl apply -f deployment.yaml -n [DEPLOYMENTNAME]
rm deployment.yaml
Helm
The Helm umbrella chart will install multiple components that comprise SAPI-G.
You can install this umbrella chart as follows:
- Ensure you are within the root directory within the deployment specification repository or folder, rather than the root directory of the secure-api-gateway-releases repository.
- Run the following command:
helm upgrade [DEPLOYMENTNAME] forgerock-helm/secure-api-gateway --version [PACKAGE_VERSION] --namespace [NAMESPACE] -f values.yaml --install --wait
Where the options are:
| Key | Description | Example |
|---|---|---|
| DEPLOYMENTNAME | Helm name for the deployment -this must be unique | secure-api-gateway-v1 |
| PACKAGE_VERSION | Version of the Charts to install | 1.0.0 |
| NAMESPACE | Namespace to deploy to | v1 |