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

capi docs: add intermediate ca how-to #1027

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

petrutlucian94
Copy link
Contributor

We're adding a guide that shows how intermediate CAs can be generated using HashiCorp Vault and passed to CAPI using management cluster secrets.

@petrutlucian94 petrutlucian94 requested a review from a team as a code owner January 31, 2025 14:43
@petrutlucian94 petrutlucian94 force-pushed the lpetrut/intermediate-ca-docs branch 2 times, most recently from 0ae6dab to d3fb20e Compare January 31, 2025 14:49
We're adding a guide that shows how intermediate CAs can be
generated using HashiCorp Vault and passed to CAPI using
management cluster secrets.
@petrutlucian94 petrutlucian94 force-pushed the lpetrut/intermediate-ca-docs branch from d3fb20e to 90fb1ca Compare January 31, 2025 14:51
Copy link
Contributor

@nhennigan nhennigan left a comment

Choose a reason for hiding this comment

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

Minor review comments left. Great work 😸

for the workload clusters.

Follow this guide to prepare an intermediate Certificate Authority (CA) using
HashiCorp Vault and then configure ClusterAPI to use the generated certificates.
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we provide a link to Vault please?

@@ -22,6 +22,7 @@ Perform an in-place upgrade <in-place-upgrades>
Upgrade the providers of a management cluster <upgrade-providers>
Migrate the management cluster <migrate-management>
Refresh workload cluster certificates <refresh-certs>
How to use intermediate CAs with Vault <intermediate-ca>
Copy link
Contributor

Choose a reason for hiding this comment

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

Please rename Use intermediate CAs with Vault

vault secrets tune -max-lease-ttl=87600h pki
```

## Generating the CA certificates
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: Generate the CA certificates

Follow this guide to prepare an intermediate Certificate Authority (CA) using
HashiCorp Vault and then configure ClusterAPI to use the generated certificates.

## Preparing Vault
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: Prepare Vault

> myca/intermediate.crt
```

## Passing intermediate CA certificates to CAPI
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: Pass intermediate ...

tls.key: |
$(cat myca/intermediate.key | sed 's/^/ /g')
EOF

Copy link
Contributor

Choose a reason for hiding this comment

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

I would separate these code blocks and add a line saying now apply the CA cert to the cluster

For the purpose of this guide, we are going to install HashiCorp Vault using
snap and start a Vault server in development mode.

```bash
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: Can you please remove the bash from the code snippets? Generally we leave them blank unless there is a real need so that the output looks the same across pages

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants