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

PerformanceProfile examples contain wrong type of quotation marks

    XMLWordPrintable

Details

    • Bug
    • Resolution: Done
    • Critical
    • 4.12.z
    • 4.13, 4.12, 4.14, 4.15
    • Documentation / CNF
    • None
    • Critical
    • No
    • 2
    • T&PS 2024 #3
    • 1
    • False
    • Hide

      None

      Show
      None
    • Hide

      2024-03-22: PR merged
      2024-03-19: Peer review complete. I think there may be another instance of incorrect quotation marks i need to correct.
      Show
      2024-03-22: PR merged 2024-03-19: Peer review complete. I think there may be another instance of incorrect quotation marks i need to correct.

    Description

      Description of problem:

      In the examples provided in the section "Adjusting the NIC queues with the performance profile" here:
      - https://docs.openshift.com/container-platform/4.15/scalability_and_performance/cnf-low-latency-tuning.html#adjusting-nic-queues-with-the-performance-profile_cnf-master
      
      There are wrong quotations mark causing the performanceprofile to not work as expected if copy/pasted, leading to an incorrect experience from customer side.
      
      Wrong quotes are present at points 6, 7, 8 and 9.
      
      For example, the content 
      
      ~~~
      apiVersion: performance.openshift.io/v2
      kind: PerformanceProfile
      metadata:
        name: manual
      spec:
        cpu:
          isolated: 3-51,54-103
          reserved: 0-2,52-54
        net:
          userLevelNetworking: true
          devices:
          - interfaceName: "eth*"
        nodeSelector:
          node-role.kubernetes.io/worker-cnf: ""
      ~~~
      
      should be (note the interfaceName field):
      
      ~~~
      apiVersion: performance.openshift.io/v2
      kind: PerformanceProfile
      metadata:
        name: manual
      spec:
        cpu:
          isolated: 3-51,54-103
          reserved: 0-2,52-54
        net:
          userLevelNetworking: true
          devices:
          - interfaceName: "eth*"
        nodeSelector:
          node-role.kubernetes.io/worker-cnf: ""
      ~~~
      
      And the same for the other points.
      
      Please note, the mentioned quotes type is interpreted as character by OpenShift and is taken as a part of the string. 

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

      All the supported versions.

      Additional info:

      This is urgent because the examples are misleading.

      Attachments

        Issue Links

          Activity

            People

              rhn-support-kquinn Kevin Quinn
              rhn-support-cpassare Christian Passarelli
              Sunil Choudhary Sunil Choudhary
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: