Skip to content

NRL-1669 Add instructions to set-up AWS CLI access and client certs #1061

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
axelkrastek1-nhs merged 4 commits into from
Oct 13, 2025
Merged

NRL-1669 Add instructions to set-up AWS CLI access and client certs #1061

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b8a2058
NRL-1669 Add instructions to set-up AWS CLI access and client certs
axelkrastek1-nhs Oct 9, 2025
30fdd48
NRL-1669 Add option to pull all the certificates
axelkrastek1-nhs Oct 9, 2025
4bb0514
NRL-1669 Fix readme environment tip.
axelkrastek1-nhs Oct 9, 2025
adc1a22
NRL-1669 Fix misstype in makefile
axelkrastek1-nhs Oct 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,9 @@ truststore-build-ca: check-warn ## Build a CA (Certificate Authority)
truststore-build-cert: check-warn ## Build a certificate
@./scripts/truststore.sh build-cert "$(CA_NAME)" "$(CERT_NAME)" "$(CERT_SUBJECT)"

truststore-pull-all: check-warn ## Pull all certificates
@./scripts/truststore.sh pull-all "$(ENV)"

truststore-pull-server: check-warn ## Pull a server certificate
@./scripts/truststore.sh pull-server "$(ENV)"

Expand Down
30 changes: 30 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,36 @@ Then install all the dependency packages with:
make configure
```

### Set up AWS CLI access

There are several ways to set up your AWS CLI access. The recommended way is to use [granted](https://docs.commonfate.io/granted/getting-started). Follow the instructions on their website to install and configure `granted`.

One of the gotchas with using `granted` is that you need to ensure that you source the environment variables into your shell session. You can do this by running:

```
source assume <profile>
```

Where `<profile>` is one of the profiles which should be in your `~/.aws/config`. You can customize the profile names to your liking.

From here on, you can use the AWS CLI as normal and run commands that need AWS access on that terminal session.

As a short guideline about profiles to assume for a typical workflow:

- Assume mgmt account for stack specific terraform deployment as indicated in `terraform/infrastructure/README.md`.
- Assume the specific environment for running feature tests against that environment.

### Set up NRLF certificates

In order to execute make commands that need AWS access, you will need to pull the NRLF certificates.
In order to do this, make sure you have AWS CLI installed and configured, then run:

```
make ENV=env truststore-pull-all
```

Where `env` is one of `dev`, `qa` , `int`, `ref` or `prod`.

## Getting Started

To build packages:
Expand Down