openshift / openshift/openshift-docs
[enterprise-4.11] Issue in file operators/user/olm-creating-apps-from-installed-operators.adoc
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 883
- Forks
- 2k
- Avg merge
- 21h 5m
- Merged PRs (30d)
- 737
Description
Which section(s) is the issue in?
Creating an etcd cluster using an Operator
What needs fixing?
The instructions assume that the etcd operator is installed in the cluster but it is not installed by default in any OpenShift release. It is also a community operator and Red Hat does not recommend that customers install community operators in production clusters and the instructions miss a warning about that.
Anyway the instruction should be explicit about exactly which operator they refer to, and that installing the operator is a pre-requisite. On my 4.10.3 cluster I can see the community operator "etcd" provided by "CCNF"
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open operators/user/olm-creating-apps-from-installed-operators.adoc and locate the “Creating an etcd cluster using an Operator” section. Verify which etcd Operator the instructions refer to, confirm that installation is a prerequisite, and review the applicable guidance for community Operators. Done means the section identifies the Operator and includes the required prerequisite and warning.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100