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

[OSDOCS-4158]: New ccoctl steps for cluster capabilities #62148

Conversation

jeana-redhat
Copy link
Contributor

@jeana-redhat jeana-redhat commented Jul 7, 2023

@jeana-redhat jeana-redhat added this to the Planned for 4.14 GA milestone Jul 7, 2023
@openshift-ci openshift-ci bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jul 7, 2023
@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Jul 7, 2023

🤖 Updated build preview is available at:
https://62148--docspreview.netlify.app

Build log: https://circleci.com/gh/ocpdocs-previewbot/openshift-docs/27697

@jeana-redhat jeana-redhat changed the title [OSDOCS-4158]: New 'ccoctl' steps for cluster capabilities [OSDOCS-4158]: New ccoctl steps for cluster capabilities Jul 27, 2023
@jeana-redhat jeana-redhat force-pushed the OSDOCS-4158-ccoctl-cluster-capabilities branch from ab1659c to 75f1eb1 Compare July 31, 2023 18:01
@openshift-ci openshift-ci bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jul 31, 2023
@jeana-redhat jeana-redhat force-pushed the OSDOCS-4158-ccoctl-cluster-capabilities branch 5 times, most recently from cb92b0d to b64d33b Compare August 1, 2023 19:39
@jeana-redhat jeana-redhat force-pushed the OSDOCS-4158-ccoctl-cluster-capabilities branch from f6cacda to 2aff820 Compare August 1, 2023 19:55
@jeana-redhat jeana-redhat force-pushed the OSDOCS-4158-ccoctl-cluster-capabilities branch from 2aff820 to 8b13835 Compare August 1, 2023 20:03
@jianping-shu
Copy link

Updating cloud provider resources with the Cloud Credential Operator utility
On the page there's still description to be deleted i.e. “If your cluster uses cluster capabilities to disable one or more optional components, delete the CredentialsRequest custom resources for any disabled components.”

@jeana-redhat jeana-redhat force-pushed the OSDOCS-4158-ccoctl-cluster-capabilities branch 3 times, most recently from 76ca2a9 to 888b52b Compare September 14, 2023 20:07
@jeana-redhat jeana-redhat force-pushed the OSDOCS-4158-ccoctl-cluster-capabilities branch from a7c584d to d274228 Compare September 15, 2023 20:34
@openshift-ci openshift-ci bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Sep 15, 2023
$ oc adm release extract \
--credentials-requests \
--included \// <1>
--install-config=<installation_directory>/auth/kubeconfig <2>
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Took a guess based on existing docs about kubeconfig and Jianping's comment that we need to point to that instead of install-config.yaml. @wking or @jianping-shu please correct this since I probably guessed wrong 🙂

Choose a reason for hiding this comment

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

You are right!

Copy link
Member

Choose a reason for hiding this comment

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

I think we can drop this line.

  • Kubeconfigs are not install-configs, so --install-config here will fail with "hey, this file content is not an install config".
  • We have docs for lots and lots of oc ... commands that just assume the user has figured out how to access a cluster via a kubeconfig. For example, this existing docs have:

Prerequisites

  • You have access to an OpenShift Container Platform account with cluster administrator permissions.
  • You have installed the OpenShift CLI (oc).

and then when they tell you to use oc, they say:

To determine the mode that the CCO is configured to use, enter the following command:

$ oc get cloudcredentials cluster -o=jsonpath={.spec.credentialsMode}

without talking about kubeconfigs or profiles or any of that stuff.

@adellape adellape self-assigned this Oct 3, 2023
Copy link
Contributor

@adellape adellape left a comment

Choose a reason for hiding this comment

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

Nice work navigating these complex conditionals. Only a few nits inline, and 2 other suggestions not worth putting in-line:

  • Not sure if I'm overthinking style guide on this, but CTRL+F the PR for "needs" and consider whether they should be "requires".
  • For any of the .Example output or .Partial example output blocks, consider [source,text] instead of [source,terminal] per latest repo guidelines (the coloring/highlighting can get funny/random when using terminal).

modules/cco-ccoctl-creating-individually.adoc Outdated Show resolved Hide resolved
modules/cco-ccoctl-deleting-sts-resources.adoc Outdated Show resolved Hide resolved
modules/cco-ccoctl-creating-individually.adoc Outdated Show resolved Hide resolved
@adellape adellape added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR peer-review-needed Signifies that the peer review team needs to review this PR labels Oct 3, 2023
@jeana-redhat
Copy link
Contributor Author

@adellape tysm for the careful review and great feedback! 🙇

@jeana-redhat jeana-redhat force-pushed the OSDOCS-4158-ccoctl-cluster-capabilities branch 5 times, most recently from 7156bcc to 8c34d14 Compare October 4, 2023 16:54
@openshift-ci openshift-ci bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Oct 4, 2023
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Content tagged azure-workload-id in this file will not show up in the preview build for this PR. This will be viewable in #64001 when I rebase it to get the changes here into main

@jeana-redhat jeana-redhat force-pushed the OSDOCS-4158-ccoctl-cluster-capabilities branch from 8c34d14 to dc73bbb Compare October 6, 2023 16:58
@jstuever
Copy link

/uncc

@openshift-ci openshift-ci bot removed the request for review from jstuever October 11, 2023 22:28
@openshift-merge-robot openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 11, 2023
@jeana-redhat jeana-redhat force-pushed the OSDOCS-4158-ccoctl-cluster-capabilities branch from dc73bbb to 2d400a1 Compare October 12, 2023 16:25
@openshift-merge-robot openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 12, 2023
@jianping-shu
Copy link

I can understand for cluster upgrade and "ccoctl gcp delete" cases, the KUBECONFIG is already configured to the alive cluster, so only --included is enough.

https://62148--docspreview.netlify.app/openshift-enterprise/latest/installing/installing_azure/uninstalling-cluster-azure#cco-ccoctl-deleting-sts-resources_uninstall-cluster-azure
I checked with @huangmingxia , "ccoctl azure delete" needs two more parameters, pls. help check and you can change it in the Azure worload Id doc PR I think.
ccoctl azure delete --name= --region=<azure_region> --subscription-id=<> --delete-oidc-resource-group

LGTM for QE

@jeana-redhat
Copy link
Contributor Author

Thank you so much @jianping-shu 🙏 And yes, I think the other PR is a good place to add that Azure detail. I will go make a note of it now so I don't lose it 🙂

@jeana-redhat jeana-redhat merged commit 1be8a76 into openshift:main Oct 13, 2023
1 check passed
@jeana-redhat
Copy link
Contributor Author

/cherrypick enterprise-4.14

@openshift-cherrypick-robot

@jeana-redhat: new pull request created: #66197

In response to this:

/cherrypick enterprise-4.14

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.

jeana-redhat added a commit to jeana-redhat/openshift-docs that referenced this pull request Oct 13, 2023
jeana-redhat added a commit to jeana-redhat/openshift-docs that referenced this pull request Oct 13, 2023
jeana-redhat added a commit to jeana-redhat/openshift-docs that referenced this pull request Oct 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
branch/enterprise-4.14 peer-review-done Signifies that the peer review team has reviewed this PR size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

8 participants