Add 'how to run' instructions for each Enos scenario #27959

rebwill · 2024-08-02T19:40:54Z

Description

Adds 'how to run' instructions for each Enos scenario. https://hashicorp.atlassian.net/browse/VAULT-29011?atlOrigin=eyJpIjoiZjYyN2JiN2YwMDcyNDM0NTg0Zjk2MzkzNzZkMGEyNTciLCJwIjoiaiJ9

TODO only if you're a HashiCorp employee

Labels: If this PR is the CE portion of an ENT change, and that ENT change is
getting backported to N-2, use the new style backport/ent/x.x.x+ent labels
instead of the old style backport/x.x.x labels.
Labels: If this PR is a CE only change, it can only be backported to N, so use
the normal backport/x.x.x label (there should be only 1).
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.

jasonodonnell · 2024-08-05T16:19:36Z

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

-    Please note that this scenario requires several inputs variables to be set in order to function
+    RUNNING THIS SCENARIO
+
+    1. Set input variables


Does this need to be 4.?

Probably, still working on polishing the dev scenarios.

jasonodonnell · 2024-08-05T16:20:06Z

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

+    with vault. If using Ubuntu, your SSH user will be `ubuntu`; if using any of the other
+    supported distros, it will be `ec2-user`.


Thanks for this. Always trips me up.

jasonodonnell · 2024-08-05T16:21:50Z

enos/enos-scenario-agent.hcl

+    $ enos scenario launch agent arch:amd64 artifact_source:crt artifact_type:bundle backend:consul config_mode:env consul_edition:ent consul_version:1.16.3 distro:ubuntu edition:ent.hsm.fips1402 seal:pkcs11
+


IMO this should be a code block and maybe use line breaks to make it more readable:

enos scenario launch agent \ arch:amd64 \ artifact_source:crt \ artifact_type:bundle \ backend:consul \ config_mode:env \ consul_edition:ent \ consul_version:1.16.3 \ distro:ubuntu \ edition:ent.hsm.fips1402 \ seal:pkcs11

jasonodonnell · 2024-08-05T16:22:23Z

enos/enos-scenario-agent.hcl

+        arm64 AMI: https://aws.amazon.com/marketplace/server/procurement?productId=a516e959-df54-4035-bb1a-63599b7a6df9
+        amd64 AMI: https://aws.amazon.com/marketplace/server/procurement?productId=5535c495-72d4-4355-b169-54ffa874f849


Nit: turn these into links.

This doesn't get put in markdown at any point, it's just a blurb of HCL.

jasonodonnell · 2024-08-05T16:22:59Z

enos/enos-scenario-proxy.hcl

+  5. Choose the matrix variants you want to use, and launch the scenario with the appropriate
+  filter for those variants, e.g.:
+
+  $ enos scenario launch proxy arch:arm64 artifact_source:artifactory artifact_type:bundle backend:raft config_mode:file consul_edition:ce consul_version:1.17.0 distro:leap edition:ent seal:shamir


Same recommendation as above: code block and newlines will make this more readable

I can see your point but I think we will leave this as one-liner for the purpose of the docs -- formatting changes may vary by personal preference and also be shell dependent.

jasonodonnell · 2024-08-05T16:23:23Z

enos/enos-scenario-replication.hcl

+    5. Choose the matrix variants you want to use, and launch the scenario with the appropriate
+    filter for those variants, e.g.:
+
+    $ enos scenario launch replication arch:amd64 artifact_source:artifactory artifact_type:bundle config_mode:env consul_edition:ce consul_version:1.16.3 distro:sles edition:ent primary_backend:raft primary_seal:shamir secondary_backend:raft secondary_seal:shamir


Same recommendation as above: code block and newlines will make this more readable

jasonodonnell · 2024-08-05T16:23:32Z

enos/enos-scenario-seal-ha.hcl

+    5. Choose the matrix variants you want to use, and launch the scenario with the appropriate
+    filter for those variants, e.g.:
+
+    $ enos scenario launch seal_ha arch:amd64 artifact_source:artifactory artifact_type:package distro:rhel edition:ent.hsm.fips1402 backend:raft config_mode:file consul_edition:ce consul_version:1.17.0 primary_seal:pkcs11 secondary_seal:pkcs11


Same recommendation as above: code block and newlines will make this more readable

jasonodonnell

Some nits but looks great. I stopped flagging the same nit over but it should be applied across the documentation.

ryancragun

I'm not sure exactly what I think. That's totally okay and perhaps we should have a conversation. It feels to me like this is very useful information but might be too verbose and sort of scary if you're just getting started.

I'm leaning towards the scenario description being information that is unique to each scenario, which would include required variables and then having like 80% of what you've done in the README. What do you think?

ryancragun · 2024-08-09T22:45:22Z

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

+
+    4. Choose what type of Vault artifact you want to use, and set the appropriate variables.
+
+      a. 'artifact:local'


The actual path of the zip bundle we create for local is probably not all that useful for configuration. Can we remove it?

ryancragun · 2024-08-09T22:45:46Z

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

+      This will download a Vault .zip bundle from releases.hashicorp.com with the version and
+      edition you specify.
+
+      TODO: add required variable


There should be none other than version.

It's also important to note that versions between dev and CI scenarios are a bit different right now. In dev scenarios you just use the 'major.minor.patch` form whereas in CI scenarios it's 'major.minor.patch.edition-prerelease'

ryancragun · 2024-08-09T22:47:56Z

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

+
+      $ enos scenario list dev_single_cluster
+
+    Once you know what filter you want to use to obtain your desired combination of matrix variants,


Would be useful to mention that you can reduce the list by providing partial filters?

ryancragun · 2024-08-09T22:48:59Z

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

+
+      $ enos scenario destroy dev_pr_replication <filter>
+
+


nit: seems like a bit of extra whilte space here.

ryancragun · 2024-08-09T22:50:59Z

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


    The scenario supports finding and installing any released 'linux/amd64' or 'linux/arm64' Vault
    artifact as long as its version is >= 1.8. You can also use the 'artifact:local' variant to
    build and deploy the current branch!

-    In order to execute this scenario you'll need to install the enos CLI:
+    You can use the following command to get a textual outline of the entire


This is a lot of information. I'm trying figure out whether it all really should be in the scenario outline now or just information that is specific to each scenario. It almost feels like half of this information would be more apt to a README than in every scenario description.

And I realize that is the opposite of what I've previously said. But seeing it here has me questioning that.

rebwill added 2 commits July 25, 2024 14:15

first changes

d53bc19

Add 'how to run' instructions for each scenario'

3cc3128

rebwill added pr/no-changelog pr/no-milestone backport/ent/1.15.x+ent backport/ent/1.16.x+ent Changes are backported to 1.16.x+ent labels Aug 2, 2024

rebwill requested a review from a team as a code owner August 2, 2024 19:40

rebwill changed the title ~~Adds 'how to run' instructions for each Enos scenario~~ Add 'how to run' instructions for each Enos scenario Aug 2, 2024

jasonodonnell reviewed Aug 5, 2024

View reviewed changes

jasonodonnell approved these changes Aug 5, 2024

View reviewed changes

Further updates

ecfece4

heatherezell added the hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed label Aug 5, 2024

Polishing

2d137be

ryancragun reviewed Aug 9, 2024

View reviewed changes

Review feedback

27dbd47

tomcf-hcp removed the backport/1.17.x label Oct 11, 2024

ldilalla-HC removed the backport/ent/1.15.x+ent label Nov 1, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add 'how to run' instructions for each Enos scenario #27959

Add 'how to run' instructions for each Enos scenario #27959

rebwill commented Aug 2, 2024

jasonodonnell Aug 5, 2024

rebwill Aug 5, 2024 •

edited

Loading

jasonodonnell Aug 5, 2024

jasonodonnell Aug 5, 2024

jasonodonnell Aug 5, 2024

rebwill Aug 5, 2024

jasonodonnell Aug 5, 2024

rebwill Aug 5, 2024

jasonodonnell Aug 5, 2024

jasonodonnell Aug 5, 2024

jasonodonnell left a comment

ryancragun left a comment

ryancragun Aug 9, 2024

ryancragun Aug 9, 2024

ryancragun Aug 9, 2024

ryancragun Aug 9, 2024

ryancragun Aug 9, 2024

ryancragun Aug 9, 2024

ryancragun Aug 9, 2024

		with vault. If using Ubuntu, your SSH user will be `ubuntu`; if using any of the other
		supported distros, it will be `ec2-user`.

		$ enos scenario launch agent arch:amd64 artifact_source:crt artifact_type:bundle backend:consul config_mode:env consul_edition:ent consul_version:1.16.3 distro:ubuntu edition:ent.hsm.fips1402 seal:pkcs11

		arm64 AMI: https://aws.amazon.com/marketplace/server/procurement?productId=a516e959-df54-4035-bb1a-63599b7a6df9
		amd64 AMI: https://aws.amazon.com/marketplace/server/procurement?productId=5535c495-72d4-4355-b169-54ffa874f849


		4. Choose what type of Vault artifact you want to use, and set the appropriate variables.

		a. 'artifact:local'


		$ enos scenario list dev_single_cluster

		Once you know what filter you want to use to obtain your desired combination of matrix variants,

Add 'how to run' instructions for each Enos scenario #27959

Are you sure you want to change the base?

Add 'how to run' instructions for each Enos scenario #27959

Conversation

rebwill commented Aug 2, 2024

Description

TODO only if you're a HashiCorp employee

Choose a reason for hiding this comment

rebwill Aug 5, 2024 • 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

jasonodonnell left a comment

Choose a reason for hiding this comment

ryancragun left a 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

rebwill Aug 5, 2024 •

edited

Loading