openshift-sos-plugin is an oc plugin to aid with gather information (status, logging, configuration, etc) from your OpenShift cluster.
NOTE: OpenShift CLI Plugins were added in v3.7 so make sure your oc binary version is up-to-date.
NOTE: The OpenShfit SOS Plugin utilizes a bash script. Make sure you are running from a bash interpreter before executing!
- Clone repository into your
~/.kube/pluginsdirectory:
# git clone https://github.com/bostrt/openshift-sos-plugin ~/.kube/plugins/openshift-sos-plugin
- Ensure the plugin is available by running:
# oc plugin
...
Available Commands:
sos Plugin for gathering various types of data from OpenShift.
- Finally, run the plugin:
# oc plugin sos -n testing
Data capture complete and archived in /tmp/oc-sos-testing-2018-01-25.tar.xz
After installation, you can run the plugin using the oc command. The prequisite is that you are logged into a cluster via the oc command.
Default behavior is to use your current namespace/project active in oc:
# oc plugin sos
Data capture complete and archived in /tmp/oc-sos-testing-2018-01-25.tar.xz
You can also specify another namespace/project using the standard OpenShift -n flag:
# oc plugin sos -n testing
Data capture complete and archived in /tmp/oc-sos-testing-2018-01-25.tar.xz
If you want to change the output format, use the standard -o flag. JSON output is default:
# oc plugin sos -n testing -o yaml
Data capture complete and archived in /tmp/oc-sos-testing-2018-01-25.tar.xz