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

feat: add how to manually collect node data #696

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

Conversation

Yu-Jack
Copy link
Collaborator

@Yu-Jack Yu-Jack commented Dec 26, 2024

@Yu-Jack Yu-Jack self-assigned this Dec 26, 2024
Copy link

@innobead innobead left a comment

Choose a reason for hiding this comment

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

Technically, LGTM.

P.S. It might be worth directly providing a script for this execution.

docs/troubleshooting/harvester.md Outdated Show resolved Hide resolved
Copy link

github-actions bot commented Dec 26, 2024

Name Link
🔨 Latest commit bf95cee
😎 Deploy Preview https://676e70a9c3164cd954a04df5--harvester-preview.netlify.app

@Yu-Jack
Copy link
Collaborator Author

Yu-Jack commented Dec 26, 2024

New Script: rancher/support-bundle-kit#130

@bk201
Copy link
Member

bk201 commented Dec 27, 2024

some suggestions to the script change: rancher/support-bundle-kit#130 (comment)

@Yu-Jack
Copy link
Collaborator Author

Yu-Jack commented Dec 27, 2024

Use a more common approach for both air-gapped and networked environments.

@Yu-Jack
Copy link
Collaborator Author

Yu-Jack commented Dec 27, 2024

Since we need to consider the air-gapped environment, I think using a common approach would be a suitable option for all different users. Alternatively, separating two different guidelines and scripts for different targets could be hardly managed. So I closed support bundle PR. @bk201 @innobead Thank you for advices.

@innobead
Copy link

Since we need to consider the air-gapped environment, I think using a common approach would be a suitable option for all different users. Alternatively, separating two different guidelines and scripts for different targets could be hardly managed. So I closed support bundle PR. @bk201 @innobead Thank you for advices.

The updated doc looks good to me.

Copy link
Contributor

@jillian-maroket jillian-maroket left a comment

Choose a reason for hiding this comment

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

Review done

Comment on lines +208 to +212
### Manually Collect Node Bunndle

If node is not ready or down, support bundle kit can't collect data. Please follow these steps to manually collect data.

1. Run script to prepare envioronment.
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
### Manually Collect Node Bunndle
If node is not ready or down, support bundle kit can't collect data. Please follow these steps to manually collect data.
1. Run script to prepare envioronment.
### Manually Collect Data for Support Bundle
Harvester is unable to collect data and generate a support bundle when the node is inaccessible or not ready. The workaround is to run a script and compress the generated files.
1. Prepare the environment.

Comment on lines +213 to +217
```sh
mkdir -p /tmp/support-bundle # ensure /tmp/support-bundle exists
echo JOURNALCTL="/usr/bin/journalctl -o short-precise" > /tmp/common
export SUPPORT_BUNDLE_NODE_NAME=$(hostname)
```
Copy link
Contributor

Choose a reason for hiding this comment

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

Please indent this code block.

Comment on lines +218 to +222
2. Run `curl -o collector-harvester https://raw.githubusercontent.com/rancher/support-bundle-kit/refs/heads/master/hack/collector-harvester` to download script
3. Run `chmod +x collector-harvester`
3. Run `./collector-harvester / /tmp/support-bundle`

After finishing this process, please compress the `/tmp/support-bundle` and attach it with the related issue.
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
2. Run `curl -o collector-harvester https://raw.githubusercontent.com/rancher/support-bundle-kit/refs/heads/master/hack/collector-harvester` to download script
3. Run `chmod +x collector-harvester`
3. Run `./collector-harvester / /tmp/support-bundle`
After finishing this process, please compress the `/tmp/support-bundle` and attach it with the related issue.
1. Run the following commands:
- Download the script: `curl -o collector-harvester https://raw.githubusercontent.com/rancher/support-bundle-kit/refs/heads/master/hack/collector-harvester`
- Add executable permissions: `chmod +x collector-harvester`
- Run the script: `./collector-harvester / /tmp/support-bundle`
1. Compress the files in `/tmp/support-bundle`, and then attach the archive to the related issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants