-
Notifications
You must be signed in to change notification settings - Fork 243
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
📖 Enhance docs #3967
📖 Enhance docs #3967
Conversation
Hi @fxierh. Thanks for your PR. I'm waiting for a crc-org member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. 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. |
/auto-cc |
The fixes for documentation and makefile should perhaps be split. They are unrelated/independent. |
02d0d0d
to
fe8237a
Compare
@@ -8,6 +8,7 @@ Upgrading the {ocp} version might cause issues that are difficult to reproduce. | |||
* It uses a single node, which behaves as both a control plane and worker node. | |||
* It disables the Cluster Monitoring Operator by default. | |||
This disabled Operator causes the corresponding part of the web console to be non-functional. | |||
* It does not include the Cloud Credential Operator. | |||
* The {ocp} cluster runs in a virtual machine known as an __instance__. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
there are more cluster operators that are currently disabled maybe that should also be listed, from: https://github.com/crc-org/snc/blob/master/cvo-overrides.yaml
- cluster-autoscaler
- cloud-controller-manager
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@anjannath Yup, done.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A lot of repetition in tone/structure.
Perhaps best to use a list here:
- It disables the following operators:
- Cloud Credential Operator
- Cluster Autoscaler Operator
- Cluster Cloud Controller Manager Operator
- Cluster Monitoring Operator
@themr0c WDYT?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@gbraad I find it somewhat challenging to include the Cluster Monitoring Operator in the same list as the other three. Unlike the others, it is only disabled 'by default' (can be enabled day 1 if needed) and its disablement results in the corresponding section of the web console becoming non-functional.
How about this:
* The Cluster Monitoring Operator is disabled by default. This results in the corresponding part of the web console to be non-functional.
* The following operators are always disabled:
** Cloud Credential Operator.
** Cluster Autoscaler Operator.
** Cluster Cloud Controller Manager Operator.
8399ade
to
dbdb291
Compare
LGTM, /cc @themr0c please take a look |
/assign @themr0c |
docs/modules/getting_started/partials/con_differences-from-production-openshift-install.adoc
Outdated
Show resolved
Hide resolved
Co-authored-by: Fabrice Flore-Thébault <[email protected]>
Comments addressed. |
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: themr0c The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
List disabled operators (cloud-credential-operator, cluster-autoscaler-operator, cluster-cloud-controller-manager-operator) in the docs.
Also incorporate a few minor adjustments.