Skip to content

Commit

Permalink
Update runPod collector documentation (#537)
Browse files Browse the repository at this point in the history
* Update runPod collector documentation

* Add the time it takes to wait to terminate the pod
  • Loading branch information
banjoh authored Jan 17, 2024
1 parent 357ccfc commit de327eb
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 9 deletions.
5 changes: 2 additions & 3 deletions docs/source/collect/deprecated/run.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,7 @@ In addition to the [shared collector properties](https://troubleshoot.sh/docs/co
The name of the collector. This will be prefixed to the path that the output is written to in the support bundle.

##### `namespace` (Optional)
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.
The namespace to schedule the pod in. If not specified, it will assume the "current" namespace that the kubectl context is set to.

##### `image` (Required)
The image to run when starting the pod. This should be accessible to the nodes in the cluster.
Expand Down Expand Up @@ -74,7 +73,7 @@ imagePullSecret:

Further information about config.json file and dockerconfigjson secrets may be found [here](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/).

See the examples below for use cases.
See the examples below for use cases.

## Example Collector Definition

Expand Down
10 changes: 4 additions & 6 deletions docs/source/collect/run-pod.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,7 @@ The name of the collector. This will be prefixed to the path that the output is
This is also used as the name of the pod and must meet pod naming criteria

##### `namespace` (Optional)
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.
The namespace to schedule the pod in. If not specified, the "default" namespace will be used

##### `podSpec` (Required)

Expand All @@ -28,8 +27,7 @@ If not specified, it will assume the "current" namespace that the kubectl contex
The `corev1.PodSpec` for the `runPod` collector. See the [Kubernetes API Reference](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#PodSpec) for all available properties.

##### `timeout` (Optional)
A [duration](https://golang.org/pkg/time/#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.
A [duration](https://golang.org/pkg/time/#Duration) that will be honored when running the pod. If the timeout ellapses, the pod is terminated. Troubleshoot waits for a maximum of `60s` for the pod to safely terminate, then forcefully deletes it. If the timeout is not specified, the collector will run for as long as the underlying command does.

#### `imagePullSecret` (Optional)

Expand Down Expand Up @@ -64,7 +62,7 @@ Further information about config.json file and dockerconfigjson secrets may be f
- name: my-image-pull-secret
```
See the examples below for use cases.
See the examples below for use cases.
## Example Collector Definition
Expand All @@ -78,7 +76,7 @@ spec:
- runPod:
name: "run-ping"
namespace: default
podSpec:
podSpec:
containers:
- name: run-ping
image: busybox:1
Expand Down

0 comments on commit de327eb

Please sign in to comment.