diff --git a/library/common/1.0.0/docs/controllers.md b/library/common/1.0.0/docs/controllers.md new file mode 100644 index 0000000000..b0d85e5776 --- /dev/null +++ b/library/common/1.0.0/docs/controllers.md @@ -0,0 +1,41 @@ +# Controllers + +| Key | Type | Required | Helm Template | Default | Description | +| :------------------------------------------------------- | :-------: | :------: | :-----------: | :---------------------------------------------------: | :----------------------------------------------------------------------------------- | +| controllers | `dict` | ❌ | ❌ | `{}` | Define the controllers as dicts | +| controllers.[controller-name] | `dict` | ✅ | ❌ | `{}` | Holds controller definition | +| controllers.[controller-name].enabled | `boolean` | ✅ | ❌ | `false` | Enables or Disables the controller | +| controllers.[controller-name].primary | `boolean` | ✅ | ❌ | `false` | Sets the controller as primary | +| controllers.[controller-name].labels | `dict` | ❌ | ✅ | `{}` | Additional labels for controller | +| controllers.[controller-name].annotations | `dict` | ❌ | ✅ | `{}` | Additional annotations for controller | +| controllers.[controller-name].type | `string` | ✅ | ❌ | `""` | Define the kind of the controller (Deployment, DaemonSet, StatefulSet, CronJob, Job) | +| controllers.[controller-name].podSpec | `dict` | ✅ | ❌ | `{}` | Holds the pod definition | +| controllers.[controller-name].podSpec.labels | `dict` | ❌ | ✅ | `{}` | Pod Labels | +| controllers.[controller-name].podSpec.annotations | `dict` | ❌ | ✅ | `{}` | Pod Annotations | +| controllers.[controller-name].podSpec.hostNetwork | `boolean` | ❌ | ❌ | `{{ .Values.podOptions.hostNetwork }}` (false) | Pod's hostNetwork | +| controllers.[controller-name].podSpec.enableServiceLinks | `boolean` | ❌ | ❌ | `{{ .Values.podOptions.enableServiceLinks }}` (false) | Pod's enableServiceLinks | +| controllers.[controller-name].podSpec.restartPolicy | `string` | ❌ | ❌ | `{{ .Values.podOptions.restartPolicy }}` (Always) | Pod's restartPolicy. (Always, Never, OnFailure) | + +--- + +Appears in: + +- `.Values.controllers` + +--- + +Naming scheme: + +- Primary: `$FullName` (release-name-chart-name) +- Non-Primary: `$FullName-$ControllerName` (release-name-chart-name-controller-name) + +--- + +> Those are the common `keys` for all controllers. +> Additional keys, information and examples, see on the specific kind of controller + +- [Deployment](deployment.md) +- [DaemonSet](daemonset.md) +- [StatefulSet](statefulset.md) +- [CronJob](cronjob.md) +- [Job](job.md) diff --git a/library/common/1.0.0/docs/cronjob.md b/library/common/1.0.0/docs/cronjob.md index ea13e043e9..a6f9131319 100644 --- a/library/common/1.0.0/docs/cronjob.md +++ b/library/common/1.0.0/docs/cronjob.md @@ -2,13 +2,6 @@ | Key | Type | Required | Helm Template | Default | Description | | :------------------------------------------------------- | :-------: | :------: | :-----------: | :---------------------------------------------------: | :---------------------------------------------------- | -| controllers | `dict` | ❌ | ❌ | `{}` | Define the controllers as dicts | -| controllers.[controller-name] | `dict` | ✅ | ❌ | `{}` | Holds controller definition | -| controllers.[controller-name].enabled | `boolean` | ✅ | ❌ | `false` | Enables or Disables the controller | -| controllers.[controller-name].primary | `boolean` | ✅ | ❌ | `false` | Sets the controller as primary | -| controllers.[controller-name].labels | `dict` | ❌ | ✅ | `{}` | Additional labels for controller | -| controllers.[controller-name].annotations | `dict` | ❌ | ✅ | `{}` | Additional annotations for controller | -| controllers.[controller-name].type | `string` | ✅ | ❌ | `""` | Define the type (kind) of the controller | | controllers.[controller-name].schedule | `string` | ✅ | ✅ | `""` | Define the schedule | | controllers.[controller-name].timezone | `string` | ❌ | ✅ | `{{ .Values.TZ }}` | Define the timezone | | controllers.[controller-name].concurrencyPolicy | `string` | ❌ | ✅ | `Forbid` | Define the concurrencyPolicy (Allow, Replace, Forbid) | @@ -21,24 +14,12 @@ | controllers.[controller-name].parallelism | `int` | ❌ | ❌ | `1` | Define the parallelism | | controllers.[controller-name].ttlSecondsAfterFinished | `int` | ❌ | ❌ | `120` | Define the ttlSecondsAfterFinished | | controllers.[controller-name].activeDeadlineSeconds | `int` | ❌ | ❌ | | Define the activeDeadlineSeconds | -| controllers.[controller-name].podSpec | `dict` | ✅ | ❌ | `{}` | Holds the pod definition | -| controllers.[controller-name].podSpec.labels | `dict` | ❌ | ✅ | `{}` | Pod Labels | -| controllers.[controller-name].podSpec.annotations | `dict` | ❌ | ✅ | `{}` | Pod Annotations | -| controllers.[controller-name].podSpec.hostNetwork | `boolean` | ❌ | ❌ | `{{ .Values.podOptions.hostNetwork }}` (false) | Pod's hostNetwork | -| controllers.[controller-name].podSpec.enableServiceLinks | `boolean` | ❌ | ❌ | `{{ .Values.podOptions.enableServiceLinks }}` (false) | Pod's enableServiceLinks | --- -Appears in: +Notes: -- `.Values.controllers` - ---- - -Naming scheme: - -- Primary: `$FullName` (release-name-chart-name) -- Non-Primary: `$FullName-$ControllerName` (release-name-chart-name-controller-name) +View common `keys` of `controllers` in [Controllers Documentation](controllers.md). --- @@ -69,6 +50,7 @@ controllers: annotations: {} hostNetwork: false enableServiceLinks: false + restartPolicy: OnFailure other-controller-name: enabled: true diff --git a/library/common/1.0.0/docs/daemonset.md b/library/common/1.0.0/docs/daemonset.md index d7041ff3f2..d889e85fce 100644 --- a/library/common/1.0.0/docs/daemonset.md +++ b/library/common/1.0.0/docs/daemonset.md @@ -1,36 +1,18 @@ # DaemonSet -| Key | Type | Required | Helm Template | Default | Description | -| :--------------------------------------------------------- | :-------: | :------: | :-----------: | :---------------------------------------------------: | :------------------------------------------------------------------- | -| controllers | `dict` | ❌ | ❌ | `{}` | Define the controllers as dicts | -| controllers.[controller-name] | `dict` | ✅ | ❌ | `{}` | Holds controller definition | -| controllers.[controller-name].enabled | `boolean` | ✅ | ❌ | `false` | Enables or Disables the controller | -| controllers.[controller-name].primary | `boolean` | ✅ | ❌ | `false` | Sets the controller as primary | -| controllers.[controller-name].labels | `dict` | ❌ | ✅ | `{}` | Additional labels for controller | -| controllers.[controller-name].annotations | `dict` | ❌ | ✅ | `{}` | Additional annotations for controller | -| controllers.[controller-name].type | `string` | ✅ | ❌ | `""` | Define the type (kind) of the controller | -| controllers.[controller-name].strategy | `string` | ❌ | ❌ | `RollingUpdate` | Define the strategy of the controller (OnDelete, RollingUpdate) | -| controllers.[controller-name].rollingUpdate | `dict` | ❌ | ❌ | `{}` | Holds the rollingUpdate options, Only when strategy is RollingUpdate | -| controllers.[controller-name].rollingUpdate.maxUnavailable | `int` | ❌ | ❌ | | Define the maxUnavailable, Only when strategy is RollingUpdate | -| controllers.[controller-name].rollingUpdate.maxSurge | `int` | ❌ | ❌ | | Define the maxSurge, Only when strategy is RollingUpdate | -| controllers.[controller-name].podSpec | `dict` | ✅ | ❌ | `{}` | Holds the pod definition | -| controllers.[controller-name].podSpec.labels | `dict` | ❌ | ✅ | `{}` | Pod Labels | -| controllers.[controller-name].podSpec.annotations | `dict` | ❌ | ✅ | `{}` | Pod Annotations | -| controllers.[controller-name].podSpec.hostNetwork | `boolean` | ❌ | ❌ | `{{ .Values.podOptions.hostNetwork }}` (false) | Pod's hostNetwork | -| controllers.[controller-name].podSpec.enableServiceLinks | `boolean` | ❌ | ❌ | `{{ .Values.podOptions.enableServiceLinks }}` (false) | Pod's enableServiceLinks | +| Key | Type | Required | Helm Template | Default | Description | +| :--------------------------------------------------------- | :-------: | :------: | :-----------: | :---------------------------------------------------: | :-------------------------------------------------------------------------- | +| controllers.[controller-name].strategy | `string` | ❌ | ❌ | `RollingUpdate` | Define the strategy of the controller (OnDelete, RollingUpdate) | +| controllers.[controller-name].rollingUpdate | `dict` | ❌ | ❌ | `{}` | Holds the rollingUpdate options, Only when strategy is RollingUpdate | +| controllers.[controller-name].rollingUpdate.maxUnavailable | `int` | ❌ | ❌ | | Define the maxUnavailable, Only when strategy is RollingUpdate | +| controllers.[controller-name].rollingUpdate.maxSurge | `int` | ❌ | ❌ | | Define the maxSurge, Only when strategy is RollingUpdate | --- +Notes: -Appears in: +View common `keys` of `controllers` in [Controllers Documentation](controllers.md). -- `.Values.controllers` - ---- - -Naming scheme: - -- Primary: `$FullName` (release-name-chart-name) -- Non-Primary: `$FullName-$ControllerName` (release-name-chart-name-controller-name) +> Value of `controllers.[controller-name].podSpec.restartPolicy` can only be `Always` for this type of controller --- @@ -55,6 +37,7 @@ controllers: annotations: {} hostNetwork: false enableServiceLinks: false + restartPolicy: Always other-controller-name: enabled: true diff --git a/library/common/1.0.0/docs/deployment.md b/library/common/1.0.0/docs/deployment.md index 612ad7b28f..418dcb0227 100644 --- a/library/common/1.0.0/docs/deployment.md +++ b/library/common/1.0.0/docs/deployment.md @@ -1,36 +1,19 @@ # Deployment -| Key | Type | Required | Helm Template | Default | Description | -| :--------------------------------------------------------- | :-------: | :------: | :-----------: | :---------------------------------------------------: | :------------------------------------------------------------------- | -| controllers | `dict` | ❌ | ❌ | `{}` | Define the controllers as dicts | -| controllers.[controller-name] | `dict` | ✅ | ❌ | `{}` | Holds controller definition | -| controllers.[controller-name].enabled | `boolean` | ✅ | ❌ | `false` | Enables or Disables the controller | -| controllers.[controller-name].primary | `boolean` | ✅ | ❌ | `false` | Sets the controller as primary | -| controllers.[controller-name].labels | `dict` | ❌ | ✅ | `{}` | Additional labels for controller | -| controllers.[controller-name].annotations | `dict` | ❌ | ✅ | `{}` | Additional annotations for controller | -| controllers.[controller-name].type | `string` | ✅ | ❌ | `""` | Define the type (kind) of the controller | -| controllers.[controller-name].strategy | `string` | ❌ | ❌ | `Recreate` | Define the strategy of the controller (Recreate, RollingUpdate) | -| controllers.[controller-name].rollingUpdate | `dict` | ❌ | ❌ | `{}` | Holds the rollingUpdate options, Only when strategy is RollingUpdate | -| controllers.[controller-name].rollingUpdate.maxUnavailable | `int` | ❌ | ❌ | | Define the maxUnavailable, Only when strategy is RollingUpdate | -| controllers.[controller-name].rollingUpdate.maxSurge | `int` | ❌ | ❌ | | Define the maxSurge, Only when strategy is RollingUpdate | -| controllers.[controller-name].podSpec | `dict` | ✅ | ❌ | `{}` | Holds the pod definition | -| controllers.[controller-name].podSpec.labels | `dict` | ❌ | ✅ | `{}` | Pod Labels | -| controllers.[controller-name].podSpec.annotations | `dict` | ❌ | ✅ | `{}` | Pod Annotations | -| controllers.[controller-name].podSpec.hostNetwork | `boolean` | ❌ | ❌ | `{{ .Values.podOptions.hostNetwork }}` (false) | Pod's hostNetwork | -| controllers.[controller-name].podSpec.enableServiceLinks | `boolean` | ❌ | ❌ | `{{ .Values.podOptions.enableServiceLinks }}` (false) | Pod's enableServiceLinks | +| Key | Type | Required | Helm Template | Default | Description | +| :--------------------------------------------------------- | :-------: | :------: | :-----------: | :---------------------------------------------------: | :-------------------------------------------------------------------------- | +| controllers.[controller-name].strategy | `string` | ❌ | ❌ | `Recreate` | Define the strategy of the controller (Recreate, RollingUpdate) | +| controllers.[controller-name].rollingUpdate | `dict` | ❌ | ❌ | `{}` | Holds the rollingUpdate options, Only when strategy is RollingUpdate | +| controllers.[controller-name].rollingUpdate.maxUnavailable | `int` | ❌ | ❌ | | Define the maxUnavailable, Only when strategy is RollingUpdate | +| controllers.[controller-name].rollingUpdate.maxSurge | `int` | ❌ | ❌ | | Define the maxSurge, Only when strategy is RollingUpdate | --- -Appears in: +Notes: -- `.Values.controllers` +View common `keys` of `controllers` in [Controllers Documentation](controllers.md). ---- - -Naming scheme: - -- Primary: `$FullName` (release-name-chart-name) -- Non-Primary: `$FullName-$ControllerName` (release-name-chart-name-controller-name) +> Value of `controllers.[controller-name].podSpec.restartPolicy` can only be `Always` for this type of controller --- @@ -55,6 +38,7 @@ controllers: annotations: {} hostNetwork: false enableServiceLinks: false + restartPolicy: Always other-controller-name: enabled: true diff --git a/library/common/1.0.0/docs/job.md b/library/common/1.0.0/docs/job.md index de36b30bfc..ca29d33904 100644 --- a/library/common/1.0.0/docs/job.md +++ b/library/common/1.0.0/docs/job.md @@ -1,38 +1,19 @@ # Job -| Key | Type | Required | Helm Template | Default | Description | -| :------------------------------------------------------- | :-------: | :------: | :-----------: | :---------------------------------------------------: | :---------------------------------------------- | -| controllers | `dict` | ❌ | ❌ | `{}` | Define the controllers as dicts | -| controllers.[controller-name] | `dict` | ✅ | ❌ | `{}` | Holds controller definition | -| controllers.[controller-name].enabled | `boolean` | ✅ | ❌ | `false` | Enables or Disables the controller | -| controllers.[controller-name].primary | `boolean` | ✅ | ❌ | `false` | Sets the controller as primary | -| controllers.[controller-name].labels | `dict` | ❌ | ✅ | `{}` | Additional labels for controller | -| controllers.[controller-name].annotations | `dict` | ❌ | ✅ | `{}` | Additional annotations for controller | -| controllers.[controller-name].type | `string` | ✅ | ❌ | `""` | Define the type (kind) of the controller | -| controllers.[controller-name].completionMode | `string` | ❌ | ❌ | `NonIndexed` | Define the completionMode (Indexed, NonIndexed) | -| controllers.[controller-name].backoffLimit | `int` | ❌ | ❌ | `5` | Define the backoffLimit | -| controllers.[controller-name].completions | `int` | ❌ | ❌ | | Define the completions | -| controllers.[controller-name].parallelism | `int` | ❌ | ❌ | `1` | Define the parallelism | -| controllers.[controller-name].ttlSecondsAfterFinished | `int` | ❌ | ❌ | `120` | Define the ttlSecondsAfterFinished | -| controllers.[controller-name].activeDeadlineSeconds | `int` | ❌ | ❌ | | Define the activeDeadlineSeconds | -| controllers.[controller-name].podSpec | `dict` | ✅ | ❌ | `{}` | Holds the pod definition | -| controllers.[controller-name].podSpec.labels | `dict` | ❌ | ✅ | `{}` | Pod Labels | -| controllers.[controller-name].podSpec.annotations | `dict` | ❌ | ✅ | `{}` | Pod Annotations | -| controllers.[controller-name].podSpec.hostNetwork | `boolean` | ❌ | ❌ | `{{ .Values.podOptions.hostNetwork }}` (false) | Pod's hostNetwork | -| controllers.[controller-name].podSpec.enableServiceLinks | `boolean` | ❌ | ❌ | `{{ .Values.podOptions.enableServiceLinks }}` (false) | Pod's enableServiceLinks | +| Key | Type | Required | Helm Template | Default | Description | +| :---------------------------------------------------- | :------: | :------: | :-----------: | :----------: | :---------------------------------------------- | +| controllers.[controller-name].completionMode | `string` | ❌ | ❌ | `NonIndexed` | Define the completionMode (Indexed, NonIndexed) | +| controllers.[controller-name].backoffLimit | `int` | ❌ | ❌ | `5` | Define the backoffLimit | +| controllers.[controller-name].completions | `int` | ❌ | ❌ | | Define the completions | +| controllers.[controller-name].parallelism | `int` | ❌ | ❌ | `1` | Define the parallelism | +| controllers.[controller-name].ttlSecondsAfterFinished | `int` | ❌ | ❌ | `120` | Define the ttlSecondsAfterFinished | +| controllers.[controller-name].activeDeadlineSeconds | `int` | ❌ | ❌ | | Define the activeDeadlineSeconds | --- -Appears in: +Notes: -- `.Values.controllers` - ---- - -Naming scheme: - -- Primary: `$FullName` (release-name-chart-name) -- Non-Primary: `$FullName-$ControllerName` (release-name-chart-name-controller-name) +View common `keys` of `controllers` in [Controllers Documentation](controllers.md). --- @@ -57,6 +38,7 @@ controllers: annotations: {} hostNetwork: false enableServiceLinks: false + restartPolicy: Never other-controller-name: enabled: true diff --git a/library/common/1.0.0/docs/statefulset.md b/library/common/1.0.0/docs/statefulset.md index 7917bfbddb..ea51239897 100644 --- a/library/common/1.0.0/docs/statefulset.md +++ b/library/common/1.0.0/docs/statefulset.md @@ -1,36 +1,19 @@ # DaemonSet -| Key | Type | Required | Helm Template | Default | Description | -| :--------------------------------------------------------- | :-------: | :------: | :-----------: | :---------------------------------------------------: | :------------------------------------------------------------------- | -| controllers | `dict` | ❌ | ❌ | `{}` | Define the controllers as dicts | -| controllers.[controller-name] | `dict` | ✅ | ❌ | `{}` | Holds controller definition | -| controllers.[controller-name].enabled | `boolean` | ✅ | ❌ | `false` | Enables or Disables the controller | -| controllers.[controller-name].primary | `boolean` | ✅ | ❌ | `false` | Sets the controller as primary | -| controllers.[controller-name].labels | `dict` | ❌ | ✅ | `{}` | Additional labels for controller | -| controllers.[controller-name].annotations | `dict` | ❌ | ✅ | `{}` | Additional annotations for controller | -| controllers.[controller-name].type | `string` | ✅ | ❌ | `""` | Define the type (kind) of the controller | -| controllers.[controller-name].strategy | `string` | ❌ | ❌ | `RollingUpdate` | Define the strategy of the controller (OnDelete, RollingUpdate) | -| controllers.[controller-name].rollingUpdate | `dict` | ❌ | ❌ | `{}` | Holds the rollingUpdate options, Only when strategy is RollingUpdate | -| controllers.[controller-name].rollingUpdate.maxUnavailable | `int` | ❌ | ❌ | | Define the maxUnavailable, Only when strategy is RollingUpdate | -| controllers.[controller-name].rollingUpdate.partition | `int` | ❌ | ❌ | | Define the partition, Only when strategy is RollingUpdate | -| controllers.[controller-name].podSpec | `dict` | ✅ | ❌ | `{}` | Holds the pod definition | -| controllers.[controller-name].podSpec.labels | `dict` | ❌ | ✅ | `{}` | Pod Labels | -| controllers.[controller-name].podSpec.annotations | `dict` | ❌ | ✅ | `{}` | Pod Annotations | -| controllers.[controller-name].podSpec.hostNetwork | `boolean` | ❌ | ❌ | `{{ .Values.podOptions.hostNetwork }}` (false) | Pod's hostNetwork | -| controllers.[controller-name].podSpec.enableServiceLinks | `boolean` | ❌ | ❌ | `{{ .Values.podOptions.enableServiceLinks }}` (false) | Pod's enableServiceLinks | +| Key | Type | Required | Helm Template | Default | Description | +| :--------------------------------------------------------- | :-------: | :------: | :-----------: | :---------------------------------------------------: | :-------------------------------------------------------------------------- | +| controllers.[controller-name].strategy | `string` | ❌ | ❌ | `RollingUpdate` | Define the strategy of the controller (OnDelete, RollingUpdate) | +| controllers.[controller-name].rollingUpdate | `dict` | ❌ | ❌ | `{}` | Holds the rollingUpdate options, Only when strategy is RollingUpdate | +| controllers.[controller-name].rollingUpdate.maxUnavailable | `int` | ❌ | ❌ | | Define the maxUnavailable, Only when strategy is RollingUpdate | +| controllers.[controller-name].rollingUpdate.partition | `int` | ❌ | ❌ | | Define the partition, Only when strategy is RollingUpdate | --- -Appears in: +Notes: -- `.Values.controllers` +View common `keys` of `controllers` in [Controllers Documentation](controllers.md). ---- - -Naming scheme: - -- Primary: `$FullName` (release-name-chart-name) -- Non-Primary: `$FullName-$ControllerName` (release-name-chart-name-controller-name) +> Value of `controllers.[controller-name].podSpec.restartPolicy` can only be `Always` for this type of controller --- @@ -55,6 +38,7 @@ controllers: annotations: {} hostNetwork: false enableServiceLinks: false + restartPolicy: Always other-controller-name: enabled: true