CORTX-32645: New script: get-logs-from-pvc.sh

walterlopatka commented 2 years ago

Description

This is a new tool to collect log files from PVC for the case when a Pod is not running and support bundle cannot collect this data otherwise. This is intended to be a support or advanced tool for a special circumstance.

This uses a Kubernetes job to start a Pod that mounts the PVC specified by the user. It tars the contents of the PVC into tmp. The script then kubectl cp's the tar file to the local host.

This script provides basic error checking, but there are some inputs that can cause problems, such as specifying a PVC that does not exist in the specified namespace. In this case the script with hang with the collector pod in "Pending" state. (This is pretty obvious from script stdout.)

Type of change

[ ] Bug fix (non-breaking change that fixes an issue)
[x] New feature (non-breaking change that adds new functionality)
[ ] Breaking change (bug fix or new feature that breaks existing functionality)
[ ] Third-party dependency update
[ ] Documentation additions or improvements
[ ] Code quality improvements to existing code or test additions/updates

Applicable issues

This change fixes an issue: CORTX-32645

CORTX image version requirements

N/A

How was this tested?

Local testing of various cortx PVCs.

Checklist

[x] The change is tested and works locally.
[ ] New or changed settings in the solution YAML are documented clearly in the README.md file.
[x] All commits are signed off and are in agreement with the CORTX Community DCO and CLA policy.

If this change requires newer CORTX or third party image versions:

[ ] The image fields in solution.example.yaml have been updated to use the required versions.
[ ] The appVersion field of the Helm chart has been updated to use the new CORTX version.

If this change addresses a CORTX Jira issue:

[x] The title of the PR starts with the issue ID (e.g. CORTX-XXXXX:)

walterlopatka commented 2 years ago

I'm not sure of this needs any additional documentation. Maybe I should add something to the troubleshooting section of README. Hopefully this tack of using a job to tar the PVC contents, and then kubectl cp to the local host is good enough to satisfy the request.

osowski commented 2 years ago

lgtm

Well it looks good once the Shellcheck error is fixed.

Seagate / cortx-k8s