Skip to content

Commit

Permalink
update etcd doc
Browse files Browse the repository at this point in the history
  • Loading branch information
nvanthao committed Aug 13, 2024
1 parent c87098a commit c57d21b
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions docs/source/collect/etcd.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ etcdctl endpoint health
etcdctl endpoint status
etcdctl member list
etcdctl alarm list
etcdctl version
```

This collector is compatible with the following Kubernetes distributions:
Expand All @@ -20,7 +21,11 @@ This collector is compatible with the following Kubernetes distributions:

## Parameters

The `etcd` collector supports the [shared collector properties](https://troubleshoot.sh/docs/collect/collectors/#shared-properties) and no additional parameters.
The `etcd` collector supports the [shared collector properties](https://troubleshoot.sh/docs/collect/collectors/#shared-properties) and following parameters.

##### `image` (optional)

The image for pod to run `etcdctl` commands. Default to `quay.io/coreos/etcd:latest`

See the examples below for use cases.

Expand All @@ -33,7 +38,8 @@ metadata:
name: etcd-collector
spec:
collectors:
- etcd: {}
- etcd:
image: quay.io/coreos/etcd:latest
```
## Included resources
Expand Down Expand Up @@ -117,3 +123,10 @@ Contains the output of the command `etcdctl alarm list --write-out json`.
}
}
```

### /etcd/version.json

```json
etcdctl version: 3.5.1
API version: 3.5
```

0 comments on commit c57d21b

Please sign in to comment.