Updated docs
This commit is contained in:
@@ -75,26 +75,30 @@ topology with `cluster`, `node`, `pool`, `component`, `path`, and `leaf` labels:
|
|||||||
- `pve_node_zfs_write_errors`
|
- `pve_node_zfs_write_errors`
|
||||||
- `pve_node_zfs_checksum_errors`
|
- `pve_node_zfs_checksum_errors`
|
||||||
|
|
||||||
## Build
|
## Pull the Latest Image
|
||||||
|
|
||||||
|
The latest published version can be downloaded from the Gitea container registry:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
docker pull gitea.lostak.dev/lostakj/pve-exporter:latest
|
||||||
|
```
|
||||||
|
|
||||||
|
## Build Locally
|
||||||
|
|
||||||
To build the Docker image for PVE Exporter, use the following command:
|
To build the Docker image for PVE Exporter, use the following command:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
docker build --rm -t gitea.lostak.dev/lostakj/pve-exporter:version .
|
docker build --rm -t gitea.lostak.dev/lostakj/pve-exporter:latest .
|
||||||
```
|
```
|
||||||
|
|
||||||
Replace `version` with the appropriate version tag you want to use.
|
|
||||||
|
|
||||||
## Run
|
## Run
|
||||||
|
|
||||||
To run the Docker image, use the following command:
|
To run the downloaded or locally built image, use the following command:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
docker run --rm -d -p 9090:9090 --name pve-exporter gitea.lostak.dev/lostakj/pve-exporter:version
|
docker run --rm -d -p 9090:9090 --name pve-exporter gitea.lostak.dev/lostakj/pve-exporter:latest
|
||||||
```
|
```
|
||||||
|
|
||||||
Replace `version` with the appropriate version tag you used during the build.
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
Once the Docker container is running, the exporter will be available on port `9090`. You can configure Prometheus to scrape metrics from the exporter by adding a new scrape configuration to your Prometheus configuration file.
|
Once the Docker container is running, the exporter will be available on port `9090`. You can configure Prometheus to scrape metrics from the exporter by adding a new scrape configuration to your Prometheus configuration file.
|
||||||
|
|||||||
Reference in New Issue
Block a user