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

Explain how certificate rotation works #446

Merged
merged 2 commits into from
Sep 6, 2024
Merged

Explain how certificate rotation works #446

merged 2 commits into from
Sep 6, 2024

Conversation

jvanz
Copy link
Member

@jvanz jvanz commented Sep 4, 2024

Description

Adds a new page in the explanation section of the documentation to clarify how the new certification rotation works.

Fix #252

Kubewarden controller now manages its own certificates structure.
Therefore, it's not necessary to install cert-manager anymore. This
commit removes the references to the cert-manager in the documentation.

Signed-off-by: José Guilherme Vanz <[email protected]>
@jvanz jvanz added area/documentation Improvements or additions to documentation kind/enhancement labels Sep 4, 2024
@jvanz jvanz self-assigned this Sep 4, 2024
@jvanz jvanz requested a review from a team as a code owner September 4, 2024 17:10
Copy link

netlify bot commented Sep 4, 2024

Deploy Preview for silly-bunny-8cedd0 ready!

Name Link
🔨 Latest commit 9d82880
🔍 Latest deploy log https://app.netlify.com/sites/silly-bunny-8cedd0/deploys/66daf5ee2256a5000836101e
😎 Deploy Preview https://deploy-preview-446--silly-bunny-8cedd0.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.

Copy link
Contributor

@jhkrug jhkrug left a comment

Choose a reason for hiding this comment

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

Some minor suggestions, thanks.

docs/explanations/certificates.md Outdated Show resolved Hide resolved
docs/explanations/certificates.md Outdated Show resolved Hide resolved
docs/explanations/certificates.md Outdated Show resolved Hide resolved
docs/explanations/certificates.md Outdated Show resolved Hide resolved
docs/explanations/certificates.md Outdated Show resolved Hide resolved
Copy link
Contributor

@fabriziosestito fabriziosestito left a comment

Choose a reason for hiding this comment

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

some comments added

Copy link
Contributor

@jhkrug jhkrug left a comment

Choose a reason for hiding this comment

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

lgtm

docs/explanations/certificates.md Outdated Show resolved Hide resolved
docs/explanations/certificates.md Outdated Show resolved Hide resolved
Comment on lines +101 to +102
cert-manager is a requirement of OpenTelemetry, but we've already installed
them in a previous section of this book.
Copy link
Member

Choose a reason for hiding this comment

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

I guess this is no longer true, we haven't covered the installation of cert-manager in other parts of the book. Have we?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, we have. But not because of Kubewarden. OpenTelemetry uses CertManager to generate certificates by default. https://deploy-preview-446--silly-bunny-8cedd0.netlify.app/howtos/telemetry/opentelemetry-qs#install-opentelemetry

| Chart dependency | Helm chart `appVersion` | Helm chart `version` | Comments |
| ----------------------------- | :---------------------: | :------------------: | :--------------------: |
| `jetstack/cert-manager` chart | `>= 1.13 < 2` | Example: `v1.13.2` | Plans to make optional |

Copy link
Member

Choose a reason for hiding this comment

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

I think it's fine to drop this section. I would not move it down into the "optional dependencies" as a dependency of OpenTelemetry. That's because OpenTelemetry has its own documentation stating what is required

Comment on lines +91 to +92
cert-manager is a requirement of OpenTelemetry, but we've already installed
them in a previous section of this book.
Copy link
Member

Choose a reason for hiding this comment

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

We haven't installed it before, have we?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, we have. But not because of Kubewarden. OpenTelemetry uses CertManager to generate certificates by default. https://deploy-preview-446--silly-bunny-8cedd0.netlify.app/howtos/telemetry/opentelemetry-qs#install-opentelemetry

Adds a new page in the explanation section of the documentation to
clarify how the new certification rotation works.

Signed-off-by: José Guilherme Vanz <[email protected]>
Co-authored-by: John Krug <[email protected]>
Co-authored-by: Flavio Castelli <[email protected]>
@jvanz jvanz merged commit 8ef9743 into kubewarden:main Sep 6, 2024
6 checks passed
jhkrug added a commit to jhkrug/kubewarden-product-docs that referenced this pull request Sep 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation kind/enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document changes to cert rotation
4 participants