Skip to content

Commit 7c9a243

Browse files
committed
fix old wrong defaults in README
1 parent a577dac commit 7c9a243

File tree

1 file changed

+14
-19
lines changed

1 file changed

+14
-19
lines changed

deployment/pcm/README.md

Lines changed: 14 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,22 @@ Helm chart instructions
55
### Features:
66

77
- privilege and non-privileged container (value: `privileged`),
8-
- node-feature-discovery based nodeSelector and nodeAffinity (values: nfd, nfdBaremetalAffinity, nfdRDTAffinity)
98
- bare-metal and VM host configurations (files: values-metal.yaml, values-vm.yaml),
109
- Ability to deploy multiple releases alongside configured differently to handle different kinds of machines (bare-metal, VM) at the same time,
11-
- Examples for non-privileged mode using device plugin ("smarter-devices-manager") or using NRI device-injector plugin (TODO) (file: values-smarter-devices-cpu-mem.yaml),
12-
- Deploy Prometheus operator' PodMonitor (value: `podMonitor`)
13-
- Integration with NRI balloons policy plugin (value: `nriBalloonsPolicyIntegration`),
1410
- Controllable set of metrics and method of collection (RDT, uncore), support direct (msr) and indirect (Linux abstractions perf/resctrl) counter accesses (file: values-indirect.yaml)
1511
- Linux Watchdog handling (controlled with PCM_KEEP_NMI_WATCHDOG, PCM_NO_AWS_WORKAROUND, nmiWatchdogMount values)
1612
- Deploy to own namespace with "helm install ... **-n pcm --create-namespace**"
17-
- Local image registry for development (file: values-local-image.yaml),
1813

19-
TODO/Ideas:
20-
- [ ] Refactor extra features: node-feature-discovery, NRI interegration only as extra values for generic fields (annotations, nodeSelector/nodeAffinity)
21-
- [ ] Check if energy metrics can be accessible through perf subsystem
22-
- [ ] GitHub actions for linter/security scanners,
23-
- [ ] Idea: Change metrics names (follow Prometheus best practices)
24-
- [ ] Idea: init container to check permission for all required components (devices/CPU)
25-
- [ ] Implement Helm chart test pods + NOTES
26-
- [ ] Test liveness/readiness probes
27-
- [ ] Testing in Cluster Manager Systems like (e.g. Ranger,Gardener) different node types VM(1socket,all sockets), bare-metal
28-
- [ ] Test in different cloud GCP/Azure/AWS
14+
#### Integration features:
15+
16+
- node-feature-discovery based nodeSelector and nodeAffinity (values: nfd, nfdBaremetalAffinity, nfdRDTAffinity),
17+
- Examples for non-privileged mode using device plugin ("smarter-devices-manager") or using NRI device-injector plugin (TODO) (file: values-smarter-devices-cpu-mem.yaml),
18+
- Integration with NRI balloons policy plugin (value: `nriBalloonsPolicyIntegration`),
19+
20+
#### Debugging features:
21+
22+
- Local image registry for development (file: values-local-image.yaml),
23+
- Deploy Prometheus operator' PodMonitor (value: `podMonitor`)
2924

3025
### Getting started
3126

@@ -63,11 +58,11 @@ helm upgrade --install pcm . --set privileged=false --set nfd=true --set podMoni
6358

6459
### Requirements
6560

66-
- Full set of metrics requires metal instance (uncore metrics, RDT, energy, UPI),
61+
- Full set of metrics requires bare-metal or .metal instance (uncore metrics, RDT, energy, UPI),
6762
- Core metrics (instructions, cycles are also available) on VM instances,
68-
- In both case "msr" kernel module has to be loaded in host OS,
69-
- pod is allowed to be run with privileged capabilities (SYS_ADMIN, SYS_RAWIO) on given namespace,
70-
- Pod Security Standards allow to run on privileged level,
63+
- /sys/fs/resctrl has to be mounted on host OS,
64+
- pod is allowed to be run with privileged capabilities (SYS_ADMIN, SYS_RAWIO) on given namespace in other words: Pod Security Standards allow to run on privileged level,
65+
7166
```
7267
pod-security.kubernetes.io/enforce: privileged
7368
pod-security.kubernetes.io/enforce-version: latest

0 commit comments

Comments
 (0)