canonical/open-documentation-academy

MicroCeph: create RGW SSL/TLS howto

Open

#263 opened on Aug 5, 2025

View on GitHub
 (16 comments) (0 reactions) (1 assignee)Python (99 forks)auto 404
help wantedhow-to

Repository metrics

Stars
 (119 stars)
PR merge metrics
 (Avg merge 6d 22h) (2 merged PRs in 30d)

Description

Background

We have reference documentation on configuring the Rados GW service incl. SSL in MicroCeph, but we're lacking a step by step guide

Why is this needed

The how-to should serve as a user friendly guide for configuring RGW including SSL/TLS

What we need from you

  • Create a how-to according to the guide lines for Diataxis

  • Howto should detail the steps to enable RGW on MicroCeph and configure SSL certificates

    • Required preconditions (e.g. valid certificates, MicroCeph deployment)
    • Options for obtaining or generating TLS certificates (self-signed vs Lets Encrypt vs external CA)
    • Enabling the RGW service
    • Configuration steps for MicroCeph to enable and verify SSL/TLS on RGW
    • How to check that HTTPS is correctly set up and used
    • Troubleshooting common issues (e.g. certificate mismatch, browser warnings, config key mistakes)

The guide should use concrete MicroCeph examples and commands.

Resources

Thank you in advance for your contribution!

Contributor guide

Research direction
Review the MicroCeph reference documentation for RGW and SSL/TLS configuration, and study the Diataxis how to guide pattern. Identify the exact commands for generating certificates, enabling RGW, and verifying HTTPS access. Note any prerequisites and common troubleshooting steps.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80