Uploaded image for project: 'Red Hat OpenShift Control Planes'
  1. Red Hat OpenShift Control Planes
  2. CNTRLPLANE-2785

Document the node pool management policy for nodePoolManagementCreds

XMLWordPrintable

    • None
    • False
    • Hide

      None

      Show
      None
    • False
    • None
    • None
    • None
    • None

      Resolve the TODO that appears in the generated docs/content/reference/api.md at line 12640: "TODO(dan): document the node pool management policy".

      The docs file is auto-generated by make api-docs, so the TODO originates in the API Go type definitions under api/. The fix must be made in the API type comments, then regenerated with make api-docs.

      Why

      Users configuring nodePoolManagementCreds have no documentation on what IAM permissions are required. This is the counterpart to the cloud controller policy TODO and needs the same treatment to prevent guesswork.

      Acceptance Criteria

      • Locate the TODO in the API Go type definition under api/ that produces this generated doc text
      • Update the Go type comment to list or link to the IAM policy required for nodePoolManagementCreds
      • Ensure consistency with the cloud controller policy documentation
      • Remove the TODO comment from the API source
      • Run make api-docs to regenerate the documentation

      Technical Details

      • Generated file: docs/content/reference/api.md line 12640
      • Source: API Go type definitions under api/ (find the TODO matching this field)
      • TODO text: "TODO(dan): document the 'node pool management policy'"
      • Context: IAM credentials section of the API reference
      • Regenerate: make api-docs

              hypershift-automation hypershift-team automation
              rh-ee-brcox Bryan Cox
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: