Skip to content

Commit 04bd44b

Browse files
authored
[Enos] Update descriptions for dev scenarios (#29828)
* Update descriptions of dev scenarios * Update docs URLs
1 parent 1574571 commit 04bd44b

File tree

2 files changed

+7
-124
lines changed

2 files changed

+7
-124
lines changed

enos/enos-dev-scenario-pr-replication.hcl

+3-60
Original file line numberDiff line numberDiff line change
@@ -3,71 +3,14 @@
33

44
scenario "dev_pr_replication" {
55
description = <<-EOF
6-
This scenario spins up a two Vault clusters with either an external Consul cluster or
6+
This scenario spins up two Vault clusters with either an external Consul cluster or
77
integrated Raft for storage. The secondary cluster is configured with performance replication
88
from the primary cluster. None of our test verification is included in this scenario in order
99
to improve end-to-end speed. If you wish to perform such verification you'll need to use a
1010
non-dev scenario.
1111
12-
The scenario supports finding and installing any released 'linux/amd64' or 'linux/arm64' Vault
13-
artifact as long as its version is >= 1.8. You can also use the 'artifact:local' variant to
14-
build and deploy the current branch!
15-
16-
In order to execute this scenario you'll need to install the enos CLI:
17-
- $ brew tap hashicorp/tap && brew update && brew install hashicorp/tap/enos
18-
19-
You'll also need access to an AWS account via Doormat, follow the guide here:
20-
https://eng-handbook.hashicorp.services/internal-tools/enos/getting-started/#authenticate-to-aws-with-doormat
21-
22-
Follow this guide to get an SSH keypair set up in the AWS account:
23-
https://eng-handbook.hashicorp.services/internal-tools/enos/getting-started/#set-your-aws-key-pair-name-and-private-key
24-
25-
Please note that this scenario requires several inputs variables to be set in order to function
26-
properly. While not all variants will require all variables, it's suggested that you look over
27-
the scenario outline to determine which variables affect which steps and which have inputs that
28-
you should set. You can use the following command to get a textual outline of the entire
29-
scenario:
30-
enos scenario outline dev_pr_replication
31-
32-
You can also create an HTML version that is suitable for viewing in web browsers:
33-
enos scenario outline dev_pr_replication --format html > index.html
34-
open index.html
35-
36-
To configure the required variables you have a couple of choices. You can create an
37-
'enos-local.vars' file in the same 'enos' directory where this scenario is defined. In it you
38-
declare your desired variable values. For example, you could copy the following content and
39-
then set the values as necessary:
40-
41-
artifactory_username = "[email protected]"
42-
artifactory_token = "<ARTIFACTORY TOKEN VALUE>
43-
aws_region = "us-west-2"
44-
aws_ssh_keypair_name = "<YOUR REGION SPECIFIC KEYPAIR NAME>"
45-
aws_ssh_keypair_key_path = "/path/to/your/private/key.pem"
46-
dev_build_local_ui = false
47-
dev_consul_version = "1.18.1"
48-
vault_license_path = "./support/vault.hclic"
49-
vault_product_version = "1.16.2"
50-
51-
Alternatively, you can set them in your environment:
52-
export ENOS_VAR_aws_region="us-west-2"
53-
export ENOS_VAR_vault_license_path="./support/vault.hclic"
54-
55-
After you've configured your inputs you can list and filter the available scenarios and then
56-
subsequently launch and destroy them.
57-
enos scenario list --help
58-
enos scenario launch --help
59-
enos scenario list dev_pr_replication
60-
enos scenario launch dev_pr_replication arch:amd64 artifact:deb distro:ubuntu edition:ent.hsm primary_backend:raft primary_seal:awskms secondary_backend:raft secondary_seal:pkcs11
61-
62-
When the scenario is finished launching you refer to the scenario outputs to see information
63-
related to your cluster. You can use this information to SSH into nodes and/or to interact
64-
with vault.
65-
enos scenario output dev_pr_replication arch:amd64 artifact:deb distro:ubuntu edition:ent.hsm primary_backend:raft primary_seal:awskms secondary_backend:raft secondary_seal:pkcs11
66-
ssh -i /path/to/your/private/key.pem <PUBLIC_IP>
67-
vault status
68-
69-
After you've finished you can tear down the cluster
70-
enos scenario destroy dev_pr_replication arch:amd64 artifact:deb distro:ubuntu edition:ent.hsm primary_backend:raft primary_seal:awskms secondary_backend:raft secondary_seal:pkcs11
12+
For a full tutorial for this scenario, see here:
13+
https://eng-handbook.hashicorp.services/internal-tools/enos/tutorial-vault-dev-scenario-pr-replication/
7114
EOF
7215

7316
// The matrix is where we define all the baseline combinations that enos can utilize to customize

enos/enos-dev-scenario-single-cluster.hcl

+4-64
Original file line numberDiff line numberDiff line change
@@ -8,73 +8,13 @@ scenario "dev_single_cluster" {
88
to improve end-to-end speed. If you wish to perform such verification you'll need to use a
99
non-dev scenario instead.
1010
11-
The scenario supports finding and installing any released 'linux/amd64' or 'linux/arm64' Vault
12-
artifact as long as its version is >= 1.8. You can also use the 'artifact:local' variant to
13-
build and deploy the current branch!
14-
15-
In order to execute this scenario you'll need to install the enos CLI:
16-
brew tap hashicorp/tap && brew update && brew install hashicorp/tap/enos
17-
18-
You'll also need access to an AWS account via Doormat, follow the guide here:
19-
https://eng-handbook.hashicorp.services/internal-tools/enos/getting-started/#authenticate-to-aws-with-doormat
20-
21-
Follow this guide to get an SSH keypair set up in the AWS account:
22-
https://eng-handbook.hashicorp.services/internal-tools/enos/getting-started/#set-your-aws-key-pair-name-and-private-key
23-
24-
Please note that this scenario requires several inputs variables to be set in order to function
25-
properly. While not all variants will require all variables, it's suggested that you look over
26-
the scenario outline to determine which variables affect which steps and which have inputs that
27-
you should set. You can use the following command to get a textual outline of the entire
28-
scenario:
29-
enos scenario outline dev_single_cluster
30-
31-
You can also create an HTML version that is suitable for viewing in web browsers:
32-
enos scenario outline dev_single_cluster --format html > index.html
33-
open index.html
34-
35-
To configure the required variables you have a couple of choices. You can create an
36-
'enos-local.vars' file in the same 'enos' directory where this scenario is defined. In it you
37-
declare your desired variable values. For example, you could copy the following content and
38-
then set the values as necessary:
39-
40-
artifactory_username = "[email protected]"
41-
artifactory_token = "<ARTIFACTORY TOKEN VALUE>
42-
aws_region = "us-west-2"
43-
aws_ssh_keypair_name = "<YOUR REGION SPECIFIC KEYPAIR NAME>"
44-
aws_ssh_keypair_key_path = "/path/to/your/private/key.pem"
45-
dev_build_local_ui = false
46-
dev_consul_version = "1.18.1"
47-
vault_license_path = "./support/vault.hclic"
48-
vault_product_version = "1.16.2"
49-
Alternatively, you can set them in your environment:
50-
export ENOS_VAR_aws_region="us-west-2"
51-
export ENOS_VAR_vault_license_path="./support/vault.hclic"
52-
53-
Alternatively, you can set them in your environment:
54-
export ENOS_VAR_aws_region="us-west-2"
55-
export ENOS_VAR_vault_license_path="./support/vault.hclic"
56-
57-
After you've configured your inputs you can list and filter the available scenarios and then
58-
subsequently launch and destroy them.
59-
enos scenario list --help
60-
enos scenario launch --help
61-
enos scenario list dev_single_cluster
62-
enos scenario launch dev_single_cluster arch:arm64 artifact:local backend:raft distro:ubuntu edition:ce seal:awskms
63-
64-
When the scenario is finished launching you refer to the scenario outputs to see information
65-
related to your cluster. You can use this information to SSH into nodes and/or to interact
66-
with vault.
67-
enos scenario output dev_single_cluster arch:arm64 artifact:local backend:raft distro:ubuntu edition:ce seal:awskms
68-
ssh -i /path/to/your/private/key.pem <PUBLIC_IP>
69-
vault status
70-
71-
After you've finished you can tear down the cluster
72-
enos scenario destroy dev_single_cluster arch:arm64 artifact:local backend:raft distro:ubuntu edition:ce seal:awskms
11+
For a full tutorial for this scenario, see here:
12+
https://eng-handbook.hashicorp.services/internal-tools/enos/tutorial-vault-dev-scenario-single-cluster/
7313
EOF
7414

7515
// The matrix is where we define all the baseline combinations that enos can utilize to customize
76-
// your scenario. By default enos attempts to perform your command on the entire product of these
77-
// possible comginations! Most of the time you'll want to reduce that by passing in a filter.
16+
// your scenario. By default, Enos attempts to perform your command on the entire product of these
17+
// possible combinations! Most of the time you'll want to reduce that by passing in a filter.
7818
// Run 'enos scenario list --help' to see more about how filtering scenarios works in enos.
7919
matrix {
8020
arch = ["amd64", "arm64"]

0 commit comments

Comments
 (0)