-
Task
-
Resolution: Done
-
Normal
-
None
-
Quality / Stability / Reliability
-
5
-
False
-
-
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
Doc staged repo within the ACM Workspace:
https://github.com/stolostron/rhacm-docs/blob/2.13_stage/governance/operator_pol_ctrl.adoc
4. - [x] Mandatory for GA content:
- [x] Add steps, the diff, known issue, and/or other important
conceptual information in the following space:
Previously, we allowed templating in entries of the `.spec.versions` list. For example:
apiVersion: policy.open-cluster-management.io/v1beta1
kind: OperatorPolicy
metadata:
...
spec:
...
versions:
- 'foo.v1.2.3'
- '{{ fromConfigMap "default" "operatorversions" "foo1" }}'
- '{{ fromConfigMap "default" "operatorversions" "foo2" }}'
--- # configmap for reference
apiVersion: v1
kind: ConfigMap
metadata:
namespace: default
name: operatorversions
data:
foo1: 'foo.v1.8.9'
foo2: 'foo.v2.0.0'
But it was not possible to template a variable number of entries.
Now, we allow multiple versions to be provided in one entry in this list, when they are separated by commas. So this works now:
apiVersion: policy.open-cluster-management.io/v1beta1 kind: OperatorPolicy metadata: ... spec: ... versions: - 'foo.v1.2.3, foo.v1.2.4, foo.v1.2.5' - '{{ fromConfigMap "default" "operatorversions" "foo" }}' --- # configmap for reference apiVersion: v1 kind: ConfigMap metadata: namespace: default name: operatorversions data: foo: 'foo.v1.8.9, foo.v2.0.0'
- [ ] *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?)
- [x] Add link to dev story here: https://issues.redhat.com/browse/ACM-20804
5. - [ ] 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.
- is triggered by
-
ACM-20804 Support multiple versions in an entry in OperatorPolicy
-
- Resolved
-