microceph icon indicating copy to clipboard operation
microceph copied to clipboard

Doc: howto SSL/TLS for RGW

Open sabaini opened this issue 8 months ago • 2 comments

We currently have reference-level documentation on how to enable SSL/TLS for Ceph Rados Gateway (RGW), but it is terse and assumes prior knowledge. This makes it difficult for users to set up a secure RGW endpoint confidently.

To address this, we propose creating a dedicated How-To guide for enabling SSL/TLS for the RGW component in MicroCeph, following the Diataxis documentation framework. The focus should be on practical, step-by-step instructions that users can follow with minimal assumptions, and that cover:

  • Required preconditions (e.g. presence of RGW, valid certificates, MicroCeph deployment)
  • Options for obtaining or generating TLS certificates (self-signed vs Lets Encrypt vs external CA)
  • 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.

The guide should be consistent with the existing documentation here: https://canonical-microceph.readthedocs-hosted.com/stable/

sabaini avatar Aug 05 '25 10:08 sabaini

Thank you for reporting your feedback to us!

The internal ticket has been created: https://warthogs.atlassian.net/browse/CEPH-1414.

This message was autogenerated

Related CODA task https://github.com/canonical/open-documentation-academy/issues/263

sabaini avatar Aug 05 '25 12:08 sabaini