Skip to content
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

Merged
merged 1 commit into from
Jan 24, 2024
Merged

📖 Enhance docs #3967

merged 1 commit into from
Jan 24, 2024

Conversation

fxierh
Copy link
Contributor

@fxierh fxierh commented Jan 20, 2024

List disabled operators (cloud-credential-operator, cluster-autoscaler-operator, cluster-cloud-controller-manager-operator) in the docs.

Also incorporate a few minor adjustments.

Copy link

openshift-ci bot commented Jan 20, 2024

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 /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

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.

@fxierh
Copy link
Contributor Author

fxierh commented Jan 20, 2024

/auto-cc

@openshift-ci openshift-ci bot requested review from evidolob and themr0c January 20, 2024 12:02
@gbraad
Copy link
Contributor

gbraad commented Jan 20, 2024

The fixes for documentation and makefile should perhaps be split. They are unrelated/independent.

@fxierh fxierh force-pushed the enhance-docs branch 2 times, most recently from 02d0d0d to fe8237a Compare January 20, 2024 13:30
@fxierh
Copy link
Contributor Author

fxierh commented Jan 20, 2024

@gbraad Yup, move the part for make targets to #3968.

@@ -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__.
Copy link
Member

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@anjannath Yup, done.

Copy link
Contributor

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?

Copy link
Contributor Author

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.

@fxierh fxierh force-pushed the enhance-docs branch 2 times, most recently from 8399ade to dbdb291 Compare January 22, 2024 06:52
@anjannath
Copy link
Member

LGTM, /cc @themr0c please take a look

@fxierh
Copy link
Contributor Author

fxierh commented Jan 24, 2024

/assign @themr0c

Co-authored-by: Fabrice Flore-Thébault <[email protected]>
@fxierh
Copy link
Contributor Author

fxierh commented Jan 24, 2024

Comments addressed.

@openshift-ci openshift-ci bot added the lgtm label Jan 24, 2024
Copy link

openshift-ci bot commented Jan 24, 2024

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: themr0c
Once this PR has been reviewed and has the lgtm label, please assign praveenkumar for approval. For more information see the Kubernetes Code Review Process.

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@praveenkumar praveenkumar merged commit 2b661eb into crc-org:main Jan 24, 2024
17 of 21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants