docs(nodectl): HashiCorp Vault backend + chart SA flexibility#156
Merged
Conversation
…t.name is set, bump chart to 0.3.0 (appVersion v0.5.0)
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the helm/nodectl Helm chart docs and chart behavior to support using HashiCorp Vault as a secrets backend and to allow attaching an externally managed Kubernetes ServiceAccount to the nodectl Pod (useful for Vault Kubernetes auth setups).
Changes:
- Document HashiCorp Vault backend configuration in
docs/setup.mdand add a detailed migration runbook for moving from file vault → HashiCorp Vault. - Chart behavior: when
serviceAccount.enabled=falsebutserviceAccount.nameis set, the Deployment now attaches that existing ServiceAccount instead of falling back todefault. - Bump chart version/appVersion and default image tag to
v0.5.0, and update the chart changelog.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| helm/nodectl/values.yaml | Updates default image tag and clarifies ServiceAccount value semantics in chart parameters. |
| helm/nodectl/templates/deployment.yaml | Attaches an existing ServiceAccount to the Pod when serviceAccount.name is provided even if creation is disabled. |
| helm/nodectl/README.md | Expands Vault documentation and adds a link to the new migration runbook. |
| helm/nodectl/docs/setup.md | Adds HashiCorp Vault backend documentation, auth examples, and query parameter reference. |
| helm/nodectl/docs/copy-file-to-hashicorp.md | Adds an operational runbook for migrating secrets from file-based vault storage to HashiCorp Vault. |
| helm/nodectl/Chart.yaml | Bumps chart version and appVersion. |
| helm/nodectl/CHANGELOG.md | Adds release notes for 0.3.0. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| |---------|-----------|----------| | ||
| | File-based | `file:///nodectl/data/vault.json?master_key=<hex>` | All setups | | ||
| | File-based | `file:///nodectl/data/vault.json?master_key=<hex>` | Single-cluster deployments, simplest setup | | ||
| | HashiCorp Vault | `hashicorp://<addr>?auth=k8s&role=<role>&...` or `?api_key=<token>&...` | Multi-tenant infra, shared key management, centralised audit | |
ITBear
approved these changes
May 19, 2026
This file contains hidden or 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
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.
Summary
helm/nodectl/docs/setup.mdalongside the existing file backend, with examples for bothtokenandk8sauth and a query-parameter reference.helm/nodectl/docs/copy-file-to-hashicorp.md— runbook for migrating a running nodectl deployment from file storage to HashiCorp Vault usingsecrets-vault-cli copy. Covers the full secret set (wallet keys, master wallet key, control client keys, REST API password hashes, JWT signing key), pre-migration safety checks, persistingVAULT_URLvia Helm, and rollback.helm/nodectl/README.md.serviceAccount.enabled=falsebutserviceAccount.nameis set, attach the existing SA to the Pod instead of falling back todefault. Lets operators bind nodectl to a SA managed outside the Helm release (e.g. one already mapped to a HashiCorp Vault Kubernetes-auth role by an external team / GitOps).0.3.0, appVersion + image tag tov0.5.0, update CHANGELOG.