Add 'how to run' instructions to each Enos scenario' #29299

rebwill · 2025-01-06T21:20:11Z

Description

Adds "how to run this scenario" overview to the description in each Enos scenario. Resolves VAULT-29011.

Note: Instructions for how to run the enos-dev-* scenarios will be addressed in a separate PR.

TODO only if you're a HashiCorp employee

Backport Labels: If this fix needs to be backported, use the appropriate backport/ label that matches the desired release branch. Note that in the CE repo, the latest release branch will look like backport/x.x.x, but older release branches will be backport/ent/x.x.x+ent.
- LTS: If this fixes a critical security vulnerability or severity 1 bug, it will also need to be backported to the current LTS versions of Vault. To ensure this, use all available enterprise labels.
ENT Breakage: If this PR either 1) removes a public function OR 2) changes the signature
of a public function, even if that change is in a CE file, double check that
applying the patch for this PR to the ENT repo and running tests doesn't
break any tests. Sometimes ENT only tests rely on public functions in CE
files.
Jira: If this change has an associated Jira, it's referenced either
in the PR description, commit message, or branch name.
RFC: If this change has an associated RFC, please link it in the description.
ENT PR: If this change has an associated ENT PR, please link it in the
description. Also, make sure the changelog is in this PR, not in your ENT PR.

github-actions · 2025-01-06T21:35:35Z

CI Results:
All Go tests succeeded! ✅

github-actions · 2025-01-06T21:40:32Z

Build Results:
All builds succeeded! ✅

anwittin · 2025-01-07T20:52:19Z

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

          The artifactory token associated with your username. You'll need this if you wish to use
          deb or rpm artifacts! You can create a token by logging into Artifactory via Okta.
+        dev_build_local_ui


Does dev_build_local_ui need a : ?

anwittin · 2025-01-07T23:10:23Z

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

@@ -163,6 +168,9 @@ scenario "dev_single_cluster" {
        artifactory_token


Missing : after artifactory_token, mostly a nit for consistency between pages.

anwittin · 2025-01-07T23:10:48Z

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

@@ -163,6 +168,9 @@ scenario "dev_single_cluster" {
        artifactory_token
          The artifactory token associated with your username. You'll need this if you wish to use
          deb or rpm artifacts! You can create a token by logging into Artifactory via Okta.
+        dev_build_local_ui


Missing : after dev_build_local_ui, mostly a nit for consistency between pages.

anwittin · 2025-01-07T23:12:29Z

enos/enos-scenario-agent.hcl

+    # How to run this scenario
+
+    For general instructions on running a scenario, refer to the Enos docs: https://eng-handbook.hashicorp.services/internal-tools/enos/running-a-scenario/
+    For troubleshooting tips and common errors, see https://eng-handbook.hashicorp.services/internal-tools/enos/troubleshooting. 


The link is missing trailing / and didn't work in my browser without it.

anwittin · 2025-01-07T23:14:34Z

enos/enos-scenario-autopilot.hcl

+    # How to run this scenario
+
+    For general instructions on running a scenario, refer to the Enos docs: https://eng-handbook.hashicorp.services/internal-tools/enos/running-a-scenario/
+    For troubleshooting tips and common errors, see https://eng-handbook.hashicorp.services/internal-tools/enos/troubleshooting. 


The link is missing the trailing / and didn't work in my browser without it.

anwittin · 2025-01-07T23:15:57Z

enos/enos-scenario-dr-replication.hcl

+    # How to run this scenario
+
+    For general instructions on running a scenario, refer to the Enos docs: https://eng-handbook.hashicorp.services/internal-tools/enos/running-a-scenario/
+    For troubleshooting tips and common errors, see https://eng-handbook.hashicorp.services/internal-tools/enos/troubleshooting. 


Same. Link missing trailing /

anwittin · 2025-01-07T23:16:46Z

enos/enos-scenario-pr-replication.hcl

+    # How to run this scenario
+
+    For general instructions on running a scenario, refer to the Enos docs: https://eng-handbook.hashicorp.services/internal-tools/enos/running-a-scenario/
+    For troubleshooting tips and common errors, see https://eng-handbook.hashicorp.services/internal-tools/enos/troubleshooting. 


Same. Link missing the trailing /

anwittin · 2025-01-07T23:17:26Z

enos/enos-scenario-proxy.hcl

+  # How to run this scenario
+
+  For general instructions on running a scenario, refer to the Enos docs: https://eng-handbook.hashicorp.services/internal-tools/enos/running-a-scenario/
+  For troubleshooting tips and common errors, see https://eng-handbook.hashicorp.services/internal-tools/enos/troubleshooting. 


anwittin · 2025-01-07T23:17:45Z

enos/enos-scenario-seal-ha.hcl

+    # How to run this scenario
+
+    For general instructions on running a scenario, refer to the Enos docs: https://eng-handbook.hashicorp.services/internal-tools/enos/running-a-scenario/
+    For troubleshooting tips and common errors, see https://eng-handbook.hashicorp.services/internal-tools/enos/troubleshooting. 


anwittin · 2025-01-07T23:18:30Z

enos/enos-scenario-smoke.hcl

+    # How to run this scenario
+
+    For general instructions on running a scenario, refer to the Enos docs: https://eng-handbook.hashicorp.services/internal-tools/enos/running-a-scenario/
+    For troubleshooting tips and common errors, see https://eng-handbook.hashicorp.services/internal-tools/enos/troubleshooting. 


anwittin · 2025-01-07T23:19:01Z

enos/enos-scenario-ui.hcl


-    The scenario deploys a Vault cluster with the candidate build and executes the ember test suite.
+    For general instructions on running a scenario, refer to the Enos docs: https://eng-handbook.hashicorp.services/internal-tools/enos/running-a-scenario/
+    For troubleshooting tips and common errors, see https://eng-handbook.hashicorp.services/internal-tools/enos/troubleshooting. 


Trailing / missing

anwittin · 2025-01-07T23:19:35Z

enos/enos-scenario-upgrade.hcl

+    # How to run this scenario
+
+    For general instructions on running a scenario, refer to the Enos docs: https://eng-handbook.hashicorp.services/internal-tools/enos/running-a-scenario/
+    For troubleshooting tips and common errors, see https://eng-handbook.hashicorp.services/internal-tools/enos/troubleshooting. 


Trailing / missing

anwittin

a couple of link issues and some minor nits.

tvo0813

looks good to me other than what tony commented on

anwittin

Thanks for fixing all those! Looks good

rebwill added pr/no-changelog pr/no-milestone hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed labels Jan 6, 2025

rebwill requested a review from a team as a code owner January 6, 2025 21:20

rebwill force-pushed the rebwill/add-run-instructions-to-enos-scenarios branch 5 times, most recently from e706108 to eb56fe0 Compare January 7, 2025 19:42

anwittin reviewed Jan 7, 2025

View reviewed changes

anwittin requested changes Jan 7, 2025

View reviewed changes

tvo0813 previously approved these changes Jan 8, 2025

View reviewed changes

rebwill added 2 commits January 8, 2025 13:57

Add 'how to run' instructions for each scenario'

2854838

Small fixes

44dce13

rebwill dismissed tvo0813’s stale review via 44dce13 January 8, 2025 20:58

rebwill force-pushed the rebwill/add-run-instructions-to-enos-scenarios branch from eb56fe0 to 44dce13 Compare January 8, 2025 20:58

anwittin approved these changes Jan 10, 2025

View reviewed changes

rebwill added backport/ent/1.16.x+ent Changes are backported to 1.16.x+ent backport/1.18.x backport/ent/1.17.x+ent Changes are backported to 1.17.x+ent labels Jan 10, 2025

Merge branch 'main' into rebwill/add-run-instructions-to-enos-scenarios

b33ed62

rebwill enabled auto-merge (squash) January 10, 2025 21:06

vercel bot deployed to Preview January 10, 2025 21:07 View deployment

rebwill merged commit 8cee664 into main Jan 10, 2025
94 checks passed

rebwill deleted the rebwill/add-run-instructions-to-enos-scenarios branch January 10, 2025 21:17

hc-github-team-secure-vault-core mentioned this pull request Jan 10, 2025

Backport of Add 'how to run' instructions to each Enos scenario' into release/1.18.x #29348

Open

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add 'how to run' instructions to each Enos scenario' #29299

Add 'how to run' instructions to each Enos scenario' #29299

rebwill commented Jan 6, 2025 •

edited

Loading

github-actions bot commented Jan 6, 2025 •

edited

Loading

github-actions bot commented Jan 6, 2025 •

edited

Loading

anwittin Jan 7, 2025

anwittin Jan 7, 2025

anwittin Jan 7, 2025

anwittin Jan 7, 2025

anwittin Jan 7, 2025

anwittin Jan 7, 2025

anwittin Jan 7, 2025

anwittin Jan 7, 2025

anwittin Jan 7, 2025

anwittin Jan 7, 2025

anwittin Jan 7, 2025

anwittin Jan 7, 2025

anwittin left a comment

tvo0813 left a comment

anwittin left a comment

		@@ -163,6 +168,9 @@ scenario "dev_single_cluster" {
		artifactory_token

Add 'how to run' instructions to each Enos scenario' #29299

Add 'how to run' instructions to each Enos scenario' #29299

Conversation

rebwill commented Jan 6, 2025 • edited Loading

Description

TODO only if you're a HashiCorp employee

github-actions bot commented Jan 6, 2025 • edited Loading

github-actions bot commented Jan 6, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

anwittin left a comment

Choose a reason for hiding this comment

tvo0813 left a comment

Choose a reason for hiding this comment

anwittin left a comment

Choose a reason for hiding this comment

rebwill commented Jan 6, 2025 •

edited

Loading

github-actions bot commented Jan 6, 2025 •

edited

Loading

github-actions bot commented Jan 6, 2025 •

edited

Loading