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

Operator API (configuration) Reference Documentation

XMLWordPrintable

    • Icon: Story Story
    • Resolution: Done
    • Icon: Critical Critical
    • None
    • None
    • Sail Operator
    • None

      The new operator ("Sail operator") will come with new CRDs (custom resource definitions) for configuring Istio that should be documented in a reference-style. These replace the OSSM 2 CRDs, like ServiceMeshControlPlane, ServiceMeshMember and ServiceMeshMemberRoll. Examples of such CRDs in the new operator include "Istio" and "IstioRevision". We should have a configuration reference page that provides a reference for each of the values implemented in the CRD (https://github.com/istio-ecosystem/sail-operator/blob/main/docs/api-reference/sailoperator.io.md)

      Note that the API reference doc must be generated for each release. It is not something we will be attempt to maintain with manual updates. Linking to the reference page in Github or another site would be a better option if it is not possible to render the entire API reference in our product documentation.

              rhn-support-tokeefe Tim O'Keefe
              jlongmui@redhat.com Jamie Longmuir
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

                Created:
                Updated:
                Resolved: