Add a note about Operators. #27668
Add a note about Operators. #27668
Conversation
openshift-ci-robot
added
the
size/S
|
The preview will be available shortly at: |
pneedle-rh
added
branch/enterprise-4.6
branch/enterprise-4.7
peer-review-needed
| the service. If this YAML has placeholder values or sample values, a service cannot start. You can modify the YAML file and start the service with the modified values. To learn how to modify YAML files and start services from it, go to xref:../../cli_reference/developer_cli_odo/creating-instances-of-services-managed-by-operators.adoc#creating-services-from-yaml-files_creating-instances-of-services-managed-by-operators[Creating services from YAML files]. | ||
| [NOTE] | ||
| ==== | ||
| You cannot install Operators with `{odo-title}` on your cluster. To install Operators, contact your cluster administrator or see xref:../../operators/user/olm-installing-operators-in-namespace.adoc#olm-installing-operators-in-namespace-prereqs[Installing Operators in your namespace] |
There was a problem hiding this comment.
You could consider changing "with {odo-title}" to "by using {odo-title}". As the sentence stands at the moment, it could be interpreted to mean that you cannot install an Operator that includes odo.
There was a problem hiding this comment.
You could also move the odo aspect to the end of the sentence, so that the statement about the task that you cannot do (install Operators on your cluster) is not interrupted by the method (using odo).
"You cannot install Operators on your cluster by using {odo-title}."
| == Prerequisites | ||
| To create services from an Operator, you must ensure that the Operator has valid values defined in its `metadata` to start the requested service. `{odo-title}` uses the `metadata.annotations.alm-examples` YAML file of an Operator to start the service. If this YAML has placeholder values or sample values, a service cannot start. You can modify the YAML file and start the service with the modified values. To learn how to modify YAML files and start services from it, go to xref:../../cli_reference/developer_cli_odo/creating-instances-of-services-managed-by-operators.adoc#creating-services-from-yaml-files_creating-instances-of-services-managed-by-operators[Creating services from YAML files]. | ||
|
|
||
| .Prerequisites |
There was a problem hiding this comment.
I think it would be useful for the reader to move this prerequisites section to the start of each of the procedure modules in this assembly. Then the prerequisites will be presented to the reader if any of those modules are reused in other assemblies.
It doesn't feel like it's in the right place at the moment, as a dot title in the introduction.
|
|
||
| == Prerequisites | ||
| To create services from an Operator, you must ensure that the Operator has valid values defined in its `metadata` to start the requested service. `{odo-title}` uses the `metadata.annotations.alm-examples` YAML file of an Operator to start the service. If this YAML has placeholder values or sample values, a service cannot start. You can modify the YAML file and start the service with the modified values. To learn how to modify YAML files and start services from it, go to xref:../../cli_reference/developer_cli_odo/creating-instances-of-services-managed-by-operators.adoc#creating-services-from-yaml-files_creating-instances-of-services-managed-by-operators[Creating services from YAML files]. |
There was a problem hiding this comment.
You could consider swapping the order of the first three sentences. I suggest introducing the metadata.annotations.alm-examples YAML file, then introducing the requirements for the file. For example:
"{odo-title} uses the metadata.annotations.alm-examples YAML file of an Operator to start a service from an Operator. A service cannot start if this YAML file has placeholder or sample values. To start a service, you must ensure that the metadata section of the YAML has valid values."
There was a problem hiding this comment.
I suggest changing "To learn how to modify YAML files and start services from it" to "To learn how to modify YAML files and start services from them".
pneedle-rh
added
peer-review-done
openshift-ci-robot
added
the
needs-rebase
|
@boczkowska: PR needs rebase. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
|
@boczkowska please let me know if you have any questions about my previous review comments or about what is required to rebase this pull request. Thanks. |
Branch 4.6 and 4.7