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

Pod connectivity check configuration documentation only contains an empty example that doesn't properly explain how to configure it

    • Moderate
    • None
    • 3
    • False
    • Hide

      None

      Show
      None

      Dock link: https://docs.openshift.com/container-platform/4.16/networking/verifying-connectivity-endpoint.html#nw-pod-network-connectivity-implementation_verifying-connectivity-endpoint

      The configuration for connection health checks added by OSDOCS-8766 contain an empty example that don't properly explain how to setup node selectors or tolerations.

      It exemplifies the configuration only like this:

      apiVersion: config.openshift.io/v1
      kind: Network
      metadata: 
        name: cluster
      spec: 
        # ...
          networkDiagnostics: 
            mode: "" 
            sourcePlacement: {} 
            targetPlacement: {} 
      

      That way, no user can imagine that you have to specify either nodeSelector or tolerations fields or both.

      It should contain a more realistic example, where both sourcePlacement and targetPlacement do specify concrete node selectors and concrete tolerations.

      Like this:

      apiVersion: config.openshift.io/v1
      kind: Network
      metadata: 
        name: cluster
      spec: 
        # ...
          networkDiagnostics: 
            mode: "All" 
            sourcePlacement: 
              nodeSelector: 
                checkNodes: groupA
              tolerations: 
              - key: myTaint
                effect: NoSchedule
                operator: Exists
            targetPlacement: 
              nodeSelector: 
                checkNodes: groupB
              tolerations: 
              - key: myOtherTaint
                effect: NoExecute
                operator: Exists 
      

      Properly explaining that both nodeSelector and tolerations are optional, i.e. that you don't necessarily need to specify both of them for both sourceNode and targetNode but you can omit some.

              jaldinge@redhat.com Joe Aldinger
              rhn-support-palonsor Pablo Alonso Rodriguez
              Huiran Wang Huiran Wang
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Created:
                Updated:
                Resolved: