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

[Doc] standardize usage of ironic agent - Ironic Python Agent (IPA)

XMLWordPrintable

    • False
    • None
    • False
    • Low
    • None

      Note: Doc team updates the current version of the documentation and the
      two previous versions (n-2), but we address *only high-priority, or
      customer-reported issues* for -2 releases in support.
      Describe the changes in the doc and link to your dev story:

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

      2. - [x ] Mandatory: Choose the type of documentation change or review.

      • [x ] We need to update to an existing topic
      • [ ] We need to add a new document to an existing section
      • [ ] We need a whole new section; this is a function not
        documented before and doesn't belong in any current section
      • [ ] We need an Operator Advisory review and approval
      • [ ] We need a z-Stream (Errata) Advisory and Release note
        for MCE and/or ACM

      3. - [x ] *Mandatory: *Use the following link to open the doc and find where the
      documentation update should go. Note: As the feature and doc is
      understood and developed, this placement decision may change:

      4. - [ ] Mandatory for GA content:

      • [ ] Add steps, the diff, known issue, and/or other important
        conceptual information in the following space:
      • [ ] *Add Required access level *(example, *Cluster
        Administrator*) for the user to complete the task:
      • [ ] 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:

      5. - [ x] Mandatory for bugs: What is the diff? Clearly define what the
      problem is, what the change is, and link to the current documentation. Only
      use this for a documentation bug.

      In the Network configuration section https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.10/html-single/clusters/index#mce-network-configuration we have a table outlining the needed ports for a firewall, however we refere in row 3 to the "ironic agent" while in row 3 we name it "Ironic Python Agent (IPA)"

      Discussing this here https://groups.google.com/a/redhat.com/g/acm-tech/c/iWI-4wDohkM/m/EfJO_2CSAgAJ

      2. Looking at https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.10/html-single/clusters/index#mce-network-configuration what is the difference between IPA and Ironic agent, are the same thing?
      Looking at https://github.com/openshift/ironic-agent-image: "Ironic Agent Container: This is an container image for using ironic-python-agent (IPA) on top of CoreOS" makes me think IPA and ironic agent are used interchangeably, however would like to get some clarification about it.
      (If it is, I think I file a docs bug to get that more clearer)

      Yes these reference the same concept, I'm not sure exactly what is the more correct way to reference it currently.
      https://docs.redhat.com/en/documentation/openshift_container_platform/4.16/html/installing/deploying-installer-provisioned-clusters-on-bare-metal#network-requirements-ensuring-required-ports-are-open_ipi-install-prerequisites uses "Ironic Python Agent (IPA)" so maybe that's the way?

      we should have the same naming in both cases to avoid confusion

              rh-ee-ofischer Oliver Fischer
              rhn-support-dmoessner Daniel Moessner
              Maxim Babushkin Maxim Babushkin
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated:
                Resolved: