Required API Keys

Required API keys:

The service allows integration with Github and it creates a REST documentation page in SwaggerHub. Therefore we need to store in AWS 4 API keys.

1. An API-key to read from Github.
2. An API-key that will allow Github to send requests to AWS (Github webhook).
3. An API-key for the REST-API of the service that allows arbitrary creations and deletions of AWS stacks.
4. An API-key to read from and write to SwaggerHub.

All API-keys are stores as Secrets in SecretsManager. All Secrets are of the type Other type of secrets and are stored as key-value pairs

Github keys

We need to store two keys for Github. One for reading from Github, and one for enabling Github to send requests to our service.

Reading from Github

1. In your Github account page, navigate to Account Settings -> Developer Settings -> Personal access tokens and create an API-key
2. Create a new Secret with name infrastructure
3. Store a new key-value pair with key read_from_github and value the the generated github key.

API-key for Github webhook

1. Go to the previously generated Secret infrastructure
2. Add a new key-value pair with key github_webhook_authorization and as a value an arbitrary String.

SwaggerHub Key

1. Create an API-key for your SwaggerHub account
2. Navigate to the secret with name infrastructure
3. Store a new key-value pair with key swaggerapikey and value the SwaggerHub generated key

REST-service key

1. Navigate to the secret with name infrastructure
2. Store a new key-value pair with key buildbranch and value an arbitrary string.