Skip to content

Conversation

@krastin
Copy link
Contributor

@krastin krastin commented Jan 6, 2026

Description

This PR is part of the Consul tutorials to documentation conversion project.

The tutorial for Vault integration with Consul on K8s became a documentation page.

Links

Jira: CE-918
Deploy preview

Contributor checklists

Review urgency:

  • ASAP: Bug fixes, broken content, imminent releases
  • 3 days: Small changes, easy reviews
  • 1 week: Default expectation
  • Best effort: No urgency

Pull request:

  • Verify that the PR is set to merge into the correct base branch
  • Verify that all status checks passed
  • Verify that the preview environment deployed successfully
  • Add additional reviewers if they are not part of assigned groups

Content:

  • I added redirects for any moved or removed pages
  • I followed the Education style guide
  • I looked at the local or Vercel build to make sure the content rendered correctly

Reviewer checklist

  • This PR is set to merge into the correct base branch.
  • The content does not contain technical inaccuracies.
  • The content follows the Education content and style guides.
  • I have verified and tested changes to instructions for end users.

@krastin krastin requested review from boruszak and danielehc January 6, 2026 14:19
@krastin krastin self-assigned this Jan 6, 2026
@krastin krastin requested review from a team as code owners January 6, 2026 14:19
@krastin krastin added the Consul label Jan 6, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Jan 6, 2026

Vercel Previews Deployed

Name Status Preview Updated (UTC)
Dev Portal ✅ Ready (Inspect) Visit Preview Tue Jan 13 11:47:22 UTC 2026
Unified Docs API ✅ Ready (Inspect) Visit Preview Tue Jan 13 11:43:10 UTC 2026

@github-actions
Copy link
Contributor

github-actions bot commented Jan 6, 2026

Broken Link Checker

No broken links found! 🎉

@krastin krastin added the documentation Improvements or additions to documentation label Jan 6, 2026
Copy link
Contributor

@boruszak boruszak left a comment

Choose a reason for hiding this comment

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

This was especially long, so after you implement the suggestions I'm going to need another read-through before I approve.

</CodeBlockConfig>

## Configure Kubernetes authentication roles in Vault
#### Configure Kubernetes authentication
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
#### Configure Kubernetes authentication
### Configure Kubernetes authentication

Copy link
Contributor

Choose a reason for hiding this comment

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

@krastin is this part of the Setup PKI secrets engine for TLS and service mesh CA header? It does not seem so from the workflow...I think that this should be an H2.

The repository contains a configuration file for your Helm chart, named `consul-ent-values.yaml`.

Open the file and modify the configuration to use your `$VAULT_PRIVATE_ADDR`.
#### Configure Consul Helm chart to use Vault as secrets manager
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
#### Configure Consul Helm chart to use Vault as secrets manager
### Configure Consul Helm chart to use Vault as secrets manager

Copy link
Contributor

Choose a reason for hiding this comment

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

@krastin I think that this also should be an H2 and should be included in the workflow.

configuration required to complete this tutorial.

<CodeTabs tabs={[ "HTTPS", "SSH"]}>
First, enable a key/value v2 secrets engine at the `consul/` path.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we need also Vault existence as a prerequisite.

- **Vault:** you need a running Vault cluster in your network. You can use a [local Vault dev server](/vault/tutorials/get-started/setup#set-up-the-lab) or an existing Vault deployment. 
  - Configure your terminal to interact with Vault cluster by setting `VAULT_ADDR`, `VAULT_CACERT`, and `VAULT_TOKEN`.

Copy link
Contributor

@danielehc danielehc left a comment

Choose a reason for hiding this comment

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

The headers are not easy to follow. I think we should first rearrange the headers using the right depth, so that the right menu shows the workflow steps, and then we can do another review pass to see if the steps are clearly identified and correct.

@krastin krastin requested review from boruszak and danielehc January 8, 2026 12:26
Copy link
Contributor

@boruszak boruszak left a comment

Choose a reason for hiding this comment

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

Keeping this solution simple. Accept and then this PR is ready to merge!

@krastin krastin dismissed danielehc’s stale review January 13, 2026 11:22

Daniele's earlier review was addressed and further on Jeff approved, therefore dismissing this one in order to merge

@krastin krastin removed the request for review from danielehc January 13, 2026 11:22
@krastin krastin merged commit e80ca71 into main Jan 13, 2026
15 checks passed
@krastin krastin deleted the krastin-CE-918 branch January 13, 2026 11:58
tgross pushed a commit that referenced this pull request Jan 13, 2026
* k8s with vault integration

* omit phrase In this example

* Apply suggestions from code review

Co-authored-by: Jeff Boruszak <[email protected]>

* add further changes and propagate to v1.22.x

* add note for vault dev mode

* fixing links in list of steps

* Apply suggestions from code review

Co-authored-by: Jeff Boruszak <[email protected]>

* apply codereview to other doc version

---------

Co-authored-by: Jeff Boruszak <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Consul documentation Improvements or additions to documentation Runtime

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants