Skip to content
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.

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

[VAULT-26888] Create developer scenarios #27028

Merged
merged 2 commits into from
May 15, 2024
Merged

[VAULT-26888] Create developer scenarios #27028

merged 2 commits into from
May 15, 2024

Conversation

ryancragun
Copy link
Collaborator

Create developer scenarios that have simplified inputs designed for provisioning clusters and limited verification.

  • Migrate Artifactory installation module from support team focused scenarios to the vault repository.
  • Migrate support focused scenarios to the repo and update them to use the latest in-repo modules.
  • Fully document and comment scenarios to help users outline, configure, and use the scenarios.
  • Remove outdated references to the private registry that is not needed.

@ryancragun ryancragun requested a review from a team as a code owner May 14, 2024 23:36
@github-actions github-actions bot added the hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed label May 14, 2024
Copy link

github-actions bot commented May 14, 2024

CI Results:
All Go tests succeeded! ✅

Copy link

github-actions bot commented May 14, 2024

Build Results:
All builds succeeded! ✅

Comment on lines 57 to 73
After you've configured your inputs you can list and filter the available scenarios and then
subsequently launch and destroy them.
enos scenario list --help
enos scenario launch --help
enos scenario list dev_pr_replication
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
EOF
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we have doc here explaining how to get access to the system after it's been launched?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I started writing more docs but then realized what I really want to do here is make it so when you ssh in the cluster has already been configured for immediate access to vault. That means making sure the vault install dir is in the PATH, setting up the VAULT_ADDR and VAULT_TOKEN, etc.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ended up writing a resource to add things to the login shell profile and also extended the docs for how to SSH in, see outputs, and tear down the scenario.

Create developer scenarios that have simplified inputs designed for
provisioning clusters and limited verification.

* Migrate Artifactory installation module from support team focused
  scenarios to the vault repository.
* Migrate support focused scenarios to the repo and update them to use
  the latest in-repo modules.
* Fully document and comment scenarios to help users outline, configure,
  and use the scenarios.
* Remove outdated references to the private registry that is not needed.

Signed-off-by: Ryan Cragun <me@ryan.ec>
Automatically configure the login shell profile to include the path to
the vault binary and the VAULT_ADDR/VAULT_TOKEN environment variables.

We also add a bit more interaction context into the description.

Signed-off-by: Ryan Cragun <me@ryan.ec>
@ryancragun ryancragun merged commit dced3ad into main May 15, 2024
85 checks passed
@ryancragun ryancragun deleted the ryan/vault-26888 branch May 15, 2024 18:10
ryancragun added a commit that referenced this pull request May 15, 2024
* [VAULT-26888] Create developer scenarios

Create developer scenarios that have simplified inputs designed for
provisioning clusters and limited verification.

* Migrate Artifactory installation module from support team focused
  scenarios to the vault repository.
* Migrate support focused scenarios to the repo and update them to use
  the latest in-repo modules.
* Fully document and comment scenarios to help users outline, configure,
  and use the scenarios.
* Remove outdated references to the private registry that is not needed.
* Automatically configure the login shell profile to include the path to
  the vault binary and the VAULT_ADDR/VAULT_TOKEN environment variables.

Signed-off-by: Ryan Cragun <me@ryan.ec>
ryancragun added a commit that referenced this pull request May 15, 2024
* [VAULT-26888] Create developer scenarios

Create developer scenarios that have simplified inputs designed for
provisioning clusters and limited verification.

* Migrate Artifactory installation module from support team focused
  scenarios to the vault repository.
* Migrate support focused scenarios to the repo and update them to use
  the latest in-repo modules.
* Fully document and comment scenarios to help users outline, configure,
  and use the scenarios.
* Remove outdated references to the private registry that is not needed.
* Automatically configure the login shell profile to include the path to
  the vault binary and the VAULT_ADDR/VAULT_TOKEN environment variables.

Signed-off-by: Ryan Cragun <me@ryan.ec>
ryancragun added a commit that referenced this pull request May 15, 2024
* [VAULT-26888] Create developer scenarios

Create developer scenarios that have simplified inputs designed for
provisioning clusters and limited verification.

* Migrate Artifactory installation module from support team focused
  scenarios to the vault repository.
* Migrate support focused scenarios to the repo and update them to use
  the latest in-repo modules.
* Fully document and comment scenarios to help users outline, configure,
  and use the scenarios.
* Remove outdated references to the private registry that is not needed.
* Automatically configure the login shell profile to include the path to
  the vault binary and the VAULT_ADDR/VAULT_TOKEN environment variables.

Signed-off-by: Ryan Cragun <me@ryan.ec>
ryancragun added a commit that referenced this pull request May 15, 2024
* [VAULT-26888] Create developer scenarios (#27028)

Create developer scenarios that have simplified inputs designed for
provisioning clusters and limited verification.

* Migrate Artifactory installation module from support team focused
  scenarios to the vault repository.
* Migrate support focused scenarios to the repo and update them to use
  the latest in-repo modules.
* Fully document and comment scenarios to help users outline, configure,
  and use the scenarios.
* Remove outdated references to the private registry that is not needed.
* Automatically configure the login shell profile to include the path to
  the vault binary and the VAULT_ADDR/VAULT_TOKEN environment variables.
* Handle cases where `vault_cluster` is used more than once on a host.

Signed-off-by: Ryan Cragun <me@ryan.ec>
ryancragun added a commit that referenced this pull request May 15, 2024
* [VAULT-26888] Create developer scenarios (#27028)

Create developer scenarios that have simplified inputs designed for
provisioning clusters and limited verification.

* Migrate Artifactory installation module from support team focused
  scenarios to the vault repository.
* Migrate support focused scenarios to the repo and update them to use
  the latest in-repo modules.
* Fully document and comment scenarios to help users outline, configure,
  and use the scenarios.
* Remove outdated references to the private registry that is not needed.
* Automatically configure the login shell profile to include the path to
  the vault binary and the VAULT_ADDR/VAULT_TOKEN environment variables.
* Handle cases where `vault_cluster` is used more than once on a host.

Signed-off-by: Ryan Cragun <me@ryan.ec>
ryancragun added a commit that referenced this pull request May 15, 2024
* [VAULT-26888] Create developer scenarios (#27028)

Create developer scenarios that have simplified inputs designed for
provisioning clusters and limited verification.

* Migrate Artifactory installation module from support team focused
  scenarios to the vault repository.
* Migrate support focused scenarios to the repo and update them to use
  the latest in-repo modules.
* Fully document and comment scenarios to help users outline, configure,
  and use the scenarios.
* Remove outdated references to the private registry that is not needed.
* Automatically configure the login shell profile to include the path to
  the vault binary and the VAULT_ADDR/VAULT_TOKEN environment variables.
* Handle cases where `vault_cluster` is used more than once on a host.

Signed-off-by: Ryan Cragun <me@ryan.ec>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed pr/no-changelog pr/no-milestone
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants