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

docs: clarify requirement to explicitly specify storage class for vault on rke2 (PAC-829) #1733

Merged
merged 15 commits into from
Nov 7, 2023

Conversation

lennessyy
Copy link
Contributor

@lennessyy lennessyy commented Nov 1, 2023

Describe the Change

This PR clarifies the requirement to explicitly specify the storage class for Vault on RKE2 clusters.

Review Changes

💻 Preview URLs:

🎫 PAC-829

Copy link

netlify bot commented Nov 1, 2023

Deploy Preview for docs-spectrocloud ready!

Name Link
🔨 Latest commit c97e4fa
🔍 Latest deploy log https://app.netlify.com/sites/docs-spectrocloud/deploys/6549934396c7e70008cdae3c
😎 Deploy Preview https://deploy-preview-1733--docs-spectrocloud.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@lennessyy lennessyy marked this pull request as ready for review November 2, 2023 17:19
@lennessyy lennessyy requested a review from a team as a code owner November 2, 2023 17:19
Copy link
Contributor

@karl-cardenas-coding karl-cardenas-coding left a comment

Choose a reason for hiding this comment

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

@lennessyy and I had a conversation about the changes and how to go about exposing this challenge in a manner that helps out from a long-term perspective.

@lennessyy lennessyy marked this pull request as draft November 2, 2023 20:03
@lennessyy lennessyy self-assigned this Nov 3, 2023
@lennessyy lennessyy marked this pull request as ready for review November 3, 2023 00:11
@lennessyy lennessyy added auto-backport Enable backport 4.0 4.0 Release 4.1 4.1 Release backport-version-4-0 Backport change to version 4.0 backport-version-4-1 Backport change to version 4.1 and removed 4.0 4.0 Release 4.1 4.1 Release labels Nov 3, 2023
Copy link
Contributor

@ritawatson ritawatson left a comment

Choose a reason for hiding this comment

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

Great refactor. Just some minor suggestions, and a Terraform section is needed.

docs/docs-content/integrations/vault.md Outdated Show resolved Hide resolved
docs/docs-content/integrations/vault.md Outdated Show resolved Hide resolved
docs/docs-content/integrations/vault.md Outdated Show resolved Hide resolved
docs/docs-content/integrations/vault.md Outdated Show resolved Hide resolved
docs/docs-content/integrations/vault.md Outdated Show resolved Hide resolved
docs/docs-content/integrations/vault.md Show resolved Hide resolved
docs/docs-content/integrations/vault.md Outdated Show resolved Hide resolved

## Supported Use cases
8. Open your browser and access the [Vault UI](https://localhost:8200/ui. You will receive a warning due to using a self-signed certificate, but you can ignore this warning. Follow the prompts on the UI to initialize your root token.
Copy link
Contributor

Choose a reason for hiding this comment

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

@lennessyy What is the root token? Can I set the root token value through the YAML? Can I get it by reviewing a kubernetes secret?

Copy link
Contributor Author

@lennessyy lennessyy Nov 6, 2023

Choose a reason for hiding this comment

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

I can add a brief definition of root tokens, but I don't think you can set root token value through the YAML unless you are using Dev mode instead of Prod. If you enable Dev mode, then yes, you can set it in the YAML and can probably set some other configuration to get it by reviewing Kubernetes secret, but otherwise I think you have to go through initialization:
https://developer.hashicorp.com/vault/docs/concepts/tokens#root-tokens

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I can add dev mode to the list of parameters so people know

docs/docs-content/integrations/vault.md Show resolved Hide resolved
Copy link
Contributor

@ritawatson ritawatson left a comment

Choose a reason for hiding this comment

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

Hi Lenny, I came back to your PR to check the terraform and added a couple more suggestions. The terraform example didn't look quite right, so I checked out the code tag in the PXK doc. It should have some color like this:
CleanShot 2023-11-06 at 11 05 26

lennessyy and others added 2 commits November 6, 2023 11:31
Co-authored-by: Karl Cardenas <karl@spectrocloud.com>
Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>
@lennessyy
Copy link
Contributor Author

lennessyy commented Nov 6, 2023

@karl-cardenas-coding I added a parameter to let people know that they can enable dev mode to skip initialization and how to configure the root token in the yaml file. I didn't add instructions on how to view it using kubectl secrets. Since this is a dev mode feature, I wasn't sure that we needed to go into such details.

If you think that having this is still good information to provide, I can try to figure it out and add it to the page.

@lennessyy lennessyy enabled auto-merge (squash) November 7, 2023 01:31

## How secrets are injected in deployments?
In a production Vault server, backend storage is on a data persistent layer, is untrusted and only stores encrypted data. In a dev mode Vault server, all data is stored in-memory and will be erased when Vault restarts.
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
In a production Vault server, backend storage is on a data persistent layer, is untrusted and only stores encrypted data. In a dev mode Vault server, all data is stored in-memory and will be erased when Vault restarts.
In a production Vault server, backend storage is on a data persistent layer, is untrusted, and only stores encrypted data. In a dev mode Vault server, all data is stored in-memory and will be erased when Vault restarts.

Copy link
Contributor

@ritawatson ritawatson left a comment

Choose a reason for hiding this comment

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

Approving - just one comma to add where suggested.

@lennessyy lennessyy merged commit 265d79d into master Nov 7, 2023
8 checks passed
@lennessyy lennessyy deleted the vault-rke2-storage-class branch November 7, 2023 17:38
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Nov 7, 2023
…lt on rke2 (PAC-829) (#1733)

* docs: clarify requirement to explicitly specify storage class for vault on rke2

* docs: specify location of change

* docs: refactor vault pack page

* Apply suggestions from code review

Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>

* Added a terraform section

* Add bullet in troubleshooting section on rke2 page

* address vale comments

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <karl@spectrocloud.com>
Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>

* Address review comments

* address vale comments

* Fix parameter path

* remove warning callout

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>
Co-authored-by: Karl Cardenas <karl@spectrocloud.com>
(cherry picked from commit 265d79d)
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Nov 7, 2023
…lt on rke2 (PAC-829) (#1733)

* docs: clarify requirement to explicitly specify storage class for vault on rke2

* docs: specify location of change

* docs: refactor vault pack page

* Apply suggestions from code review

Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>

* Added a terraform section

* Add bullet in troubleshooting section on rke2 page

* address vale comments

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <karl@spectrocloud.com>
Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>

* Address review comments

* address vale comments

* Fix parameter path

* remove warning callout

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>
Co-authored-by: Karl Cardenas <karl@spectrocloud.com>
(cherry picked from commit 265d79d)
@vault-token-factory-spectrocloud
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
version-4-0
version-4-1

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation and see the Github Action logs for details

lennessyy added a commit that referenced this pull request Nov 7, 2023
…lt on rke2 (PAC-829) (#1733) (#1753)

* docs: clarify requirement to explicitly specify storage class for vault on rke2

* docs: specify location of change

* docs: refactor vault pack page

* Apply suggestions from code review

Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>

* Added a terraform section

* Add bullet in troubleshooting section on rke2 page

* address vale comments

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <karl@spectrocloud.com>
Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>

* Address review comments

* address vale comments

* Fix parameter path

* remove warning callout

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>
Co-authored-by: Karl Cardenas <karl@spectrocloud.com>
(cherry picked from commit 265d79d)

Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com>
lennessyy added a commit that referenced this pull request Nov 7, 2023
…lt on rke2 (PAC-829) (#1733) (#1754)

* docs: clarify requirement to explicitly specify storage class for vault on rke2

* docs: specify location of change

* docs: refactor vault pack page

* Apply suggestions from code review

Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>

* Added a terraform section

* Add bullet in troubleshooting section on rke2 page

* address vale comments

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <karl@spectrocloud.com>
Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>

* Address review comments

* address vale comments

* Fix parameter path

* remove warning callout

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>
Co-authored-by: Karl Cardenas <karl@spectrocloud.com>
(cherry picked from commit 265d79d)

Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Enable backport backport-version-4-0 Backport change to version 4.0 backport-version-4-1 Backport change to version 4.1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants