kong-configuration

This repository contains the configuration for Impala services exposed through Kong.

For information on the management of our Kong infrastructure, see the documentation in the infrastructure repository.

Changes are only possible for Services, Routes and Plugins - Any other changes must be done via the Konga UI.

How to use kong-configurator

Install dependencies

Before starting, you must ensure you have updated your dependencies:

yarn
brew install jq

Update and apply configurations

1. Change whatever you want the new configuration for the service you are updating in the gateway_services directory.

2. Start your Impala VPN (Twingate)

3. Login your AWS CLI to the appropriate AWS account you wish to deploy to. All relevant credentials and helper binaries are downloaded from AWS so we don't have to pass any credentials

   export DEPLOYMENT_ENV=staging # staging | production
   export AWS_PROFILE=StagingAdmin # StagingAdmin | ProductionGDAPI
   aws sso login --profile $AWS_PROFILE

4. Run the configurator for the environment you want to deploy to (it may require you to add your user password as in mac there is a mandatory sudo step)

   yarn update-kong-config $DEPLOYMENT_ENV $AWS_PROFILE # yarn update-kong-config production $AWS_PROFILE # if you want to deploy to prod

5. Read the plan CAREFULLY. Yes I know it might be big and it might be hard to read but read it line by line, it should make sense

6. If it does press yes and it will execute the changes.

7. If something goes wrong, it will try to revert to the old changes. That might fail as well, in that case you might wanna go to Konga and see what is going on. In end case scenario, you can manually delete all the services that are setup in the .yaml file and run the configurator again. This would recreate all the services from scratch.

8. The Configurator is still in beta so you might face some problems, no place to panic, remember that you can always delete all services manually and then restart the configurator. Also remember to test on staging Kong first before running anything on production!

9. Always read the error logs carefully. If you need some feature that is not currently available (Like plugin for installation). You can always add make a PR in the Configurator's repo, publish new version and install it here.