Skip to content

Commit 58e08c2

Browse files
Merge branch 'main' into documentation-script
2 parents a52d6cc + 1da751c commit 58e08c2

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

docs/guides/setting-up-a-new-consumer.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ per environment.
2626
```bash
2727
make generate-client-certificate
2828
```
29-
3029
This will output three files in the ./scripts/client_certificates directory:
3130

3231
- a private key e.g. `dev-nhs-client.key`
@@ -121,3 +120,14 @@ kubectl -n hmpps-integration-api-[environment] get secrets [your queue secret na
121120
5. Create new [Cloud Platform Environments GitHub repository](https://github.com/ministryofjustice/cloud-platform-environments/tree/main) branch
122121
6. Update terraform to load the secret value from AWS and update filter_policy value. Follow [Example](https://github.com/ministryofjustice/cloud-platform-environments/pull/22111/files). Note: The name of aws_secretsmanager_secret module has to be same as the secret name created from step 4/5 above.
123122
7. Follow steps 3-8 in [Create an API key](#create-an-api-key) to merge branch to main.
123+
124+
## Create a new endpoint for a client
125+
126+
### Create basic infrastructure
127+
Within the [Cloud Platform Environments GitHub repository](https://github.com/ministryofjustice/cloud-platform-environments/tree/main) and the namespace of the environment:
128+
129+
1. Create a branch.
130+
2. Add a new API Gateway resource, a SQS method, a SQS method response, and an integration. Example: [api_gateway.tf](https://github.com/ministryofjustice/cloud-platform-environments/pull/22695/files)
131+
3. Ensure that all the permissions are up-to-date and add a new role and policy for your new resource. Example: [iam.tf](https://github.com/ministryofjustice/cloud-platform-environments/pull/22787/files#diff-a376622fa4a4c2fd9404d5ee4221487259264608a0cbe36b99c150c472558f29)
132+
4. Check that the integration is pointing to the right queue. Example: [api_gateway.tf](https://github.com/ministryofjustice/cloud-platform-environments/pull/22795/files)
133+
5. Deploy and test (do not use Postman, rather use a GET cURL command with "x-api-key" as your header.)

0 commit comments

Comments
 (0)