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

OADP - 3343 Update Using the must-gather tool #70665

Merged
merged 1 commit into from
Feb 5, 2024

Conversation

@openshift-ci openshift-ci bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jan 23, 2024
@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Jan 23, 2024

🤖 Sun Feb 04 12:37:23 - Prow CI generated the docs preview: https://70665--ocpdocs-pr.netlify.app

Copy link

@weshayutin weshayutin left a comment

Choose a reason for hiding this comment

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

thanks!
/LGTM

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jan 23, 2024
@PrasadJoshi12
Copy link

@CarmiWisemon I think PR is missing below flag. This flag is needed when customer has configured s3url with prefix https:// and insecureSkipTLSVerify: true flag set on DPA
oc adm must-gather --image=registry.access.redhat.com/oadp/oadp-mustgather-rhel9:1.3.0-138 – /usr/bin/gather_without_tls true

@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Jan 24, 2024
@CarmiWisemon
Copy link
Contributor Author

@CarmiWisemon I think PR is missing below flag. This flag is needed when customer has configured s3url with prefix https:// and insecureSkipTLSVerify: true flag set on DPA oc adm must-gather --image=registry.access.redhat.com/oadp/oadp-mustgather-rhel9:1.3.0-138 – /usr/bin/gather_without_tls true

@PrasadJoshi12

Where in the document and how should it be included?

@PrasadJoshi12
Copy link

@CarmiWisemon I think PR is missing below flag. This flag is needed when customer has configured s3url with prefix https:// and insecureSkipTLSVerify: true flag set on DPA oc adm must-gather --image=registry.access.redhat.com/oadp/oadp-mustgather-rhel9:1.3.0-138 – /usr/bin/gather_without_tls true

@PrasadJoshi12

Where in the document and how should it be included?

Maybe we can add this instructions under this section "Combining options when using the must-gather tool".

If DPA is configured with s3Url and having insecureSkipTLS flat set to true in that case it will not collect the necessary logs due to missing CA cert. In order to collect those logs execute must gather command with below option.
oc adm must-gather --image=registry.access.redhat.com/oadp/oadp-mustgather-rhel9:1.3.0-138 – /usr/bin/gather_without_tls true

@openshift-ci openshift-ci bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jan 25, 2024
@CarmiWisemon CarmiWisemon force-pushed the oadp3343-mustgather branch 4 times, most recently from b9135f9 to bcfde28 Compare January 30, 2024 09:58
@CarmiWisemon
Copy link
Contributor Author

/label OADP
/label peer-review-needed

@openshift-ci openshift-ci bot added OADP Label for all OADP PRs peer-review-needed Signifies that the peer review team needs to review this PR labels Jan 30, 2024
@openshift-ci openshift-ci bot 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 labels Feb 1, 2024
@CarmiWisemon
Copy link
Contributor Author

/label merge-review-needed

@openshift-ci openshift-ci bot added the merge-review-needed Signifies that the merge review team needs to review this PR label Feb 1, 2024
@opayne1 opayne1 added merge-review-in-progress Signifies that the merge review team is reviewing this PR and removed merge-review-needed Signifies that the merge review team needs to review this PR labels Feb 1, 2024
@opayne1 opayne1 added this to the Continuous Release milestone Feb 1, 2024
Copy link
Contributor

@opayne1 opayne1 left a comment

Choose a reason for hiding this comment

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

Just a couple things to consider before merging. Just ping me when you are ready!

@@ -18,3 +18,10 @@ The only other variables that you can specify this way are the following:

* `logs_since`, with a default value of `72h`
* `request_timeout`, with a default value of `0s`

If DataProtectionApplication (DPA) is configured with `s3Url` and `insecureSkipTLS: true`, the CR does not collect the necessary logs because of a missing CA certificate. To collect those logs, run the `must-gather` command with the following option:
Copy link
Contributor

Choose a reason for hiding this comment

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

I haven't seen DataProtectionApplication (DPA) written that way in the docs, but I have seen it with backticks which would make sense to me. Just wanted to check on this.

Suggested change
If DataProtectionApplication (DPA) is configured with `s3Url` and `insecureSkipTLS: true`, the CR does not collect the necessary logs because of a missing CA certificate. To collect those logs, run the `must-gather` command with the following option:
If `DataProtectionApplication` custom resource (CR) is configured with `s3Url` and `insecureSkipTLS: true`, the CR does not collect the necessary logs because of a missing CA certificate. To collect those logs, run the `must-gather` command with the following option:

@@ -28,6 +28,8 @@ endif::[]

* You must be logged in to the {product-title} cluster as a user with the `cluster-admin` role.
* You must have the OpenShift CLI (`oc`) installed.
* For use with OADP 1.2 you must use {op-system-base-full} 8.x.
Copy link
Contributor

Choose a reason for hiding this comment

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

To keep your bullets consistent consider:

Suggested change
* For use with OADP 1.2 you must use {op-system-base-full} 8.x.
* You must use {op-system-base-full} 8.x with OADP 1.2.

@@ -28,6 +28,8 @@ endif::[]

* You must be logged in to the {product-title} cluster as a user with the `cluster-admin` role.
* You must have the OpenShift CLI (`oc`) installed.
* For use with OADP 1.2 you must use {op-system-base-full} 8.x.
* For use with OADP 1.3 you must use {op-system-base-full} {op-system-version}.
Copy link
Contributor

Choose a reason for hiding this comment

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

Same for this one:

Suggested change
* For use with OADP 1.3 you must use {op-system-base-full} {op-system-version}.
* You must use {op-system-base-full} {op-system-version} with OADP 1.3 y.

@@ -40,10 +42,18 @@ endif::[]
ifdef::oadp-troubleshooting[]
* Full `must-gather` data collection, including Prometheus metrics:
endif::[]
.. For OADP 1.2 use the following command:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
.. For OADP 1.2 use the following command:
.. For OADP 1.2, use the following command:

oc adm must-gather --image=registry.redhat.io/oadp/oadp-mustgather-rhel8:v1.2
----
+
.. For OADP 1.3 use the following command:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
.. For OADP 1.3 use the following command:
.. For OADP 1.3, use the following command:

@@ -73,12 +83,17 @@ endif::[]
ifdef::oadp-troubleshooting[]
* Prometheus metrics data dump:
endif::[]
.. For OADP 1.2 use the following command:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
.. For OADP 1.2 use the following command:
.. For OADP 1.2, use the following command:

----
.. For OADP 1.3 use the following command:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
.. For OADP 1.3 use the following command:
.. For OADP 1.3, use the following command:

Copy link

openshift-ci bot commented Feb 4, 2024

@CarmiWisemon: all tests passed!

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

@CarmiWisemon
Copy link
Contributor Author

Just a couple things to consider before merging. Just ping me when you are ready!

@opayne1
Thank you for your feedback.
I made the changes you requested.
Please merge the PR.
Thank you!!!
Carmi

Copy link
Contributor

@opayne1 opayne1 left a comment

Choose a reason for hiding this comment

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

/lgtm

@opayne1 opayne1 merged commit 64373c0 into openshift:main Feb 5, 2024
2 checks passed
@opayne1
Copy link
Contributor

opayne1 commented Feb 5, 2024

/cherrypick enterprise-4.13

@opayne1
Copy link
Contributor

opayne1 commented Feb 5, 2024

/cherrypick enterprise-4.14

@opayne1
Copy link
Contributor

opayne1 commented Feb 5, 2024

/cherrypick enterprise-4.15

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Feb 5, 2024
@openshift-cherrypick-robot

@opayne1: new pull request created: #71166

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.

@openshift-cherrypick-robot

@opayne1: new pull request created: #71167

In response to this:

/cherrypick enterprise-4.15

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.

@openshift-cherrypick-robot

@opayne1: new pull request created: #71168

In response to this:

/cherrypick enterprise-4.13

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
branch/enterprise-4.13 branch/enterprise-4.14 branch/enterprise-4.15 lgtm Indicates that a PR is ready to be merged. merge-review-in-progress Signifies that the merge review team is reviewing this PR OADP Label for all OADP PRs peer-review-done Signifies that the peer review team has reviewed this PR size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

8 participants