Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

document: [issue-1401]: Added documenation for helm values in helm collector #534

Merged
merged 2 commits into from
Jan 23, 2024
+39 −15
Merged

document: [issue-1401]: Added documenation for helm values in helm collector #534

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2d9cb5c
document: [issue-1401]: Added documenation for helm values in helm co…
avaakash Dec 26, 2023
a8bad5e
added values example for helm
avaakash Jan 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 39 additions & 15 deletions docs/source/collect/helm.md
View file
Open in desktop
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,27 +73,49 @@ 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:
`/helm/[namespace].json`

```json
[
{
"releaseName": "mysql-1692919203",
"chart": "mysql",
"chartVersion": "9.10.9",
"appVersion": "8.0.34",
"namespace": "default",
"releaseHistory": [
{
"revision": "1",
"date": "2023-08-25 11:20:05.153483 +1200 NZST",
"status": "deployed"
}
]
}
{
"releaseName": "mysql-1692919203",
"chart": "mysql",
"chartVersion": "9.10.9",
"appVersion": "8.0.34",
"namespace": "default",
"releaseHistory": [
{
"revision": "1",
"date": "2023-08-25 11:20:05.153483 +1200 NZST",
"status": "deployed",
"values": {
"affinity": {},
"image": {
"digest": "",
"pullPolicy": "IfNotPresent",
"pullSecrets": [],
"registry": "docker.io",
"repository": "bitnami/git",
"tag": "2.41.0-debian-11-r76"
},
},
}
}
]
```

Expand All @@ -113,4 +138,3 @@ The namespace of the helm release

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