Skip to content

Commit c761cbd

Browse files
committed
docs: add shp buildrun gather command documentation
Signed-off-by: karthik balasubramanian <karthikbalasubramanian08@gmail.com>
1 parent e18ffda commit c761cbd

2 files changed

Lines changed: 45 additions & 0 deletions

File tree

docs/shp_buildrun.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ shp buildrun [flags]
2626
* [shp buildrun cancel](shp_buildrun_cancel.md) - Cancel BuildRun
2727
* [shp buildrun create](shp_buildrun_create.md) - Creates a BuildRun instance.
2828
* [shp buildrun delete](shp_buildrun_delete.md) - Delete BuildRun
29+
* [shp buildrun gather](shp_buildrun_gather.md) - Gather BuildRun diagnostics into a single directory or archive.
2930
* [shp buildrun list](shp_buildrun_list.md) - List Builds
3031
* [shp buildrun logs](shp_buildrun_logs.md) - See BuildRun log output
3132

docs/shp_buildrun_gather.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
## shp buildrun gather
2+
3+
Gather BuildRun diagnostics into a single directory or archive.
4+
5+
### Synopsis
6+
7+
8+
Gather collects the BuildRun object, the TaskRun created for it, the Pod created
9+
for that TaskRun, and all the container logs into a single directory.
10+
11+
By default the command writes:
12+
13+
buildrun.yaml
14+
taskrun.yaml
15+
pod.yaml
16+
logs/*.log
17+
18+
Use --archive to package the gathered files as a .tar.gz archive.
19+
20+
21+
```
22+
shp buildrun gather <name> [flags]
23+
```
24+
25+
### Options
26+
27+
```
28+
-z, --archive package gathered diagnostics as a .tar.gz archive
29+
-h, --help help for gather
30+
-o, --output string directory to write gathered files (default ".")
31+
```
32+
33+
### Options inherited from parent commands
34+
35+
```
36+
--kubeconfig string Path to the kubeconfig file to use for CLI requests.
37+
-n, --namespace string If present, the namespace scope for this CLI request
38+
--request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
39+
```
40+
41+
### SEE ALSO
42+
43+
* [shp buildrun](shp_buildrun.md) - Manage BuildRuns
44+

0 commit comments

Comments
 (0)