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

OPCT-263: docs: review installation review guide removing etcd log #154

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

mtulio
Copy link
Contributor

@mtulio mtulio commented Mar 3, 2025

What this PR does / why we need it:

Review installation-review guide removing unnecessary etcd data which is
now addressed by a embedded/adm command.

This PR decomposes changes from #113

Which issue(s) this PR fixes:

https://issues.redhat.com/browse/OPCT-263

Closes #113

Checklist

  • Subject and description added to both, commit and PR.
  • Relevant issues have been referenced.
  • This change includes docs.
  • This change includes unit tests.

@openshift-ci openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 3, 2025
Copy link

openshift-ci bot commented Mar 3, 2025

[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 ask for approval from mtulio. 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

@mtulio mtulio changed the title Docs v0.5 report install review OPCT-263: docs: report updates, and install review Mar 3, 2025
@mtulio mtulio requested a review from Copilot March 3, 2025 20:07

Choose a reason for hiding this comment

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

PR Overview

This PR updates documentation related to e2e test execution, baseline administration, and installation review. The changes add a comprehensive guide for running native Kubernetes e2e tests with opct and openshift-tests, revise the baseline administration documentation with updated commands and examples, and update the installation review guide by replacing deprecated instructions with a reference to the new log parser command. Additionally, legacy commented-out content in the BYO plugin documentation has been removed.

Reviewed Changes

File Description
docs/guides/features/running-e2e.md Adds a detailed guide for running Kubernetes conformance tests using opct and related tools.
docs/opct/adm/baseline.md Updates baseline administration documentation with revised command details and improved output examples.
docs/guides/cluster-validation/installation-review.md Revises the installation review instructions and replaces outdated examples with a reference to opct adm parse-etcd-logs.
docs/devel/byo-plugin.md Removes legacy commented-out content.

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

Comments suppressed due to low confidence (1)

docs/opct/adm/baseline.md:8

  • There is a grammatical inconsistency: consider changing the line to 'The baseline results are automated executions that are automatically published to the result services.'
The baselines results are automated executions that is automatically published to the result services.
Review installation-review guide removing unnecessary etcd data which is
now addressed by a embedded/adm command.
@mtulio mtulio force-pushed the docs-v0.5-report-install-review branch from 8bf4ce9 to ff4e4b0 Compare March 3, 2025 21:11
@mtulio mtulio changed the title OPCT-263: docs: report updates, and install review OPCT-263: docs: review installation review guide removing etcd data Mar 3, 2025
@mtulio mtulio marked this pull request as ready for review March 3, 2025 21:12
@openshift-ci openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 3, 2025
@openshift-ci openshift-ci bot requested review from faermanj and jinhli March 3, 2025 21:12
@mtulio mtulio requested a review from Copilot March 3, 2025 21:12
@mtulio mtulio added target-release/opct-v0.5 kind/documentation Categorizes issue or PR as related to documentation. labels Mar 3, 2025
@mtulio mtulio changed the title OPCT-263: docs: review installation review guide removing etcd data OPCT-263: docs: review installation review guide removing etcd lof Mar 3, 2025
@mtulio mtulio changed the title OPCT-263: docs: review installation review guide removing etcd lof OPCT-263: docs: review installation review guide removing etcd log Mar 3, 2025
@mtulio mtulio requested review from Copilot and removed request for Copilot March 3, 2025 21:34
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

PR Overview

This PR updates the documentation to reflect the new embedded command for parsing etcd logs and removes obsolete log analysis instructions. Key changes include:

  • Replacing instructions that used the deprecated utility with references to the new opct adm parse-etcd-logs command.
  • Removing outdated output examples and related commentary.
  • Cleaning up commented-out sections in the BYO Plugin guide.

Reviewed Changes

File Description
docs/guides/cluster-validation/installation-review.md Updates descriptions to reference the new opct adm parse-etcd-logs command and removes obsolete examples.
docs/devel/byo-plugin.md Removes deprecated commented-out section related to BYO Plugin.

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (1)

docs/guides/cluster-validation/installation-review.md:129

  • [nitpick] Consider revising the phrase 'shows by buckets' for clarity; for example, 'displays results in buckets of 100ms increments' would improve readability.
The command `opct adm parse-etcd-logs` reads the logs, aggregates the requests and shows by buckets of 100ms from 200ms to 1s.

Comment on lines +131 to 132
`opct adm parse-etcd-logs` is the utility to help to troubleshoot the slow requests in the cluster, and help make decisions like changing the flavor of the block device used by the control plane, increasing IOPS, changing the flavor of the instances, etc.

Copy link
Preview

Copilot AI Mar 3, 2025

Choose a reason for hiding this comment

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

[nitpick] Consider removing the redundant 'to' in 'help to troubleshoot'; using 'help troubleshoot' makes the sentence more concise.

Suggested change
`opct adm parse-etcd-logs` is the utility to help to troubleshoot the slow requests in the cluster, and help make decisions like changing the flavor of the block device used by the control plane, increasing IOPS, changing the flavor of the instances, etc.
`opct adm parse-etcd-logs` is the utility to help troubleshoot the slow requests in the cluster, and help make decisions like changing the flavor of the block device used by the control plane, increasing IOPS, changing the flavor of the instances, etc.

Copilot is powered by AI, so mistakes are possible. Review output carefully before use.

Positive Feedback
Negative Feedback

Provide additional feedback

Please help us improve GitHub Copilot by sharing more details about this comment.

Please select one or more of the options
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation. target-release/opct-v0.5
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant