Skip to content

Conversation

@opayne1
Copy link
Contributor

@opayne1 opayne1 commented Mar 27, 2023

[WIP]OSDOCS-5259: MicroShift sos reports

Version(s):
4.13 only

Issue:
https://issues.redhat.com/browse/OSDOCS-5259

Link to docs preview:
https://57828--docspreview.netlify.app/microshift/latest/microshift_support/microshift-sos-report.html

QE review:

  • QE has approved this change.

Additional information:

@opayne1 opayne1 added this to the Planned for 4.13 GA milestone Mar 27, 2023
@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Mar 27, 2023
@openshift-ci-robot
Copy link

openshift-ci-robot commented Mar 27, 2023

@opayne1: This pull request references OSDOCS-5259 which is a valid jira issue.

In response to this:

[WIP]OSDOCS-5259: MicroShift sos reports

Version(s):
4.13 only

Issue:

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

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-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 27, 2023
@openshift-ci-robot
Copy link

openshift-ci-robot commented Mar 27, 2023

@opayne1: This pull request references OSDOCS-5259 which is a valid jira issue.

In response to this:

[WIP]OSDOCS-5259: MicroShift sos reports

Version(s):
4.13 only

Issue:
https://issues.redhat.com/browse/OSDOCS-5259

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

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.

2 similar comments
@openshift-ci-robot
Copy link

openshift-ci-robot commented Mar 27, 2023

@opayne1: This pull request references OSDOCS-5259 which is a valid jira issue.

In response to this:

[WIP]OSDOCS-5259: MicroShift sos reports

Version(s):
4.13 only

Issue:
https://issues.redhat.com/browse/OSDOCS-5259

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

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-ci-robot
Copy link

openshift-ci-robot commented Mar 27, 2023

@opayne1: This pull request references OSDOCS-5259 which is a valid jira issue.

In response to this:

[WIP]OSDOCS-5259: MicroShift sos reports

Version(s):
4.13 only

Issue:
https://issues.redhat.com/browse/OSDOCS-5259

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

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-ci openshift-ci bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Mar 27, 2023
@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 Mar 29, 2023
@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Mar 29, 2023

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

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

@openshift-ci-robot
Copy link

openshift-ci-robot commented Mar 29, 2023

@opayne1: This pull request references OSDOCS-5259 which is a valid jira issue.

In response to this:

[WIP]OSDOCS-5259: MicroShift sos reports

Version(s):
4.13 only

Issue:
https://issues.redhat.com/browse/OSDOCS-5259

Link to docs preview:
https://57828--docspreview.netlify.app/microshift/latest/microshift_support/microshift-sos-report.html

QE review:

  • QE has approved this change.

Additional information:

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.

@opayne1 opayne1 changed the title [WIP]OSDOCS-5259: MicroShift sos reports OSDOCS-5259: MicroShift sos reports Mar 30, 2023
@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 30, 2023
+
[source,terminal]
----
$ sudo report --upload
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
$ sudo report --upload
$ sudo sos report --upload

We should verify that this is how support wants this done.

Choose a reason for hiding this comment

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

I tried to test the above but it looks like above command collects the sos report again and uploads it. It does not upload existing report. May be we should add a command here which actually uploads the existing sos report instead of generating a new one ?

Above command generates sos report for whole system and just not for microshift.

Copy link
Contributor

Choose a reason for hiding this comment

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

@vwalek can you help with this procedure? Do we usually tell users to generate a report and then upload it, or is uploading it when the report is generated normal?

Copy link
Contributor

Choose a reason for hiding this comment

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

@dhellmann yes, we will first collect the sosreport and use the redhat attachment tool to upload that. I haven't seen the option to --upload, but I will check it on my lab.

Copy link
Contributor

Choose a reason for hiding this comment

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

Hi. looking at the definition of the upload, the upload should be used if you have specific server you want to push it.

  --upload              Upload archive to a policy-default location
  --upload-url UPLOAD_URL
                        Upload the archive to specified server
  --upload-directory UPLOAD_DIRECTORY
                        Specify upload directory for archive
  --upload-user UPLOAD_USER
                        Username to authenticate to server with
  --upload-pass UPLOAD_PASS
                        Password to authenticate to server with
  --upload-method {auto,put,post}
                        HTTP method to use for uploading
  --upload-no-ssl-verify
                        Disable SSL verification for upload url
  --upload-protocol {auto,https,ftp,sftp}
                        Manually specify the upload protocol

I am not sure if we want to document that you can push it directly to some location.

I would leave it optional, like you can push it to your own server using SFTP, SCP or HTTP protocols.

Usually, the sosreport is collected to the bastion host and use of the redhat attachment tool or run the tool directly from the RHEL system.

I don't think the --upload should be part of the sos collection docs.

When running the sos report the system will ask you the ticket number to upload it directly, but that's optional.

Choose a reason for hiding this comment

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

Thanks !!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you! We will leave those out.

@dhellmann
Copy link
Contributor

lgtm, thank you!

@kasturinarra
Copy link

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Apr 14, 2023
@openshift-ci-robot
Copy link

openshift-ci-robot commented Apr 14, 2023

@opayne1: This pull request references OSDOCS-5259 which is a valid jira issue.

In response to this:

[WIP]OSDOCS-5259: MicroShift sos reports

Version(s):
4.13 only

Issue:
https://issues.redhat.com/browse/OSDOCS-5259

Link to docs preview:
https://57828--docspreview.netlify.app/microshift/latest/microshift_support/microshift-sos-report.html

QE review:

  • QE has approved this change.

Additional information:

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.

@opayne1 opayne1 added the peer-review-needed Signifies that the peer review team needs to review this PR label Apr 14, 2023
+
[source,terminal]
----
$ sos report --upload --batch --clean --all-logs --profile microshift
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
$ sos report --upload --batch --clean --all-logs --profile microshift
$ sos report --batch --clean --all-logs --profile microshift

Based on @vwalek 's comments, I think we want to remove the upload option that I had suggested adding previously.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

updated. Thanks!

@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Apr 14, 2023
@dhellmann
Copy link
Contributor

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Apr 14, 2023
@GroceryBoyJr
Copy link
Contributor

/remove-label peer-review-needed
/label peer-review-in-progress

@openshift-ci openshift-ci bot added peer-review-in-progress Signifies that the peer review team is reviewing this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels Apr 14, 2023
@GroceryBoyJr
Copy link
Contributor

/label peer-review-done
/remove-label peer-review-in-progress

@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 Apr 14, 2023
Copy link
Contributor

@GroceryBoyJr GroceryBoyJr 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 20604e5 into openshift:main Apr 14, 2023
@opayne1
Copy link
Contributor Author

opayne1 commented Apr 14, 2023

/cherrypick enterprise-4.13

@openshift-cherrypick-robot

@opayne1: new pull request created: #58753

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 jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. lgtm Indicates that a PR is ready to be merged. peer-review-done Signifies that the peer review team has reviewed this PR size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants