Uploaded image for project: 'OpenShift Virtualization'
  1. OpenShift Virtualization
  2. CNV-57866

autoResourceLimits documentation needs update and in the wrong place ( For 4.16 to 4.18 )

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Done
    • Icon: Major Major
    • None
    • CNV v4.16.0, CNV v4.17.0, CNV v4.18.0, CNV v4.19.0
    • CNV Documentation
    • None
    • Quality / Stability / Reliability
    • 0.42
    • False
    • Hide

      None

      Show
      None
    • False
    • None
    • Green
    • Yes
    • None

      Description of problem:

      autoResourceLimits is documented here:
      https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html-single/virtualization/index#virt-about-cpu-and-memory-quota-namespace_virt-configuring-cdi-for-namespace-resourcequota
      In a CDI section.
      
      This is related to CNV-29984
      

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

      4.18
      

      How reproducible:

      Always
      

      Steps to Reproduce:

      1.
      2.
      3.
      

      Actual results:

      Issue details are mentioned in Additional Info section below.
      1. Move the paragraph to the right sectoin
      2. Be a little bit more verbose on what it does
      3. Rename existing section
      4. Explain how to enable it!
      5. add a warning that manual qouta management (3) is not recommended

      Expected results:

      However, it is mostly quota related and should therefore be moved to 
      https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html-single/virtualization/index#virt-setting-resource-quota-limits-for-vms_virt-working-with-resource-quotas-for-vms
      

      Additional info:

      We want to do a few things:
      1. Move the paragraph to the right sectoin
      2. Be a little bit more verbose on what it does
      3. Rename existing section
      4. Explain how to enable it!
      5. add a warning that manual qouta management (3) is not recommended
      
      For 1:
      Move
      https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html-single/virtualization/index#virt-about-cpu-and-memory-quota-namespace_virt-configuring-cdi-for-namespace-resourcequota
      To https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html-single/virtualization/index#virt-setting-resource-quota-limits-for-vms_virt-working-with-resource-quotas-for-vms
      
      Section header "Enable automatic resource quota limits for virtual machines"
      
      For 2:
      Add soimething like:
      > If resourcequota are also requiring limits, then enabling the automatic computation of quotas for virtual machine is recommended.
      > By default, $product is already computing resource requests for a virtual machine, with the feature enabled, the product is also computing resource limits in order to comply with quota needs.
      
      For 3:
      Rename "Setting resource quota limits for virtual machines"
      to "Manually setting resource quota limits for virtual machines"
      
      For 4:
      Add a procedure of how to enable the feature!
      
      For 5:
      Add a warning to the section from (3):
      > It is strongly recommended to use atuoamtic limit computation, and recommended to not set limits manually.
      

              dclowers@redhat.com Daniel Clowers
              fdeutsch@redhat.com Fabian Deutsch
              Kedar Bidarkar Kedar Bidarkar
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

                Created:
                Updated:
                Resolved: