Skip to content

Commit c9616ae

Browse files
committed
make pdate-readme-tools
Signed-off-by: Swarup Ghosh <[email protected]>
1 parent b614f4a commit c9616ae

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,8 @@ The following sets of tools are available (all on by default):
213213

214214
<summary>config</summary>
215215

216+
- **configuration_contexts_list** - List all available context names and associated server urls from the kubeconfig file
217+
216218
- **configuration_view** - Get the current Kubernetes configuration content as a kubeconfig YAML
217219
- `minified` (`boolean`) - Return a minified version of the configuration. If set to true, keeps only the current-context and the relevant pieces of the configuration for that context. If set to false, all contexts, clusters, auth-infos, and users are returned in the configuration. (Optional, default true)
218220

@@ -294,6 +296,19 @@ The following sets of tools are available (all on by default):
294296
- `name` (`string`) **(required)** - Name of the resource
295297
- `namespace` (`string`) - Optional Namespace to delete the namespaced resource from (ignored in case of cluster scoped resources). If not provided, will delete resource from configured namespace
296298

299+
- **plan_mustgather** - Plan for collecting a must-gather archive from an OpenShift cluster, must-gather is a tool for collecting cluster data related to debugging and troubleshooting like logs, kubernetes resources, etc.
300+
- `all_component_images` (`boolean`) - Optional when enabled, collects and runs multiple must gathers for all operators and components on the cluster that have an annotated must-gather image available
301+
- `gather_command` (`string`) - Optionally specify a custom gather command to run a specialized script, eg. /usr/bin/gather_audit_logs
302+
- `host_network` (`boolean`) - Optionally run the must-gather pods in the host network of the node. This is only relevant if a specific gather image needs to capture host-level data
303+
- `images` (`array`) - Optional list of images to use for gathering custom information about specific operators or cluster components. If not specified, OpenShift's default must-gather image will be used by default
304+
- `keep_namespace` (`boolean`) - Optional to retain all temporary resources when the mustgather completes, otherwise temporary resources created will be cleaned up
305+
- `namespace` (`string`) - Optional to specify an existing privileged namespace where must-gather pods should run. If not provided, a temporary namespace will be created
306+
- `node_name` (`string`) - Optional node to run the mustgather pod. If not provided, a random control-plane node will be selected automatically
307+
- `node_selector` (`string`) - Optional node label selector to use, only relevant when specifying a command and image which needs to capture data on a set of cluster nodes simultaneously
308+
- `since` (`string`) - Optional to collect logs newer than a relative duration like 5s, 2m5s, or 3h6m10s. If unspecified, all available logs will be collected
309+
- `source_dir` (`string`) - Optional to set a specific directory where the pod will copy gathered data from
310+
- `timeout` (`string`) - Timeout of the gather process eg. 30s, 6m20s, or 2h10m30s
311+
297312
</details>
298313

299314
<details>

0 commit comments

Comments
 (0)