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

Add note for policy dependency with dot in its name

XMLWordPrintable

    • Quality / Stability / Reliability
    • 5
    • False
    • Hide

      None

      Show
      None
    • False
    • 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: Find the link to where the documentation update
      should go and add it to the recommended changes. You can either use the
      published doc or the staged repo for this step:

      Note: As the feature and doc is understood, this recommendation may
      change. If this is new documentation, link to the section where you think
      it should be placed.

      Customer Portal published version

      https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.13/html-single/governance/index#policy-dependencies 

      Doc staged repo within the ACM Workspace:
      https://github.com/stolostron/rhacm-docs/blob/2.13_stage/governance/policy_dependencies.adoc 

      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.

      This was pointed out in https://issues.redhat.com/browse/ACM-19976 and a Slack thread. There is a technical limitation to dependencies which are Policies and have a dot in their name: in order to function properly, the user must supply the namespace of the Policy by prefixing it to the name, like `<namespace>.<name>`. This limitation can not be fixed in the code - any "fix" would likely cause different scenarios to fail.

      I propose adding a Note to the linked section, such as:

      Note: If the dependency is a Policy and has a period (.) in its name, then the namespace must be added to the start of the name in the dependency section, followed by a period.

      An example might be helpful: a Policy in the "default" namespace called "my-4.17-policy" must be written as "default.my-4.17-policy".

      This could alternatively be added as a known issue, but since it is not a temporary problem (it can not be fixed in code), it doesn't seem to fit there.

              bswope@redhat.com Brandi Swope
              jkulikau@redhat.com Justin Kulikauskas
              Derek Ho Derek Ho
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Created:
                Updated:
                Resolved: