Skip to content
This repository was archived by the owner on Sep 9, 2024. It is now read-only.

Commit d8a8f02

Browse files
committed
docs: add section on helm charts to README (#81)
Signed-off-by: Philip Brownlow <[email protected]>
1 parent b8d42c9 commit d8a8f02

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,44 @@ syncFrequency: 0s
181181
volumeStatsAggPeriod: 0s
182182
````
183183

184+
## Deploying the Kubernetes Power Manager using Helm
185+
186+
The Kubernetes Power Manager includes a helm chart for the latest releases, allowing the user to easily deploy
187+
everything that is needed for the overarching operator and the node agent to run. The following versions are
188+
supported with helm charts:
189+
190+
* v2.0.0
191+
* v2.1.0
192+
* v2.2.0
193+
* v2.3.0
194+
195+
When set up using the provided helm charts, the following will be deployed:
196+
197+
* The intel-power namespace
198+
* The RBAC rules for the operator and node agent
199+
* The operator deployment itself
200+
* The operator's power config
201+
* A shared power profile
202+
203+
To change any of the values the above are deployed with, edit the values.yaml file of the relevant helm chart.
204+
205+
To deploy the Kubernetes Power Manager using Helm, you must have Helm installed. For more information on installing
206+
Helm, see the installation guide here https://helm.sh/docs/intro/install/.
207+
208+
The Kubernetes Power Manager has make targets for each version available. To deploy the latest version, use the following command:
209+
210+
`make helm-install`
211+
212+
To uninstall the latest version, use the following command:
213+
214+
`make helm-uninstall`
215+
216+
Or you can use the following commands to deploy a specific version of the Kubernetes Power Manager:
217+
218+
`make helm-install-v2.2.0`
219+
`make helm-install-v2.1.0`
220+
`make helm-install-v2.0.0`
221+
184222
## Working environments
185223

186224
The Kubernetes Power Manager has been tested in different environments.

0 commit comments

Comments
 (0)