Running pods during collection time to create data
Looking for the old Run collector? See: Run (Deprecated)
runPod collector can be used to run a pod in the cluster with the parameters provided.
The collector will delete and clean up this pod and any artifacts after it's created.
This collector can be included multiple times, each defining different commands to run.
In addition to the shared collector properties, the
runPod collector accepts the following parameters:
The name of the collector. This will be prefixed to the path that the output is written to in the support bundle. This is also used as the name of the pod and must meet pod naming criteria
The namespace to look for the pod selector in. If not specified, it will assume the "current" namespace that the kubectl context is set to.
Introduced in Troubleshoot v0.33.0.
corev1.PodSpec for the
runPod collector. See the Kubernetes API Reference for all available properties.
A duration that will be honored when running the pod. This cannot be greater than 30 seconds (30s) and if not specified, the default is 20s.
Troubleshoot offers the ability to use ImagePullSecrets, either using the name of a pre-existing secret in the
podSpec or dynamically creating a temporary secret to extract the image and destroy it after run-collector is done.
The ImagePullSecret field at the collector level accepts the following parameters:
A string indicating that the secret is of type "kubernetes.io/dockerconfigjson".
To let Troubleshoot create an ImagePullSecret for the run collector to pull the image:
imagePullSecret: name: mysecret data: .dockerconfigjson: ewoJICJhdXRocyI6IHsKCQksHR0cHM6Ly9pbmRleC5kb2NrZXIuaW8vdjEvIjoge30KCX0sCgkiSHR0cEhlYWRlcnMiOiB7CgkJIlVzZXItQWdlbnQiOiAiRG9ja2VyLUNsaWVudC8xOS4wMy4xMiAoZGFyd2luKSIKCX0sCgkiY3JlZHNTdG9yZSI6ICJkZXNrdG9wIiwKCSJleHBlcmltZW50YWwiOiAiZGlzYWJsZWQiLAoJInN0YWNrT3JjaGVzdHJhdG9yIjogInN3YXJtIgp9 type: kubernetes.io/dockerconfigjson
Further information about config.json file and dockerconfigjson secrets may be found here.
To use an existing ImagePullSecret:
podSpec: containers: - args: ["go", "run", "main.go"] image: my-private-repository/myRestApi imagePullSecrets: - name: my-image-pull-secret
See the examples below for use cases.
apiVersion: troubleshoot.sh/v1beta2 kind: SupportBundle metadata: name: sample spec: collectors: - runPod: name: "run-ping" namespace: default podSpec: containers: - name: run-ping image: busybox:1 command: ["ping"] args: ["-w", "5", "www.google.com"]
Troubleshoot will create a temporary secret, use it to pull the image from the private repository and delete it after the run collector is completed.
spec: collectors: - runPod: name: "myPrivateApp" namespace: default imagePullSecret: name: my-temporary-secret data: .dockerconfigjson: ewoJICJhdXRocyI6IHsKzCQksHR0cHM6Ly9pbmRleC5kb2NrZXIuaW8vdjEvIjoge30KCX0sCgkiSHR0cEhlYWRlcnMiOiB7CgkJIlVzZXItQWdlbnQiOiAiRG9ja2VyLUNsaWVudC8xOS4wMy4xMiAoZGFyd2luKSIKCX0sCgkiY3JlZHNTdG9yZSI6ICJkZXNrdG9wIiwKCSJleHBlcmltZW50YWwiOiAiZGlzYWJsZWQiLAoJInN0YWNrT3JjaGVzdHJhdG9yIjogInN3YXJtIgp9 type: kubernetes.io/dockerconfigjson podSpec: containers: - args: ["go", "run", "main.go"] image: my-private-repository/myRestApi
When this collector is executed, it will include the following files in a support bundle:
This will contain the pod output (up to 10000 lines).