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

fix (status) : Log info in CRC status for OKD preset (#3626) #4479

Merged
merged 1 commit into from
Dec 23, 2024

Conversation

rohanKanojia
Copy link
Contributor

@rohanKanojia rohanKanojia commented Nov 22, 2024

⚠️ This currently doesn't work as expected due to #4478 . It requires #4480 to me merged first

Fixes: Issue #3626

Relates to: Issue #3626

Solution/Idea

Currently, crc status logs information only for OpenShift and MicroShift presets. We should also log cluster information for the OKD preset.

Proposed changes

This PR only changes the way crc status logs information for okd preset.

Old behavior of crc status on OKD preset (Nothing is logged for OpenShift version as there is no handling for okd preset):

CRC VM:          Running
RAM Usage:       647.2MB of 10.95GB
Disk Usage:      21.48GB of 32.68GB (Inside the CRC VM)
Cache Usage:     67.13GB
Cache Directory: /home/rokumar/.crc/cache

Expected New behavior of crc status on OKD preset:

CRC VM:          Running
OpenShift/OKD:       Running (v4.15.0-0.okd-2024-02-23-163410)
RAM Usage:       647.2MB of 10.95GB
Disk Usage:      21.48GB of 32.68GB (Inside the CRC VM)
Cache Usage:     67.13GB
Cache Directory: /home/rokumar/.crc/cache

Testing

  • Set up crc cluster
    • crc config set preset okd
    • crc setup
    • crc start
  • Run crc status (should see OpenShift/OKD in status logs)

Copy link

openshift-ci bot commented Nov 22, 2024

Hi @rohanKanojia. 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-sigs/prow repository.

lines = append(lines, line{"MicroShift", openshiftStatus(s)})
case preset.OKD:
lines = append(lines, line{"OpenShift/OKD", openshiftStatus(s)})
Copy link
Member

Choose a reason for hiding this comment

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

Is there any reason why we need to use OpenShift/OKD instead just OKD ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hello, as per the discussion in #3626 (comment)

I thought of adding this as a suggestion from @cfergeau as it seemed to both group OpenShift and OKD together along with giving user an idea a different preset is in use.

Copy link
Member

Choose a reason for hiding this comment

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

Hello, as per the discussion in #3626 (comment)

This comment says if we want to group OpenShift and OKD both then better to use OpenShift/OKD otherwise just use OKD and in the code we have default for OpenShift preset.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry, I assumed it was okay to proceed forward with any of the suggested options.

I'll update it to use OKD only.

case preset.OKD:
lines = append(lines, line{"OpenShift/OKD", openshiftStatus(s)})
default:
panic(fmt.Sprintf("unknown preset provided : %s (expecting OpenShift, MicroShift, or OKD) ", s.Preset))
Copy link
Member

Choose a reason for hiding this comment

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

Also this change is only on cmd side, did you check this looks similar when get this info using /status api call using daemon?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

On crc daemon side, I see that we default to OpenShift preset :

switch bundleType {
case preset.Microshift:
clusterStatusResult.Preset = preset.Microshift
case preset.OKD:
clusterStatusResult.Preset = preset.OKD
default:
clusterStatusResult.Preset = preset.OpenShift
}

Shall I update cmd side logic to make it consistent with this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've updated it to align with /status api call logic.

Copy link

openshift-ci bot commented Dec 13, 2024

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign praveenkumar for approval. For more information see the 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

case preset.OKD:
lines = append(lines, line{"OKD", openshiftStatus(s)})
default:
lines = append(lines, line{"OpenShift", openshiftStatus(s)})
Copy link
Contributor

Choose a reason for hiding this comment

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

lines = append(lines, line{s.Preset.ForDisplay(), openshiftStatus(s)}) should do the trick.

Currently `crc status` only logs information for OpenShift and
MicroShift presets only. We should also log cluster information for OKD
preset.

Signed-off-by: Rohan Kumar <[email protected]>
Copy link

openshift-ci bot commented Dec 20, 2024

@rohanKanojia: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/integration-crc 62b7663 link true /test integration-crc
ci/prow/e2e-crc 62b7663 link true /test e2e-crc

Full PR test history. Your PR dashboard.

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-sigs/prow repository. I understand the commands that are listed here.

@praveenkumar praveenkumar merged commit c72a45f into crc-org:main Dec 23, 2024
28 of 35 checks passed
@rohanKanojia rohanKanojia deleted the pr/issue3626 branch December 23, 2024 05:32
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.

4 participants