Skip to content

Add documentation for the TLS Vault feature#84

Merged
wolsen merged 1 commit into
canonical:mainfrom
fabi200123:tls-vault-feature
Jul 28, 2025
Merged

Add documentation for the TLS Vault feature#84
wolsen merged 1 commit into
canonical:mainfrom
fabi200123:tls-vault-feature

Conversation

@fabi200123

Copy link
Copy Markdown
Contributor

This PR adds the documentation for the TLS Vault feature of Sunbeam.

NOTE: This PR shouldn't be merged until the snap-openstack PR is merged, because the documentation might be changed accordingly to the spec for this feature.

@fabi200123
fabi200123 force-pushed the tls-vault-feature branch from 0d5f659 to 5a3f860 Compare July 3, 2025 13:58
@fabi200123 fabi200123 changed the title [WIP] Add documentation for the TLS Vault feature Add documentation for the TLS Vault feature Jul 16, 2025

@hemanthnakkina hemanthnakkina left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Some review comments on the first pass

https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/misc/implement-tls-using-a-third-party-ca/ also needs to be updated.

I will talk with documentation team if there is any restructuring required given TLS has support with CA and Vault now.

Comment thread how-to/misc/generate-a-ca-certificate.rst Outdated
Comment thread how-to/features/tls-vault.rst Outdated
@hemanthnakkina

Copy link
Copy Markdown
Contributor

@hemanthnakkina

Copy link
Copy Markdown
Contributor

@fabi200123 CI Spell check failures, just cross check if those words are used in TLS CA in capitalised form or you can add them in ignore list

@fabi200123
fabi200123 force-pushed the tls-vault-feature branch 4 times, most recently from 7d44e41 to e7fc773 Compare July 17, 2025 14:54
Comment thread explanation/service-endpoint-encryption.rst
Comment thread explanation/service-endpoint-encryption.rst Outdated
Comment thread explanation/service-endpoint-encryption.rst Outdated
Comment thread explanation/service-endpoint-encryption.rst Outdated
Comment thread explanation/service-endpoint-encryption.rst Outdated
Comment thread explanation/service-endpoint-encryption.rst Outdated
Comment thread explanation/service-endpoint-encryption.rst Outdated
Comment thread how-to/features/tls-vault.rst Outdated
Comment thread how-to/features/tls-vault.rst Outdated
Comment thread how-to/features/tls-vault.rst Outdated
Comment thread how-to/features/tls-vault.rst Outdated
Comment thread how-to/features/tls-vault.rst Outdated
Comment thread how-to/features/tls-vault.rst Outdated

@skoech skoech left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hi @fabi200123 and @hemanthnakkina, I've left some suggestions and nitpicks.

@hemanthnakkina hemanthnakkina left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I am thinking over the lines like TLS enablement under Features and then subpages for CA and Vault.

This page also requires update (The content should be generic for both TLS CA and Vault except the output for outstanding certificates differ).

https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/misc/implement-tls-using-a-third-party-ca/

Comment thread reference/manifest-file-reference.rst
@fabi200123
fabi200123 force-pushed the tls-vault-feature branch 5 times, most recently from 3b31a90 to 079f65f Compare July 23, 2025 07:56
@fabi200123
fabi200123 force-pushed the tls-vault-feature branch 2 times, most recently from 3565b08 to 5b46374 Compare July 23, 2025 08:09

@wolsen wolsen left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM

@wolsen
wolsen merged commit f1cff88 into canonical:main Jul 28, 2025
4 of 5 checks passed
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.

4 participants