diff --git a/deployment/pcm/README.md b/deployment/pcm/README.md index 5b587778..3102695e 100644 --- a/deployment/pcm/README.md +++ b/deployment/pcm/README.md @@ -4,22 +4,22 @@ Helm chart instructions ### Features: -- privilege and non-privileged container (value: `privileged`), -- bare-metal and VM host configurations (files: [values-metal.yaml](), [values-vm.yaml]()), +- Configurable as non-privileged container (value: `privileged=false` / default) and privileged container, +- Support for bare-metal and VM host configurations (files: [values-metal.yaml](values-metal.yaml), [values-vm.yaml](values-metal.yaml)), - Ability to deploy multiple releases alongside configured differently to handle different kinds of machines (bare-metal, VM) at the [same time](#heterogeneous-mixed-vmmetal-instances-cluster), -- 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`) -- Linux Watchdog handling (controlled with PCM_KEEP_NMI_WATCHDOG, PCM_NO_AWS_WORKAROUND, nmiWatchdogMount values) +- 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`). +- Linux Watchdog handling (controlled with PCM_KEEP_NMI_WATCHDOG, PCM_NO_AWS_WORKAROUND, nmiWatchdogMount values). - Deploy to own namespace with "helm install ... **-n pcm --create-namespace**" #### Integration features: - node-feature-discovery based nodeSelector and nodeAffinity (values: nfd, nfdBaremetalAffinity, nfdRDTAffinity), -- 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), +- 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](values-smarter-devices-cpu-mem.yaml) ), - Integration with NRI balloons policy plugin (value: `nriBalloonsPolicyIntegration`), #### Debugging features: -- Local image registry for development (file: values-local-image.yaml), +- Local image registry for development (file: [values-local-image.yaml](values-local-image.yaml) ), - Deploy Prometheus operator' PodMonitor (value: `podMonitor`) ### Getting started @@ -165,7 +165,7 @@ Check that resctrl is available inside kind node: docker exec kind-control-plane ls /sys/fs/resctrl/info ``` -Export kind kubeconfig as default for furhter kubectl commands: +Export kind kubeconfig as default for further kubectl commands: ``` kind export kubeconfig ```