From 7e2cd01f1adb3516419c772dc748adf08fa81492 Mon Sep 17 00:00:00 2001 From: Ruslan Mstoi Date: Mon, 11 Apr 2022 17:45:05 +0300 Subject: [PATCH] README: document helm charts Signed-off-by: Ruslan Mstoi --- README.md | 5 +++++ charts/README.md | 20 ++++++++++++++++++++ 2 files changed, 25 insertions(+) create mode 100644 charts/README.md diff --git a/README.md b/README.md index 57f49552..3c81687a 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,7 @@ Table of Contents * [License](#license) * [Security](#security) * [Related code](#related-code) +* [Helm charts](#helm-charts) ## Prerequisites @@ -336,3 +337,7 @@ how Intel works to resolve security issues, see [Vulnerability Handling Guidelin ## Related code A related Intel SRIOV network device plugin can be found in [this repository](https://github.com/intel/sriov-network-device-plugin) + +### Helm charts + +The [helm charts](charts/README.md) is one way of distributing Kubernetes resources of the device plugins framework. diff --git a/charts/README.md b/charts/README.md new file mode 100644 index 00000000..4ee3c4a2 --- /dev/null +++ b/charts/README.md @@ -0,0 +1,20 @@ +## Helm charts + +Make "helm" target provides a way to to create a versioned chart archive file: + +``` +$ make helm +``` + +The generated chart archives can be uploaded to helm package repository to enable further distribution. It is also needed to generate an index file and upload it to the repository. + +``` +helm repo index intel-device-plugins-operator-VERSION.tgz +``` + +To download a chart directly from a repository, use the following commands: + +``` +$ helm pull intel-device-plugins-chart-repo/intel-device-plugins-helm-chart +$ helm install intel-device-plugins intel-device-plugins-chart-repo/intel-device-plugins-helm-chart +```