Uploaded image for project: 'OpenShift Bugs'
  1. OpenShift Bugs
  2. OCPBUGS-33667

Add docs section for protocolStrategy

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Done
    • Icon: Undefined Undefined
    • None
    • 4.12, 4.11, 4.14, 4.15, 4.16, 4.17
    • Low
    • No
    • 3
    • False
    • Hide

      None

      Show
      None

      Description of problem:

      A docs section should be added to https://docs.openshift.com/container-platform/4.15/networking/dns-operator.html discussing the use of protocolStrategy, specifically using TCP (the only current available option), with examples.
      
      The original implementation of protocolStrategy was not an official feature, but was done as a bug-fix (https://issues.redhat.com/browse/OCPBUGS-6829) and backported to 4.12. The use of protocolStrategy is documented in API docs (https://docs.openshift.com/container-platform/4.15/rest_api/operator_apis/dns-operator-openshift-io-v1.html), but a dedicated user-doc section should be added too. 

      Version-Release number of selected component (if applicable):

          4.12+

      How reproducible:

          100%

      Steps to Reproduce:

          1.Visit https://docs.openshift.com/container-platform/4.15/networking/dns-operator.html

      Actual results:

          Doesn't contain info on how to use protocolStrategy

      Expected results:

          Should contain info on protocolStrategy

      Additional info:

          https://issues.redhat.com/browse/OCPBUGS-15833 was created to ensure the API docs (https://docs.openshift.com/container-platform/4.15/rest_api/operator_apis/dns-operator-openshift-io-v1.html) were getting updated, not user docs.

              jmanthei@redhat.com Jessica Manthei
              gspence@redhat.com Grant Spence
              Melvin Joseph Melvin Joseph
              Votes:
              0 Vote for this issue
              Watchers:
              6 Start watching this issue

                Created:
                Updated:
                Resolved: