Secure API Gateway - Releases Helpers

Prerequisites

• Kubernetes v1.23 +
• Helm 3.0.0 +

To add the forgerock helm artifactory repository to your local machine to consume helm charts use the following;

  helm repo add forgerock-helm https://maven.forgerock.org/artifactory/forgerock-helm-virtual/ --username [backstage_username]  --password [backstage_password]
  helm repo update

NOTE: You must have a valid subscription to aquire the backstage_username and backstage_password values.

It is assumed that, the following components have been sucessfully built and docker images are within a docker container registry ready to be used.

• Secure API Gateway - Remote Consent Service
• Secure API Gateway - Remote Consent Service User Interface
• Secure API Gateway - Test Bank Facility
• Secure API Gateway - Test User Account Creator

It is assumed that, either a deployments repo has been created containing the specific deployment overrides has been created, or if a repository are not being used they are at hand (within the instructions below it is assumed that a repo is being used)

It is assumed that all infrastructure has been created, including deploying the Cloud Instance, and that the following prerequisits have been deployed to the cluster

• Nginx
• MongoDB

External Secrets GSM

The external secrets Google Secrets Manager charts specify the secrets to be created in the kubernetes cluster. We use Google Secrets Manager for our secrets, but other secrets managers can be used.

Deployment Guide

The charts in this repo can create helm package to be pushed to the forgerock helm artifactory. To publish a new version of the secure-api-gateway-helpers to the artifactory perform the following steps

• Go to Github Actions
• Click Run Workflow
  • Keep Branch as master
  • Add 'Release [VERSION]' as the description (optional)
  • Add [VERSION] to 'Provide release version number'
  • Click Run Workflow

Once the workflow has completed, a new tag and release will have been created within secure-api-gateway-release-helpers repo, and new helm packages will have been pushed to the atrifactory.

Key	Description	Example
VERSION	Version of the charts to publish, must be unique and not already be in use	1.0.0

Support

For any issues or questions, please raise an issue within the SecureApiGateway repository.