docs: add how-to guide for configuring the backend protocol#601
Open
Thanhphan1147 wants to merge 5 commits into
Open
docs: add how-to guide for configuring the backend protocol#601Thanhphan1147 wants to merge 5 commits into
Thanhphan1147 wants to merge 5 commits into
Conversation
6 tasks
github-actions
Bot
added
Libraries: Out of sync
Libraries: OK
and removed
Libraries: Out of sync
labels
Thanhphan1147
added
documentation
erinecon
reviewed
Jul 6, 2026
erinecon
left a comment
erinecon
left a comment
Contributor
There was a problem hiding this comment.
Thanks for creating this how-to guide! The content LGTM with some suggestions. Not approving yet because I have some open questions about the scope and whether we should include this page in the home page's table
Co-authored-by: Erin Conley <erin.conley@canonical.com>
Co-authored-by: Erin Conley <erin.conley@canonical.com>
github-actions
Bot
added
Libraries: OK
Libraries: Out of sync
and removed
Libraries: Out of sync
Libraries: OK
labels
- Add HTML metadata description - Rename title to 'How to set the protocol to HTTPS for a backend application' - Fix 'integration' -> 'relation' in prerequisite paragraph - Add guide link to Security row in home page table
github-actions
Bot
added
Libraries: OK
Libraries: Out of sync
and removed
Libraries: OK
Libraries: Out of sync
labels
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
Adds a how-to guide,
docs/how-to/configure-backend-protocol.md, explaining how to configure HTTPS as the communication protocol between thehaproxycharm and its backend applications.This adapts the content originally proposed in #195 to the current RTD documentation format, following the conventions used by the other how-to guides.
Rationale
The original PR (#195) predates the current docs structure and used outdated relation/endpoint names. This version:
configure-backend-protocol.md) and adds the MyST anchor(how_to_configure_backend_protocol)=.receive-ca-certsrelation endpoint (the oldcertificates-transfername no longer exists).self-signed-certificatesas the CA provider andingress-configuratoras thehaproxy-routerequirer, matching the other guides./var/lib/haproxy/cas/cas.pem).index.mdtoctree (Security section) and adds a changelog entry.Documentation
make htmlbuilds successfully.make spellingandmake lint-mdboth pass.