Skip to content

Commit 6a71c9a

Browse files
Removed emoji's since some aren't resolving
Updated section headers in README to improve formatting and clarity.
1 parent 8a71f11 commit 6a71c9a

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

oci_scanner_plugin/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Deploy all components with a single command:
1111
kubectl apply -f oci_scanner_plugin/
1212
```
1313

14-
## �� Components
14+
## Components
1515

1616
### 1. **NVlink RDMA exporter** (`go-plugin/`)
1717
**Custom OCI Lens metric collector with GPU and system monitoring**
@@ -100,7 +100,7 @@ kubectl apply -f oci_scanner_plugin/active-health-check/
100100
- GPU temperature and power monitoring
101101
- Error detection and reporting
102102

103-
## 🔧 Configuration
103+
## Configuration
104104

105105
### Prerequisites
106106
- Kubernetes cluster with GPU nodes
@@ -119,7 +119,7 @@ kubectl create namespace oci-monitoring
119119
- NVIDIA GPU nodes should have `nvidia.com/gpu` taint
120120
- Nodes must have appropriate GPU drivers installed
121121

122-
## �� Monitoring
122+
## Monitoring
123123

124124
### Access Metrics
125125
- **Node Exporter**: `http://node-ip:9100/metrics`
@@ -136,7 +136,7 @@ kubectl logs -l app=metrics-push-job -n oci-monitoring --tail=50
136136
kubectl logs -l app=amd-gpu-healthcheck -n monitoring
137137
```
138138

139-
## 🧹 Cleanup
139+
## Cleanup
140140

141141
Remove all components:
142142

@@ -187,7 +187,7 @@ kubectl run test-pod --image=curlimages/curl --rm -it --restart=Never -- curl ht
187187
3. **Push Gateway Unreachable**: Check network connectivity and URL configuration
188188
4. **Metrics Not Appearing**: Verify Prometheus scraping configuration
189189

190-
## 📚 Advanced Usage
190+
## Advanced Usage
191191

192192
### Custom GPU Types
193193
Modify the `GPU_TYPE` environment variable in the Go Plugin DaemonSet to support specific GPU architectures.
@@ -200,4 +200,4 @@ Configure Prometheus to scrape the exposed metrics endpoints or use the Push Gat
200200

201201
---
202202

203-
**Note**: This plugin is designed to work with OCI Lens but can be used independently for GPU monitoring on any Kubernetes cluster with GPU nodes.
203+
**Note**: This plugin is designed to work with OCI Lens but can be used independently for GPU monitoring on any Kubernetes cluster with GPU nodes.

0 commit comments

Comments
 (0)