mirrors/kyverno
mirrors/kyverno
1
0
Fork 0
mirror of https://github.com/kyverno/kyverno.git synced 2025-03-31 03:45:17 +00:00
Code Activity

Fix Helm chart README.md for Helm 3

Browse source
This commit is contained in:
Michael Barrientos 2020-05-13 02:15:36 -07:00
parent a3889d8c39
commit b328dc6ff1
No known key found for this signature in database
GPG key ID: 6A578A6BD88D0398
1 changed files with 8 additions and 6 deletions

14
charts/kyverno/README.md
View file

@ -11,7 +11,7 @@
## TL;DR; ## TL;DR;
```console ```console
$ helm install -n kyverno ./kyverno $ helm install --create-namespace -n kyverno kyverno ./kyverno
``` ```
## Introduction ## Introduction
@ -23,9 +23,11 @@ This chart bootstraps a Kyverno deployment on a [Kubernetes](http://kubernetes.i
Kyverno makes assumptions about naming of namespaces and resources. Therefore, the chart must be installed with the default release name `kyverno` (default if --name is omitted) and in the namespace 'kyverno': Kyverno makes assumptions about naming of namespaces and resources. Therefore, the chart must be installed with the default release name `kyverno` (default if --name is omitted) and in the namespace 'kyverno':
```console ```console
$ helm install --namespace kyverno --name kyverno ./kyverno $ helm install --namespace kyverno kyverno ./kyverno
``` ```
Note that Helm by default expects the namespace to already exist before running helm install. If you want Helm to create the namespace, add --create-namespace to the command.
The command deploys kyverno on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation. The command deploys kyverno on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation.
## Uninstalling the Chart ## Uninstalling the Chart
@ -33,7 +35,7 @@ The command deploys kyverno on the Kubernetes cluster in the default configurati
To uninstall/delete the `kyverno` deployment: To uninstall/delete the `kyverno` deployment:
```console ```console
$ helm delete -n kyverno $ helm delete -n kyverno kyverno
``` ```
The command removes all the Kubernetes components associated with the chart and deletes the release. The command removes all the Kubernetes components associated with the chart and deletes the release.
@ -83,14 +85,14 @@ Parameter | Description | Default
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
```console ```console
$ helm install --namespace kyverno --name kyverno ./kyverno \ $ helm install --namespace kyverno kyverno ./kyverno \
--set=image.tag=v0.0.2,resources.limits.cpu=200m --set=image.tag=v0.0.2,resources.limits.cpu=200m
``` ```
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,
```console ```console
$ helm install --namespace kyverno --name kyverno ./kyverno -f values.yaml $ helm install --namespace kyverno kyverno ./kyverno -f values.yaml
``` ```
> **Tip**: You can use the default [values.yaml](values.yaml) > **Tip**: You can use the default [values.yaml](values.yaml)
@ -99,4 +101,4 @@ $ helm install --namespace kyverno --name kyverno ./kyverno -f values.yaml
If `createSelfSignedCert` is `true`, Helm will take care of the steps of creating an external self-signed certificate describe in option 2 of the [installation documentation](https://github.com/nirmata/kyverno/blob/master/documentation/installation.md#option-2-use-your-own-ca-signed-certificate) If `createSelfSignedCert` is `true`, Helm will take care of the steps of creating an external self-signed certificate describe in option 2 of the [installation documentation](https://github.com/nirmata/kyverno/blob/master/documentation/installation.md#option-2-use-your-own-ca-signed-certificate)
If `createSelfSignedCert` is `false`, Kyverno will generate a pair using the kube-controller-manager., or you can provide your own TLS CA and signed-key pair and create the secret yourself as described in the documentation. If `createSelfSignedCert` is `false`, Kyverno will generate a pair using the kube-controller-manager., or you can provide your own TLS CA and signed-key pair and create the secret yourself as described in the documentation.