search

openservicemesh / osm-docs

a docs page for open service mesh
https://docs.openservicemesh.io
Apache License 2.0
4 stars 40 forks source link

docs/demo: Add MeshRootCertificate information to docs #448

Closed jsturtevant closed 1 year ago

jsturtevant commented 1 year ago

This adds documentation and demo for the MeshRootCertificate feature.

Requires a few PR's in the OSM repo so a hold is on but would like to get feedback on the changes.

Resolves #436 Resolves #434

Signed-off-by: James Sturtevant jstur@microsoft.com

netlify[bot] commented 1 year ago

Deploy Preview for osm-docs ready!

Name Link
Latest commit c5b13707c733ab5523d0523423c88a7d4a6ab9ab
Latest deploy log https://app.netlify.com/sites/osm-docs/deploys/6397ac2e3c685d0008fa12c5
Deploy Preview https://deploy-preview-448--osm-docs.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

shalier commented 1 year ago

Across all the docs instead of having osm-system there should be something akin to export osm_namespace=osm-system # Replace osm-system with the namespace where OSM is installed Likewise, adding a comment to configurations that have

namespace: osm-system  # Replace osm-system with the namespace where OSM is installed
jsturtevant commented 1 year ago

/unhold I believe everything has merged 🚀

shalier commented 1 year ago

For the demo doc, we can have the user set a variable for the namespace where OSM is installed so then we don't have to have a comment mentioning to change the namespace for each command and would instead just be -n $osm_namespace Something like

osm_namespace=osm-system # Replace osm-system with the namespace where OSM is installed
shalier commented 1 year ago

Nit: For the certificate_rotation.md, it might be clearer if the section tree was something like

Manual Root Certificate Rotation
\----Certificate Rotation without Mesh Root Certificate
        \----Rotating with Tresor
        \----Rotating with Other Certificate Providers
\----Certificate Rotation with Mesh Root Certificate
        \----Rotating with Tresor
        \----Rotating with Hashicorp Vault
        \----Rotating with cert-manager