Uploaded image for project: 'OpenShift Service Mesh'
  1. OpenShift Service Mesh
  2. OSSM-2503

Update configuration reference

    XMLWordPrintable

Details

    • Epic
    • Resolution: Unresolved
    • Major
    • None
    • OSSM 2.0.0
    • Documentation
    • None
    • Update configuration reference
    • False
    • False
    • 96
    • 96% 96%
    • Undefined

    Description

      In https://docs.openshift.com/container-platform/4.6/service_mesh/v2x/ossm-reference.html

      update the descriptions in the tables. Currently, they track Rob's maistra doc. https://github.com/maistra/istio-operator/blob/maistra-2.0/docs/crd/maistra.io_ServiceMeshControlPlane_v2.adoc

      The descriptions in the tables need more development. They list the possible items, but could use more information about what happens when you choose those items.  The tables and organization may be updated also. This could be better in headings rather than in tables. I'm not sure that's a requirement, but maybe a suggestion to consider. It would give more room to expand.   If links to configuration docs exist add them. Some are already added.

      Assembly = ossm-reference-smcp.adoc

      (adding a checklist for subsections/modules that fall under `spec:` in the SMCP to track was has been added or still needs to be added to the reference documentation)

      [ ] addons (OSSMDOC-510)

      [ ] cluster (OSSMDOC-509)

      [ ] gateways (OSSMDOC-508)

      [✔] general

      [ ] policy (OSSMDOC-507)

      [✔] profiles

      [ ] proxy (OSSMDOC-34, OSSMDOC-236)

      [ ] runtime (OSSMDOC-506)

      [ ] security (OSSMDOC-505)

      [✔] techPreview

      [ ] telemetry (OSSMDOC-504)

      [✔] tracing

      [✔] version

      General "We need config docs" issues: OSSMDOC-149, OSSMDOC-263, OSSMDOC-378, OSSMDOC-379

      Kiali config: OSSMDOC-63, OSSMDOC-168

      Jaeger config: OSSMDOC-140

      Attachments

        Issue Links

          Activity

            People

              Unassigned Unassigned
              ntimpe@redhat.com Neal Timpe
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated: