Uploaded image for project: 'Red Hat Advanced Cluster Management'
  1. Red Hat Advanced Cluster Management
  2. ACM-9626

[ Documentation ] scale_nodepool_hosted_bm, mandatory parameter is missing from the documentation


    • False
    • None
    • False
    • No

      Create an informative issue (See each section, incomplete templates/issues won't be triaged)

      Using the current documentation as a model, please complete the issue template. 

      Note: Doc team updates the current version and the two previous versions (n-2). For earlier versions, we will address only high-priority, customer-reported issues for releases in support.

      Prerequisite: Start with what we have

      Always look at the current documentation to describe the change that is needed. Use the source or portal link for Step 4:

       - Use the Customer Portal: https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes

       - Use the GitHub link to find the staged docs in the repository: https://github.com/stolostron/rhacm-docs 

      Describe the changes in the doc and link to your dev story

      Provide info for the following steps:

      1. - [ ] Mandatory Add the required version to the Fix version/s field.

      2. - [ ] Mandatory Choose the type of documentation change.

            - [ ] New topic in an existing section or new section
            - [X] Update to an existing topic

      3. - [ ] Mandatory for GA content:
             - [ ] Add steps and/or other important conceptual information here: 
             - [ ] Add Required access level for the user to complete the task here:

             - [ ] Add verification at the end of the task, how does the user verify success (a command to run or a result to see?)
             - [ ] Add link to dev story here:

      4. - [ ] Mandatory for bugs: What is the diff? Clearly define what the problem is, what the change is, and link to the current documentation:
      Documentation is not updated, a mandatory parameter --node-upgrade-type is not mentioned

      following the documentation from here fails :

      Trying to run :
      (.venv) [kni@ocp-edge77 ocp-edge-auto_cluster]$ hcp create nodepool agent   --cluster-name $CLUSTER_NAME   --name $NODEPOOL_NAME   --node-count $WORKER_COUNT 

      Renault in an err:
        3.    spec.management.upgradeType: Unsupported value: "": supported values: "Replace", "InPlace"

         (.venv) [kni@ocp-edge77 ocp-edge-auto_cluster]$ hcp create nodepool agent --help 
      Creates basic functional NodePool resources for Agent platformUsage:
        hcp create nodepool agent [flags]Flags:
        -h, --help   help for agentGlobal Flags:
            --cluster-name string             The name of the HostedCluster nodes in this pool will join. (default "example")
            --name string                     The name of the NodePool.
            --namespace string                The namespace in which to create the NodePool. (default "clusters")
            --node-count int32                The number of nodes to create in the NodePool. (default 2)
            --node-upgrade-type UpgradeType   The NodePool upgrade strategy for how nodes should behave when upgraded. Supported options: Replace, InPlace
            --release-image string            The release image for nodes; if this is empty, defaults to the same release image as the HostedCluster.
            --render                          Render output as YAML to stdout instead of applying.
      (.venv) [kni@ocp-edge77 ocp-edge-auto_cluster]

      This seems to be the correct syntax :

      (.venv) [kni@ocp-edge77 ocp-edge-auto_cluster]$ hcp create nodepool agent   --cluster-name $CLUSTER_NAME   --name $NODEPOOL_NAME   --node-count $WORKER_COUNT --node-upgrade-type Replace
      NodePool hosted-0-extra-cpu created
      (.venv) [kni@ocp-edge77 ocp-edge-auto_cluster]$



      More details are here  

            sdudhgao@redhat.com Servesha Dudhgaonkar
            rhn-support-gamado Gal Amado
            David Huynh David Huynh
            0 Vote for this issue
            3 Start watching this issue