Skip to content

Commit

Permalink
Update helm-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
J12934 committed Jul 5, 2021
1 parent dae9726 commit f1c0417
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions helm/multi-juicer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ MultiJuicer gives you the ability to run separate Juice Shop instances for every

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| balancer.affinity | object | `{}` | |
| balancer.affinity | object | `{}` | Optional Configure kubernetes scheduling affinity for the created JuiceShops (see: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#affinity-and-anti-affinity) |
| balancer.cookie.cookieParserSecret | string | `nil` | Set this to a fixed random alpa-numeric string (recommended length 24 chars). If not set this get randomly generated with every helm upgrade, each rotation invalidates all active cookies / sessions requirering users to login again. |
| balancer.cookie.name | string | `"balancer"` | Changes the cookies name used to identify teams. Note will automatically be prefixed with "__Secure-" when balancer.cookie.secure is set to `true` |
| balancer.cookie.secure | bool | `false` | |
Expand All @@ -41,13 +41,14 @@ MultiJuicer gives you the ability to run separate Juice Shop instances for every
| balancer.service.type | string | `"ClusterIP"` | Kubernetes service type |
| balancer.skipOwnerReference | bool | `false` | If set to true this skips setting ownerReferences on the teams JuiceShop Deployment and Services. This lets MultiJuicer run in older kubernetes cluster which don't support the reference type or the app/v1 deployment type |
| balancer.tag | string | `nil` | |
| balancer.tolerations | list | `[]` | |
| balancer.tolerations | list | `[]` | Optional Configure kubernetes toleration for the created JuiceShops (see: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) |
| imagePullPolicy | string | `"Always"` | |
| ingress.annotations | object | `{}` | |
| ingress.enabled | bool | `false` | |
| ingress.hosts[0].host | string | `"multi-juicer.local"` | |
| ingress.hosts[0].paths[0] | string | `"/"` | |
| ingress.tls | list | `[]` | |
| juiceShop.affinity | object | `{}` | Optional Configure kubernetes scheduling affinity for the created JuiceShops (see: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#affinity-and-anti-affinity) |
| juiceShop.config | string | See values.yaml for full details | Specify a custom Juice Shop config.yaml. See the JuiceShop Config Docs for more detail: https://pwning.owasp-juice.shop/part1/customization.html#yaml-configuration-file |
| juiceShop.ctfKey | string | `"zLp@.-6fMW6L-7R3b!9uR_K!NfkkTr"` | Change the key when hosting a CTF event. This key gets used to generate the challenge flags. See: https://pwning.owasp-juice.shop/part1/ctf.html#overriding-the-ctfkey |
| juiceShop.env | list | `[]` | Optional environment variables to set for each JuiceShop instance (see: https://kubernetes.io/docs/tasks/inject-data-application/define-environment-variable-container/) |
Expand All @@ -57,10 +58,11 @@ MultiJuicer gives you the ability to run separate Juice Shop instances for every
| juiceShop.nodeEnv | string | `"multi-juicer"` | Specify a custom NODE_ENV for JuiceShop. If value is changed to something other than 'multi-juicer' it's not possible to set a custom config via `juiceShop.config`. |
| juiceShop.resources | object | `{"requests":{"cpu":"150m","memory":"200Mi"}}` | Optional resources definitions to set for each JuiceShop instance |
| juiceShop.securityContext | object | `{}` | |
| juiceShop.tag | string | `"v12.7.1"` | |
| juiceShop.tag | string | `"v12.8.1"` | |
| juiceShop.tolerations | list | `[]` | Optional Configure kubernetes toleration for the created JuiceShops (see: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) |
| juiceShop.volumeMounts | list | `[]` | |
| juiceShop.volumes | list | `[]` | Optional Volumes to set for each JuiceShop instance (see: https://kubernetes.io/docs/concepts/storage/volumes/) |
| juiceShopCleanup.affinity | object | `{}` | |
| juiceShopCleanup.affinity | object | `{}` | Optional Configure kubernetes scheduling affinity for the JuiceShopCleanup Job(see: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#affinity-and-anti-affinity) |
| juiceShopCleanup.cron | string | `"0 * * * *"` | Cron in which the clean up job is run. Defaults to once in an hour. Change this if your grace period if shorter than 1 hour |
| juiceShopCleanup.enabled | bool | `true` | |
| juiceShopCleanup.failedJobsHistoryLimit | int | `1` | |
Expand All @@ -71,14 +73,16 @@ MultiJuicer gives you the ability to run separate Juice Shop instances for every
| juiceShopCleanup.securityContext | object | `{}` | |
| juiceShopCleanup.successfulJobsHistoryLimit | int | `1` | |
| juiceShopCleanup.tag | string | `nil` | |
| juiceShopCleanup.tolerations | list | `[]` | |
| juiceShopCleanup.tolerations | list | `[]` | Optional Configure kubernetes toleration for the JuiceShopCleanup Job (see: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) |
| nodeSelector | object | `{}` | |
| progressWatchdog.affinity | object | `{}` | Optional Configure kubernetes scheduling affinity for the ProgressWatchdog (see: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#affinity-and-anti-affinity) |
| progressWatchdog.repository | string | `"iteratec/progress-watchdog"` | |
| progressWatchdog.resources.limits.cpu | string | `"20m"` | |
| progressWatchdog.resources.limits.memory | string | `"48Mi"` | |
| progressWatchdog.resources.requests.cpu | string | `"20m"` | |
| progressWatchdog.resources.requests.memory | string | `"48Mi"` | |
| progressWatchdog.securityContext | object | `{}` | |
| progressWatchdog.tag | string | `nil` | |
| progressWatchdog.tolerations | list | `[]` | Optional Configure kubernetes toleration for the ProgressWatchdog (see: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) |
| service.port | int | `3000` | |
| service.type | string | `"ClusterIP"` | |

0 comments on commit f1c0417

Please sign in to comment.