Skip to content

Commit 319e364

Browse files
committed
Updated README.md for oci-scanner-plugin-helm
1 parent 0712af7 commit 319e364

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

oci-scanner-plugin-helm/README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Multi-vendor GPU monitoring and health check solution for OCI compute instances
1515
- **Node Problem Detector**: GPU health monitoring via DRHPC integration (requires labeling)
1616
- **OpenCost**: Cost tracking and resource allocation metrics (via subchart)
1717

18-
## Configuration
18+
## Installation Configuration
1919

2020
```bash
2121
helm dependency build
@@ -24,26 +24,28 @@ helm dependency update
2424
helm install oci-gpu-scanner-plugin . -f values.yaml -n oci-gpu-scanner-plugin \
2525
--set global.pushGatewayUrl="<your-push-gateway-url>" \
2626
--create-namespace
27+
```
2728

28-
# Enable health check
29-
helm upgrade oci-gpu-scanner-plugin ./oci-scanner-plugin-helm \
30-
-n oci-gpu-scanner-plugin \
31-
--set healthCheck.enabled=true
32-
33-
# Enable Node Problem Detector (requires node labeling and drhpc to be enabled- see below)
34-
helm upgrade oci-gpu-scanner-plugin . \
35-
--set nodeProblemDetector.enabled=true \
36-
--set drhpc.enabled=true
29+
The following plugins are enabled by default; if you want to disable it set the following flags when install/upgrade:
30+
```bash
31+
# health check
32+
--set healthCheck.enabled=false
3733

38-
# Disable OpenCost (enabled by default)
39-
helm install oci-gpu-scanner-plugin . -f values.yaml -n oci-gpu-scanner-plugin \
34+
# Node Problem Detector (requires node labeling and drhpc to be disabled
35+
--set nodeProblemDetector.enabled=false \
36+
--set drhpc.enabled=false
37+
```
38+
**Cost Tracking**: OpenCost is enabled by default to provide cost visibility for Kubernetes workloads. See [cost_tracking.md](cost_tracking.md) for detailed metrics.
39+
```bash
40+
# Disable OpenCost
4041
--set opencost.enabled=false
42+
```
4143

42-
# Uninstall
44+
**Uninstall**:
45+
```bash
4346
helm uninstall oci-gpu-scanner-plugin -n oci-gpu-scanner-plugin
4447
```
4548

46-
**Cost Tracking**: OpenCost is enabled by default to provide cost visibility for Kubernetes workloads. See [cost_tracking.md](cost_tracking.md) for detailed metrics.
4749

4850
## Requirements
4951

0 commit comments

Comments
 (0)