Skip to content

Commit 9331fdf

Browse files
authored
Update README.md
1 parent e0bea23 commit 9331fdf

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,34 +20,40 @@ A list of the tooling that comes with the Kali distro and the extras that we hav
2020
### Pre-requisite:
2121
Within the AWS account you wish to deploy to.
2222

23+
- Ensure you have installed and configured aws-vault. More info: https://github.com/99designs/aws-vault
24+
2325
- Go to AWS Marketplace search for Kali and open a subscription.
2426

25-
- Assume the role of the aws account you wish to deploy to at your cli.
27+
- Ensure you are using terraform `0.12.3`
2628

27-
*Note that this has already been done for the `security-vuln-testing` aws account*
29+
- Assume the role of the aws account you wish to deploy to at your cli. If this is your first time, you will need to create an access key on the `gds-users` account to be able to assume role programatically. See aws doc: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html#Using_CreateAccessKey
2830

29-
### Deploy with the below commands
31+
*Note that this has already been done for the `security-vuln-testing` aws account. If you are using another aws account, ensure you change line 6 on https://github.com/alphagov/penetration-testing-instance/blob/readme-update/terraform/main.tf to replace the s3 bucket name. Create the bucket manually before running the terraform template.*
3032

31-
- Ensure you are using terraform `0.12.3`
33+
### Deploy with the below commands
3234

33-
- `git clone git@github.com:alphagov/penetration-testing-instance.git`
35+
- Clone this GitHub repository:
36+
`git clone git@github.com:alphagov/penetration-testing-instance.git`
3437

3538
- `cd penetration-testing-instance/terraform`
3639

37-
- edit main.tf and place in your public ssh-key at ssh-pub-key-{number}.
40+
- edit main.tf and place in your public ssh-key at ssh-pub-key-{number}. Note for MAC users: run `ssh-add -L` to get your public key.
3841

3942
- `terraform init; terraform plan`
4043

4144
*AWS Vault: `aws-vault exec <profile> -- terraform init; terraform plan`*
4245

4346
- If the plan looks good then run:
44-
`terraform apply`
47+
`aws-vault exec <profile> -- terraform apply`
4548

4649
- The public IP will be output by TF
4750

4851
- Once the instance is up, to access use:
4952
`ssh pentester@<public-ip-address>`
5053

54+
- Once you have finihed with the Kali instance, destroy it:
55+
`aws-vault exec <profile> -- terraform destroy`
56+
5157
## Cheatsheet to get started on some of the tooling
5258
CHEATSHEET FOR TOOLING
5359

0 commit comments

Comments
 (0)