Skip to content

Commit

Permalink
helm-chart: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
matheusfm committed May 17, 2023
1 parent c018286 commit 2bced5d
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions charts/zora/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Zora Helm Chart

![Version: 0.5.2-rc1](https://img.shields.io/badge/Version-0.5.2--rc1-informational?style=flat-square&color=3CA9DD) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square&color=3CA9DD) ![AppVersion: v0.5.2-rc1](https://img.shields.io/badge/AppVersion-v0.5.2--rc1-informational?style=flat-square&color=3CA9DD)
![Version: 0.6.0-rc1](https://img.shields.io/badge/Version-0.6.0--rc1-informational?style=flat-square&color=3CA9DD) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square&color=3CA9DD) ![AppVersion: v0.6.0-rc1](https://img.shields.io/badge/AppVersion-v0.6.0--rc1-informational?style=flat-square&color=3CA9DD)

Zora scans multiple Kubernetes clusters and reports potential issues.

Expand All @@ -12,7 +12,7 @@ To install the chart with the release name `zora`:
helm repo add undistro https://charts.undistro.io --force-update
helm upgrade --install zora undistro/zora \
-n zora-system \
--version 0.5.2-rc1 \
--version 0.6.0-rc1 \
--create-namespace --wait
```

Expand Down Expand Up @@ -97,12 +97,15 @@ The following table lists the configurable parameters of the Zora chart and thei
| scan.plugins.marvin.enabled | bool | `true` | Specifies whether the marvin plugin should be created |
| scan.plugins.marvin.resources | object | `{"limits":{"cpu":"500m","memory":"500Mi"},"requests":{"cpu":"250m","memory":"256Mi"}}` | [Resources](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers) to add to `marvin` container |
| scan.plugins.marvin.image.repository | string | `"ghcr.io/undistro/marvin"` | marvin plugin image repository |
| scan.plugins.marvin.image.tag | string | `"v0.1.4"` | marvin plugin image tag |
| scan.plugins.marvin.image.tag | string | `"v0.1.6"` | marvin plugin image tag |
| scan.plugins.popeye.enabled | bool | `true` | Specifies whether the popeye plugin should be created |
| scan.plugins.popeye.skipInternalResources | bool | `false` | Specifies whether the following resources should be skipped by `popeye` scans. 1. resources from `kube-system`, `kube-public` and `kube-node-lease` namespaces; 2. kubernetes system reserved RBAC (prefixed with `system:`); 3. `kube-root-ca.crt` configmaps; 4. `default` namespace; 5. `default` serviceaccounts; 6. Helm secrets (prefixed with `sh.helm.release`); 7. Zora components. See `popeye` configuration file that is used for this case: https://github.com/undistro/zora/blob/main/charts/zora/templates/plugins/popeye-config.yaml |
| scan.plugins.popeye.resources | object | `{"limits":{"cpu":"500m","memory":"500Mi"},"requests":{"cpu":"250m","memory":"256Mi"}}` | [Resources](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers) to add to `popeye` container |
| scan.plugins.popeye.image.repository | string | `"ghcr.io/undistro/popeye"` | popeye plugin image repository |
| scan.plugins.popeye.image.tag | string | `"pr252"` | popeye plugin image tag |
| kubexnsImage.repository | string | `"ghcr.io/undistro/kubexns"` | kubexns image repository |
| kubexnsImage.tag | string | `"v0.1.1"` | kubexns image tag |
| customChecksConfigMap | string | `"zora-custom-checks"` | Custom checks ConfigMap name |

Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,

Expand Down

0 comments on commit 2bced5d

Please sign in to comment.