Configuring application provider and API gateway environments
This guide provides the necessary steps to configure application and gateway environments for a tenant. The configuration ensures proper environment hierarchy and association with the corresponding gateway settings.
Prerequisites
Access to the database for executing SQL scripts.
Permission to update the configuration map (
CONFIGMAP).Access to
env.jsonfor modifying frontend settings.
Operational Steps
Step 1: Define the Application Provider and API Gateway Environments
List all environments sequentially from lowest (e.g., DEV) to highest (e.g., PROD). If the application and gateway environments differ, specify both lists. Optionally, include alternative aliases used for these environments.
Example environment list:
Step 1: Database Configuration - Configure Application Provider Environments
To configure the Application Provider Environments, execute the following SQL statements:
Step 2: Database Configuration - Configure API Gateway Environments
To configure the API Gateways Environments, execute the following SQL statements:
Step 3: Update the Tenant-Config Configuration Map
In Kubernetes, you will need to update the tenant configuration to reflect the API Gateway environments. This can be done by modifying the tenant-config to include the environments in the following way:
Update the
TENANT_ENVIRONMENTSvariable
Step 4: Adjust Frontend Display Order (Optional)
To control the display order of API Gateway environments in the frontend, you may need to modify the environment-conf-cm.yaml configuration.
If you want to reverse the display order (e.g., display PROD first, then TEST, then DEV), you can update the descEnvironmentsOrder property in the configuration file.
Verifications
Check the database to ensure correct insertion of environment data.
Validate the configuration map updates.
Confirm that the frontend displays the environments in the expected order.