Skip to content

docs: add Mayastor security page covering TLS for the REST API#608

Open
tiagolobocastro with Copilot wants to merge 3 commits into
mainfrom
copilot/create-documentation-for-mayastor-tls
Open

docs: add Mayastor security page covering TLS for the REST API#608
tiagolobocastro with Copilot wants to merge 3 commits into
mainfrom
copilot/create-documentation-for-mayastor-tls

Conversation

Copilot AI commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

Adds a new Security configuration page for Replicated PV Mayastor, covering TLS for the public REST API today and providing forward-looking stubs for upcoming features.

New page: configuration/rs-security.md

  • Overview table mapping each connection layer (REST, gRPC, etcd) and feature (TLS, JWT) to its current status
  • TLS section with annotated Helm values examples for all three certificate engines:
    • pod — transient cert at startup, dev/eval only, no mTLS
    • helm — chart-managed self-signed CA + leaf certs, configurable durations
    • cert-manager — production-grade provisioning/rotation, supports existing Issuer/ClusterIssuer
  • mTLSmutualAuth: true flag, client cert coverage, incompatibility with engine: pod
  • BYO certsautoGenerated.enabled: false path with full apis.rest.security.tls.clients structure
  • Per-service overrides — how to override mutualAuth and cert-manager secret names per service
  • Verification — port 8080 (TLS) vs 8081 (plain), pod log check
  • Upcoming stubs for internal gRPC TLS (transparent, no user action), etcd TLS (will require config), and JWT authentication

Sidebar & cross-links

  • Added Security entry in sidebars.ts under Configuration, after Enable RDMA
  • Added See Also links to the security page from encryption.md and rs-rdma.md

- [Create StorageClass(s)](../configuration/rs-create-storageclass.md)
- [Storage Class Parameters](../configuration/rs-storage-class-parameters.md)
- [Topology Parameters](../configuration/rs-topology-parameters.md)
- [Security (TLS / mTLS)](rs-security.md)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Why is this under rs-rdma? how is this related to rdma?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@copilot remove the reference

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Removed in 3e5bb26.

Comment on lines +128 to +131
## See Also

- [Security (TLS / mTLS)](../configuration/rs-security.md)
- [Installation](../../../../quickstart-guide/installation.md) No newline at end of file

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Hmm, I don't think this is correct. This is not related to storage encryption at all. This is security between mircoservices.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

hmm I think it is somewhat related; if you're interested in encrypting your data you may want to encrypt your service traffic as well

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Yes, but that should not be under mayastor's storage encryption feature. This is not data encryption at flight, this has nothing to do with inflight storage data, might give false picture if we put it under storage encryption feature. This could be put at a different place, on the overall installation level.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

It's not "under storage encryption", it's just a related link at the bottom, see also.

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