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

[DPE-6460] Add documentation for TLS #43

Open
wants to merge 3 commits into
base: 3.5/edge
Choose a base branch
from
Open

Conversation

skourta
Copy link
Contributor

@skourta skourta commented Feb 14, 2025

This pull request includes updates to the TLS documentation for charmed-etcd. The changes provide instructions on enabling and disabling TLS encryption for peer-to-peer and client-to-server communication, managing private keys, and rotating TLS certificates.

docs/tls/disable-tls.md Outdated Show resolved Hide resolved
docs/tls/disable-tls.md Outdated Show resolved Hide resolved
docs/tls/disable-tls.md Outdated Show resolved Hide resolved
docs/tls/disable-tls.md Outdated Show resolved Hide resolved
docs/tls/disable-tls.md Outdated Show resolved Hide resolved
docs/tls/disable-tls.md Outdated Show resolved Hide resolved
docs/tls/disable-tls.md Outdated Show resolved Hide resolved
docs/tls/disable-tls.md Outdated Show resolved Hide resolved
docs/tls/disable-tls.md Outdated Show resolved Hide resolved
docs/tls/enable-tls.md Outdated Show resolved Hide resolved
docs/tls/enable-tls.md Outdated Show resolved Hide resolved
docs/tls/enable-tls.md Outdated Show resolved Hide resolved
Check [this guide](/t/11664) for an overview of the TLS certificates charms available.

```shell
juju deploy self-signed-certificates --channel edge
Copy link
Contributor

Choose a reason for hiding this comment

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

Does this have to be deployed in the edge channel?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

For now, yes. We use the v4 lib which is currently only supported in the edge channel.

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 add a note there for some context, since the assumption is usually to deploy from the default channel (and is what the self-signed-certificates documentation does in their tutorial)

Maybe something like:

juju deploy self-signed-certificates --channel edge

etcd usesv4 of the tls-certificates library. This version is currently only supported in the edge channel of the self-signed-certificates charm.

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 added the comment. Thank you @a-velasco!

docs/tls/enable-tls.md Outdated Show resolved Hide resolved
docs/tls/enable-tls.md Outdated Show resolved Hide resolved
docs/tls/enable-tls.md Outdated Show resolved Hide resolved
docs/tls/enable-tls.md Outdated Show resolved Hide resolved
docs/tls/enable-tls.md Outdated Show resolved Hide resolved
docs/tls/enable-tls.md Outdated Show resolved Hide resolved
Copy link
Contributor

@a-velasco a-velasco left a comment

Choose a reason for hiding this comment

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

Made a couple of small suggestions. Very nice guides overall :)

Copy link
Collaborator

@reneradoi reneradoi left a comment

Choose a reason for hiding this comment

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

Thank you @skourta for the very nice documentation and @a-velasco for the extensive review!

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.

3 participants