Skip to content

Commit

Permalink
document: [issue-1401]: Added documenation for helm values in helm co…
Browse files Browse the repository at this point in the history
…llector

Signed-off-by: Akash Shrivastava <[email protected]>
  • Loading branch information
avaakash committed Jan 12, 2024
1 parent 357ccfc commit 2d9cb5c
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions docs/source/collect/helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ The name of the helm release. If not specified, all releases will be searched or

**Note:** if both `namespace` and `releaseName` are not specified, all releases in all namespaces will be collected.

#### `collectValues`(Optional)
If set to `true`, the values of the helm release will be collected. Defaults to `false`.

## Example Collector Definitions

Collect All Helm Releases in All Namespaces:
Expand Down Expand Up @@ -70,6 +73,18 @@ spec:
releaseName: mysql-1692919203
```
Collect All Helm Releases in All Namespaces with Helm Values:
```yaml
apiVersion: troubleshoot.sh/v1beta2
kind: SupportBundle
metadata:
name: sample
spec:
collectors:
- helm:
collectValues: true
```
## Included resources
When this collector is executed, it will include the following files in a support bundle:
Expand All @@ -87,7 +102,8 @@ When this collector is executed, it will include the following files in a suppor
{
"revision": "1",
"date": "2023-08-25 11:20:05.153483 +1200 NZST",
"status": "deployed"
"status": "deployed",
"values": {},
}
]
}
Expand All @@ -113,4 +129,3 @@ The namespace of the helm release

#### `releaseHistory`
The history of the helm release

0 comments on commit 2d9cb5c

Please sign in to comment.