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

updated vault helm chart doc with usecase of nlb #27690

Merged

Conversation

rajesht-source
Copy link
Contributor

Description

This PR updates the document of vault helm about what needs to be done if there is a special requirement of running vault with NLB.

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.

@rajesht-source rajesht-source requested a review from a team as a code owner July 4, 2024 11:45
Copy link

hashicorp-cla-app bot commented Jul 4, 2024

CLA assistant check
All committers have signed the CLA.

Copy link

CLA assistant check

Thank you for your submission! We require that all contributors sign our Contributor License Agreement ("CLA") before we can accept the contribution. Read and sign the agreement

Learn more about why HashiCorp requires a CLA and what the CLA includes

Have you signed the CLA already but the status is still pending? Recheck it.

@rajesht-source
Copy link
Contributor Author

This PR addresses this issue : #27592

@rajesht-source
Copy link
Contributor Author

rajesht-source commented Jul 12, 2024

Hi @miagilepner,
Could you please advise / help on how this PR can be merged in? This PR is about to just update the document.
also is this "Vercel" test mandatory for the documentation contribution? I authorized Vercel but I still see its status as " Authorization required to deploy"

@rajesht-source
Copy link
Contributor Author

rajesht-source commented Jul 17, 2024

@miagilepner could you please take a look at this PR and please advise if this can be approved.
Thanks!

@rajesht-source
Copy link
Contributor Author

Hi @hashishaw Could you please review this PR and advise if this can be approved?

@heatherezell heatherezell added ecosystem helmchart Helm chart for deploying Vault on Kubernetes. Also consider hashicorp/vault-helm docs labels Jul 22, 2024
@rajesht-source
Copy link
Contributor Author

Hi @schavis this branch was out of sync with main so I just updated it, it should be good for your review.
Thanks!

@@ -59,6 +59,8 @@ cluster](https://kubernetes.io/docs/tasks/administer-cluster/securing-a-cluster/
options](/vault/docs/platform/k8s/helm/configuration), and read the [production deployment
checklist](/vault/docs/platform/k8s/helm/run#architecture).

-> **Important:** This helm chart always provisions Application Load Balancer(ALB) at the AWS side, if you have the requirements of running vault with Network Load Balancer(NLB) then you need to provision NLB in front of your ALB. This special kind of requirement can arise where you need to use AWS PrivateLink with your vault and PrivateLink only works with NLB.
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
-> **Important:** This helm chart always provisions Application Load Balancer(ALB) at the AWS side, if you have the requirements of running vault with Network Load Balancer(NLB) then you need to provision NLB in front of your ALB. This special kind of requirement can arise where you need to use AWS PrivateLink with your vault and PrivateLink only works with NLB.
<Important title="Helm chart provisions ALB on AWS side">
If you use AWS features (e.g, AWS PrivateLink) that require a network load
balancer (NLB), you must provision your NLB **before** your application load
balancer (ALB).
</Important>

Style correction: write in active voice

@rajesht-source
Copy link
Contributor Author

rajesht-source commented Aug 13, 2024

Hi @schavis I made the suggested change , could you please review and approve?

@rajesht-source
Copy link
Contributor Author

@schavis Thanks for the approval on this PR, would need one more approval in order to get it merged.
Will really appreciate, if I can get one more approval on this.

Thanks!

@rajesht-source
Copy link
Contributor Author

Hi @schavis, could we please get some of your colleague to review this PR, so that we can merge it in?

Copy link
Contributor

@VioletHynes VioletHynes left a comment

Choose a reason for hiding this comment

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

Hey there! Thanks for this. Since this is a docs-only change and Sarah's already approved it, I'm going to go ahead and merge this. Thanks for the contribution, and I apologize it took so long to get merged.

@VioletHynes VioletHynes merged commit 0c986fc into hashicorp:main Sep 20, 2024
28 of 30 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs ecosystem helmchart Helm chart for deploying Vault on Kubernetes. Also consider hashicorp/vault-helm pr/no-changelog pr/no-milestone
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants