VAULT-31181: Add pipeline tool to Vault
#28536
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ryancragun
added
pr/no-changelog
pr/no-milestone
backport/ent/1.15.x+ent
github-actions
bot
added
the
hashicorp-contributed-pr
|
CI Results: |
|
Build Results: |
As the Vault pipeline and release processes evolves over time, so too must the tooling that drives it. Historically we've utilized a combination of CI features and shell scripts that are wrapped into make targets to drive our CI. While this approach has worked, it requires careful consideration of what features to use (bash in CI almost never matches bash in developer machines, etc.) and often requires a deep understanding of several CLI tools (jq, etc). `make` itself also has limitations in user experience, e.g. passing flags. As we're all in on Github Actions as our pipeline coordinator, continuing to utilize and build CLI tools to perform our pipeline tasks makes sense. This PR adds a new CLI tool called `pipeline` which we can use to build new isolated tasks that we can string together in Github Actions. We intend to use this utility as the interface for future release automation work, see VAULT-27514. For the first task in this new pipeline tool, I've chosen to build a small command that allows us to list Vault versions between a range. The goal is to utilize this tool on all active branches to automatically populate a list of all N-3 versions relative to that Vault edition and branch. We'll feed that list of released versions into our Enos sampling algorithm and make all of those versions candidates in our upgrade testing scenarios, allowing us to test upgrades from all supported versions over the lifecycle of a given Vault version. As it's automated and dyanmic we will no longer have to maintain a list of initial versions on each branch. We also create a new tools Go module so that our pipeline tooling dependencies will not be required to build Vault. Signed-off-by: Ryan Cragun <me@ryan.ec>
Signed-off-by: Ryan Cragun <me@ryan.ec>
ryancragun
force-pushed
the
vault-31181
branch
from
00b6f09
to
fad24d2
Compare
rebwill
approved these changes
Sep 30, 2024
Signed-off-by: Ryan Cragun <me@ryan.ec>
Signed-off-by: Ryan Cragun <me@ryan.ec>
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
As the Vault pipeline and release processes evolve over time, so too must the tooling that drives them. Historically we've utilized a combination of CI features and shell scripts that are wrapped into make targets to drive our CI. While this
approach has worked, it requires careful consideration of what features to use (bash in CI almost never matches bash in developer machines, etc.) and often requires a deep understanding of several CLI tools (jq, etc).
makeitself also has limitations in user experience, e.g. passing flags.As we're all in on Github Actions as our pipeline coordinator, continuing to utilize and build CLI tools to perform our pipeline tasks makes sense. This PR adds a new CLI tool called
pipelinewhich we can use to build new isolated tasks that we can string together in Github Actions. We intend to use this utility as the interface for future release automation work, see VAULT-27514.For the first task in this new pipeline tool, I've chosen to build a small command that allows us to list Vault versions between a range. The goal is to utilize this tool on all active branches to automatically populate a list of all N-3 versions relative to that Vault edition and branch. We'll feed that list of released versions into our Enos sampling algorithm and make all of those versions candidates in our upgrade testing scenarios, allowing us to test upgrades from all supported versions over the lifecycle of a given Vault version. As it's automated and dynamic we will no longer have to maintain a list of initial versions on each branch. See VAULT-31180 and VAULT-31182.
We also create a new tools Go module so that our pipeline tooling dependencies ought not interfere with those required to build Vault.
TODO only if you're a HashiCorp employee
to N, N-1, and N-2, using the
backport/ent/x.x.x+entlabels. If this PR is in the CE repo, you should only backport to N, using thebackport/x.x.xlabel, not the enterprise labels.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.
in the PR description, commit message, or branch name.
description. Also, make sure the changelog is in this PR, not in your ENT PR.