v0.8 documentation

[draychev]

This GitHub issue is the root node for all tasks related to creating a) Documentation b) Demo scenarios c) Troubleshooting Guides w/ common issues for v0.8 of OSM

Immediate documentation needs for v0.8

• Permissive Traffic Mode: docs: Permissive Traffic Mode osm-docs#81
• TCP Route + OSM handling TCP traffic: doc: TCP Route + Demo osm-docs#80
• Traffic Split: doc: Traffic Split osm-docs#79 (ensure existing docs are 💯)
• per-service Filter Chains: design doc: Per Service Filter Chains #2858
• Certificates and Rotation: doc: Certificates and Rotation osm-docs#78
• Table w/ SMI versions supported by v0.8: doc: Table w/ SMI versions supported by v0.8 of OSM Controller #2862
• Integrate w/ Nginx: Document how to install nginx ingress controller #2827
• Integrate w/ AGIC: doc: Integrate w/ AGIC osm-docs#75
• Remove references to onboarding VMs: doc: Cleanup VM onboarding since this is not fully implemented in v0.8 #2863
• Egress: doc: Egress osm-docs#77
• Ingress: doc: Ingress osm-docs#76
• Integrate w/ Grafana: doc: Integrate w/ Grafana #2873
• Integrate w/ Prometheus: doc: Integrate w/ Prometheus #2874
• Integrate w/ Dapr: Integrate w/ Dapr #2875
• Payload Health Probes doc: meshed payload Health Probes #2876
• OSM Controller health probes doc: OSM Controller health probes #2877
• Uninstalling OSM: doc: uninstalling OSM and removing all related components from a cluster #2880
• Integration w/ Jaeger doc: Integration w/ Jaeger #2881
• Integrate w/ Azure Monitor doc: Integrate w/ Azure Monitor osm-docs#74
• Caveats and peculiarities of container startup sequencing: doc: caveats and peculiarities of container startup sequencing osm-docs#73
• Dynamic iptables configuration: doc: Dynamic iptables configuration osm-docs#72
• osm-config ConfigMap doc: osm-config ConfigMap #2886
• Update Scale and limits: doc: Update Scale and limits #2893
• Document how "osm namespace join" works: doc: Explain how the "osm namespace add|remove" command works #2904
• Document support for different application traffic types Document support for different application traffic types osm-docs#82

Link to the list of issues (documentation + p0)

Longer Term

• Adding unique error codes to Error messages: Create unique error codes for error messages that need context #2866
• Summary and links to all demos on front-page: openservicemesh/osm#2872
• Create CLI tool to run troubleshooting tooling: cli: Create CLI tool to run troubleshooting tooling #2879

Related / Follow-up

• Update release guide to point docs w/ hardcoded OSM versions: doc: Update release guide to point docs w/ hardcoded OSM versions #2908
• Move and reorganize all newly written docs for v0.8: doc: Move and reorganize all newly written docs for v0.8 osm-docs#83

[bridgetkromhout]

I checked off any that either are closed or are correctly listed on https://github.com/openservicemesh/osm-docs/projects/1.

[bridgetkromhout]

I'm moving this issue back to the code repo now that we have other issues for all the checked-off items, so it can be revisited and handled in terms of demos/examples that remain.

[shashankram]

v0.8 docs are archived and are no longer being updated.