-
Task
-
Resolution: Done
-
Normal
-
None
Value Statement
The issue was experienced in support case 03472397.
Customers installing ACM via CLI are instructed to use a YAML file for creating an OperatorGroup, but the example given in the docs does not result in a working configuration.
Specifically, section 1.3.4 of the ACM install guide [1]states that the customer should use this example:
apiVersion: operators.coreos.com/v1
kind: OperatorGroup
metadata:
name: <default>
spec:
targetNamespaces:
- <namespace>
However, that example will result in a failure ("SingleNamespace InstallModeType not supported, cannot configure to watch one namespace"). A working sample would include the namespace in the annotation, as well:
apiVersion: operators.coreos.com/v1
kind: OperatorGroup
metadata:
name: <default>
namespace: <namespace>
spec:
targetNamespaces:
- <namespace>
[1]https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.7/html/install/installing#installing-from-the-cli
Definition of Done for Engineering Story Owner (Checklist)
- The docs include example configuration files that will result in a working installation
Development Complete
- The code is complete.
- Functionality is working.
- Any required downstream Docker file changes are made.
Tests Automated
- [ ] Unit/function tests have been automated and incorporated into the
build. - [ ] 100% automated unit/function test coverage for new or changed APIs.
Secure Design
- [ ] Security has been assessed and incorporated into your threat model.
Multidisciplinary Teams Readiness
- [ ] Create an informative documentation issue using the [Customer
Portal_doc_issue template](
https://github.com/stolostron/backlog/issues/new?assignees=&labels=squad%3Adoc&template=doc_issue.md&title=),
and ensure doc acceptance criteria is met. Link the development issue to
the doc issue. - [ ] Provide input to the QE team, and ensure QE acceptance criteria
(established between story owner and QE focal) are met.
Support Readiness
- [ ] The must-gather script has been updated.