Skip to content

Commit

Permalink
Update helm docs (#151)
Browse files Browse the repository at this point in the history
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: sahibamittal <[email protected]>
  • Loading branch information
github-actions[bot] and sahibamittal authored Aug 28, 2024
1 parent cafba8a commit afc83b6
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions charts/hyades/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,29 @@ The GA roadmap for Hyades is tracked here: https://github.com/DependencyTrack/hy
| ingress.hostname | string | `"example.com"` | |
| ingress.ingressClassName | string | `""` | |
| ingress.tls | list | `[]` | |
| initializer.annotations | object | `{}` | |
| initializer.args | list | `[]` | |
| initializer.command | list | `[]` | |
| initializer.enabled | bool | `false` | Whether to enable the initializer Job. When enabled, an init container will be added to all deployments that require database access. The init container will wait for the initializer Job to complete. Requires the service account token to be mounted. |
| initializer.extraEnv | list | `[]` | |
| initializer.extraEnvFrom | list | `[]` | |
| initializer.image.pullPolicy | string | `"Always"` | |
| initializer.image.registry | string | `""` | Override common.image.registry for the API server. |
| initializer.image.repository | string | `"dependencytrack/hyades-apiserver"` | |
| initializer.image.tag | string | `"snapshot"` | Can be a tag name such as "latest", or an image digest prefixed with "sha256:". |
| initializer.noHelmHook | bool | `false` | Whether to NOT deploy the initializer Job as `post-install` and `post-upgrade` Helm hook. Deploying as Helm hook can create deadlock situations when `helm install` and `helm upgrade` are executed with `--wait` flag. See <https://github.com/helm/helm/issues/10555>. Note that without hooks, `helm upgrade` may fail due to Job fields being immutable. |
| initializer.nodeSelector | object | `{}` | |
| initializer.resources.limits.cpu | string | `"500m"` | |
| initializer.resources.limits.memory | string | `"256Mi"` | |
| initializer.resources.requests.cpu | string | `"150m"` | |
| initializer.resources.requests.memory | string | `"256Mi"` | |
| initializer.securityContext | object | `{"allowPrivilegeEscalation":false,"capabilities":{"drop":["ALL"]},"readOnlyRootFilesystem":true,"runAsNonRoot":true,"seccompProfile":{"type":"RuntimeDefault"}}` | Security context of the Container. |
| initializer.tolerations | list | `[]` | |
| initializer.waiter.createRole | bool | `true` | Whether to create a Role with permissions to wait for Job completion, and bind it to the ServiceAccount. |
| initializer.waiter.image.pullPolicy | string | `"Always"` | |
| initializer.waiter.image.registry | string | `"docker.io"` | |
| initializer.waiter.image.repository | string | `"bitnami/kubectl"` | |
| initializer.waiter.image.tag | string | `"latest"` | |
| mirrorService.additionalVolumeMounts | list | `[]` | |
| mirrorService.additionalVolumes | list | `[]` | |
| mirrorService.annotations | object | `{}` | |
Expand Down

0 comments on commit afc83b6

Please sign in to comment.