diff --git a/.github/workflows/charts-test.yaml b/.github/workflows/charts-test.yaml index af54c199..3131f606 100644 --- a/.github/workflows/charts-test.yaml +++ b/.github/workflows/charts-test.yaml @@ -42,7 +42,7 @@ jobs: fail-fast: false steps: - name: Checkout - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4 + uses: actions/checkout@v4 with: fetch-depth: 0 ref: ${{ inputs.checkoutCommit }} @@ -80,7 +80,10 @@ jobs: overrides: ${{ inputs.overrideDeps }} - name: Run chart-testing (install) - run: ct install --config .ci/ct/ct.yaml --charts "charts/${{ matrix.chart }}" + working-directory: "charts/${{ matrix.chart }}" + # TODO: Awaiting https://github.com/actions/checkout/issues/1607 + run: | + ct install --config "$GITHUB_WORKSPACE/.ci/ct/ct.yaml" --charts . install_success: needs: @@ -112,7 +115,7 @@ jobs: fail-fast: false steps: - name: Checkout - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4 + uses: actions/checkout@v4 with: fetch-depth: 0 ref: ${{ inputs.checkoutCommit }} @@ -132,10 +135,11 @@ jobs: overrides: ${{ inputs.overrideDeps }} - name: Run tests + working-directory: "charts/${{ matrix.chart }}" run: | helm plugin install https://github.com/helm-unittest/helm-unittest.git - helm dep update "charts/${{ matrix.chart }}" - helm unittest -f "tests/**/*_test.yaml" "charts/${{ matrix.chart }}" + helm dep update + helm unittest -f "tests/**/*_test.yaml" . unittest_success: needs: diff --git a/charts/library/common-test/ci/advanced-values.yaml b/charts/library/common-test/ci/advanced-values.yaml index 6e7f1a10..cbaa8c01 100644 --- a/charts/library/common-test/ci/advanced-values.yaml +++ b/charts/library/common-test/ci/advanced-values.yaml @@ -50,7 +50,16 @@ controllers: ingress: main: - enabled: true + hosts: + - host: "test.local" + paths: + - path: / + service: + name: main + port: http + tls: + - hosts: + - "test.local" configMaps: config: @@ -59,9 +68,6 @@ configMaps: test: value 1 persistence: - config: - enabled: true - data: type: configMap name: |- diff --git a/charts/library/common-test/ci/basic-values.yaml b/charts/library/common-test/ci/basic-values.yaml index 18b4ee52..68187d2d 100644 --- a/charts/library/common-test/ci/basic-values.yaml +++ b/charts/library/common-test/ci/basic-values.yaml @@ -17,13 +17,19 @@ controllers: ingress: main: - enabled: true + hosts: + - host: "test.local" + paths: + - path: / + service: + name: main + port: http + tls: + - hosts: + - "test.local" persistence: - config: - enabled: true media: - enabled: true type: persistentVolumeClaim accessMode: ReadWriteOnce size: 1Gi diff --git a/charts/library/common-test/ci/cronjob-values.yaml b/charts/library/common-test/ci/cronjob-values.yaml index 91f10929..1f520f77 100644 --- a/charts/library/common-test/ci/cronjob-values.yaml +++ b/charts/library/common-test/ci/cronjob-values.yaml @@ -3,6 +3,7 @@ controllers: type: cronjob cronjob: timeZone: UTC + schedule: "*/20 * * * *" containers: main: image: diff --git a/charts/library/common-test/ci/no-service.yaml b/charts/library/common-test/ci/no-service.yaml index f206f83f..0c404aa1 100644 --- a/charts/library/common-test/ci/no-service.yaml +++ b/charts/library/common-test/ci/no-service.yaml @@ -11,10 +11,6 @@ service: main: enabled: false -ingress: - main: - enabled: false - probes: liveness: enabled: false diff --git a/charts/library/common-test/ci/vaultwarden-example.yaml b/charts/library/common-test/ci/vaultwarden-example.yaml index 2c5de1a2..acbba413 100644 --- a/charts/library/common-test/ci/vaultwarden-example.yaml +++ b/charts/library/common-test/ci/vaultwarden-example.yaml @@ -32,7 +32,6 @@ service: ingress: # -- Enable and configure ingress settings for the chart under this key. main: - enabled: true hosts: - host: chart-example.local paths: @@ -55,7 +54,6 @@ ingress: # -- Configure persistence settings for the chart under this key. persistence: config: - enabled: true type: persistentVolumeClaim accessMode: ReadWriteOnce size: 1Gi diff --git a/charts/library/common-test/tests/_values/ingress_main_default_hosts.yaml b/charts/library/common-test/tests/_values/ingress_main_default_hosts.yaml new file mode 100644 index 00000000..e5f64c30 --- /dev/null +++ b/charts/library/common-test/tests/_values/ingress_main_default_hosts.yaml @@ -0,0 +1,9 @@ +ingress: + main: + hosts: + - host: "chart-example.local" + paths: + - path: / + service: + name: main + port: http diff --git a/charts/library/common-test/tests/configmap/metadata_test.yaml b/charts/library/common-test/tests/configmap/metadata_test.yaml index 3fe31eab..854dc8d5 100644 --- a/charts/library/common-test/tests/configmap/metadata_test.yaml +++ b/charts/library/common-test/tests/configmap/metadata_test.yaml @@ -8,7 +8,8 @@ tests: set: configMaps: config: - enabled: true + data: + test: test asserts: - hasDocuments: count: 3 @@ -31,7 +32,8 @@ tests: set: configMaps: config: - enabled: true + data: + test: test annotations: test_annotation: test labels: @@ -66,7 +68,8 @@ tests: global_annotation: test configMaps: config: - enabled: true + data: + test: test annotations: test_annotation: test labels: diff --git a/charts/library/common-test/tests/configmap/names_test.yaml b/charts/library/common-test/tests/configmap/names_test.yaml index 86b1b377..5c8718bc 100644 --- a/charts/library/common-test/tests/configmap/names_test.yaml +++ b/charts/library/common-test/tests/configmap/names_test.yaml @@ -22,6 +22,8 @@ tests: configMaps: config: enabled: false + data: + test: test asserts: - hasDocuments: count: 2 @@ -38,11 +40,11 @@ tests: set: configMaps: config: - enabled: true data: foo: bar secondary: - enabled: true + data: + test: test asserts: - hasDocuments: count: 4 @@ -63,7 +65,8 @@ tests: set: configMaps: config: - enabled: true + data: + test: test asserts: - hasDocuments: count: 3 @@ -79,7 +82,8 @@ tests: set: configMaps: config: - enabled: true + data: + test: test nameOverride: http asserts: - hasDocuments: diff --git a/charts/library/common-test/tests/container/args_test.yaml b/charts/library/common-test/tests/container/args_test.yaml index e81fc952..b46ebfae 100644 --- a/charts/library/common-test/tests/container/args_test.yaml +++ b/charts/library/common-test/tests/container/args_test.yaml @@ -39,7 +39,7 @@ tests: equal: path: spec.template.spec.containers[0].args value: - - | + - |- echo hello echo world diff --git a/charts/library/common-test/tests/container/command_test.yaml b/charts/library/common-test/tests/container/command_test.yaml index 53d4cd38..e1d98ae4 100644 --- a/charts/library/common-test/tests/container/command_test.yaml +++ b/charts/library/common-test/tests/container/command_test.yaml @@ -39,7 +39,7 @@ tests: equal: path: spec.template.spec.containers[0].command value: - - | + - |- /bin/sh -c diff --git a/charts/library/common-test/tests/container/env_test.yaml b/charts/library/common-test/tests/container/env_test.yaml index 39cfea3e..a2accfa5 100644 --- a/charts/library/common-test/tests/container/env_test.yaml +++ b/charts/library/common-test/tests/container/env_test.yaml @@ -94,6 +94,25 @@ tests: fieldRef: fieldPath: spec.nodeName + - it: Implicit ValueFrom in list should pass + set: + controllers.main.containers.main.env: + - name: DYNAMIC_ENV_FROM_LIST + fieldRef: + fieldPath: spec.nodeName + asserts: + - documentIndex: &DeploymentDoc 0 + isKind: + of: Deployment + - documentIndex: *DeploymentDoc + equal: + path: spec.template.spec.containers[0].env[0] + value: + name: DYNAMIC_ENV_FROM_LIST + valueFrom: + fieldRef: + fieldPath: spec.nodeName + - it: Implicit ValueFrom should pass set: controllers.main.containers.main.env: diff --git a/charts/library/common-test/tests/container/envfrom_test.yaml b/charts/library/common-test/tests/container/envfrom_test.yaml index 61345ab0..8b8a348f 100644 --- a/charts/library/common-test/tests/container/envfrom_test.yaml +++ b/charts/library/common-test/tests/container/envfrom_test.yaml @@ -46,6 +46,10 @@ tests: prefix: test - configMapRef: identifier: config + configMaps: + config: + data: + test: test asserts: - documentIndex: &DeploymentDoc 0 isKind: @@ -72,6 +76,10 @@ tests: - secretRef: identifier: secret prefix: test + secrets: + secret: + stringData: + test: test asserts: - documentIndex: &DeploymentDoc 0 isKind: diff --git a/charts/library/common-test/tests/container/field_restartpolicy_test.yaml b/charts/library/common-test/tests/container/field_restartpolicy_test.yaml new file mode 100644 index 00000000..d7d3570a --- /dev/null +++ b/charts/library/common-test/tests/container/field_restartpolicy_test.yaml @@ -0,0 +1,29 @@ +--- +# yaml-language-server: $schema=https://raw.githubusercontent.com/helm-unittest/helm-unittest/main/schema/helm-testsuite.json +suite: container restartPolicy +templates: + - common.yaml +tests: + - it: default should pass + asserts: + - documentIndex: 0 + isKind: + of: Deployment + - documentIndex: 0 + notExists: + path: spec.template.spec.containers[0].restartPolicy + + - it: custom restartPolicy should pass + set: + controllers.main.containers: + main: + restartPolicy: Always + + asserts: + - documentIndex: 0 + isKind: + of: Deployment + - documentIndex: 0 + equal: + path: spec.template.spec.containers[0].restartPolicy + value: Always diff --git a/charts/library/common-test/tests/container/name_test.yaml b/charts/library/common-test/tests/container/name_test.yaml index 8a12ca07..ab03aa51 100644 --- a/charts/library/common-test/tests/container/name_test.yaml +++ b/charts/library/common-test/tests/container/name_test.yaml @@ -9,7 +9,6 @@ tests: controllers.main.containers: main: nameOverride: template-test - controller: main image: repository: ghcr.io/mendhak/http-https-echo asserts: @@ -25,7 +24,6 @@ tests: set: controllers.main.containers: main: - controller: main image: repository: ghcr.io/mendhak/http-https-echo asserts: @@ -42,7 +40,6 @@ tests: controllers.main.containers: main: nameOverride: "{{ .Release.Name }}-container" - controller: main image: repository: ghcr.io/mendhak/http-https-echo asserts: diff --git a/charts/library/common-test/tests/container/probes_test.yaml b/charts/library/common-test/tests/container/probes_test.yaml index 636bbea8..d908f802 100644 --- a/charts/library/common-test/tests/container/probes_test.yaml +++ b/charts/library/common-test/tests/container/probes_test.yaml @@ -3,6 +3,12 @@ suite: container probes templates: - common.yaml + +set: + controllers.main.containers.main.probes.liveness.enabled: true + controllers.main.containers.main.probes.readiness.enabled: true + controllers.main.containers.main.probes.startup.enabled: true + tests: - it: default should pass set: @@ -40,9 +46,9 @@ tests: equal: path: spec.template.spec.containers[0].startupProbe value: - failureThreshold: 30 + failureThreshold: 3 initialDelaySeconds: 0 - periodSeconds: 5 + periodSeconds: 10 tcpSocket: port: *port timeoutSeconds: 1 @@ -87,9 +93,9 @@ tests: equal: path: spec.template.spec.containers[0].startupProbe value: - failureThreshold: 30 + failureThreshold: 3 initialDelaySeconds: 0 - periodSeconds: 5 + periodSeconds: 10 tcpSocket: port: *port timeoutSeconds: 1 @@ -130,9 +136,9 @@ tests: equal: path: spec.template.spec.containers[0].startupProbe value: - failureThreshold: 30 + failureThreshold: 3 initialDelaySeconds: 0 - periodSeconds: 5 + periodSeconds: 10 tcpSocket: port: 80 timeoutSeconds: 1 @@ -162,6 +168,7 @@ tests: main: ports: http: + protocol: HTTP port: &port 80 controllers.main.containers.main.probes: @@ -462,9 +469,9 @@ tests: equal: path: spec.template.spec.containers[0].startupProbe value: - failureThreshold: 30 + failureThreshold: 3 initialDelaySeconds: 0 - periodSeconds: 5 + periodSeconds: 10 tcpSocket: port: *port timeoutSeconds: 1 diff --git a/charts/library/common-test/tests/container/validations_test.yaml b/charts/library/common-test/tests/container/validations_test.yaml index 107fd55e..64d726c7 100644 --- a/charts/library/common-test/tests/container/validations_test.yaml +++ b/charts/library/common-test/tests/container/validations_test.yaml @@ -4,17 +4,6 @@ suite: Container validations templates: - common.yaml tests: - - it: image required to be a dictionary - set: - controllers: - main: - containers: - test: - image: "test:latest" - asserts: - - failedTemplate: - errorMessage: "Image required to be a dictionary with repository and tag fields. (controller main, container test)" - - it: image repository is required set: controllers: diff --git a/charts/library/common-test/tests/container/volumemounts_test.yaml b/charts/library/common-test/tests/container/volumemounts_test.yaml index ee999e27..b39ff31b 100644 --- a/charts/library/common-test/tests/container/volumemounts_test.yaml +++ b/charts/library/common-test/tests/container/volumemounts_test.yaml @@ -17,7 +17,8 @@ tests: set: persistence: config: - enabled: true + accessMode: ReadWriteOnce + size: 1Gi asserts: - documentIndex: &DeploymentDoc 1 isKind: @@ -123,7 +124,6 @@ tests: set: persistence: config: - enabled: true accessMode: ReadWriteMany size: 1G globalMounts: @@ -143,7 +143,6 @@ tests: set: persistence: config: - enabled: true existingClaim: myClaim globalMounts: - path: /config @@ -164,7 +163,6 @@ tests: set: persistence: config: - enabled: true type: hostPath hostPath: /tmp globalMounts: @@ -184,7 +182,6 @@ tests: set: persistence: config: - enabled: true type: hostPath hostPath: /dev globalMounts: diff --git a/charts/library/common-test/tests/controller/cronjob_test.yaml b/charts/library/common-test/tests/controller/cronjob_test.yaml index d96b8d48..f5eabac2 100644 --- a/charts/library/common-test/tests/controller/cronjob_test.yaml +++ b/charts/library/common-test/tests/controller/cronjob_test.yaml @@ -6,16 +6,16 @@ templates: tests: - it: default cronjob configuration should pass set: - controllers: - main: - type: cronjob + controllers.main.type: cronjob + controllers.main.cronjob.schedule: "*/20 * * * *" asserts: - documentIndex: &ControllerDoc 0 isKind: of: CronJob - documentIndex: *ControllerDoc - notExists: + equal: path: spec.suspend + value: false - documentIndex: *ControllerDoc equal: path: spec.schedule diff --git a/charts/library/common-test/tests/controller/job_test.yaml b/charts/library/common-test/tests/controller/job_test.yaml index 4298bdcd..4bb3379a 100644 --- a/charts/library/common-test/tests/controller/job_test.yaml +++ b/charts/library/common-test/tests/controller/job_test.yaml @@ -14,8 +14,9 @@ tests: isKind: of: Job - documentIndex: *ControllerDoc - notExists: + equal: path: spec.suspend + value: false - documentIndex: *ControllerDoc notExists: path: spec.ttlSecondsAfterFinished diff --git a/charts/library/common-test/tests/controller/metadata_cronjob_test.yaml b/charts/library/common-test/tests/controller/metadata_cronjob_test.yaml index 3dcf0cc2..4f6d0c4a 100644 --- a/charts/library/common-test/tests/controller/metadata_cronjob_test.yaml +++ b/charts/library/common-test/tests/controller/metadata_cronjob_test.yaml @@ -3,6 +3,10 @@ suite: controller metadata cronjob templates: - common.yaml + +set: + controllers.main.cronjob.schedule: "*/20 * * * *" + tests: - it: default metadata should pass set: diff --git a/charts/library/common-test/tests/controller/type_test.yaml b/charts/library/common-test/tests/controller/type_test.yaml index 0380e707..17feb175 100644 --- a/charts/library/common-test/tests/controller/type_test.yaml +++ b/charts/library/common-test/tests/controller/type_test.yaml @@ -116,6 +116,7 @@ tests: - it: cronjob should pass set: controllers.main.type: cronjob + controllers.main.cronjob.schedule: "*/20 * * * *" asserts: - documentIndex: &ControllerDoc 0 isKind: diff --git a/charts/library/common-test/tests/ingress/metadata_test.yaml b/charts/library/common-test/tests/ingress/metadata_test.yaml index 3294fb95..37ba7e54 100644 --- a/charts/library/common-test/tests/ingress/metadata_test.yaml +++ b/charts/library/common-test/tests/ingress/metadata_test.yaml @@ -3,10 +3,12 @@ suite: ingress metadata templates: - common.yaml + +values: + - ../_values/ingress_main_default_hosts.yaml + tests: - it: default metadata should pass - set: - ingress.main.enabled: true asserts: - documentIndex: &IngressDocument 2 isKind: @@ -26,7 +28,6 @@ tests: - it: custom metadata should pass set: ingress.main: - enabled: true annotations: test_annotation: test labels: @@ -58,7 +59,6 @@ tests: annotations: global_annotation: test ingress.main: - enabled: true annotations: test_annotation: test labels: diff --git a/charts/library/common-test/tests/ingress/presence_test.yaml b/charts/library/common-test/tests/ingress/presence_test.yaml index 4ecbf686..0c1c16c2 100644 --- a/charts/library/common-test/tests/ingress/presence_test.yaml +++ b/charts/library/common-test/tests/ingress/presence_test.yaml @@ -18,6 +18,8 @@ tests: of: Ingress - it: explicitly disabled should pass + values: + - ../_values/ingress_main_default_hosts.yaml set: ingress.main.enabled: false asserts: @@ -33,6 +35,8 @@ tests: of: Ingress - it: explicitly enabled should pass + values: + - ../_values/ingress_main_default_hosts.yaml set: ingress.main.enabled: true asserts: @@ -50,33 +54,18 @@ tests: isKind: of: Ingress - - it: multiple enabled should pass + - it: multiple ingress should pass + values: + - ../_values/ingress_main_default_hosts.yaml set: - ingress.main.enabled: true - ingress.test.enabled: true - asserts: - - hasDocuments: - count: 4 - - documentIndex: 0 - not: true - isKind: - of: Ingress - - documentIndex: 1 - not: true - isKind: - of: Ingress - - documentIndex: 2 - isKind: - of: Ingress - - documentIndex: 3 - isKind: - of: Ingress - - - it: multiple with default enabled should pass - set: - ingress.main.enabled: true - ingress.test: {} - + ingress.test: + hosts: + - host: "chart-example.local" + paths: + - path: / + service: + name: main + port: http asserts: - hasDocuments: count: 4 @@ -102,3 +91,35 @@ tests: equal: path: metadata.name value: RELEASE-NAME-test + + - it: multiple ingress with explicit disabled should pass + values: + - ../_values/ingress_main_default_hosts.yaml + set: + ingress.test: + enabled: false + hosts: + - host: "chart-example.local" + paths: + - path: / + service: + name: main + port: http + asserts: + - hasDocuments: + count: 3 + - documentIndex: 0 + not: true + isKind: + of: Ingress + - documentIndex: 1 + not: true + isKind: + of: Ingress + - documentIndex: &FirstIngressDocument 2 + isKind: + of: Ingress + - documentIndex: *FirstIngressDocument + equal: + path: metadata.name + value: RELEASE-NAME diff --git a/charts/library/common-test/tests/ingress/service_reference_test.yaml b/charts/library/common-test/tests/ingress/service_reference_test.yaml index 057bab78..1db8e77e 100644 --- a/charts/library/common-test/tests/ingress/service_reference_test.yaml +++ b/charts/library/common-test/tests/ingress/service_reference_test.yaml @@ -3,10 +3,12 @@ suite: ingress service reference templates: - common.yaml + +values: + - ../_values/ingress_main_default_hosts.yaml + tests: - it: default should pass - set: - ingress.main.enabled: true asserts: - documentIndex: &IngressDocument 2 isKind: @@ -23,7 +25,6 @@ tests: - it: custom service reference should pass set: ingress.main: - enabled: true hosts: - host: chart-test.local paths: @@ -56,7 +57,6 @@ tests: port: &http2Port 1880 ingress: main: - enabled: true className: "nginx" hosts: - host: http.chart-test.local diff --git a/charts/library/common-test/tests/ingress/tls_test.yaml b/charts/library/common-test/tests/ingress/tls_test.yaml index d2e2b768..a823fc54 100644 --- a/charts/library/common-test/tests/ingress/tls_test.yaml +++ b/charts/library/common-test/tests/ingress/tls_test.yaml @@ -3,10 +3,12 @@ suite: ingress tls templates: - common.yaml + +values: + - ../_values/ingress_main_default_hosts.yaml + tests: - it: default should pass - set: - ingress.main.enabled: true asserts: - documentIndex: &IngressDocument 2 isKind: @@ -18,7 +20,6 @@ tests: - it: tls enabled should pass set: ingress.main: - enabled: true tls: - secretName: test hosts: @@ -38,7 +39,6 @@ tests: - it: tls enabled without secret should pass set: ingress.main: - enabled: true tls: - hosts: - hostname @@ -56,7 +56,6 @@ tests: - it: tls enabled with secret template should pass set: ingress.main: - enabled: true tls: - secretName: "{{ .Release.Name }}-secret" hosts: @@ -76,7 +75,6 @@ tests: - it: tls enabled with secret template evaluate empty should pass set: ingress.main: - enabled: true tls: - secretName: '{{ "" }}' hosts: diff --git a/charts/library/common-test/tests/ingress/values_test.yaml b/charts/library/common-test/tests/ingress/values_test.yaml index 07dac71e..1155fa42 100644 --- a/charts/library/common-test/tests/ingress/values_test.yaml +++ b/charts/library/common-test/tests/ingress/values_test.yaml @@ -3,10 +3,12 @@ suite: ingress values templates: - common.yaml + +values: + - ../_values/ingress_main_default_hosts.yaml + tests: - it: default should pass - set: - ingress.main.enabled: true asserts: - documentIndex: &IngressDocument 2 isKind: @@ -23,7 +25,6 @@ tests: - it: custom host and path should pass set: ingress.main: - enabled: true hosts: - host: chart-test.local paths: @@ -46,10 +47,13 @@ tests: - it: host with template should pass set: ingress.main: - enabled: true hosts: - host: "{{ .Release.Name }}.hostname" - + paths: + - path: / + service: + name: main + port: http asserts: - documentIndex: &IngressDocument 2 isKind: @@ -62,7 +66,6 @@ tests: - it: path with template should pass set: ingress.main: - enabled: true hosts: - host: chart-test.local paths: @@ -81,7 +84,6 @@ tests: - it: with defaultBackend should pass set: ingress.main: - enabled: true defaultBackend: test asserts: - documentIndex: &IngressDocument 2 diff --git a/charts/library/common-test/tests/networkpolicy/metadata_test.yaml b/charts/library/common-test/tests/networkpolicy/metadata_test.yaml index d2602713..1f51c597 100644 --- a/charts/library/common-test/tests/networkpolicy/metadata_test.yaml +++ b/charts/library/common-test/tests/networkpolicy/metadata_test.yaml @@ -1,14 +1,19 @@ --- # yaml-language-server: $schema=https://raw.githubusercontent.com/helm-unittest/helm-unittest/main/schema/helm-testsuite.json suite: networkPolicy metadata + +set: + networkpolicies.main: + controller: main + policyTypes: + - Ingress + - Egress + rules: {} + templates: - common.yaml tests: - it: default metadata should pass - set: - networkpolicies: - main: - enabled: true asserts: - documentIndex: &NetworkPolicyDocument 2 isKind: @@ -29,7 +34,6 @@ tests: set: networkpolicies: main: - enabled: true annotations: test_annotation: test labels: @@ -62,7 +66,6 @@ tests: global_annotation: test networkpolicies: main: - enabled: true annotations: test_annotation: test labels: diff --git a/charts/library/common-test/tests/networkpolicy/names_test.yaml b/charts/library/common-test/tests/networkpolicy/names_test.yaml index 1a508488..0500099a 100644 --- a/charts/library/common-test/tests/networkpolicy/names_test.yaml +++ b/charts/library/common-test/tests/networkpolicy/names_test.yaml @@ -8,7 +8,11 @@ tests: set: networkpolicies: main: - enabled: true + controller: main + policyTypes: + - Ingress + - Egress + rules: {} asserts: - hasDocuments: count: 3 @@ -24,7 +28,11 @@ tests: set: networkpolicies: main: - enabled: true + controller: main + policyTypes: + - Ingress + - Egress + rules: {} nameOverride: block-ingress asserts: - documentIndex: &NetworkPolicyDocument 2 diff --git a/charts/library/common-test/tests/networkpolicy/validations_test.yaml b/charts/library/common-test/tests/networkpolicy/validations_test.yaml index 84d1b261..11715ebe 100644 --- a/charts/library/common-test/tests/networkpolicy/validations_test.yaml +++ b/charts/library/common-test/tests/networkpolicy/validations_test.yaml @@ -8,8 +8,8 @@ tests: set: networkpolicies: main: - enabled: true controller: "" + rules: {} asserts: - failedTemplate: errorMessage: "controller reference or podSelector is required for NetworkPolicy. (NetworkPolicy main)" @@ -18,8 +18,9 @@ tests: set: networkpolicies: main: - enabled: true + controller: main policyTypes: [] + rules: {} asserts: - failedTemplate: errorMessage: "policyTypes is required for NetworkPolicy. (NetworkPolicy main)" @@ -28,9 +29,10 @@ tests: set: networkpolicies: main: - enabled: true + controller: main policyTypes: - test + rules: {} asserts: - failedTemplate: errorMessage: "Not a valid policyType for NetworkPolicy. (NetworkPolicy main, value test)" diff --git a/charts/library/common-test/tests/networkpolicy/values_test.yaml b/charts/library/common-test/tests/networkpolicy/values_test.yaml index 36c312f9..eff6ff7f 100644 --- a/charts/library/common-test/tests/networkpolicy/values_test.yaml +++ b/charts/library/common-test/tests/networkpolicy/values_test.yaml @@ -3,6 +3,7 @@ suite: NetworkPolicy values templates: - common.yaml + tests: - it: main networkpolicy is disabled by default asserts: @@ -17,9 +18,12 @@ tests: - it: main networkpolicy can be enabled set: - networkpolicies: - main: - enabled: true + networkpolicies.main: + controller: main + policyTypes: + - Ingress + - Egress + rules: {} asserts: - hasDocuments: count: 3 @@ -37,8 +41,11 @@ tests: set: networkpolicies: main: - enabled: true controller: main + policyTypes: + - Ingress + - Egress + rules: {} asserts: - documentIndex: &NetworkPolicyDocument 2 isKind: @@ -56,9 +63,12 @@ tests: set: networkpolicies: main: - enabled: true controller: main + policyTypes: + - Ingress + - Egress podSelector: {} + rules: {} asserts: - documentIndex: &NetworkPolicyDocument 2 isKind: @@ -72,8 +82,10 @@ tests: set: networkpolicies: main: - enabled: true controller: main + policyTypes: + - Ingress + - Egress rules: ingress: - {} diff --git a/charts/library/common-test/tests/persistence/claimnames_test.yaml b/charts/library/common-test/tests/persistence/claimnames_test.yaml index 60bac5b8..815c5069 100644 --- a/charts/library/common-test/tests/persistence/claimnames_test.yaml +++ b/charts/library/common-test/tests/persistence/claimnames_test.yaml @@ -8,7 +8,8 @@ tests: set: persistence: config: - enabled: true + accessMode: ReadWriteOnce + size: 1Gi asserts: - documentIndex: 1 isKind: @@ -25,12 +26,7 @@ tests: set: persistence: existingClaim: - enabled: true existingClaim: myClaim - mounts: - - controllers: - - main - mountPath: "/data" asserts: - documentIndex: 0 isKind: @@ -47,14 +43,9 @@ tests: set: persistence: claimWithoutSuffix: - enabled: true nameOverride: "-" accessMode: ReadWriteMany size: 1G - mounts: - - controllers: - - main - mountPath: "/data" asserts: - documentIndex: 1 isKind: @@ -71,14 +62,9 @@ tests: set: persistence: claimWithNameOverride: - enabled: true nameOverride: suffix accessMode: ReadWriteMany size: 1G - mounts: - - controllers: - - main - mountPath: "/data" asserts: - documentIndex: 1 isKind: diff --git a/charts/library/common-test/tests/persistence/hostpath_test.yaml b/charts/library/common-test/tests/persistence/hostpath_test.yaml index e564ce59..8535afb2 100644 --- a/charts/library/common-test/tests/persistence/hostpath_test.yaml +++ b/charts/library/common-test/tests/persistence/hostpath_test.yaml @@ -11,10 +11,6 @@ tests: enabled: true type: hostPath hostPath: "/tmp1" - mounts: - - controllers: - - main - mountPath: "/data" asserts: - documentIndex: 0 isKind: @@ -35,10 +31,6 @@ tests: type: hostPath hostPath: "/tmp2" hostPathType: "Directory" - mounts: - - controllers: - - main - mountPath: "/data2" asserts: - documentIndex: 0 isKind: diff --git a/charts/library/common-test/tests/persistence/types_test.yaml b/charts/library/common-test/tests/persistence/types_test.yaml index 7b6ac0f8..4363fad9 100644 --- a/charts/library/common-test/tests/persistence/types_test.yaml +++ b/charts/library/common-test/tests/persistence/types_test.yaml @@ -16,10 +16,6 @@ tests: - path: "labels" fieldRef: fieldPath: metadata.labels - mounts: - - controllers: - - main - mountPath: "/data" asserts: - documentIndex: 0 isKind: @@ -42,10 +38,6 @@ tests: enabled: true type: configMap name: mySettings - mounts: - - controllers: - - main - mountPath: "/data" asserts: - documentIndex: 0 isKind: @@ -65,10 +57,6 @@ tests: enabled: true type: configMap name: '{{ include "bjw-s.common.lib.chart.names.fullname" $ }}-config' - mounts: - - controllers: - - main - mountPath: "/data" asserts: - documentIndex: 0 isKind: @@ -88,10 +76,6 @@ tests: enabled: true type: secret name: mySettings - mounts: - - controllers: - - main - mountPath: "/data" asserts: - documentIndex: 0 isKind: @@ -111,10 +95,6 @@ tests: enabled: true type: secret name: "{{ .Release.Name }}-config" - mounts: - - controllers: - - main - mountPath: "/data" asserts: - documentIndex: 0 isKind: @@ -135,10 +115,6 @@ tests: type: nfs server: 10.10.0.8 path: /tank/nas/library - mounts: - - controllers: - - main - mountPath: "/data" asserts: - documentIndex: 0 isKind: diff --git a/charts/library/common-test/tests/persistence/volumes_test.yaml b/charts/library/common-test/tests/persistence/volumes_test.yaml index 9c592ba0..c8029eae 100644 --- a/charts/library/common-test/tests/persistence/volumes_test.yaml +++ b/charts/library/common-test/tests/persistence/volumes_test.yaml @@ -17,7 +17,8 @@ tests: set: persistence: config: - enabled: true + accessMode: ReadWriteOnce + size: 1Gi asserts: - documentIndex: &DeploymentDoc 1 isKind: @@ -48,7 +49,6 @@ tests: persistence: config: - enabled: true existingClaim: test advancedMounts: main: diff --git a/charts/library/common-test/tests/pod/sidecars_test.yaml b/charts/library/common-test/tests/pod/additional_containers_test.yaml similarity index 95% rename from charts/library/common-test/tests/pod/sidecars_test.yaml rename to charts/library/common-test/tests/pod/additional_containers_test.yaml index 65ed67c6..10144039 100644 --- a/charts/library/common-test/tests/pod/sidecars_test.yaml +++ b/charts/library/common-test/tests/pod/additional_containers_test.yaml @@ -1,6 +1,6 @@ --- # yaml-language-server: $schema=https://raw.githubusercontent.com/helm-unittest/helm-unittest/main/schema/helm-testsuite.json -suite: pod sidecar containers +suite: pod with multiple containers templates: - common.yaml tests: @@ -9,6 +9,7 @@ tests: controllers.main.containers: additional1: nameOverride: template-test + dependsOn: main image: repository: test tag: test @@ -25,6 +26,7 @@ tests: set: controllers.main.containers: additional1: + dependsOn: main image: repository: test tag: test @@ -42,6 +44,7 @@ tests: controllers.main.containers: additional1: nameOverride: "{{ .Release.Name }}-container" + dependsOn: main image: repository: test tag: test @@ -61,6 +64,7 @@ tests: env: main_env: value additional1: + dependsOn: main image: repository: test tag: test diff --git a/charts/library/common-test/tests/pod/container_order_test.yaml b/charts/library/common-test/tests/pod/container_order_test.yaml index 733b2708..81802611 100644 --- a/charts/library/common-test/tests/pod/container_order_test.yaml +++ b/charts/library/common-test/tests/pod/container_order_test.yaml @@ -7,6 +7,10 @@ tests: - it: with default order set: controllers.main.containers: + main: + image: + repository: test + tag: test additional1: image: repository: test @@ -26,60 +30,15 @@ tests: - documentIndex: *DeploymentDocument equal: path: spec.template.spec.containers[0].name - value: main - - documentIndex: *DeploymentDocument - equal: - path: spec.template.spec.containers[1].name value: additional1 - - documentIndex: *DeploymentDocument - equal: - path: spec.template.spec.containers[2].name - value: additional2 - - # TODO: Remove this test case after "order" removal in v3 - - it: with custom order - set: - controllers.main.containers: - main: - order: 2 - additional1: - order: 3 - image: - repository: test - tag: test - additional2: - order: 1 - image: - repository: test - tag: test - additional3: - image: - repository: test - tag: test - asserts: - - documentIndex: &DeploymentDocument 0 - isKind: - of: Deployment - - documentIndex: *DeploymentDocument - lengthEqual: - path: spec.template.spec.containers - count: 4 - - documentIndex: *DeploymentDocument - equal: - path: spec.template.spec.containers[0].name - value: additional2 - documentIndex: *DeploymentDocument equal: path: spec.template.spec.containers[1].name - value: main + value: additional2 - documentIndex: *DeploymentDocument equal: path: spec.template.spec.containers[2].name - value: additional1 - - documentIndex: *DeploymentDocument - equal: - path: spec.template.spec.containers[3].name - value: additional3 + value: main - it: with dependsOn set: @@ -123,48 +82,3 @@ tests: equal: path: spec.template.spec.containers[3].name value: additional2 - - # TODO: Remove this test case after "order" removal in v3 - - it: with both order and dependsOn - set: - controllers.main.containers: - additional1: - dependsOn: additional3 - image: - repository: test - tag: test - additional2: - dependsOn: additional3 - order: 1 - image: - repository: test - tag: test - additional3: - dependsOn: main - image: - repository: test - tag: test - asserts: - - documentIndex: &DeploymentDocument 0 - isKind: - of: Deployment - - documentIndex: *DeploymentDocument - lengthEqual: - path: spec.template.spec.containers - count: 4 - - documentIndex: *DeploymentDocument - equal: - path: spec.template.spec.containers[0].name - value: main - - documentIndex: *DeploymentDocument - equal: - path: spec.template.spec.containers[1].name - value: additional3 - - documentIndex: *DeploymentDocument - equal: - path: spec.template.spec.containers[2].name - value: additional1 - - documentIndex: *DeploymentDocument - equal: - path: spec.template.spec.containers[3].name - value: additional2 diff --git a/charts/library/common-test/tests/pod/field_dnsPolicy.yaml b/charts/library/common-test/tests/pod/field_dnsPolicy_test.yaml similarity index 100% rename from charts/library/common-test/tests/pod/field_dnsPolicy.yaml rename to charts/library/common-test/tests/pod/field_dnsPolicy_test.yaml diff --git a/charts/library/common-test/tests/pod/field_enableServiceLinks_test.yaml b/charts/library/common-test/tests/pod/field_enableServiceLinks_test.yaml new file mode 100644 index 00000000..1ec0434b --- /dev/null +++ b/charts/library/common-test/tests/pod/field_enableServiceLinks_test.yaml @@ -0,0 +1,39 @@ +--- +# yaml-language-server: $schema=https://raw.githubusercontent.com/helm-unittest/helm-unittest/main/schema/helm-testsuite.json +suite: pod enableServiceLinks +templates: + - common.yaml +tests: + - it: default should pass + asserts: + - documentIndex: 0 + isKind: + of: Deployment + - documentIndex: 0 + equal: + path: spec.template.spec.enableServiceLinks + value: false + + - it: enabled in defaultPodOptions should pass + set: + defaultPodOptions.enableServiceLinks: true + asserts: + - documentIndex: 0 + isKind: + of: Deployment + - documentIndex: 0 + equal: + path: spec.template.spec.enableServiceLinks + value: true + + - it: enabled in pod options should pass + set: + controllers.main.pod.enableServiceLinks: true + asserts: + - documentIndex: 0 + isKind: + of: Deployment + - documentIndex: 0 + equal: + path: spec.template.spec.enableServiceLinks + value: true diff --git a/charts/library/common-test/tests/pod/field_replicas_test.yaml b/charts/library/common-test/tests/pod/field_replicas_test.yaml index b299d004..e9554b3f 100644 --- a/charts/library/common-test/tests/pod/field_replicas_test.yaml +++ b/charts/library/common-test/tests/pod/field_replicas_test.yaml @@ -14,6 +14,17 @@ tests: path: spec.replicas value: 1 + - it: nil should pass + set: + controllers.main.replicas: null + asserts: + - documentIndex: 0 + isKind: + of: Deployment + - documentIndex: 0 + notExists: + path: spec.replicas + - it: custom replicas should pass set: controllers.main.replicas: 3 diff --git a/charts/library/common-test/tests/pod/initcontainers_test.yaml b/charts/library/common-test/tests/pod/initcontainers_test.yaml index 0929cf18..f791f206 100644 --- a/charts/library/common-test/tests/pod/initcontainers_test.yaml +++ b/charts/library/common-test/tests/pod/initcontainers_test.yaml @@ -52,6 +52,7 @@ tests: enabled: false image: repository: ghcr.io/mendhak/http-https-echo + tag: test asserts: - documentIndex: &DeploymentDocument 0 isKind: @@ -60,37 +61,6 @@ tests: notExists: path: spec.template.spec.initContainers - # TODO: Remove this test case after "order" removal in v3 - - it: custom order should pass - set: - controllers.main.initContainers: - init1: - order: 2 - image: - repository: ghcr.io/mendhak/http-https-echo - tag: latest - init2: - order: 1 - image: - repository: ghcr.io/mendhak/http-https-echo - tag: latest - asserts: - - documentIndex: &DeploymentDocument 0 - isKind: - of: Deployment - - documentIndex: *DeploymentDocument - lengthEqual: - path: spec.template.spec.initContainers - count: 2 - - documentIndex: *DeploymentDocument - equal: - path: spec.template.spec.initContainers[0].name - value: init2 - - documentIndex: *DeploymentDocument - equal: - path: spec.template.spec.initContainers[1].name - value: init1 - - it: with dependsOn set: controllers.main.initContainers: @@ -119,3 +89,28 @@ tests: equal: path: spec.template.spec.initContainers[1].name value: init1 + + - it: with custom restartPolicy (sidecar) + set: + controllers.main.initContainers: + test: + image: + repository: ghcr.io/mendhak/http-https-echo + tag: latest + restartPolicy: Always + asserts: + - documentIndex: &DeploymentDocument 0 + isKind: + of: Deployment + - documentIndex: *DeploymentDocument + lengthEqual: + path: spec.template.spec.initContainers + count: 1 + - documentIndex: *DeploymentDocument + equal: + path: spec.template.spec.initContainers[0].name + value: test + - documentIndex: *DeploymentDocument + equal: + path: spec.template.spec.initContainers[0].restartPolicy + value: Always diff --git a/charts/library/common-test/tests/pvc/datasource_test.yaml b/charts/library/common-test/tests/pvc/datasource_test.yaml index 65be0d96..1dd5dbcf 100644 --- a/charts/library/common-test/tests/pvc/datasource_test.yaml +++ b/charts/library/common-test/tests/pvc/datasource_test.yaml @@ -3,10 +3,14 @@ suite: pvc datasource templates: - common.yaml + +set: + persistence.config: + accessMode: ReadWriteOnce + size: 1Gi + tests: - it: default should pass - set: - persistence.config.enabled: true asserts: - documentIndex: &PersistentVolumeClaimDocument 0 isKind: @@ -21,7 +25,6 @@ tests: - it: with dataSource should pass set: persistence.config: - enabled: true dataSource: apiGroup: snapshot.storage.k8s.io kind: VolumeSnapshot @@ -44,7 +47,6 @@ tests: - it: templated dataSource name should pass set: persistence.config: - enabled: true dataSource: apiGroup: snapshot.storage.k8s.io kind: VolumeSnapshot @@ -67,7 +69,6 @@ tests: - it: with dataSourceRef should pass set: persistence.config: - enabled: true dataSourceRef: apiGroup: snapshot.storage.k8s.io kind: VolumeSnapshot @@ -90,7 +91,6 @@ tests: - it: templated dataSourceRef name should pass set: persistence.config: - enabled: true dataSourceRef: apiGroup: snapshot.storage.k8s.io kind: VolumeSnapshot diff --git a/charts/library/common-test/tests/pvc/metadata_test.yaml b/charts/library/common-test/tests/pvc/metadata_test.yaml index 2dc42d4d..87b2ef8e 100644 --- a/charts/library/common-test/tests/pvc/metadata_test.yaml +++ b/charts/library/common-test/tests/pvc/metadata_test.yaml @@ -3,10 +3,14 @@ suite: pvc metadata templates: - common.yaml + +set: + persistence.config: + accessMode: ReadWriteOnce + size: 1Gi + tests: - it: default should pass - set: - persistence.config.enabled: true asserts: - documentIndex: &PersistentVolumeClaimDocument 0 isKind: @@ -26,7 +30,6 @@ tests: - it: retain enabled should pass set: persistence.config: - enabled: true retain: true asserts: - documentIndex: &PersistentVolumeClaimDocument 0 @@ -49,7 +52,6 @@ tests: - it: custom metadata should pass set: persistence.config: - enabled: true labels: test_label: test annotations: @@ -81,7 +83,6 @@ tests: annotations: global_annotation: test persistence.config: - enabled: true labels: test_label: test annotations: diff --git a/charts/library/common-test/tests/pvc/names_test.yaml b/charts/library/common-test/tests/pvc/names_test.yaml index 25c8f261..bb3fb887 100644 --- a/charts/library/common-test/tests/pvc/names_test.yaml +++ b/charts/library/common-test/tests/pvc/names_test.yaml @@ -3,8 +3,16 @@ suite: pvc names templates: - common.yaml + +set: + persistence.config: + accessMode: ReadWriteOnce + size: 1Gi + tests: - it: disabled should pass + set: + persistence.config.enabled: false asserts: - hasDocuments: count: 2 @@ -17,7 +25,7 @@ tests: isKind: of: PersistentVolumeClaim - - it: default should pass + - it: enabled should pass set: persistence.config.enabled: true asserts: @@ -42,7 +50,6 @@ tests: - it: without suffix should pass set: persistence.config: - enabled: true nameOverride: "-" asserts: - documentIndex: &PersistentVolumeClaimDocument 0 @@ -56,7 +63,6 @@ tests: - it: with custom suffix should pass set: persistence.config: - enabled: true nameOverride: "custom" asserts: - documentIndex: &PersistentVolumeClaimDocument 0 diff --git a/charts/library/common-test/tests/pvc/storageclass_test.yaml b/charts/library/common-test/tests/pvc/storageclass_test.yaml index d2202dc2..372063f7 100644 --- a/charts/library/common-test/tests/pvc/storageclass_test.yaml +++ b/charts/library/common-test/tests/pvc/storageclass_test.yaml @@ -3,10 +3,14 @@ suite: pvc storageclass templates: - common.yaml + +set: + persistence.config: + accessMode: ReadWriteOnce + size: 1Gi + tests: - it: default should pass - set: - persistence.config.enabled: true asserts: - documentIndex: &PersistentVolumeClaimDocument 0 isKind: @@ -18,7 +22,6 @@ tests: - it: custom should pass set: persistence.config: - enabled: true storageClass: custom asserts: - documentIndex: &PersistentVolumeClaimDocument 0 @@ -32,7 +35,6 @@ tests: - it: empty should pass set: persistence.config: - enabled: true storageClass: "-" asserts: - documentIndex: &PersistentVolumeClaimDocument 0 diff --git a/charts/library/common-test/tests/secret/metadata_test.yaml b/charts/library/common-test/tests/secret/metadata_test.yaml index e8178379..508615ad 100644 --- a/charts/library/common-test/tests/secret/metadata_test.yaml +++ b/charts/library/common-test/tests/secret/metadata_test.yaml @@ -8,7 +8,8 @@ tests: set: secrets: secret: - enabled: true + stringData: + test: test asserts: - hasDocuments: count: 3 @@ -31,7 +32,8 @@ tests: set: secrets: secret: - enabled: true + stringData: + test: test annotations: test_annotation: test labels: @@ -66,7 +68,8 @@ tests: global_annotation: test secrets: secret: - enabled: true + stringData: + test: test annotations: test_annotation: test labels: @@ -98,7 +101,8 @@ tests: set: secrets: secret: - enabled: true + stringData: + test: test type: &type kubernetes.io/service-account-token asserts: - hasDocuments: diff --git a/charts/library/common-test/tests/secret/names_test.yaml b/charts/library/common-test/tests/secret/names_test.yaml index 4b5c456b..ece73879 100644 --- a/charts/library/common-test/tests/secret/names_test.yaml +++ b/charts/library/common-test/tests/secret/names_test.yaml @@ -22,6 +22,8 @@ tests: secrets: secret: enabled: false + stringData: + test: test asserts: - hasDocuments: count: 2 @@ -39,10 +41,12 @@ tests: secrets: secret: enabled: true - data: + stringData: foo: bar secondary: enabled: true + stringData: + test: test asserts: - hasDocuments: count: 4 @@ -63,7 +67,8 @@ tests: set: secrets: secret: - enabled: true + stringData: + test: test asserts: - hasDocuments: count: 3 @@ -79,7 +84,8 @@ tests: set: secrets: secret: - enabled: true + stringData: + test: test nameOverride: http asserts: - hasDocuments: diff --git a/charts/library/common-test/tests/secret/pod_metadata_test.yaml b/charts/library/common-test/tests/secret/pod_metadata_test.yaml index 117d9fc8..3715f25f 100644 --- a/charts/library/common-test/tests/secret/pod_metadata_test.yaml +++ b/charts/library/common-test/tests/secret/pod_metadata_test.yaml @@ -8,16 +8,15 @@ tests: set: secrets: secret_1: - enabled: true - data: + stringData: test: value 1 secret_2: # default enabled - data: + stringData: test_1: value 1 test_2: value 2 test_disabled: enabled: false - data: + stringData: test: value 1 asserts: - documentIndex: &ControllerDoc 0 @@ -27,4 +26,4 @@ tests: equal: path: spec.template.metadata.annotations value: - checksum/secrets: 4107837201f46be5279f7accdf3942edabd38f0eb534a61c91d2d7cba7ffc557 + checksum/secrets: cd4e5076088172611ca1c43c659a275232d9eeb887acc20575ac141038b9aacb diff --git a/charts/library/common-test/tests/serviceMonitor/servicemonitor_test.yaml b/charts/library/common-test/tests/serviceMonitor/servicemonitor_test.yaml index 8f0b008f..bc148ef6 100644 --- a/charts/library/common-test/tests/serviceMonitor/servicemonitor_test.yaml +++ b/charts/library/common-test/tests/serviceMonitor/servicemonitor_test.yaml @@ -3,6 +3,7 @@ suite: serviceMonitor values templates: - common.yaml + tests: - it: a serviceMonitor is not created by default asserts: @@ -20,6 +21,7 @@ tests: serviceMonitor: main: enabled: false + serviceName: "{{ .Release.Name }}" asserts: - hasDocuments: count: 2 @@ -34,9 +36,9 @@ tests: set: serviceMonitor: main: - enabled: true labels: test.label: testvalue + serviceName: "{{ .Release.Name }}" endpoints: - port: http scheme: http @@ -83,8 +85,14 @@ tests: set: serviceMonitor: main: - enabled: true nameOverride: test + serviceName: "{{ .Release.Name }}" + endpoints: + - port: http + scheme: http + path: /metrics + interval: 1m + scrapeTimeout: 10s asserts: - hasDocuments: count: 3 @@ -107,8 +115,13 @@ tests: set: serviceMonitor: main: - enabled: true serviceName: "{{ .Release.Name }}" + endpoints: + - port: http + scheme: http + path: /metrics + interval: 1m + scrapeTimeout: 10s asserts: - hasDocuments: count: 3 @@ -131,10 +144,15 @@ tests: set: serviceMonitor: main: - enabled: true selector: - mySelector: + matchExpressions: test: "true" + endpoints: + - port: http + scheme: http + path: /metrics + interval: 1m + scrapeTimeout: 10s asserts: - hasDocuments: count: 3 @@ -149,13 +167,15 @@ tests: equal: path: spec.selector value: - mySelector: + matchExpressions: test: "true" + - it: a serviceMonitor is created with targetLabels set: serviceMonitor: main: enabled: true + serviceName: "{{ .Release.Name }}" endpoints: - port: http scheme: http @@ -163,8 +183,8 @@ tests: interval: 1m scrapeTimeout: 10s targetLabels: - - testlabel1 - - testlabel2 + - testlabel1 + - testlabel2 asserts: - hasDocuments: count: 3 diff --git a/charts/library/common-test/values.schema.json b/charts/library/common-test/values.schema.json new file mode 100644 index 00000000..da6da83e --- /dev/null +++ b/charts/library/common-test/values.schema.json @@ -0,0 +1,3 @@ +{ + "$ref": "file://../common/values.schema.json" +} diff --git a/charts/library/common-test/values.yaml b/charts/library/common-test/values.yaml index 0f44fbaa..843cb9b4 100644 --- a/charts/library/common-test/values.yaml +++ b/charts/library/common-test/values.yaml @@ -10,6 +10,7 @@ controllers: service: main: + controller: main ports: http: port: 8080 diff --git a/charts/library/common/Chart.yaml b/charts/library/common/Chart.yaml index 98c948ba..df27ff2a 100644 --- a/charts/library/common/Chart.yaml +++ b/charts/library/common/Chart.yaml @@ -3,7 +3,7 @@ apiVersion: v2 name: common description: Function library for Helm charts type: library -version: 2.6.0 +version: 3.0.0-beta1 kubeVersion: ">=1.22.0-0" keywords: - common @@ -14,9 +14,15 @@ maintainers: email: me@bjw-s.dev annotations: artifacthub.io/changes: |- - - kind: fixed + - kind: changed description: |- - ConfigMap and Secret checksums take enabled state in to account again + Default objects (they used to be called main) have been commented out and will therefore no longer provide any (both expected and unexpected) default values. + - kind: changed + description: |- + enableServiceLinks is disabled by default - kind: added description: |- - Add support for specifying parallelism in CronJobs and Jobs + Added support for restartPolicy field on container level + - kind: added + description: |- + Added json-schema to the chart diff --git a/charts/library/common/README.md b/charts/library/common/README.md index fa0a3973..0b1fe636 100644 --- a/charts/library/common/README.md +++ b/charts/library/common/README.md @@ -1,6 +1,6 @@ # common -![Version: 2.6.0](https://img.shields.io/badge/Version-2.6.0-informational?style=flat-square) ![Type: library](https://img.shields.io/badge/Type-library-informational?style=flat-square) +![Version: 3.0.0-beta1](https://img.shields.io/badge/Version-3.0.0--beta1-informational?style=flat-square) ![Type: library](https://img.shields.io/badge/Type-library-informational?style=flat-square) Function library for Helm charts @@ -27,7 +27,7 @@ Include this chart as a dependency in your `Chart.yaml` e.g. # Chart.yaml dependencies: - name: common - version: 2.6.0 + version: 3.0.0-beta1 repository: https://bjw-s.github.io/helm-charts/ ``` @@ -49,94 +49,26 @@ The following table contains an overview of available values and their descripti | Key | Type | Default | Description | |-----|------|---------|-------------| | configMaps | object | See below | Configure configMaps for the chart here. Additional configMaps can be added by adding a dictionary key similar to the 'config' object. | -| configMaps.config.annotations | object | `{}` | Annotations to add to the configMap | -| configMaps.config.data | object | `{}` | configMap data content. Helm template enabled. | -| configMaps.config.enabled | bool | `false` | Enables or disables the configMap | -| configMaps.config.labels | object | `{}` | Labels to add to the configMap | -| controllers.main.annotations | object | `{}` | Set annotations on the deployment/statefulset/daemonset/cronjob/job | -| controllers.main.containers.main.args | list | `[]` | Override the args for the default container | -| controllers.main.containers.main.command | list | `[]` | Override the command(s) for the default container | -| controllers.main.containers.main.dependsOn | list | `[]` | Specify if this container depends on any other containers This is used to determine the order in which the containers are rendered. The use of "dependsOn" completely disables the "order" field within the controller. | -| controllers.main.containers.main.env | string | `nil` | Environment variables. Template enabled. Syntax options: A) TZ: UTC B) PASSWD: '{{ .Release.Name }}' B) TZ: value: UTC dependsOn: otherVar D) PASSWD: configMapKeyRef: name: config-map-name key: key-name E) PASSWD: dependsOn: - otherVar1 - otherVar2 valueFrom: secretKeyRef: name: secret-name key: key-name ... F) - name: TZ value: UTC G) - name: TZ value: '{{ .Release.Name }}' | -| controllers.main.containers.main.envFrom | list | `[]` | Secrets and/or ConfigMaps that will be loaded as environment variables. Syntax options: A) Pass an app-template configMap identifier: - config: config B) Pass any configMap name that is not also an identifier (Template enabled): - config: random-configmap-name C) Pass an app-template configMap identifier, explicit syntax: - configMapRef: identifier: config D) Pass any configMap name, explicit syntax (Template enabled): - configMapRef: name: "{{ .Release.Name }}-config" E) Pass an app-template secret identifier: - secret: secret F) Pass any secret name that is not also an identifier (Template enabled): - secret: random-secret-name G) Pass an app-template secret identifier, explicit syntax: - secretRef: identifier: secret H) Pass any secret name, explicit syntax (Template enabled): - secretRef: name: "{{ .Release.Name }}-secret" | -| controllers.main.containers.main.image.pullPolicy | string | `nil` | image pull policy | -| controllers.main.containers.main.image.repository | string | `nil` | image repository | -| controllers.main.containers.main.image.tag | string | `nil` | image tag | -| controllers.main.containers.main.lifecycle | object | `{}` | [[ref](https://kubernetes.io/docs/tasks/configure-pod-container/attach-handler-lifecycle-event/)] | -| controllers.main.containers.main.nameOverride | string | `nil` | Override the container name | -| controllers.main.containers.main.order | int | 99 | Override the default container order Containers get sorted alphanumerically by the `-` combination. | -| controllers.main.containers.main.probes | object | See below | [[ref]](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) | -| controllers.main.containers.main.probes.liveness | object | See below | Liveness probe configuration | -| controllers.main.containers.main.probes.liveness.custom | bool | `false` | Set this to `true` if you wish to specify your own livenessProbe | -| controllers.main.containers.main.probes.liveness.enabled | bool | `true` | Enable the liveness probe | -| controllers.main.containers.main.probes.liveness.spec | object | See below | The spec field contains the values for the default livenessProbe. If you selected `custom: true`, this field holds the definition of the livenessProbe. | -| controllers.main.containers.main.probes.liveness.type | string | "TCP" | sets the probe type when not using a custom probe | -| controllers.main.containers.main.probes.readiness | object | See below | Redainess probe configuration | -| controllers.main.containers.main.probes.readiness.custom | bool | `false` | Set this to `true` if you wish to specify your own readinessProbe | -| controllers.main.containers.main.probes.readiness.enabled | bool | `true` | Enable the readiness probe | -| controllers.main.containers.main.probes.readiness.spec | object | See below | The spec field contains the values for the default readinessProbe. If you selected `custom: true`, this field holds the definition of the readinessProbe. | -| controllers.main.containers.main.probes.readiness.type | string | "TCP" | sets the probe type when not using a custom probe | -| controllers.main.containers.main.probes.startup | object | See below | Startup probe configuration | -| controllers.main.containers.main.probes.startup.custom | bool | `false` | Set this to `true` if you wish to specify your own startupProbe | -| controllers.main.containers.main.probes.startup.enabled | bool | `true` | Enable the startup probe | -| controllers.main.containers.main.probes.startup.spec | object | See below | The spec field contains the values for the default startupProbe. If you selected `custom: true`, this field holds the definition of the startupProbe. | -| controllers.main.containers.main.probes.startup.type | string | "TCP" | sets the probe type when not using a custom probe | -| controllers.main.containers.main.resources | object | `{}` | Set the resource requests / limits for the container. | -| controllers.main.containers.main.securityContext | object | `{}` | Configure the Security Context for the container | -| controllers.main.containers.main.terminationMessagePath | string | `nil` | [[ref](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#lifecycle-1)] | -| controllers.main.containers.main.terminationMessagePolicy | string | `nil` | [[ref](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#lifecycle-1)] | -| controllers.main.containers.main.workingDir | string | `nil` | Override the working directory for the default container | -| controllers.main.cronjob | object | See below | CronJob configuration. Required only when using `controller.type: cronjob`. | -| controllers.main.cronjob.backoffLimit | int | `6` | Limits the number of times a failed job will be retried | -| controllers.main.cronjob.concurrencyPolicy | string | `"Forbid"` | Specifies how to treat concurrent executions of a job that is created by this cron job valid values are Allow, Forbid or Replace | -| controllers.main.cronjob.failedJobsHistory | int | `1` | The number of failed Jobs to keep | -| controllers.main.cronjob.parallelism | string | `nil` | Specify the number of parallel jobs | -| controllers.main.cronjob.schedule | string | `"*/20 * * * *"` | Sets the CronJob time when to execute your jobs | -| controllers.main.cronjob.startingDeadlineSeconds | int | `30` | The deadline in seconds for starting the job if it misses its scheduled time for any reason | -| controllers.main.cronjob.successfulJobsHistory | int | `1` | The number of succesful Jobs to keep | -| controllers.main.cronjob.suspend | string | false | Suspends the CronJob [[ref]](https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/#schedule-suspension) | -| controllers.main.cronjob.timeZone | string | `nil` | Sets the CronJob timezone (only works in Kubernetes >= 1.27) | -| controllers.main.cronjob.ttlSecondsAfterFinished | string | `nil` | If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. | -| controllers.main.enabled | bool | `true` | enable the controller. | -| controllers.main.initContainers | object | `{}` | Specify any initContainers here as dictionary items. Each initContainer should have its own key initContainers get sorted alphanumerically by the `-` combination if no order or dependsOn has been configured for them. | -| controllers.main.job | object | See below | Job configuration. Required only when using `controller.type: job`. | -| controllers.main.job.backoffLimit | int | `6` | Limits the number of times a failed job will be retried | -| controllers.main.job.completionMode | string | `nil` | Specify the completionMode for the job | -| controllers.main.job.completions | string | `nil` | Specify the number of completions for the job | -| controllers.main.job.parallelism | string | `nil` | Specify the number of parallel jobs | -| controllers.main.job.suspend | string | false | Suspends the Job [[ref]](https://kubernetes.io/docs/concepts/workloads/controllers/job/#suspending-a-job) | -| controllers.main.job.ttlSecondsAfterFinished | string | `nil` | If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. | -| controllers.main.labels | object | `{}` | Set labels on the deployment/statefulset/daemonset/cronjob/job | -| controllers.main.pod | object | `{}` | | -| controllers.main.replicas | int | `1` | Number of desired pods. When using a HorizontalPodAutoscaler, set this to `null`. | -| controllers.main.revisionHistoryLimit | int | `3` | ReplicaSet revision history limit | -| controllers.main.rollingUpdate.partition | string | `nil` | Set statefulset RollingUpdate partition | -| controllers.main.rollingUpdate.surge | string | `nil` | Set deployment RollingUpdate max surge | -| controllers.main.rollingUpdate.unavailable | string | `nil` | Set deployment RollingUpdate max unavailable | -| controllers.main.statefulset | object | `{"podManagementPolicy":null,"volumeClaimTemplates":[]}` | StatefulSet configuration. Required only when using `controller.type: statefulset`. | -| controllers.main.statefulset.podManagementPolicy | string | `nil` | Set podManagementPolicy, valid values are Parallel and OrderedReady (default). | -| controllers.main.statefulset.volumeClaimTemplates | list | `[]` | Used to create individual disks for each instance. | -| controllers.main.strategy | string | `nil` | Set the controller upgrade strategy For Deployments, valid values are Recreate (default) and RollingUpdate. For StatefulSets, valid values are OnDelete and RollingUpdate (default). DaemonSets/CronJobs/Jobs ignore this. | -| controllers.main.type | string | `"deployment"` | Set the controller type. Valid options are deployment, daemonset, statefulset, cronjob or job | -| defaultPodOptions | object | `{"affinity":{},"annotations":{},"automountServiceAccountToken":true,"dnsConfig":{},"dnsPolicy":null,"enableServiceLinks":true,"hostAliases":[],"hostIPC":false,"hostNetwork":false,"hostPID":false,"hostname":null,"imagePullSecrets":[],"labels":{},"nodeSelector":{},"priorityClassName":null,"restartPolicy":null,"runtimeClassName":null,"schedulerName":null,"securityContext":{},"terminationGracePeriodSeconds":null,"tolerations":[],"topologySpreadConstraints":[]}` | Set default options for all controllers / pods here Each of these options can be overridden on a Controller level | +| controllers | object | `{}` | | +| defaultPodOptions | object | `{"affinity":{},"annotations":{},"automountServiceAccountToken":true,"dnsConfig":{},"dnsPolicy":"","enableServiceLinks":false,"hostAliases":[],"hostIPC":false,"hostNetwork":false,"hostPID":false,"hostname":"","imagePullSecrets":[],"labels":{},"nodeSelector":{},"priorityClassName":"","restartPolicy":"","runtimeClassName":"","schedulerName":"","securityContext":{},"terminationGracePeriodSeconds":null,"tolerations":[],"topologySpreadConstraints":[]}` | Set default options for all controllers / pods here Each of these options can be overridden on a Controller level | | defaultPodOptions.affinity | object | `{}` | Defines affinity constraint rules. [[ref]](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#affinity-and-anti-affinity) | | defaultPodOptions.annotations | object | `{}` | Set annotations on the Pod. Pod-specific values will be merged with this. | | defaultPodOptions.automountServiceAccountToken | bool | `true` | Specifies whether a service account token should be automatically mounted. | | defaultPodOptions.dnsConfig | object | `{}` | Configuring the ndots option may resolve nslookup issues on some Kubernetes setups. | -| defaultPodOptions.dnsPolicy | string | `nil` | Defaults to "ClusterFirst" if hostNetwork is false and "ClusterFirstWithHostNet" if hostNetwork is true. | -| defaultPodOptions.enableServiceLinks | bool | `true` | Enable/disable the generation of environment variables for services. [[ref]](https://kubernetes.io/docs/concepts/services-networking/connect-applications-service/#accessing-the-service) | +| defaultPodOptions.dnsPolicy | string | `""` | Defaults to "ClusterFirst" if hostNetwork is false and "ClusterFirstWithHostNet" if hostNetwork is true. | +| defaultPodOptions.enableServiceLinks | bool | `false` | Enable/disable the generation of environment variables for services. [[ref]](https://kubernetes.io/docs/concepts/services-networking/connect-applications-service/#accessing-the-service) | | defaultPodOptions.hostAliases | list | `[]` | Use hostAliases to add custom entries to /etc/hosts - mapping IP addresses to hostnames. [[ref]](https://kubernetes.io/docs/concepts/services-networking/add-entries-to-pod-etc-hosts-with-host-aliases/) | | defaultPodOptions.hostIPC | bool | `false` | Use the host's ipc namespace | | defaultPodOptions.hostNetwork | bool | `false` | When using hostNetwork make sure you set dnsPolicy to `ClusterFirstWithHostNet` | | defaultPodOptions.hostPID | bool | `false` | Use the host's pid namespace | -| defaultPodOptions.hostname | string | `nil` | Allows specifying explicit hostname setting | +| defaultPodOptions.hostname | string | `""` | Allows specifying explicit hostname setting | | defaultPodOptions.imagePullSecrets | list | `[]` | Set image pull secrets | | defaultPodOptions.labels | object | `{}` | Set labels on the Pod. Pod-specific values will be merged with this. | | defaultPodOptions.nodeSelector | object | `{}` | Node selection constraint [[ref]](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector) | -| defaultPodOptions.priorityClassName | string | `nil` | Custom priority class for different treatment by the scheduler | +| defaultPodOptions.priorityClassName | string | `""` | Custom priority class for different treatment by the scheduler | | defaultPodOptions.restartPolicy | string | `Always`. When `controller.type` is `cronjob` it defaults to `Never`. | Set Container restart policy. | -| defaultPodOptions.runtimeClassName | string | `nil` | Allow specifying a runtimeClassName other than the default one (ie: nvidia) | -| defaultPodOptions.schedulerName | string | `nil` | Allows specifying a custom scheduler name | +| defaultPodOptions.runtimeClassName | string | `""` | Allow specifying a runtimeClassName other than the default one (ie: nvidia) | +| defaultPodOptions.schedulerName | string | `""` | Allows specifying a custom scheduler name | | defaultPodOptions.securityContext | object | `{}` | Configure the Security Context for the Pod | | defaultPodOptions.terminationGracePeriodSeconds | string | `nil` | [[ref](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#lifecycle)] | | defaultPodOptions.tolerations | list | `[]` | Specify taint tolerations [[ref]](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) | @@ -145,86 +77,17 @@ The following table contains an overview of available values and their descripti | global.fullnameOverride | string | `nil` | Set the entire name definition | | global.labels | object | `{}` | Set additional global labels. Helm templates can be used. | | global.nameOverride | string | `nil` | Set an override for the prefix of the fullname | -| ingress | object | See below | Configure the ingresses for the chart here. Additional ingresses can be added by adding a dictionary key similar to the 'main' ingress. | -| ingress.main.annotations | object | `{}` | Provide additional annotations which may be required. | -| ingress.main.className | string | `nil` | Set the ingressClass that is used for this ingress. | -| ingress.main.defaultBackend | string | `nil` | Configure the defaultBackend for this ingress. This will disable any other rules for the ingress. | -| ingress.main.enabled | bool | `false` | Enables or disables the ingress | -| ingress.main.hosts[0].host | string | `"chart-example.local"` | Host address. Helm template can be passed. | -| ingress.main.hosts[0].paths[0].path | string | `"/"` | Path. Helm template can be passed. | -| ingress.main.hosts[0].paths[0].service.name | string | `"main"` | Overrides the service name reference for this path This can be an actual service name, or reference a service identifier from this values.yaml | -| ingress.main.hosts[0].paths[0].service.port | string | `nil` | Overrides the service port number reference for this path | -| ingress.main.labels | object | `{}` | Provide additional labels which may be required. | -| ingress.main.nameOverride | string | `nil` | Override the name suffix that is used for this ingress. | -| ingress.main.primary | bool | `true` | Make this the primary ingress (used in probes, notes, etc...). If there is more than 1 ingress, make sure that only 1 ingress is marked as primary. | -| ingress.main.tls | list | `[]` | Configure TLS for the ingress. Both secretName and hosts can process a Helm template. | +| ingress | object | `{}` | Configure the ingresses for the chart here. | | networkpolicies | object | See below | Configure the networkPolicies for the chart here. Additional networkPolicies can be added by adding a dictionary key similar to the 'main' networkPolicy. | -| networkpolicies.main.controller | string | `"main"` | Configure which controller this networkPolicy should target | -| networkpolicies.main.enabled | bool | `false` | Enables or disables the networkPolicy item. Defaults to true | -| networkpolicies.main.policyTypes | list | `["Ingress","Egress"]` | The policyTypes for this networkPolicy | -| networkpolicies.main.rules | object | `{"egress":[{}],"ingress":[{}]}` | The rulesets for this networkPolicy [[ref]](https://kubernetes.io/docs/concepts/services-networking/network-policies/#networkpolicy-resource) | -| networkpolicies.main.rules.egress | list | `[{}]` | The egress rules for this networkPolicy. Allows all egress traffic by default. | -| networkpolicies.main.rules.ingress | list | `[{}]` | The ingress rules for this networkPolicy. Allows all ingress traffic by default. | | persistence | object | See below | Configure persistence for the chart here. Additional items can be added by adding a dictionary key similar to the 'config' key. [[ref]](https://bjw-s.github.io/helm-charts/docs/common-library/common-library-storage) | -| persistence.config.accessMode | string | `"ReadWriteOnce"` | AccessMode for the persistent volume. Make sure to select an access mode that is supported by your storage provider! [[ref]](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes) | -| persistence.config.advancedMounts | object | `{}` | Explicitly configure mounts for specific controllers and containers. Example: advancedMounts: main: # the controller with the "main" identifier main: # the container with the "main" identifier - path: /data/config.yaml readOnly: true mountPropagation: None subPath: config.yaml second-container: # the container with the "second-container" identifier - path: /appdata/config readOnly: true second-controller: # the controller with the "second-controller" identifier main: # the container with the "main" identifier - path: /data/config.yaml readOnly: false subPath: config.yaml | -| persistence.config.dataSource | object | `{}` | The optional data source for the persistentVolumeClaim. [[ref]](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#volume-populators-and-data-sources) | -| persistence.config.dataSourceRef | object | `{}` | The optional volume populator for the persistentVolumeClaim. [[ref]](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#volume-populators-and-data-sources) | -| persistence.config.enabled | bool | `false` | Enables or disables the persistence item. Defaults to true | -| persistence.config.existingClaim | string | `nil` | If you want to reuse an existing claim, the name of the existing PVC can be passed here. | -| persistence.config.globalMounts | list | `[]` | Configure mounts to all controllers and containers. By default the persistence item will be mounted to `/`. Example: globalMounts: - path: /config readOnly: false | -| persistence.config.retain | bool | `false` | Set to true to retain the PVC upon `helm uninstall` | -| persistence.config.size | string | `"1Gi"` | The amount of storage that is requested for the persistent volume. | -| persistence.config.storageClass | string | `nil` | Storage Class for the config volume. If set to `-`, dynamic provisioning is disabled. If set to something else, the given storageClass is used. If undefined (the default) or set to null, no storageClassName spec is set, choosing the default provisioner. | -| persistence.config.type | string | `"persistentVolumeClaim"` | Sets the persistence type Valid options are persistentVolumeClaim, emptyDir, nfs, hostPath, secret, configMap or custom | | route | object | See below | Configure the gateway routes for the chart here. Additional routes can be added by adding a dictionary key similar to the 'main' route. [[ref]](https://gateway-api.sigs.k8s.io/references/spec/) | -| route.main.annotations | object | `{}` | Provide additional annotations which may be required. | -| route.main.enabled | bool | `false` | Enables or disables the route | -| route.main.hostnames | list | `[]` | Host addresses. Helm template can be passed. | -| route.main.kind | string | `"HTTPRoute"` | Set the route kind Valid options are GRPCRoute, HTTPRoute, TCPRoute, TLSRoute, UDPRoute | -| route.main.labels | object | `{}` | Provide additional labels which may be required. | -| route.main.nameOverride | string | `nil` | Override the name suffix that is used for this route. | -| route.main.parentRefs | list | `[{"group":"gateway.networking.k8s.io","kind":"Gateway","name":null,"namespace":null,"sectionName":null}]` | Configure the resource the route attaches to. | -| route.main.rules | list | `[{"backendRefs":[],"filters":[],"matches":[{"path":{"type":"PathPrefix","value":"/"}}],"timeouts":{}}]` | Configure rules for routing. Defaults to the primary service. | -| route.main.rules[0].backendRefs | list | `[]` | Configure backends where matching requests should be sent. | | secrets | object | See below | Use this to populate secrets with the values you specify. Be aware that these values are not encrypted by default, and could therefore visible to anybody with access to the values.yaml file. Additional Secrets can be added by adding a dictionary key similar to the 'secret' object. | -| secrets.secret.annotations | object | `{}` | Annotations to add to the Secret | -| secrets.secret.enabled | bool | `false` | Enables or disables the Secret | -| secrets.secret.labels | object | `{}` | Labels to add to the Secret | -| secrets.secret.stringData | object | `{}` | Secret stringData content. Helm template enabled. | | service | object | See below | Configure the services for the chart here. Additional services can be added by adding a dictionary key similar to the 'main' service. | -| service.main.annotations | object | `{}` | Provide additional annotations which may be required. | -| service.main.controller | string | `"main"` | Configure which controller this service should target | -| service.main.enabled | bool | `true` | Enables or disables the service | -| service.main.externalTrafficPolicy | string | `nil` | [[ref](https://kubernetes.io/docs/tutorials/services/source-ip/)] | -| service.main.extraSelectorLabels | object | `{}` | Allow adding additional match labels | -| service.main.ipFamilies | list | `[]` | The ip families that should be used. Options: IPv4, IPv6 | -| service.main.ipFamilyPolicy | string | `nil` | Specify the ip policy. Options: SingleStack, PreferDualStack, RequireDualStack | -| service.main.labels | object | `{}` | Provide additional labels which may be required. | -| service.main.nameOverride | string | `nil` | Override the name suffix that is used for this service | -| service.main.ports | object | See below | Configure the Service port information here. Additional ports can be added by adding a dictionary key similar to the 'http' service. | -| service.main.ports.http.appProtocol | string | `nil` | Specify the appProtocol value for the Service. [[ref]](https://kubernetes.io/docs/concepts/services-networking/service/#application-protocol) | -| service.main.ports.http.enabled | bool | `true` | Enables or disables the port | -| service.main.ports.http.nodePort | string | `nil` | Specify the nodePort value for the LoadBalancer and NodePort service types. [[ref]](https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport) | -| service.main.ports.http.port | string | `nil` | The port number | -| service.main.ports.http.primary | bool | `true` | Make this the primary port (used in probes, notes, etc...) If there is more than 1 service, make sure that only 1 port is marked as primary. | -| service.main.ports.http.protocol | string | `"HTTP"` | Port protocol. Support values are `HTTP`, `HTTPS`, `TCP` and `UDP`. HTTP and HTTPS spawn a TCP service and get used for internal URL and name generation | -| service.main.ports.http.targetPort | string | `nil` | Specify a service targetPort if you wish to differ the service port from the application port. If `targetPort` is specified, this port number is used in the container definition instead of the `port` value. Therefore named ports are not supported for this field. | -| service.main.primary | bool | `true` | Make this the primary service for this controller (used in probes, notes, etc...). If there is more than 1 service targeting the controller, make sure that only 1 service is marked as primary. | -| service.main.type | string | `"ClusterIP"` | Set the service type | | serviceAccount.annotations | object | `{}` | Annotations to add to the service account | | serviceAccount.create | bool | `false` | Specifies whether a service account should be created | | serviceAccount.labels | object | `{}` | Labels to add to the service account | | serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template | | serviceMonitor | object | See below | Configure the ServiceMonitors for the chart here. Additional ServiceMonitors can be added by adding a dictionary key similar to the 'main' ServiceMonitors. | -| serviceMonitor.main.annotations | object | `{}` | Provide additional annotations which may be required. | -| serviceMonitor.main.enabled | bool | `false` | Enables or disables the serviceMonitor. | -| serviceMonitor.main.endpoints | list | See values.yaml | Configures the endpoints for the serviceMonitor. | -| serviceMonitor.main.labels | object | `{}` | Provide additional labels which may be required. | -| serviceMonitor.main.nameOverride | string | `nil` | Override the name suffix that is used for this serviceMonitor. | -| serviceMonitor.main.selector | object | `{}` | Configures a custom selector for the serviceMonitor, this takes precedence over specifying a service name. Helm templates can be used. | -| serviceMonitor.main.serviceName | string | `"{{ include \"bjw-s.common.lib.chart.names.fullname\" $ }}"` | Configures the target Service for the serviceMonitor. Helm templates can be used. | -| serviceMonitor.main.targetLabels | list | `[]` | Configures custom targetLabels for the serviceMonitor. (All collected meterics will have these labels, taking the value from the target service) [[ref]](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#servicemonitorspec/) | diff --git a/charts/library/common/schemas/configmap.json b/charts/library/common/schemas/configmap.json new file mode 100644 index 00000000..15067ffc --- /dev/null +++ b/charts/library/common/schemas/configmap.json @@ -0,0 +1,28 @@ +{ + "instance": { + "type": "object", + "additionalProperties": false, + "properties": { + "enabled": { + "type": "boolean", + "default": true + }, + "annotations": { + "$ref": "definitions.json#/annotations" + }, + "labels": { + "$ref": "definitions.json#/labels" + }, + "nameOverride": { + "type": "string" + }, + "data": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "required": ["data"] + } +} diff --git a/charts/library/common/schemas/containers.json b/charts/library/common/schemas/containers.json new file mode 100644 index 00000000..976a15d5 --- /dev/null +++ b/charts/library/common/schemas/containers.json @@ -0,0 +1,397 @@ +{ + "container": { + "type": "object", + "additionalProperties": false, + + "properties": { + "enabled": { + "type": "boolean", + "default": true + }, + "args": { + "oneOf": [ + { + "type": "array", + "items": {"type": "string"} + }, + {"type": "string"} + ] + }, + "command": { + "oneOf": [ + { + "type": "array", + "items": {"type": "string"} + }, + {"type": "string"} + ] + }, + "dependsOn": { + "oneOf": [ + { + "type": "array", + "items": {"type": "string"} + }, + {"type": "string"} + ] + }, + "env": { + "anyOf": [ + { + "type": "array", + "items": { + "anyOf": [ + {"$ref": "#/envValueWithName"}, + {"$ref": "#/envValueFromWithName"}, + {"$ref": "#/envImplicitValueFromWithName"} + ] + } + }, + { + "type": "object", + "additionalProperties": { + "anyOf": [ + {"type": ["string", "number", "boolean"]}, + {"$ref": "#/envValue"}, + {"$ref": "#/envValueFrom"}, + {"$ref": "#/envImplicitValueFrom"} + ] + } + } + ] + }, + "envFrom": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false, + "properties": { + "configMap": { + "type": "string" + }, + "configMapRef": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": {"type": "string"}, + "identifier": {"type": "string"}, + "optional": {"type": "boolean"} + }, + "oneOf": [{"required": ["name"]}, {"required": ["identifier"]}] + }, + "prefix": { + "type": ["string", "null"] + }, + "secret": { + "type": "string" + }, + "secretRef": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": {"type": "string"}, + "identifier": {"type": "string"}, + "optional": {"type": "boolean"} + }, + "oneOf": [{"required": ["name"]}, {"required": ["identifier"]}] + } + } + } + }, + "image": { + "type": "object", + "additionalProperties": false, + "properties": { + "pullPolicy": { + "type": "string", + "enum": ["Always", "IfNotPresent"] + }, + "repository": { + "type": "string" + }, + "tag": { + "type": ["string", "number"] + } + }, + "required": ["repository", "tag"] + }, + "lifecycle": { + "$ref": "k8s-api.json#/core.v1.Lifecycle" + }, + "nameOverride": { + "type": "string" + }, + "ports": { + "type": "array", + "items": { + "$ref": "k8s-api.json#/core.v1.ContainerPort" + } + }, + "probes": { + "type": "object", + "additionalProperties": false, + "properties": { + "liveness": { + "$ref": "#/probe" + }, + "readiness": { + "$ref": "#/probe" + }, + "startup": { + "$ref": "#/probe" + } + } + }, + "resources": { + "$ref": "k8s-api.json#/core.v1.ResourceRequirements" + }, + "restartPolicy": { + "type": "string" + }, + "securityContext": { + "$ref": "k8s-api.json#/core.v1.ContainerSecurityContext" + }, + "terminationMessagePath": { + "type": "string" + }, + "terminationMessagePolicy": { + "type": "string", + "enum": ["File", "FallbackToLogsOnError"] + }, + "workingDir": { + "type": "string" + } + } + }, + + "envValueWithName": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": ["string", "number", "boolean"] + } + }, + "required": ["name", "value"] + }, + + "envValue": { + "type": "object", + "additionalProperties": false, + "properties": { + "value": { + "type": ["string", "number", "boolean"] + }, + "dependsOn": {"$ref": "#/envDependsOn"} + }, + "required": ["value"] + }, + + "envValueFromWithName": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "type": "string" + }, + "valueFrom": { + "oneOf": [ + {"$ref": "#/envValueFrom.fieldRef"}, + {"$ref": "#/envValueFrom.secretKeyRef"} + ] + }, + "dependsOn": {"$ref": "#/envDependsOn"} + }, + "required": ["name", "valueFrom"] + }, + + "envValueFrom": { + "type": "object", + "additionalProperties": false, + "properties": { + "valueFrom": { + "oneOf": [ + {"$ref": "#/envValueFrom.fieldRef"}, + {"$ref": "#/envValueFrom.secretKeyRef"} + ] + }, + "dependsOn": {"$ref": "#/envDependsOn"} + }, + "required": ["valueFrom"] + }, + + "envImplicitValueFromWithName": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "type": "string" + }, + "fieldRef": {"$ref": "#/envValueFrom.fieldPath"}, + "secretKeyRef": {"$ref": "#/envValueFrom.secretKeyRef"}, + "configMapKeyRef": {"$ref": "#/envValueFrom.configMapKeyRef"} + }, + "required": ["name"], + "dependencies": { + "fieldRef": { + "allOf": [ + {"not": {"required": ["secretKeyRef"]}}, + {"not": {"required": ["configMapKeyRef"]}} + ] + }, + "secretKeyRef": { + "allOf": [ + {"not": {"required": ["fieldRef"]}}, + {"not": {"required": ["configMapKeyRef"]}} + ] + }, + "configMapKeyRef": { + "allOf": [ + {"not": {"required": ["secretKeyRef"]}}, + {"not": {"required": ["configMapKeyRef"]}} + ] + } + } + }, + + "envImplicitValueFrom": { + "type": "object", + "oneOf": [ + {"$ref": "#/envValueFrom.fieldRef"}, + {"$ref": "#/envValueFrom.secretKeyRef"}, + {"$ref": "#/envValueFrom.configMapKeyRef"} + ] + }, + + "envDependsOn": { + "oneOf": [ + {"type": "string"}, + {"type": "array", "items": {"type": "string"}} + ] + }, + + "envValueFrom.secretKeyRef": { + "type": "object", + "additionalProperties": false, + "properties": { + "secretKeyRef": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "key": { + "type": "string" + } + }, + "required": ["name", "key"] + } + }, + "required": ["secretKeyRef"] + }, + + "envValueFrom.configMapKeyRef": { + "type": "object", + "additionalProperties": false, + "properties": { + "configMapKeyRef": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "key": { + "type": "string" + } + }, + "required": ["name", "key"] + } + }, + "required": ["secretKeyRef"] + }, + + "envValueFrom.fieldRef": { + "type": "object", + "additionalProperties": false, + "properties": { + "fieldRef": { + "$ref": "#/envValueFrom.fieldPath" + } + }, + "required": ["fieldRef"] + }, + + "envValueFrom.fieldPath": { + "type": "object", + "additionalProperties": false, + "properties": { + "fieldPath": { + "type": "string" + } + }, + "required": ["fieldPath"] + }, + + "probe": { + "additionalProperties": false, + "properties": { + "enabled": { + "type": "boolean", + "default": false + }, + "custom": { + "type": "boolean", + "default": false + }, + "path": { + "type": "string" + }, + "port": { + "type": ["number", "string"] + }, + "spec": { + "allOf": [ + { + "if": {}, + "then": {"$ref": "k8s-api.json#/core.v1.Probe"}, + "else": { + "type": "object", + "additionalProperties": false, + "properties": { + "failureThreshold": { + "type": "integer", + "default": 3 + }, + "initialDelaySeconds": { + "type": "integer", + "default": 0 + }, + "periodSeconds": { + "type": "integer", + "default": 10 + }, + "timeoutSeconds": { + "type": "integer", + "default": 1 + } + }, + "required": [ + "initialDelaySeconds", + "periodSeconds", + "timeoutSeconds", + "failureThreshold" + ] + } + } + ] + }, + "type": { + "type": "string", + "enum": ["TCP", "HTTP", "HTTPS", "AUTO"] + } + } + } +} diff --git a/charts/library/common/schemas/controllers.json b/charts/library/common/schemas/controllers.json new file mode 100644 index 00000000..0e3f29e1 --- /dev/null +++ b/charts/library/common/schemas/controllers.json @@ -0,0 +1,262 @@ +{ + "instance": { + "type": "object", + "additionalProperties": false, + + "properties": { + "enabled": { + "type": "boolean", + "default": true + }, + "type": { + "type": "string", + "enum": ["deployment", "statefulset", "daemonset", "cronjob", "job"], + "default": "deployment" + }, + "annotations": { + "$ref": "definitions.json#/annotations" + }, + "labels": { + "$ref": "definitions.json#/labels" + }, + "nameOverride": { + "type": "string" + }, + "pod": { + "$ref": "pod.json#/options" + }, + "replicas": { + "type": ["integer", "null"], + "default": 1 + }, + "revisionHistoryLimit": { + "type": "integer" + }, + "rollingUpdate": { + "type": "object" + }, + "strategy": { + "type": "string" + }, + "cronjob": { + "$ref": "#/cronjob" + }, + "job": { + "$ref": "#/job" + }, + "statefulset": { + "$ref": "#/statefulset" + }, + "initContainers": { + "type": "object", + "additionalProperties": { + "$ref": "containers.json#/container" + } + }, + "containers": { + "type": "object", + "additionalProperties": { + "$ref": "containers.json#/container" + } + } + }, + + "allOf": [ + { + "if": { + "properties": { + "type": {"const": "deployment"} + } + }, + "then": { + "not": { + "anyOf": [ + {"required": ["statefulset"]}, + {"required": ["cronjob"]}, + {"required": ["job"]}, + {"required": ["daemonset"]} + ] + } + } + }, + { + "if": { + "properties": { + "type": {"const": "statefulset"} + }, + "required": ["type"] + }, + "then": { + "not": { + "anyOf": [ + {"required": ["cronjob"]}, + {"required": ["job"]}, + {"required": ["daemonset"]} + ] + } + } + }, + { + "if": { + "properties": { + "type": {"const": "cronjob"} + }, + "required": ["type"] + }, + "then": { + "allOf": [ + { + "not": { + "anyOf": [ + {"required": ["statefulset"]}, + {"required": ["job"]}, + {"required": ["daemonset"]} + ] + } + }, + {"required": ["cronjob"]} + ] + } + }, + { + "if": { + "properties": { + "type": {"const": "job"} + }, + "required": ["type"] + }, + "then": { + "not": { + "anyOf": [ + {"required": ["statefulset"]}, + {"required": ["cronjob"]}, + {"required": ["daemonset"]} + ] + } + } + } + ] + }, + + "statefulset": { + "type": "object", + "additionalProperties": false, + + "properties": { + "podManagementPolicy": { + "type": "string" + }, + "volumeClaimTemplates": { + "type": "array", + "items": { + "$ref": "#/statefulset.volumeClaimTemplate" + } + } + } + }, + + "statefulset.volumeClaimTemplate": { + "type": "object", + "additionalProperties": false, + + "properties": { + "enabled": { + "type": "boolean", + "default": true + }, + "accessMode": { + "type": "string" + }, + "advancedMounts": { + "type": "object", + "additionalProperties": { + "$ref": "persistence.json#/mountPathCollection" + } + }, + "annotations": {"$ref": "definitions.json#/annotations"}, + "dataSource": {"$ref": "persistence.json#/dataSourceReference"}, + "dataSourceRef": {"$ref": "persistence.json#/dataSourceReference"}, + "globalMounts": {"$ref": "persistence.json#/globalMounts"}, + "labels": {"$ref": "definitions.json#/labels"}, + "name": { + "type": "string" + }, + "size": { + "type": "string" + }, + "storageClass": { + "type": "string" + } + }, + "required": ["name", "size"] + }, + + "cronjob": { + "type": "object", + "additionalProperties": false, + + "properties": { + "backoffLimit": { + "type": "integer", + "default": 6 + }, + "concurrencyPolicy": { + "type": "string", + "default": "Forbid" + }, + "failedJobsHistory": { + "type": "integer", + "default": 1 + }, + "parallelism": { + "type": "integer" + }, + "schedule": { + "type": "string" + }, + "startingDeadlineSeconds": { + "type": "integer", + "default": 30 + }, + "successfulJobsHistory": { + "type": "integer", + "default": 1 + }, + "suspend": { + "type": "boolean", + "default": false + }, + "timeZone": { + "type": "string" + }, + "ttlSecondsAfterFinished": { + "type": "integer" + } + }, + "required": ["schedule"] + }, + + "job": { + "type": "object", + "additionalProperties": false, + + "properties": { + "backoffLimit": { + "type": "integer", + "default": 6 + }, + "completions": {}, + "completionMode": {}, + "parallelism": { + "type": "integer" + }, + "suspend": { + "type": "boolean", + "default": false + }, + "ttlSecondsAfterFinished": { + "type": "integer" + } + } + } +} diff --git a/charts/library/common/schemas/definitions.json b/charts/library/common/schemas/definitions.json new file mode 100644 index 00000000..71b0c71b --- /dev/null +++ b/charts/library/common/schemas/definitions.json @@ -0,0 +1,15 @@ +{ + "annotations": { + "type": ["object", "null"], + "additionalProperties": { + "type": ["string"] + } + }, + + "labels": { + "type": ["object", "null"], + "additionalProperties": { + "type": ["string"] + } + } +} diff --git a/charts/library/common/schemas/ingress.json b/charts/library/common/schemas/ingress.json new file mode 100644 index 00000000..bf449c41 --- /dev/null +++ b/charts/library/common/schemas/ingress.json @@ -0,0 +1,105 @@ +{ + "instance": { + "type": "object", + "additionalProperties": false, + + "properties": { + "enabled": { + "type": "boolean", + "default": true + }, + + "annotations": { + "$ref": "definitions.json#/annotations" + }, + + "className": { + "type": "string" + }, + + "defaultBackend": { + "type": "string" + }, + + "hosts": { + "type": "array", + "items": { + "$ref": "#/hostEntry" + } + }, + + "labels": { + "$ref": "definitions.json#/labels" + }, + + "nameOverride": { + "type": "string" + }, + + "tls": { + "type": "array", + "items": { + "$ref": "#/tlsEntry" + } + } + }, + "required": ["hosts"] + }, + + "hostEntry": { + "additionalProperties": false, + "properties": { + "host": { + "type": "string" + }, + "paths": { + "items": { + "additionalProperties": false, + "properties": { + "path": { + "type": "string" + }, + "pathType": { + "type": "string", + "default": "Prefix" + }, + + "service": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "type": "string" + }, + "port": { + "type": ["string", "integer"] + } + }, + "required": ["name"] + } + }, + "required": ["path", "service"] + }, + "title": "paths", + "type": "array" + } + }, + "required": ["host", "paths"] + }, + + "tlsEntry": { + "additionalProperties": false, + "properties": { + "hosts": { + "type": "array", + "items": { + "type": ["string"] + } + }, + "secretName": { + "type": "string" + } + }, + "required": ["hosts"] + } +} diff --git a/charts/library/common/schemas/k8s-api.json b/charts/library/common/schemas/k8s-api.json new file mode 100644 index 00000000..144cd087 --- /dev/null +++ b/charts/library/common/schemas/k8s-api.json @@ -0,0 +1,971 @@ +{ + "core.v1.HostAlias": { + "type": "object", + "description": "HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.", + "additionalProperties": false, + "properties": { + "hostnames": { + "description": "Hostnames for the above IP address.", + "items": { + "type": "string" + }, + "type": "array" + }, + "ip": { + "description": "IP address of the host file entry.", + "type": "string" + } + } + }, + + "core.v1.LocalObjectReference": { + "type": "object", + "description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.", + "properties": { + "name": { + "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", + "type": "string" + } + } + }, + + "core.v1.NodeSelectorRequirement": { + "type": "object", + "description": "A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", + "additionalProperties": false, + "properties": { + "key": { + "description": "The label key that the selector applies to.", + "type": "string" + }, + "operator": { + "description": "Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.", + "type": "string" + }, + "values": { + "description": "An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": ["key", "operator"] + }, + + "core.v1.NodeSelectorTerm": { + "type": "object", + "description": "A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.", + "additionalProperties": false, + "properties": { + "matchExpressions": { + "description": "A list of node selector requirements by node's labels.", + "items": { + "$ref": "#/core.v1.NodeSelectorRequirement" + }, + "type": "array" + }, + "matchFields": { + "description": "A list of node selector requirements by node's fields.", + "items": { + "$ref": "#/core.v1.NodeSelectorRequirement" + }, + "type": "array" + } + } + }, + + "core.v1.NodeSelector": { + "type": "object", + "description": "A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.", + "additionalProperties": false, + "properties": { + "nodeSelectorTerms": { + "description": "Required. A list of node selector terms. The terms are ORed.", + "items": { + "$ref": "#/core.v1.NodeSelectorTerm" + }, + "type": "array" + } + }, + "required": ["nodeSelectorTerms"] + }, + + "core.v1.Affinity": { + "type": "object", + "description": "Affinity is a group of affinity scheduling rules.", + "additionalProperties": false, + "properties": { + "nodeAffinity": { + "$ref": "#/core.v1.NodeAffinity", + "description": "Describes node affinity scheduling rules for the pod." + }, + "podAffinity": { + "$ref": "#/core.v1.PodAffinity", + "description": "Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s))." + }, + "podAntiAffinity": { + "$ref": "#/core.v1.PodAntiAffinity", + "description": "Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s))." + } + } + }, + + "core.v1.NodeAffinity": { + "type": "object", + "description": "Node affinity is a group of node affinity scheduling rules.", + "additionalProperties": false, + "properties": { + "preferredDuringSchedulingIgnoredDuringExecution": { + "description": "The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.", + "items": { + "$ref": "#/core.v1.PreferredSchedulingTerm" + }, + "type": "array" + }, + "requiredDuringSchedulingIgnoredDuringExecution": { + "$ref": "#/core.v1.NodeSelector", + "description": "If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node." + } + } + }, + + "core.v1.PodAffinity": { + "type": "object", + "description": "Pod affinity is a group of inter pod affinity scheduling rules.", + "additionalProperties": false, + "properties": { + "preferredDuringSchedulingIgnoredDuringExecution": { + "description": "The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.", + "items": { + "$ref": "#/core.v1.WeightedPodAffinityTerm" + }, + "type": "array" + }, + "requiredDuringSchedulingIgnoredDuringExecution": { + "description": "If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.", + "items": { + "$ref": "#/core.v1.PodAffinityTerm" + }, + "type": "array" + } + } + }, + + "core.v1.WeightedPodAffinityTerm": { + "type": "object", + "description": "The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)", + "additionalProperties": false, + "properties": { + "podAffinityTerm": { + "$ref": "#/core.v1.PodAffinityTerm", + "description": "Required. A pod affinity term, associated with the corresponding weight." + }, + "weight": { + "description": "weight associated with matching the corresponding podAffinityTerm, in the range 1-100.", + "format": "int32", + "type": "integer" + } + }, + "required": ["weight", "podAffinityTerm"] + }, + + "core.v1.PodAffinityTerm": { + "type": "object", + "description": "Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running", + "additionalProperties": false, + "properties": { + "labelSelector": { + "$ref": "#/meta.v1.LabelSelector", + "description": "A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods." + }, + "matchLabelKeys": { + "description": "MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.", + "items": { + "type": "string" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" + }, + "mismatchLabelKeys": { + "description": "MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.", + "items": { + "type": "string" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" + }, + "namespaceSelector": { + "$ref": "#/meta.v1.LabelSelector", + "description": "A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces." + }, + "namespaces": { + "description": "namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\".", + "items": { + "type": "string" + }, + "type": "array" + }, + "topologyKey": { + "description": "This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.", + "type": "string" + } + }, + "required": ["topologyKey"] + }, + + "core.v1.PodAntiAffinity": { + "type": "object", + "description": "Pod anti affinity is a group of inter pod anti affinity scheduling rules.", + "additionalProperties": false, + "properties": { + "preferredDuringSchedulingIgnoredDuringExecution": { + "description": "The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.", + "items": { + "$ref": "#/core.v1.WeightedPodAffinityTerm" + }, + "type": "array" + }, + "requiredDuringSchedulingIgnoredDuringExecution": { + "description": "If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.", + "items": { + "$ref": "#/core.v1.PodAffinityTerm" + }, + "type": "array" + } + } + }, + + "core.v1.PreferredSchedulingTerm": { + "type": "object", + "description": "An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).", + "additionalProperties": false, + "properties": { + "preference": { + "$ref": "#/core.v1.NodeSelectorTerm", + "description": "A node selector term, associated with the corresponding weight." + }, + "weight": { + "description": "Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.", + "format": "int32", + "type": "integer" + } + }, + "required": ["weight", "preference"] + }, + + "core.v1.PodDNSConfig": { + "type": "object", + "description": "PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.", + "additionalProperties": false, + "properties": { + "nameservers": { + "description": "A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.", + "items": { + "type": "string" + }, + "type": "array" + }, + "options": { + "description": "A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy.", + "items": { + "$ref": "#/core.v1.PodDNSConfigOption" + }, + "type": "array" + }, + "searches": { + "description": "A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed.", + "items": { + "type": "string" + }, + "type": "array" + } + } + }, + + "core.v1.PodDNSConfigOption": { + "type": "object", + "description": "PodDNSConfigOption defines DNS resolver options of a pod.", + "additionalProperties": false, + "properties": { + "name": { + "description": "Required.", + "type": "string" + }, + "value": { + "type": "string" + } + } + }, + + "core.v1.SeccompProfile": { + "type": "object", + "description": "SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.", + "additionalProperties": false, + "properties": { + "localhostProfile": { + "description": "localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is \"Localhost\". Must NOT be set for any other type.", + "type": "string" + }, + "type": { + "description": "type indicates which kind of seccomp profile will be applied. Valid options are:\n\nLocalhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied.", + "type": "string" + } + }, + "required": ["type"] + }, + + "core.v1.SELinuxOptions": { + "type": "object", + "description": "SELinuxOptions are the labels to be applied to the container", + "additionalProperties": false, + "properties": { + "level": { + "description": "Level is SELinux level label that applies to the container.", + "type": "string" + }, + "role": { + "description": "Role is a SELinux role label that applies to the container.", + "type": "string" + }, + "type": { + "description": "Type is a SELinux type label that applies to the container.", + "type": "string" + }, + "user": { + "description": "User is a SELinux user label that applies to the container.", + "type": "string" + } + } + }, + + "core.v1.Sysctl": { + "type": "object", + "description": "Sysctl defines a kernel parameter to be set", + "additionalProperties": false, + "properties": { + "name": { + "description": "Name of a property to set", + "type": "string" + }, + "value": { + "description": "Value of a property to set", + "type": "string" + } + }, + "required": ["name", "value"] + }, + + "core.v1.PodSecurityContext": { + "type": "object", + "description": "PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.", + "additionalProperties": false, + "properties": { + "fsGroup": { + "description": "A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:\n\n1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----\n\nIf unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows.", + "format": "int64", + "type": "integer" + }, + "fsGroupChangePolicy": { + "description": "fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are \"OnRootMismatch\" and \"Always\". If not specified, \"Always\" is used. Note that this field cannot be set when spec.os.name is windows.", + "type": "string" + }, + "runAsGroup": { + "description": "The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.", + "format": "int64", + "type": "integer" + }, + "runAsNonRoot": { + "description": "Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.", + "type": "boolean" + }, + "runAsUser": { + "description": "The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows.", + "format": "int64", + "type": "integer" + }, + "seLinuxOptions": { + "$ref": "#/core.v1.SELinuxOptions", + "description": "The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows." + }, + "seccompProfile": { + "$ref": "#/core.v1.SeccompProfile", + "description": "The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows." + }, + "supplementalGroups": { + "description": "A list of groups applied to the first process run in each container, in addition to the container's primary GID, the fsGroup (if specified), and group memberships defined in the container image for the uid of the container process. If unspecified, no additional groups are added to any container. Note that group memberships defined in the container image for the uid of the container process are still effective, even if they are not included in this list. Note that this field cannot be set when spec.os.name is windows.", + "items": { + "format": "int64", + "type": "integer" + }, + "type": "array" + }, + "sysctls": { + "description": "Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows.", + "items": { + "$ref": "#/core.v1.Sysctl" + }, + "type": "array" + } + } + }, + + "core.v1.Toleration": { + "type": "object", + "description": "The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator .", + "additionalProperties": false, + "properties": { + "effect": { + "description": "Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.", + "type": "string" + }, + "key": { + "description": "Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.", + "type": "string" + }, + "operator": { + "description": "Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.", + "type": "string" + }, + "tolerationSeconds": { + "description": "TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.", + "format": "int64", + "type": "integer" + }, + "value": { + "description": "Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.", + "type": "string" + } + } + }, + + "core.v1.TopologySpreadConstraint": { + "type": "object", + "description": "TopologySpreadConstraint specifies how to spread matching pods among the given topology.", + "additionalProperties": false, + "properties": { + "labelSelector": { + "$ref": "#/meta.v1.LabelSelector", + "description": "LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain." + }, + "matchLabelKeys": { + "description": "MatchLabelKeys is a set of pod label keys to select the pods over which spreading will be calculated. The keys are used to lookup values from the incoming pod labels, those key-value labels are ANDed with labelSelector to select the group of existing pods over which spreading will be calculated for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. MatchLabelKeys cannot be set when LabelSelector isn't set. Keys that don't exist in the incoming pod labels will be ignored. A null or empty list means only match against labelSelector.\n\nThis is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).", + "items": { + "type": "string" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" + }, + "maxSkew": { + "description": "MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. | zone1 | zone2 | zone3 | | P P | P P | P | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed.", + "format": "int32", + "type": "integer" + }, + "minDomains": { + "description": "MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats \"global minimum\" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won't schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule.\n\nFor example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P | The number of domains is less than 5(MinDomains), so \"global minimum\" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew.\n\nThis is a beta field and requires the MinDomainsInPodTopologySpread feature gate to be enabled (enabled by default).", + "format": "int32", + "type": "integer" + }, + "nodeAffinityPolicy": { + "description": "NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.\n\nIf this value is nil, the behavior is equivalent to the Honor policy. This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.", + "type": "string" + }, + "nodeTaintsPolicy": { + "description": "NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included. - Ignore: node taints are ignored. All nodes are included.\n\nIf this value is nil, the behavior is equivalent to the Ignore policy. This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.", + "type": "string" + }, + "topologyKey": { + "description": "TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each as a \"bucket\", and try to put balanced number of pods into each bucket. We define a domain as a particular instance of a topology. Also, we define an eligible domain as a domain whose nodes meet the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey is \"kubernetes.io/hostname\", each Node is a domain of that topology. And, if TopologyKey is \"topology.kubernetes.io/zone\", each zone is a domain of that topology. It's a required field.", + "type": "string" + }, + "whenUnsatisfiable": { + "description": "WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location,\n but giving higher precedence to topologies that would help reduce the\n skew.\nA constraint is considered \"Unsatisfiable\" for an incoming pod if and only if every possible node assignment for that pod would violate \"MaxSkew\" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field.", + "type": "string" + } + }, + "required": ["maxSkew", "topologyKey", "whenUnsatisfiable"] + }, + + "meta.v1.LabelSelector": { + "type": "object", + "description": "A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.", + "additionalProperties": false, + "properties": { + "matchExpressions": { + "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", + "items": { + "$ref": "#/meta.v1.LabelSelectorRequirement" + }, + "type": "array" + }, + "matchLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", + "type": "object" + } + } + }, + + "meta.v1.LabelSelectorRequirement": { + "type": "object", + "description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", + "additionalProperties": false, + "properties": { + "key": { + "description": "key is the label key that the selector applies to.", + "type": "string" + }, + "operator": { + "description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.", + "type": "string" + }, + "values": { + "description": "values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": ["key", "operator"] + }, + + "core.v1.ContainerPort": { + "type": "object", + "additionalProperties": false, + "properties": { + "containerPort": { + "description": "Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.", + "format": "int32", + "type": ["integer", "null"] + }, + "hostIP": { + "description": "What host IP to bind the external port to.", + "type": ["string", "null"] + }, + "hostPort": { + "description": "Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.", + "format": "int32", + "type": ["integer", "null"] + }, + "name": { + "description": "If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.", + "type": ["string", "null"] + }, + "protocol": { + "description": "Protocol for port. Must be UDP, TCP, or SCTP. Defaults to \"TCP\".", + "type": ["string", "null"] + } + }, + "required": ["containerPort"] + }, + + "core.v1.ExecAction": { + "description": "ExecAction describes a \"run in container\" action.", + "properties": { + "command": { + "description": "Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.", + "items": { + "type": ["string", "null"] + }, + "type": ["array", "null"] + } + }, + "type": "object" + }, + + "core.v1.GRPCAction": { + "properties": { + "port": { + "description": "Port number of the gRPC service. Number must be in the range 1 to 65535.", + "format": "int32", + "type": ["integer", "null"] + }, + "service": { + "description": "Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\nIf this is not specified, the default behavior is defined by gRPC.", + "type": ["string", "null"] + } + }, + "required": ["port"], + "type": "object" + }, + + "core.v1.HTTPHeader": { + "description": "HTTPHeader describes a custom header to be used in HTTP probes", + "properties": { + "name": { + "description": "The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.", + "type": ["string", "null"] + }, + "value": { + "description": "The header field value", + "type": ["string", "null"] + } + }, + "required": ["name", "value"], + "type": "object" + }, + + "core.v1.HTTPGetAction": { + "description": "HTTPGetAction describes an action based on HTTP Get requests.", + "properties": { + "host": { + "description": "Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead.", + "type": ["string", "null"] + }, + "httpHeaders": { + "description": "Custom headers to set in the request. HTTP allows repeated headers.", + "items": { + "$ref": "#/core.v1.HTTPHeader" + }, + "type": ["array", "null"] + }, + "path": { + "description": "Path to access on the HTTP server.", + "type": ["string", "null"] + }, + "port": { + "type": ["string", "integer"], + "description": "Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME." + }, + "scheme": { + "description": "Scheme to use for connecting to the host. Defaults to HTTP.", + "type": ["string", "null"] + } + }, + "required": ["port"], + "type": "object" + }, + + "core.v1.SleepAction": { + "description": "SleepAction describes a \"sleep\" action.", + "properties": { + "seconds": { + "description": "Seconds is the number of seconds to sleep.", + "format": "int64", + "type": "integer" + } + }, + "required": ["seconds"], + "type": "object" + }, + + "core.v1.TCPSocketAction": { + "description": "TCPSocketAction describes an action based on opening a socket", + "properties": { + "host": { + "description": "Optional: Host name to connect to, defaults to the pod IP.", + "type": ["string", "null"] + }, + "port": { + "type": ["string", "integer"], + "description": "Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME." + } + }, + "required": ["port"], + "type": "object" + }, + + "core.v1.Probe": { + "description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.", + "properties": { + "exec": { + "$ref": "#/core.v1.ExecAction", + "description": "Exec specifies the action to take." + }, + "failureThreshold": { + "description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.", + "format": "int32", + "type": ["integer", "null"] + }, + "grpc": { + "$ref": "#/core.v1.GRPCAction", + "description": "GRPC specifies an action involving a GRPC port." + }, + "httpGet": { + "$ref": "#/core.v1.HTTPGetAction", + "description": "HTTPGet specifies the http request to perform." + }, + "initialDelaySeconds": { + "description": "Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", + "format": "int32", + "type": ["integer", "null"] + }, + "periodSeconds": { + "description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.", + "format": "int32", + "type": ["integer", "null"] + }, + "successThreshold": { + "description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.", + "format": "int32", + "type": ["integer", "null"] + }, + "tcpSocket": { + "$ref": "#/core.v1.TCPSocketAction", + "description": "TCPSocket specifies an action involving a TCP port." + }, + "terminationGracePeriodSeconds": { + "description": "Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.", + "format": "int64", + "type": ["integer", "null"] + }, + "timeoutSeconds": { + "description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", + "format": "int32", + "type": ["integer", "null"] + } + }, + "type": "object" + }, + + "core.v1.ResourceRequirements": { + "description": "ResourceRequirements describes the compute resource requirements.", + "additionalProperties": false, + "properties": { + "claims": { + "description": "Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.\n\nThis is an alpha field and requires enabling the DynamicResourceAllocation feature gate.\n\nThis field is immutable. It can only be set for containers.", + "items": { + "properties": { + "name": { + "description": "Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.", + "type": "string" + } + }, + "required": ["name"] + }, + "type": ["array", "null"] + }, + "limits": { + "additionalProperties": { + "$ref": "#/core.v1.ResourceQuantity" + }, + "description": "Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/", + "type": ["object", "null"] + }, + "requests": { + "additionalProperties": { + "$ref": "#/core.v1.ResourceQuantity" + }, + "description": "Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/", + "type": ["object", "null"] + } + }, + "type": "object" + }, + + "core.v1.ResourceQuantity": { + "oneOf": [{"type": "string"}, {"type": "number"}] + }, + + "core.v1.Capabilities": { + "description": "Adds and removes POSIX capabilities from running containers.", + "properties": { + "add": { + "description": "Added capabilities", + "items": { + "type": "string" + }, + "type": "array" + }, + "drop": { + "description": "Removed capabilities", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + + "core.v1.ContainerSecurityContext": { + "io.k8s.api.core.v1.SecurityContext": { + "description": "SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.", + "properties": { + "allowPrivilegeEscalation": { + "description": "AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows.", + "type": "boolean" + }, + "capabilities": { + "$ref": "#/core.v1.Capabilities", + "description": "The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows." + }, + "privileged": { + "description": "Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.", + "type": "boolean" + }, + "procMount": { + "description": "procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows.", + "type": "string" + }, + "readOnlyRootFilesystem": { + "description": "Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.", + "type": "boolean" + }, + "runAsGroup": { + "description": "The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.", + "format": "int64", + "type": "integer" + }, + "runAsNonRoot": { + "description": "Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.", + "type": "boolean" + }, + "runAsUser": { + "description": "The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows.", + "format": "int64", + "type": "integer" + }, + "seLinuxOptions": { + "$ref": "#/core.v1.SELinuxOptions", + "description": "The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows." + }, + "seccompProfile": { + "$ref": "#/core.v1.SeccompProfile", + "description": "The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows." + } + }, + "type": "object" + } + }, + + "core.v1.Lifecycle": { + "description": "Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.", + "properties": { + "postStart": { + "$ref": "#/core.v1.LifecycleHandler", + "description": "PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks" + }, + "preStop": { + "$ref": "#/core.v1.LifecycleHandler", + "description": "PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks" + } + }, + "type": "object" + }, + + "core.v1.LifecycleHandler": { + "description": "LifecycleHandler defines a specific action that should be taken in a lifecycle hook. One and only one of the fields, except TCPSocket must be specified.", + "properties": { + "exec": { + "$ref": "#/core.v1.ExecAction", + "description": "Exec specifies the action to take." + }, + "httpGet": { + "$ref": "#/core.v1.HTTPGetAction", + "description": "HTTPGet specifies the http request to perform." + }, + "sleep": { + "$ref": "#/core.v1.SleepAction", + "description": "Sleep represents the duration that the container should sleep before being terminated." + }, + "tcpSocket": { + "$ref": "#/core.v1.TCPSocketAction", + "description": "Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified." + } + }, + "type": "object" + }, + + "networking.v1.IPBlock": { + "description": "IPBlock describes a particular CIDR (Ex. \"192.168.1.0/24\",\"2001:db8::/64\") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.", + "properties": { + "cidr": { + "description": "cidr is a string representing the IPBlock Valid examples are \"192.168.1.0/24\" or \"2001:db8::/64\"", + "type": "string" + }, + "except": { + "description": "except is a slice of CIDRs that should not be included within an IPBlock Valid examples are \"192.168.1.0/24\" or \"2001:db8::/64\" Except values will be rejected if they are outside the cidr range", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": ["cidr"], + "type": "object" + }, + + "networking.v1.NetworkPolicyPeer": { + "description": "NetworkPolicyPeer describes a peer to allow traffic to/from. Only certain combinations of fields are allowed", + "properties": { + "ipBlock": { + "$ref": "#/networking.v1.IPBlock", + "description": "ipBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be." + }, + "namespaceSelector": { + "$ref": "#/meta.v1.LabelSelector", + "description": "namespaceSelector selects namespaces using cluster-scoped labels. This field follows standard label selector semantics; if present but empty, it selects all namespaces.\n\nIf podSelector is also set, then the NetworkPolicyPeer as a whole selects the pods matching podSelector in the namespaces selected by namespaceSelector. Otherwise it selects all pods in the namespaces selected by namespaceSelector." + }, + "podSelector": { + "$ref": "#/meta.v1.LabelSelector", + "description": "podSelector is a label selector which selects pods. This field follows standard label selector semantics; if present but empty, it selects all pods.\n\nIf namespaceSelector is also set, then the NetworkPolicyPeer as a whole selects the pods matching podSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects the pods matching podSelector in the policy's own namespace." + } + }, + "type": "object" + }, + "networking.v1.NetworkPolicyPort": { + "description": "NetworkPolicyPort describes a port to allow traffic on", + "properties": { + "endPort": { + "description": "endPort indicates that the range of ports from port to endPort if set, inclusive, should be allowed by the policy. This field cannot be defined if the port field is not defined or if the port field is defined as a named (string) port. The endPort must be equal or greater than port.", + "format": "int32", + "type": "integer" + }, + "port": { + "type": ["string", "integer"], + "description": "port represents the port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. If present, only traffic on the specified protocol AND port will be matched." + }, + "protocol": { + "description": "protocol represents the protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP.", + "type": "string" + } + }, + "type": "object" + }, + + "networking.v1.NetworkPolicyEgressRule": { + "description": "NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to. This type is beta-level in 1.8", + "properties": { + "ports": { + "description": "ports is a list of destination ports for outgoing traffic. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.", + "items": { + "$ref": "#/networking.v1.NetworkPolicyPort" + }, + "type": "array" + }, + "to": { + "description": "to is a list of destinations for outgoing traffic of pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all destinations (traffic not restricted by destination). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the to list.", + "items": { + "$ref": "#/networking.v1.NetworkPolicyPeer" + }, + "type": "array" + } + }, + "type": "object" + }, + + "networking.v1.NetworkPolicyIngressRule": { + "description": "NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and from.", + "properties": { + "from": { + "description": "from is a list of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all sources (traffic not restricted by source). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the from list.", + "items": { + "$ref": "#/networking.v1.NetworkPolicyPeer" + }, + "type": "array" + }, + "ports": { + "description": "ports is a list of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.", + "items": { + "$ref": "#/networking.v1.NetworkPolicyPort" + }, + "type": "array" + } + }, + "type": "object" + } +} diff --git a/charts/library/common/schemas/networkpolicy.json b/charts/library/common/schemas/networkpolicy.json new file mode 100644 index 00000000..e4662e49 --- /dev/null +++ b/charts/library/common/schemas/networkpolicy.json @@ -0,0 +1,52 @@ +{ + "instance": { + "type": "object", + "additionalProperties": false, + + "properties": { + "enabled": { + "type": "boolean", + "default": true + }, + "annotations": { + "$ref": "definitions.json#/annotations" + }, + "controller": { + "type": "string" + }, + "labels": { + "$ref": "definitions.json#/labels" + }, + "nameOverride": { + "type": "string" + }, + "podSelector": {}, + "policyTypes": { + "type": "array", + "items": { + "type": "string" + } + }, + "rules": { + "type": "object", + "additionalProperties": false, + + "properties": { + "ingress": { + "type": "array", + "items": { + "$ref": "k8s-api.json#/networking.v1.NetworkPolicyIngressRule" + } + }, + "egress": { + "type": "array", + "items": { + "$ref": "k8s-api.json#/networking.v1.NetworkPolicyEgressRule" + } + } + } + } + }, + "required": ["rules"] + } +} diff --git a/charts/library/common/schemas/persistence.json b/charts/library/common/schemas/persistence.json new file mode 100644 index 00000000..b94cacce --- /dev/null +++ b/charts/library/common/schemas/persistence.json @@ -0,0 +1,269 @@ +{ + "item": { + "oneOf": [ + {"$ref": "#/persistentVolumeClaimItem"}, + {"$ref": "#/persistentVolumeClaimWithExistingClaimItem"}, + {"$ref": "#/configMapItem"}, + {"$ref": "#/secretItem"}, + {"$ref": "#/nfsItem"}, + {"$ref": "#/emptyDirItem"}, + {"$ref": "#/hostPathItem"}, + {"$ref": "#/customItem"} + ] + }, + + "persistentVolumeClaimItem": { + "type": "object", + "additionalProperties": false, + + "properties": { + "type": { + "const": "persistentVolumeClaim" + }, + "enabled": { + "type": "boolean", + "default": true + }, + "accessMode": { + "type": "string" + }, + "annotations": { + "$ref": "definitions.json#/annotations" + }, + "dataSource": { + "$ref": "#/dataSourceReference" + }, + "dataSourceRef": { + "$ref": "#/dataSourceReference" + }, + "labels": { + "$ref": "definitions.json#/labels" + }, + "nameOverride": { + "type": "string" + }, + "retain": { + "type": "boolean" + }, + "size": { + "type": "string" + }, + "storageClass": { + "type": "string" + }, + "advancedMounts": {"$ref": "#/advancedMounts"}, + "globalMounts": {"$ref": "#/globalMounts"} + }, + "required": ["accessMode", "size"] + }, + + "persistentVolumeClaimWithExistingClaimItem": { + "type": "object", + "additionalProperties": false, + + "properties": { + "type": { + "const": "persistentVolumeClaim" + }, + "enabled": { + "type": "boolean", + "default": true + }, + "existingClaim": { + "type": "string" + }, + "advancedMounts": {"$ref": "#/advancedMounts"}, + "globalMounts": {"$ref": "#/globalMounts"} + }, + "required": ["existingClaim"] + }, + + "configMapItem": { + "type": "object", + "additionalProperties": false, + + "properties": { + "type": { + "const": "configMap" + }, + "enabled": { + "type": "boolean", + "default": true + }, + "name": { + "type": "string" + }, + "advancedMounts": {"$ref": "#/advancedMounts"}, + "globalMounts": {"$ref": "#/globalMounts"} + }, + "required": ["name"] + }, + + "secretItem": { + "type": "object", + "additionalProperties": false, + + "properties": { + "type": { + "const": "secret" + }, + "enabled": { + "type": "boolean", + "default": true + }, + "name": { + "type": "string" + }, + "advancedMounts": {"$ref": "#/advancedMounts"}, + "globalMounts": {"$ref": "#/globalMounts"} + }, + "required": ["name"] + }, + + "nfsItem": { + "type": "object", + "additionalProperties": false, + + "properties": { + "type": { + "const": "nfs" + }, + "enabled": { + "type": "boolean", + "default": true + }, + "path": { + "type": "string" + }, + "server": { + "type": "string" + }, + "advancedMounts": {"$ref": "#/advancedMounts"}, + "globalMounts": {"$ref": "#/globalMounts"} + }, + "required": ["server", "path"] + }, + + "emptyDirItem": { + "type": "object", + "additionalProperties": false, + + "properties": { + "type": { + "const": "emptyDir" + }, + "enabled": { + "type": "boolean", + "default": true + }, + "medium": { + "type": "string" + }, + "sizeLimit": { + "type": "string" + }, + "advancedMounts": {"$ref": "#/advancedMounts"}, + "globalMounts": {"$ref": "#/globalMounts"} + } + }, + + "hostPathItem": { + "type": "object", + "additionalProperties": false, + + "properties": { + "type": { + "const": "hostPath" + }, + "enabled": { + "type": "boolean", + "default": true + }, + "hostPath": { + "type": "string" + }, + "hostPathType": { + "type": "string" + }, + "advancedMounts": {"$ref": "#/advancedMounts"}, + "globalMounts": {"$ref": "#/globalMounts"} + } + }, + + "customItem": { + "type": "object", + "additionalProperties": false, + + "properties": { + "type": { + "const": "custom" + }, + "enabled": { + "type": "boolean", + "default": true + }, + "volumeSpec": { + "type": "object" + }, + "globalMounts": {"$ref": "#/globalMounts"}, + "advancedMounts": {"$ref": "#/advancedMounts"} + }, + "required": ["volumeSpec"] + }, + + "dataSourceReference": { + "type": "object", + "additionalProperties": false, + "properties": { + "apiGroup": { + "type": "string" + }, + "kind": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": ["kind", "name"] + }, + + "globalMounts": { + "type": "array", + "items": { + "$ref": "#/mountPath" + } + }, + + "advancedMounts": { + "additionalProperties": { + "type": "object", + "additionalProperties": { + "$ref": "#/mountPathCollection" + } + } + }, + + "mountPathCollection": { + "type": "array", + "items": {"$ref": "#/mountPath"} + }, + + "mountPath": { + "additionalProperties": false, + "properties": { + "path": { + "type": "string" + }, + "readOnly": { + "type": "boolean" + }, + "subPath": { + "type": "string" + }, + "mountPropagation": { + "type": "string" + } + } + } +} diff --git a/charts/library/common/schemas/pod.json b/charts/library/common/schemas/pod.json new file mode 100644 index 00000000..fc1f298b --- /dev/null +++ b/charts/library/common/schemas/pod.json @@ -0,0 +1,96 @@ +{ + "options": { + "type": "object", + "additionalProperties": false, + "properties": { + "affinity": { + "type": "object", + "$ref": "k8s-api.json#/core.v1.Affinity" + }, + "annotations": { + "$ref": "definitions.json#/annotations" + }, + "automountServiceAccountToken": { + "type": "boolean", + "default": true + }, + "dnsConfig": { + "type": "object", + "$ref": "k8s-api.json#/core.v1.PodDNSConfig" + }, + "dnsPolicy": { + "type": "string" + }, + "enableServiceLinks": { + "type": "boolean", + "default": false + }, + "hostAliases": { + "type": "array", + "items": { + "$ref": "k8s-api.json#/core.v1.HostAlias" + } + }, + "hostIPC": { + "type": "boolean", + "default": false + }, + "hostNetwork": { + "type": "boolean", + "default": "false" + }, + "hostPID": { + "type": "boolean", + "default": false + }, + "hostname": { + "type": "string" + }, + "imagePullSecrets": { + "type": "array", + "items": { + "$ref": "k8s-api.json#/core.v1.LocalObjectReference" + } + }, + "labels": { + "$ref": "definitions.json#/annotations" + }, + "nodeSelector": { + "type": "object", + "additionalProperties": { + "type": ["string"] + } + }, + "priorityClassName": { + "type": "string" + }, + "restartPolicy": { + "type": "string" + }, + "runtimeClassName": { + "type": "string" + }, + "schedulerName": { + "type": "string" + }, + "securityContext": { + "$ref": "k8s-api.json#/core.v1.PodSecurityContext" + }, + "terminationGracePeriodSeconds": { + "type": ["integer", "null"] + }, + "tolerations": { + "type": "array", + "items": { + "$ref": "k8s-api.json#/core.v1.Toleration" + } + }, + "topologySpreadConstraints": { + "type": "array", + "items": { + "$ref": "k8s-api.json#/core.v1.TopologySpreadConstraint" + } + } + } + } +} diff --git a/charts/library/common/schemas/route.json b/charts/library/common/schemas/route.json new file mode 100644 index 00000000..d428ac3d --- /dev/null +++ b/charts/library/common/schemas/route.json @@ -0,0 +1,126 @@ +{ + "instance": { + "type": "object", + "additionalProperties": false, + + "properties": { + "enabled": { + "type": "boolean", + "default": true + }, + + "annotations": { + "$ref": "definitions.json#/annotations" + }, + + "hostnames": { + "type": "array", + "items": {"type": "string"} + }, + + "kind": { + "type": "string", + "enum": ["GRPCRoute", "HTTPRoute", "TCPRoute", "TLSRoute", "UDPRoute"] + }, + + "labels": { + "$ref": "definitions.json#/labels" + }, + + "nameOverride": { + "type": "string" + }, + + "parentRefs": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false, + "properties": { + "group": { + "type": "string" + }, + "kind": { + "type": "string" + }, + "namespace": { + "type": "string" + }, + "name": { + "type": "string" + }, + "sectionName": { + "type": "string" + } + }, + "required": ["name"] + } + }, + + "rules": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false, + "properties": { + "backendRefs": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false, + "properties": { + "group": { + "type": "string" + }, + "kind": { + "type": "string" + }, + "namespace": { + "type": "string" + }, + "name": { + "type": "string" + }, + "port": { + "type": ["string", "integer"] + }, + "weight": { + "type": "integer" + } + } + } + }, + "matches": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false, + "properties": { + "path": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string" + }, + "value": { + "type": "string" + } + } + } + } + } + }, + "filters": { + "type": "array", + "items": {} + }, + "timeouts": { + "type": "object" + } + } + } + } + } + } +} diff --git a/charts/library/common/schemas/secret.json b/charts/library/common/schemas/secret.json new file mode 100644 index 00000000..4dcefaeb --- /dev/null +++ b/charts/library/common/schemas/secret.json @@ -0,0 +1,31 @@ +{ + "instance": { + "type": "object", + "additionalProperties": false, + "properties": { + "enabled": { + "type": "boolean", + "default": true + }, + "annotations": { + "$ref": "definitions.json#/annotations" + }, + "labels": { + "$ref": "definitions.json#/labels" + }, + "nameOverride": { + "type": "string" + }, + "type": { + "type": "string" + }, + "stringData": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "required": ["stringData"] + } +} diff --git a/charts/library/common/schemas/service.json b/charts/library/common/schemas/service.json new file mode 100644 index 00000000..c70e179a --- /dev/null +++ b/charts/library/common/schemas/service.json @@ -0,0 +1,110 @@ +{ + "instance": { + "type": "object", + "additionalProperties": false, + "properties": { + "enabled": { + "type": "boolean", + "default": true + }, + "annotations": { + "$ref": "definitions.json#/annotations" + }, + "labels": { + "$ref": "definitions.json#/labels" + }, + "nameOverride": { + "type": "string" + }, + "type": { + "type": "string" + }, + "clusterIP": { + "type": "string" + }, + "loadBalancerIP": { + "type": "string" + }, + "loadBalancerSourceRanges": { + "type": "array", + "items": {"type": "string"} + }, + "externalTrafficPolicy": { + "type": "string", + "enum": ["Cluster", "Local"] + }, + "allocateLoadBalancerNodePorts": { + "type": "boolean" + }, + "sessionAffinity": { + "type": "string", + "enum": ["None", "ClientIP"] + }, + "sessionAffinityConfig": { + "type": "object" + }, + "externalIPs": { + "type": "array", + "items": {"type": "string"} + }, + "publishNotReadyAddresses": { + "type": "boolean" + }, + "ipFamilyPolicy": { + "type": "string", + "enum": ["SingleStack", "PreferDualStack", "RequireDualStack"] + }, + "ipFamilies": { + "type": "array", + "items": { + "type": "string", + "enum": ["IPv4", "IPv6"] + } + }, + "ports": { + "type": "object", + "additionalProperties": { + "$ref": "#/servicePort" + } + }, + "primary": { + "type": "boolean", + "default": false + }, + "controller": { + "type": "string" + }, + "extraSelectorLabels": {} + }, + "required": ["controller"] + }, + + "servicePort": { + "type": "object", + "additionalProperties": false, + "properties": { + "enabled": { + "type": "boolean", + "default": true + }, + "primary": { + "type": "boolean", + "default": false + }, + "port": { + "type": ["string", "integer"] + }, + "protocol": { + "type": "string", + "enum": ["HTTP", "HTTPS", "TCP", "UDP"] + }, + "targetPort": { + "type": ["string", "integer"] + }, + "appProtocol": { + "type": "string" + } + }, + "required": ["port"] + } +} diff --git a/charts/library/common/schemas/serviceAccount.json b/charts/library/common/schemas/serviceAccount.json new file mode 100644 index 00000000..a11f7c6c --- /dev/null +++ b/charts/library/common/schemas/serviceAccount.json @@ -0,0 +1,21 @@ +{ + "settings": { + "type": "object", + "additionalProperties": false, + "properties": { + "create": { + "type": "boolean", + "default": false + }, + "name": { + "type": "string" + }, + "annotations": { + "$ref": "definitions.json#/annotations" + }, + "labels": { + "$ref": "definitions.json#/labels" + } + } + } +} diff --git a/charts/library/common/schemas/serviceMonitor.json b/charts/library/common/schemas/serviceMonitor.json new file mode 100644 index 00000000..96be7b57 --- /dev/null +++ b/charts/library/common/schemas/serviceMonitor.json @@ -0,0 +1,62 @@ +{ + "instance": { + "type": "object", + "additionalProperties": false, + "properties": { + "enabled": { + "type": "boolean", + "default": true + }, + "annotations": { + "$ref": "definitions.json#/annotations" + }, + "labels": { + "$ref": "definitions.json#/labels" + }, + "nameOverride": { + "type": "string" + }, + "endpoints": { + "type": "array", + "items": { + "type": "object" + } + }, + "selector": { + "type": "object", + "additionalProperties": false, + "properties": { + "matchLabels": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false, + "properties": { + "key": {"type": "string"}, + "operator": {"type": "string"}, + "values": { + "type": "array", + "items": {"type": "string"} + } + } + } + }, + "matchExpressions": { + "type": "object" + } + } + }, + "serviceName": { + "type": "string" + }, + "targetLabels": { + "type": "array" + } + }, + "oneOf": [{"required": ["serviceName"]}, {"required": ["selector"]}], + "dependencies": { + "selector": {"not": {"required": ["serviceName"]}}, + "serviceName": {"not": {"required": ["selector"]}} + } + } +} diff --git a/charts/library/common/templates/classes/_cronjob.tpl b/charts/library/common/templates/classes/_cronjob.tpl index 84657d95..91d0d7aa 100644 --- a/charts/library/common/templates/classes/_cronjob.tpl +++ b/charts/library/common/templates/classes/_cronjob.tpl @@ -20,6 +20,8 @@ using the common library. ($cronjobObject.annotations | default dict) (include "bjw-s.common.lib.metadata.globalAnnotations" $rootContext | fromYaml) -}} + + {{- $cronJobSettings := dig "cronjob" dict $cronjobObject -}} --- apiVersion: batch/v1 kind: CronJob @@ -32,26 +34,24 @@ metadata: annotations: {{- toYaml . | nindent 4 -}} {{- end }} spec: - {{- with $cronjobObject.cronjob.suspend }} - suspend: {{ ternary "true" "false" . }} - {{- end }} - concurrencyPolicy: "{{ $cronjobObject.cronjob.concurrencyPolicy }}" - startingDeadlineSeconds: {{ $cronjobObject.cronjob.startingDeadlineSeconds }} + suspend: {{ default false $cronJobSettings.suspend }} + concurrencyPolicy: {{ default "Forbid" $cronJobSettings.concurrencyPolicy }} + startingDeadlineSeconds: {{ default 30 $cronJobSettings.startingDeadlineSeconds }} {{- with $timeZone }} - timeZone: "{{ . }}" + timeZone: {{ . }} {{- end }} - schedule: "{{ $cronjobObject.cronjob.schedule }}" - successfulJobsHistoryLimit: {{ $cronjobObject.cronjob.successfulJobsHistory }} - failedJobsHistoryLimit: {{ $cronjobObject.cronjob.failedJobsHistory }} + schedule: {{ $cronJobSettings.schedule | quote }} + successfulJobsHistoryLimit: {{ default 1 $cronJobSettings.successfulJobsHistory }} + failedJobsHistoryLimit: {{ default 1 $cronJobSettings.failedJobsHistory }} jobTemplate: spec: - {{- with $cronjobObject.cronjob.ttlSecondsAfterFinished }} + {{- with $cronJobSettings.ttlSecondsAfterFinished }} ttlSecondsAfterFinished: {{ . }} {{- end }} - {{- with $cronjobObject.cronjob.parallelism }} + {{- with $cronJobSettings.parallelism }} parallelism: {{ . }} {{- end }} - backoffLimit: {{ $cronjobObject.cronjob.backoffLimit }} + backoffLimit: {{ default 6 $cronJobSettings.backoffLimit }} template: metadata: {{- with (include "bjw-s.common.lib.pod.metadata.annotations" (dict "rootContext" $rootContext "controllerObject" $cronjobObject)) }} diff --git a/charts/library/common/templates/classes/_daemonset.tpl b/charts/library/common/templates/classes/_daemonset.tpl index cdb26fb8..0ce6edd2 100644 --- a/charts/library/common/templates/classes/_daemonset.tpl +++ b/charts/library/common/templates/classes/_daemonset.tpl @@ -27,7 +27,7 @@ metadata: annotations: {{- toYaml . | nindent 4 -}} {{- end }} spec: - revisionHistoryLimit: {{ $daemonsetObject.revisionHistoryLimit }} + revisionHistoryLimit: {{ default 3 $daemonsetObject.revisionHistoryLimit }} selector: matchLabels: app.kubernetes.io/component: {{ $daemonsetObject.identifier }} diff --git a/charts/library/common/templates/classes/_deployment.tpl b/charts/library/common/templates/classes/_deployment.tpl index ee0a829c..b39f9dff 100644 --- a/charts/library/common/templates/classes/_deployment.tpl +++ b/charts/library/common/templates/classes/_deployment.tpl @@ -27,9 +27,13 @@ metadata: annotations: {{- toYaml . | nindent 4 -}} {{- end }} spec: - revisionHistoryLimit: {{ $deploymentObject.revisionHistoryLimit }} - {{- if not (eq $deploymentObject.replicas nil) }} + revisionHistoryLimit: {{ default 3 $deploymentObject.revisionHistoryLimit }} + {{- if hasKey $deploymentObject "replicas" }} + {{- if not (eq $deploymentObject.replicas nil) }} replicas: {{ $deploymentObject.replicas }} + {{- end }} + {{- else }} + replicas: 1 {{- end }} strategy: type: {{ $deploymentObject.strategy }} diff --git a/charts/library/common/templates/classes/_job.tpl b/charts/library/common/templates/classes/_job.tpl index 92ebb555..0ba51539 100644 --- a/charts/library/common/templates/classes/_job.tpl +++ b/charts/library/common/templates/classes/_job.tpl @@ -15,6 +15,8 @@ within the common library. ($jobObject.annotations | default dict) (include "bjw-s.common.lib.metadata.globalAnnotations" $rootContext | fromYaml) -}} + + {{- $jobSettings := dig "job" dict $jobObject -}} --- apiVersion: batch/v1 kind: Job @@ -27,22 +29,20 @@ metadata: annotations: {{- toYaml . | nindent 4 -}} {{- end }} spec: - {{- with $jobObject.job.suspend }} - suspend: {{ ternary "true" "false" . }} - {{- end }} - {{- with $jobObject.job.ttlSecondsAfterFinished }} + suspend: {{ default false $jobSettings.suspend }} + {{- with $jobSettings.ttlSecondsAfterFinished }} ttlSecondsAfterFinished: {{ . }} {{- end }} - {{- with $jobObject.job.parallelism }} + {{- with $jobSettings.parallelism }} parallelism: {{ . }} {{- end }} - {{- with $jobObject.job.completions }} + {{- with $jobSettings.completions }} completions: {{ . }} {{- end }} - {{- with $jobObject.job.completionMode }} + {{- with $jobSettings.completionMode }} completionMode: {{ . }} {{- end }} - backoffLimit: {{ $jobObject.job.backoffLimit }} + backoffLimit: {{ default 6 $jobSettings.backoffLimit }} template: metadata: {{- with (include "bjw-s.common.lib.pod.metadata.annotations" (dict "rootContext" $rootContext "controllerObject" $jobObject)) }} diff --git a/charts/library/common/templates/classes/_service.tpl b/charts/library/common/templates/classes/_service.tpl index 223e82b7..35aa24f5 100644 --- a/charts/library/common/templates/classes/_service.tpl +++ b/charts/library/common/templates/classes/_service.tpl @@ -6,7 +6,7 @@ within the common library. {{- $rootContext := .rootContext -}} {{- $serviceObject := .object -}} - {{- $svcType := $serviceObject.type | default "" -}} + {{- $svcType := default "ClusterIP" $serviceObject.type -}} {{- $enabledPorts := include "bjw-s.common.lib.service.enabledPorts" (dict "rootContext" $rootContext "serviceObject" $serviceObject) | fromYaml }} {{- $labels := merge (dict "app.kubernetes.io/service" $serviceObject.name) @@ -29,7 +29,7 @@ metadata: annotations: {{- toYaml . | nindent 4 -}} {{- end }} spec: - {{- if (or (eq $svcType "ClusterIP") (empty $svcType)) }} + {{- if (eq $svcType "ClusterIP") }} type: ClusterIP {{- if $serviceObject.clusterIP }} clusterIP: {{ $serviceObject.clusterIP }} diff --git a/charts/library/common/templates/classes/_statefulset.tpl b/charts/library/common/templates/classes/_statefulset.tpl index bdcf48a3..c244aca5 100644 --- a/charts/library/common/templates/classes/_statefulset.tpl +++ b/charts/library/common/templates/classes/_statefulset.tpl @@ -27,7 +27,7 @@ metadata: annotations: {{- toYaml . | nindent 4 -}} {{- end }} spec: - revisionHistoryLimit: {{ $statefulsetObject.revisionHistoryLimit }} + revisionHistoryLimit: {{ default 3 $statefulsetObject.revisionHistoryLimit }} replicas: {{ $statefulsetObject.replicas }} podManagementPolicy: {{ dig "statefulset" "podManagementPolicy" "OrderedReady" $statefulsetObject }} updateStrategy: diff --git a/charts/library/common/templates/lib/container/_spec.tpl b/charts/library/common/templates/lib/container/_spec.tpl index 9dfd3d43..e0e08571 100644 --- a/charts/library/common/templates/lib/container/_spec.tpl +++ b/charts/library/common/templates/lib/container/_spec.tpl @@ -47,6 +47,9 @@ ports: {{ toYaml . | trim | nindent 2 }} {{- end -}} {{- with $containerObject.resources }} resources: {{ toYaml . | trim | nindent 2 }} + {{- end -}} + {{- with $containerObject.restartPolicy }} +restartPolicy: {{ . | trim }} {{- end -}} {{- with (include "bjw-s.common.lib.container.field.volumeMounts" (dict "ctx" $ctx) | trim) }} volumeMounts: {{ . | trim | nindent 2 }} diff --git a/charts/library/common/templates/lib/container/fields/_probes.tpl b/charts/library/common/templates/lib/container/fields/_probes.tpl index 5f6d60e1..02034da4 100644 --- a/charts/library/common/templates/lib/container/fields/_probes.tpl +++ b/charts/library/common/templates/lib/container/fields/_probes.tpl @@ -24,6 +24,8 @@ Probes used by the container. {{- $parsedProbeSpec := tpl ($probeValues.spec | toYaml) $rootContext -}} {{- $probeDefinition = $parsedProbeSpec | fromYaml -}} {{- else -}} + {{- $probeSpec := dig "spec" dict $probeValues -}} + {{- $primaryService := include "bjw-s.common.lib.service.primaryForController" (dict "rootContext" $rootContext "controllerIdentifier" $controllerObject.identifier) | fromYaml -}} {{- $primaryServiceDefaultPort := dict -}} {{- if $primaryService -}} @@ -37,10 +39,10 @@ Probes used by the container. {{- $probeType = $probeValues.type | default "TCP" -}} {{- end -}} - {{- $_ := set $probeDefinition "initialDelaySeconds" $probeValues.spec.initialDelaySeconds -}} - {{- $_ := set $probeDefinition "failureThreshold" $probeValues.spec.failureThreshold -}} - {{- $_ := set $probeDefinition "timeoutSeconds" $probeValues.spec.timeoutSeconds -}} - {{- $_ := set $probeDefinition "periodSeconds" $probeValues.spec.periodSeconds -}} + {{- $_ := set $probeDefinition "initialDelaySeconds" (default 0 $probeSpec.initialDelaySeconds) -}} + {{- $_ := set $probeDefinition "failureThreshold" (default 3 $probeSpec.failureThreshold) -}} + {{- $_ := set $probeDefinition "timeoutSeconds" (default 1 $probeSpec.timeoutSeconds) -}} + {{- $_ := set $probeDefinition "periodSeconds" (default 10 $probeSpec.periodSeconds) -}} {{- $probeHeader := "" -}} {{- if or ( eq $probeType "HTTPS" ) ( eq $probeType "HTTP" ) -}} diff --git a/charts/library/common/templates/lib/controller/_valuesToObject.tpl b/charts/library/common/templates/lib/controller/_valuesToObject.tpl index 6badac92..6e10e7e8 100644 --- a/charts/library/common/templates/lib/controller/_valuesToObject.tpl +++ b/charts/library/common/templates/lib/controller/_valuesToObject.tpl @@ -24,18 +24,6 @@ Convert controller values to an object {{- $_ := set $objectValues "name" $objectName -}} {{- $_ := set $objectValues "identifier" $identifier -}} - {{- /* Set the default Pod options for the controller */ -}} - {{- range $index, $key := keys $rootContext.Values.defaultPodOptions -}} - {{- if not (hasKey $objectValues "pod") -}} - {{- $_ := set $objectValues "pod" dict -}} - {{- end -}} - - {{- $defaultValue := get $rootContext.Values.defaultPodOptions $key -}} - {{- if not (hasKey $objectValues.pod $key) -}} - {{- $_ := set $objectValues.pod $key $defaultValue -}} - {{- end -}} - {{- end -}} - {{- /* Return the controller object */ -}} {{- $objectValues | toYaml -}} {{- end -}} diff --git a/charts/library/common/templates/lib/ingress/_primary.tpl b/charts/library/common/templates/lib/ingress/_primary.tpl deleted file mode 100644 index 5198d09a..00000000 --- a/charts/library/common/templates/lib/ingress/_primary.tpl +++ /dev/null @@ -1,21 +0,0 @@ -{{/* Return the name of the primary Ingress object */}} -{{- define "bjw-s.common.lib.ingress.primary" -}} - {{- $enabledIngresses := dict -}} - {{- range $name, $ingress := .Values.ingress -}} - {{- if $ingress.enabled -}} - {{- $_ := set $enabledIngresses $name . -}} - {{- end -}} - {{- end -}} - - {{- $result := "" -}} - {{- range $name, $ingress := $enabledIngresses -}} - {{- if and (hasKey $ingress "primary") $ingress.primary -}} - {{- $result = $name -}} - {{- end -}} - {{- end -}} - - {{- if not $result -}} - {{- $result = keys $enabledIngresses | first -}} - {{- end -}} - {{- $result -}} -{{- end -}} diff --git a/charts/library/common/templates/lib/job/_valuesToObject.tpl b/charts/library/common/templates/lib/job/_valuesToObject.tpl index 5886d603..687d6254 100644 --- a/charts/library/common/templates/lib/job/_valuesToObject.tpl +++ b/charts/library/common/templates/lib/job/_valuesToObject.tpl @@ -6,6 +6,10 @@ Convert job values to an object {{- $identifier := .id -}} {{- $objectValues := .values -}} + {{- if not (hasKey $objectValues "pod") -}} + {{- $_ := set $objectValues "pod" dict -}} + {{- end -}} + {{- $restartPolicy := default "Never" $objectValues.pod.restartPolicy -}} {{- $_ := set $objectValues.pod "restartPolicy" $restartPolicy -}} diff --git a/charts/library/common/templates/lib/pod/_getOption.tpl b/charts/library/common/templates/lib/pod/_getOption.tpl index c436ee32..70c7a19a 100644 --- a/charts/library/common/templates/lib/pod/_getOption.tpl +++ b/charts/library/common/templates/lib/pod/_getOption.tpl @@ -5,11 +5,12 @@ Returns the value for the specified field {{- $rootContext := .ctx.rootContext -}} {{- $controllerObject := .ctx.controllerObject -}} {{- $option := .option -}} + {{- $default := default "" .default -}} - {{- $value := "" -}} + {{- $value := $default -}} {{- /* Set to the default if it is set */ -}} - {{- $defaultOption := get $rootContext.Values.defaultPodOptions $option -}} + {{- $defaultOption := dig $option nil (default dict $rootContext.Values.defaultPodOptions) -}} {{- if kindIs "bool" $defaultOption -}} {{- $value = $defaultOption -}} {{- else if not (empty $defaultOption) -}} @@ -17,13 +18,11 @@ Returns the value for the specified field {{- end -}} {{- /* See if a pod-specific override is needed */ -}} - {{- if hasKey $controllerObject "pod" -}} - {{- $podOption := get $controllerObject.pod $option -}} - {{- if kindIs "bool" $podOption -}} - {{- $value = $podOption -}} - {{- else if not (empty $podOption) -}} - {{- $value = $podOption -}} - {{- end -}} + {{- $podOption := dig $option nil (default dict $controllerObject.pod) -}} + {{- if kindIs "bool" $podOption -}} + {{- $value = $podOption -}} + {{- else if not (empty $podOption) -}} + {{- $value = $podOption -}} {{- end -}} {{- if kindIs "bool" $value -}} diff --git a/charts/library/common/templates/lib/pod/_spec.tpl b/charts/library/common/templates/lib/pod/_spec.tpl index 103acc3c..a38b3dd9 100644 --- a/charts/library/common/templates/lib/pod/_spec.tpl +++ b/charts/library/common/templates/lib/pod/_spec.tpl @@ -6,54 +6,54 @@ The pod definition included in the controller. {{- $controllerObject := .controllerObject -}} {{- $ctx := dict "rootContext" $rootContext "controllerObject" $controllerObject -}} -enableServiceLinks: {{ $controllerObject.pod.enableServiceLinks }} +enableServiceLinks: {{ include "bjw-s.common.lib.pod.getOption" (dict "ctx" $ctx "option" "enableServiceLinks" "default" false) }} serviceAccountName: {{ include "bjw-s.common.lib.pod.field.serviceAccountName" (dict "ctx" $ctx) | trim }} -automountServiceAccountToken: {{ $controllerObject.pod.automountServiceAccountToken }} - {{- with ($controllerObject.pod.priorityClassName) }} +automountServiceAccountToken: {{ include "bjw-s.common.lib.pod.getOption" (dict "ctx" $ctx "option" "automountServiceAccountToken" "default" true) }} + {{- with (include "bjw-s.common.lib.pod.getOption" (dict "ctx" $ctx "option" "priorityClassName")) }} priorityClassName: {{ . | trim }} {{- end -}} - {{- with ($controllerObject.pod.runtimeClassName) }} + {{- with (include "bjw-s.common.lib.pod.getOption" (dict "ctx" $ctx "option" "runtimeClassName")) }} runtimeClassName: {{ . | trim }} {{- end -}} - {{- with ($controllerObject.pod.schedulerName) }} + {{- with (include "bjw-s.common.lib.pod.getOption" (dict "ctx" $ctx "option" "schedulerName")) }} schedulerName: {{ . | trim }} {{- end -}} - {{- with ($controllerObject.pod.securityContext) }} -securityContext: {{ . | toYaml | nindent 2 }} + {{- with (include "bjw-s.common.lib.pod.getOption" (dict "ctx" $ctx "option" "securityContext")) }} +securityContext: {{ . | nindent 2 }} {{- end -}} - {{- with ($controllerObject.pod.hostname) }} + {{- with (include "bjw-s.common.lib.pod.getOption" (dict "ctx" $ctx "option" "hostname")) }} hostname: {{ . | trim }} {{- end }} -hostIPC: {{ $controllerObject.pod.hostIPC }} -hostNetwork: {{ $controllerObject.pod.hostNetwork }} -hostPID: {{ $controllerObject.pod.hostPID }} +hostIPC: {{ include "bjw-s.common.lib.pod.getOption" (dict "ctx" $ctx "option" "hostIPC" "default" false) }} +hostNetwork: {{ include "bjw-s.common.lib.pod.getOption" (dict "ctx" $ctx "option" "hostNetwork" "default" false) }} +hostPID: {{ include "bjw-s.common.lib.pod.getOption" (dict "ctx" $ctx "option" "hostPID" "default" false) }} dnsPolicy: {{ include "bjw-s.common.lib.pod.field.dnsPolicy" (dict "ctx" $ctx) | trim }} - {{- with $controllerObject.pod.dnsConfig }} -dnsConfig: {{ . | toYaml | nindent 2 }} + {{- with (include "bjw-s.common.lib.pod.getOption" (dict "ctx" $ctx "option" "dnsConfig")) }} +dnsConfig: {{ . | nindent 2 }} {{- end -}} - {{- with $controllerObject.pod.hostAliases }} -hostAliases: {{ . | toYaml | nindent 2 }} + {{- with (include "bjw-s.common.lib.pod.getOption" (dict "ctx" $ctx "option" "hostAliases")) }} +hostAliases: {{ . | nindent 2 }} {{- end -}} - {{- with $controllerObject.pod.imagePullSecrets }} -imagePullSecrets: {{ . | toYaml | nindent 2 }} + {{- with (include "bjw-s.common.lib.pod.getOption" (dict "ctx" $ctx "option" "imagePullSecrets")) }} +imagePullSecrets: {{ . | nindent 2 }} {{- end -}} - {{- with $controllerObject.pod.terminationGracePeriodSeconds }} + {{- with (include "bjw-s.common.lib.pod.getOption" (dict "ctx" $ctx "option" "terminationGracePeriodSeconds")) }} terminationGracePeriodSeconds: {{ . | trim }} {{- end -}} - {{- with $controllerObject.pod.restartPolicy }} + {{- with (include "bjw-s.common.lib.pod.getOption" (dict "ctx" $ctx "option" "restartPolicy")) }} restartPolicy: {{ . | trim }} {{- end -}} - {{- with $controllerObject.pod.nodeSelector }} -nodeSelector: {{ . | toYaml | nindent 2 }} + {{- with (include "bjw-s.common.lib.pod.getOption" (dict "ctx" $ctx "option" "nodeSelector")) }} +nodeSelector: {{ . | nindent 2 }} {{- end -}} - {{- with $controllerObject.pod.affinity }} -affinity: {{ . | toYaml | nindent 2 }} + {{- with (include "bjw-s.common.lib.pod.getOption" (dict "ctx" $ctx "option" "affinity")) }} +affinity: {{ . | nindent 2 }} {{- end -}} - {{- with $controllerObject.pod.topologySpreadConstraints }} -topologySpreadConstraints: {{ . | toYaml | nindent 2 }} + {{- with (include "bjw-s.common.lib.pod.getOption" (dict "ctx" $ctx "option" "topologySpreadConstraints")) }} +topologySpreadConstraints: {{ . | nindent 2 }} {{- end -}} - {{- with $controllerObject.pod.tolerations }} -tolerations: {{ . | toYaml | nindent 2 }} + {{- with (include "bjw-s.common.lib.pod.getOption" (dict "ctx" $ctx "option" "tolerations")) }} +tolerations: {{ . | nindent 2 }} {{- end }} {{- with (include "bjw-s.common.lib.pod.field.initContainers" (dict "ctx" $ctx) | trim) }} initContainers: {{ . | nindent 2 }} diff --git a/charts/library/common/templates/lib/pod/fields/_containers.tpl b/charts/library/common/templates/lib/pod/fields/_containers.tpl index a20f7d41..6c9f8ded 100644 --- a/charts/library/common/templates/lib/pod/fields/_containers.tpl +++ b/charts/library/common/templates/lib/pod/fields/_containers.tpl @@ -13,10 +13,6 @@ Returns the value for containers {{- $enabledContainers := include "bjw-s.common.lib.controller.enabledContainers" (dict "rootContext" $rootContext "controllerObject" $controllerObject) | fromYaml }} {{- $renderedContainers := dict -}} - {{- /* TODO: Remove this logic after "order" removal in v3 */ -}} - {{- $containersWithDependsOn := include "bjw-s.common.lib.getMapItemsWithKey" (dict "map" $enabledContainers "key" "dependsOn") | fromYaml | keys -}} - {{- $useDependsOn := gt (len $containersWithDependsOn) 0 -}} - {{- range $key, $containerValues := $enabledContainers -}} {{- /* Create object from the container values */ -}} {{- $containerObject := (include "bjw-s.common.lib.container.valuesToObject" (dict "rootContext" $rootContext "id" $key "values" $containerValues)) | fromYaml -}} @@ -29,40 +25,23 @@ Returns the value for containers {{- $_ := set $renderedContainers $key $renderedContainer -}} {{- /* Determine the Container order */ -}} - {{- if $useDependsOn -}} - {{- if empty (dig "dependsOn" nil $containerValues) -}} - {{- $_ := set $graph $key ( list ) -}} - {{- else if kindIs "string" $containerValues.dependsOn -}} - {{- $_ := set $graph $key ( list $containerValues.dependsOn ) -}} - {{- else if kindIs "slice" $containerValues.dependsOn -}} - {{- $_ := set $graph $key $containerValues.dependsOn -}} - {{- end -}} - {{- else -}} - {{- /* TODO: Remove this logic after "order" removal in v3 */ -}} - {{- $containerOrder := (dig "order" 99 $containerValues) -}} - {{- $_ := set $graph $key $containerOrder -}} + {{- if empty (dig "dependsOn" nil $containerValues) -}} + {{- $_ := set $graph $key ( list ) -}} + {{- else if kindIs "string" $containerValues.dependsOn -}} + {{- $_ := set $graph $key ( list $containerValues.dependsOn ) -}} + {{- else if kindIs "slice" $containerValues.dependsOn -}} + {{- $_ := set $graph $key $containerValues.dependsOn -}} {{- end -}} + {{- end -}} {{- /* Process graph */ -}} - {{- if $useDependsOn -}} - {{- $args := dict "graph" $graph "out" list -}} - {{- include "bjw-s.common.lib.kahn" $args -}} + {{- $args := dict "graph" $graph "out" list -}} + {{- include "bjw-s.common.lib.kahn" $args -}} - {{- range $name := $args.out -}} - {{- $containerItem := get $renderedContainers $name -}} - {{- $containers = append $containers $containerItem -}} - {{- end -}} - {{- else -}} - {{- /* TODO: Remove this logic after "order" removal in v3 */ -}} - {{- $orderedContainers := dict -}} - {{- range $key, $order := $graph -}} - {{- $containerItem := get $renderedContainers $key -}} - {{- $_ := set $orderedContainers (printf "%v-%s" $order $key) $containerItem -}} - {{- end -}} - {{- range $key, $containerValues := $orderedContainers -}} - {{- $containers = append $containers $containerValues -}} - {{- end -}} + {{- range $name := $args.out -}} + {{- $containerItem := get $renderedContainers $name -}} + {{- $containers = append $containers $containerItem -}} {{- end -}} {{- if not (empty $containers) -}} diff --git a/charts/library/common/templates/lib/pod/fields/_dnsPolicy.tpl b/charts/library/common/templates/lib/pod/fields/_dnsPolicy.tpl index e82636d0..91de8f98 100644 --- a/charts/library/common/templates/lib/pod/fields/_dnsPolicy.tpl +++ b/charts/library/common/templates/lib/pod/fields/_dnsPolicy.tpl @@ -9,13 +9,13 @@ Returns the value for dnsPolicy {{- $dnsPolicy := "ClusterFirst" -}} {{- /* Get hostNetwork value "" */ -}} - {{- $hostNetwork:= get $controllerObject.pod "hostNetwork" -}} - {{- if $hostNetwork -}} + {{- $hostNetwork:= include "bjw-s.common.lib.pod.getOption" (dict "ctx" $ctx "option" "hostNetwork") -}} + {{- if (eq $hostNetwork "true") -}} {{- $dnsPolicy = "ClusterFirstWithHostNet" -}} {{- end -}} {{- /* See if an override is desired */ -}} - {{- $override := get $controllerObject.pod "dnsPolicy" -}} + {{- $override := include "bjw-s.common.lib.pod.getOption" (dict "ctx" $ctx "option" "dnsPolicy") -}} {{- if not (empty $override) -}} {{- $dnsPolicy = $override -}} diff --git a/charts/library/common/templates/lib/pod/fields/_initContainers.tpl b/charts/library/common/templates/lib/pod/fields/_initContainers.tpl index 2d780092..f5bc750a 100644 --- a/charts/library/common/templates/lib/pod/fields/_initContainers.tpl +++ b/charts/library/common/templates/lib/pod/fields/_initContainers.tpl @@ -12,10 +12,6 @@ Returns the value for initContainers {{- /* Fetch configured containers for this controller */ -}} {{- $renderedContainers := dict -}} - {{- /* TODO: Remove this logic after "order" removal in v3 */ -}} - {{- $containersWithDependsOn := include "bjw-s.common.lib.getMapItemsWithKey" (dict "map" $controllerObject.initContainers "key" "dependsOn") | fromYaml | keys -}} - {{- $useDependsOn := gt (len $containersWithDependsOn) 0 -}} - {{- range $key, $containerValues := $controllerObject.initContainers -}} {{- /* Enable container by default, but allow override */ -}} {{- $containerEnabled := true -}} @@ -35,41 +31,23 @@ Returns the value for initContainers {{- $_ := set $renderedContainers $key $renderedContainer -}} {{- /* Determine the Container order */ -}} - {{- if $useDependsOn -}} - {{- if empty (dig "dependsOn" nil $containerValues) -}} - {{- $_ := set $graph $key ( list ) -}} - {{- else if kindIs "string" $containerValues.dependsOn -}} - {{- $_ := set $graph $key ( list $containerValues.dependsOn ) -}} - {{- else if kindIs "slice" $containerValues.dependsOn -}} - {{- $_ := set $graph $key $containerValues.dependsOn -}} - {{- end -}} - {{- else -}} - {{- /* TODO: Remove this logic after "order" removal in v3 */ -}} - {{- $containerOrder := (dig "order" 99 $containerValues) -}} - {{- $_ := set $graph $key $containerOrder -}} + {{- if empty (dig "dependsOn" nil $containerValues) -}} + {{- $_ := set $graph $key ( list ) -}} + {{- else if kindIs "string" $containerValues.dependsOn -}} + {{- $_ := set $graph $key ( list $containerValues.dependsOn ) -}} + {{- else if kindIs "slice" $containerValues.dependsOn -}} + {{- $_ := set $graph $key $containerValues.dependsOn -}} {{- end -}} {{- end -}} {{- end -}} {{- /* Process graph */ -}} - {{- if $useDependsOn -}} - {{- $args := dict "graph" $graph "out" list -}} - {{- include "bjw-s.common.lib.kahn" $args -}} + {{- $args := dict "graph" $graph "out" list -}} + {{- include "bjw-s.common.lib.kahn" $args -}} - {{- range $name := $args.out -}} - {{- $containerItem := get $renderedContainers $name -}} - {{- $containers = append $containers $containerItem -}} - {{- end -}} - {{- else -}} - {{- /* TODO: Remove this logic after "order" removal in v3 */ -}} - {{- $orderedContainers := dict -}} - {{- range $key, $order := $graph -}} - {{- $containerItem := get $renderedContainers $key -}} - {{- $_ := set $orderedContainers (printf "%v-%s" $order $key) $containerItem -}} - {{- end -}} - {{- range $key, $containerValues := $orderedContainers -}} - {{- $containers = append $containers $containerValues -}} - {{- end -}} + {{- range $name := $args.out -}} + {{- $containerItem := get $renderedContainers $name -}} + {{- $containers = append $containers $containerItem -}} {{- end -}} {{- if not (empty $containers) -}} diff --git a/charts/library/common/templates/lib/pod/metadata/_annotations.tpl b/charts/library/common/templates/lib/pod/metadata/_annotations.tpl index 9f203754..a8edb7a3 100644 --- a/charts/library/common/templates/lib/pod/metadata/_annotations.tpl +++ b/charts/library/common/templates/lib/pod/metadata/_annotations.tpl @@ -9,7 +9,7 @@ Returns the value for annotations {{- $annotations := dict -}} {{- /* Set to the default if it is set */ -}} - {{- $defaultOption := get $rootContext.Values.defaultPodOptions "annotations" -}} + {{- $defaultOption := get (default dict $rootContext.Values.defaultPodOptions) "annotations" -}} {{- if not (empty $defaultOption) -}} {{- $annotations = merge $defaultOption $annotations -}} {{- end -}} diff --git a/charts/library/common/templates/lib/pod/metadata/_labels.tpl b/charts/library/common/templates/lib/pod/metadata/_labels.tpl index 82a1731b..837ffa29 100644 --- a/charts/library/common/templates/lib/pod/metadata/_labels.tpl +++ b/charts/library/common/templates/lib/pod/metadata/_labels.tpl @@ -17,7 +17,7 @@ Returns the value for labels {{- end -}} {{- /* Set to the default if it is set */ -}} - {{- $defaultOption := get $rootContext.Values.defaultPodOptions "labels" -}} + {{- $defaultOption := get (default dict $rootContext.Values.defaultPodOptions) "labels" -}} {{- if not (empty $defaultOption) -}} {{- $labels = merge $defaultOption $labels -}} {{- end -}} diff --git a/charts/library/common/templates/lib/service/_valuesToObject.tpl b/charts/library/common/templates/lib/service/_valuesToObject.tpl index 2b1417cb..9d283513 100644 --- a/charts/library/common/templates/lib/service/_valuesToObject.tpl +++ b/charts/library/common/templates/lib/service/_valuesToObject.tpl @@ -12,7 +12,8 @@ Convert Service values to an object {{- if $objectValues.nameOverride -}} {{- $objectName = printf "%s-%s" $objectName $objectValues.nameOverride -}} {{- else -}} - {{- if not $objectValues.primary -}} + {{- $enabledServices := (include "bjw-s.common.lib.service.enabledServices" (dict "rootContext" $rootContext) | fromYaml ) }} + {{- if and (not $objectValues.primary) (gt 1 (len $enabledServices)) -}} {{- $objectName = printf "%s-%s" $objectName $identifier -}} {{- end -}} {{- end -}} diff --git a/charts/library/common/values.schema.json b/charts/library/common/values.schema.json new file mode 100644 index 00000000..1bd4cf0f --- /dev/null +++ b/charts/library/common/values.schema.json @@ -0,0 +1,76 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema", + "$id": "https://raw.githubusercontent.com/bjw-s/helm-charts/common-3.0.0-beta1/charts/library/common/values.schema.json", + + "type": "object", + "properties": { + "global": { + "type": "object", + "properties": { + "annotations": { + "$ref": "schemas/definitions.json#/annotations" + }, + "nameOverride": { + "type": ["string", "null"] + }, + "fullnameOverride": { + "type": ["string", "null"] + }, + "labels": { + "$ref": "schemas/definitions.json#/labels" + } + } + }, + "defaultPodOptions": { + "$ref": "schemas/pod.json#/options" + }, + "controllers": { + "additionalProperties": { + "$ref": "schemas/controllers.json#/instance" + } + }, + "serviceAccount": { + "$ref": "schemas/serviceAccount.json#/settings" + }, + "configMaps": { + "additionalProperties": { + "$ref": "schemas/configmap.json#/instance" + } + }, + "secrets": { + "additionalProperties": { + "$ref": "schemas/secret.json#/instance" + } + }, + "ingress": { + "additionalProperties": { + "$ref": "schemas/ingress.json#/instance" + } + }, + "route": { + "additionalProperties": { + "$ref": "schemas/route.json#/instance" + } + }, + "service": { + "additionalProperties": { + "$ref": "schemas/service.json#/instance" + } + }, + "serviceMonitor": { + "additionalProperties": { + "$ref": "schemas/serviceMonitor.json#/instance" + } + }, + "networkpolicies": { + "additionalProperties": { + "$ref": "schemas/networkpolicy.json#/instance" + } + }, + "persistence": { + "additionalProperties": { + "$ref": "schemas/persistence.json#/item" + } + } + } +} diff --git a/charts/library/common/values.yaml b/charts/library/common/values.yaml index 506b3ef5..6a14bc75 100644 --- a/charts/library/common/values.yaml +++ b/charts/library/common/values.yaml @@ -23,30 +23,21 @@ defaultPodOptions: automountServiceAccountToken: true # -- Configuring the ndots option may resolve nslookup issues on some Kubernetes setups. - dnsConfig: - {} - # options: - # - name: ndots - # value: "1" + dnsConfig: {} - # -- Defaults to "ClusterFirst" if hostNetwork is false - # and "ClusterFirstWithHostNet" if hostNetwork is true. - dnsPolicy: # ClusterFirst + # -- Defaults to "ClusterFirst" if hostNetwork is false and "ClusterFirstWithHostNet" if hostNetwork is true. + dnsPolicy: "" # -- Enable/disable the generation of environment variables for services. # [[ref]](https://kubernetes.io/docs/concepts/services-networking/connect-applications-service/#accessing-the-service) - enableServiceLinks: true + enableServiceLinks: false # -- Allows specifying explicit hostname setting - hostname: + hostname: "" # -- Use hostAliases to add custom entries to /etc/hosts - mapping IP addresses to hostnames. # [[ref]](https://kubernetes.io/docs/concepts/services-networking/add-entries-to-pod-etc-hosts-with-host-aliases/) hostAliases: [] - # - ip: "192.168.1.100" - # hostnames: - # - "example.com" - # - "www.example.com" # -- Use the host's ipc namespace hostIPC: false @@ -68,17 +59,17 @@ defaultPodOptions: nodeSelector: {} # -- Custom priority class for different treatment by the scheduler - priorityClassName: # system-node-critical + priorityClassName: "" # -- Set Container restart policy. # @default -- `Always`. When `controller.type` is `cronjob` it defaults to `Never`. - restartPolicy: + restartPolicy: "" # -- Allow specifying a runtimeClassName other than the default one (ie: nvidia) - runtimeClassName: # nvidia + runtimeClassName: "" # -- Allows specifying a custom scheduler name - schedulerName: # awkward-dangerous-scheduler + schedulerName: "" # -- Configure the Security Context for the Pod securityContext: {} @@ -94,296 +85,283 @@ defaultPodOptions: # -- Defines topologySpreadConstraint rules. # [[ref]](https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/) topologySpreadConstraints: [] - # - maxSkew: - # topologyKey: - # whenUnsatisfiable: - # labelSelector: -controllers: - main: - # -- enable the controller. - enabled: true +controllers: {} +# main: +# # -- enable the controller. +# enabled: true - # -- Set the controller type. - # Valid options are deployment, daemonset, statefulset, cronjob or job - type: deployment - # -- Set annotations on the deployment/statefulset/daemonset/cronjob/job - annotations: {} - # -- Set labels on the deployment/statefulset/daemonset/cronjob/job - labels: {} - # -- Number of desired pods. When using a HorizontalPodAutoscaler, set this to `null`. - replicas: 1 - # -- Set the controller upgrade strategy - # For Deployments, valid values are Recreate (default) and RollingUpdate. - # For StatefulSets, valid values are OnDelete and RollingUpdate (default). - # DaemonSets/CronJobs/Jobs ignore this. - strategy: +# # -- Set the controller type. +# # Valid options are deployment, daemonset, statefulset, cronjob or job +# type: deployment +# # -- Set annotations on the deployment/statefulset/daemonset/cronjob/job +# annotations: {} +# # -- Set labels on the deployment/statefulset/daemonset/cronjob/job +# labels: {} +# # -- Number of desired pods. When using a HorizontalPodAutoscaler, set this to `null`. +# replicas: 1 +# # -- Set the controller upgrade strategy +# # For Deployments, valid values are Recreate (default) and RollingUpdate. +# # For StatefulSets, valid values are OnDelete and RollingUpdate (default). +# # DaemonSets/CronJobs/Jobs ignore this. +# strategy: - rollingUpdate: - # -- Set deployment RollingUpdate max unavailable - unavailable: - # -- Set deployment RollingUpdate max surge - surge: - # -- Set statefulset RollingUpdate partition - partition: - # -- ReplicaSet revision history limit - revisionHistoryLimit: 3 +# rollingUpdate: +# # -- Set deployment RollingUpdate max unavailable +# unavailable: +# # -- Set deployment RollingUpdate max surge +# surge: +# # -- Set statefulset RollingUpdate partition +# partition: +# # -- ReplicaSet revision history limit +# revisionHistoryLimit: 3 - # -- CronJob configuration. Required only when using `controller.type: cronjob`. - # @default -- See below - cronjob: - # -- Suspends the CronJob - # [[ref]](https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/#schedule-suspension) - # @default -- false - suspend: - # -- Specifies how to treat concurrent executions of a job that is created by this cron job - # valid values are Allow, Forbid or Replace - concurrencyPolicy: Forbid - # -- Sets the CronJob timezone (only works in Kubernetes >= 1.27) - timeZone: - # -- Sets the CronJob time when to execute your jobs - schedule: "*/20 * * * *" - # -- The deadline in seconds for starting the job if it misses its scheduled time for any reason - startingDeadlineSeconds: 30 - # -- The number of succesful Jobs to keep - successfulJobsHistory: 1 - # -- The number of failed Jobs to keep - failedJobsHistory: 1 - # -- If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to - # be automatically deleted. - ttlSecondsAfterFinished: - # -- Limits the number of times a failed job will be retried - backoffLimit: 6 - # -- Specify the number of parallel jobs - parallelism: +# # -- CronJob configuration. Required only when using `controller.type: cronjob`. +# # @default -- See below +# cronjob: +# # -- Suspends the CronJob +# # [[ref]](https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/#schedule-suspension) +# # @default -- false +# suspend: +# # -- Specifies how to treat concurrent executions of a job that is created by this cron job +# # valid values are Allow, Forbid or Replace +# concurrencyPolicy: Forbid +# # -- Sets the CronJob timezone (only works in Kubernetes >= 1.27) +# timeZone: +# # -- Sets the CronJob time when to execute your jobs +# schedule: "*/20 * * * *" +# # -- The deadline in seconds for starting the job if it misses its scheduled time for any reason +# startingDeadlineSeconds: 30 +# # -- The number of succesful Jobs to keep +# successfulJobsHistory: 1 +# # -- The number of failed Jobs to keep +# failedJobsHistory: 1 +# # -- If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to +# # be automatically deleted. +# ttlSecondsAfterFinished: +# # -- Limits the number of times a failed job will be retried +# backoffLimit: 6 +# # -- Specify the number of parallel jobs +# parallelism: - # -- Job configuration. Required only when using `controller.type: job`. - # @default -- See below - job: - # -- Suspends the Job - # [[ref]](https://kubernetes.io/docs/concepts/workloads/controllers/job/#suspending-a-job) - # @default -- false - suspend: - # -- If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to - # be automatically deleted. - ttlSecondsAfterFinished: - # -- Limits the number of times a failed job will be retried - backoffLimit: 6 - # -- Specify the number of parallel jobs - parallelism: - # -- Specify the number of completions for the job - completions: - # -- Specify the completionMode for the job - completionMode: +# # -- Job configuration. Required only when using `controller.type: job`. +# # @default -- See below +# job: +# # -- Suspends the Job +# # [[ref]](https://kubernetes.io/docs/concepts/workloads/controllers/job/#suspending-a-job) +# # @default -- false +# suspend: +# # -- If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to +# # be automatically deleted. +# ttlSecondsAfterFinished: +# # -- Limits the number of times a failed job will be retried +# backoffLimit: 6 +# # -- Specify the number of parallel jobs +# parallelism: +# # -- Specify the number of completions for the job +# completions: +# # -- Specify the completionMode for the job +# completionMode: - # -- StatefulSet configuration. Required only when using `controller.type: statefulset`. - statefulset: - # -- Set podManagementPolicy, valid values are Parallel and OrderedReady (default). - podManagementPolicy: +# # -- StatefulSet configuration. Required only when using `controller.type: statefulset`. +# statefulset: +# # -- Set podManagementPolicy, valid values are Parallel and OrderedReady (default). +# podManagementPolicy: - # -- Used to create individual disks for each instance. - volumeClaimTemplates: [] - # - name: data - # labels: {} - # annotations: {} - # globalMounts: - # - path: /data - # accessMode: "ReadWriteOnce" - # dataSourceRef: - # apiGroup: snapshot.storage.k8s.io - # kind: VolumeSnapshot - # name: MySnapshot - # size: 1Gi - # - name: backup - # labels: {} - # annotations: {} - # globalMounts: - # - path: /backup - # subPath: theSubPath - # accessMode: "ReadWriteOnce" - # size: 2Gi - # storageClass: cheap-storage-class +# # -- Used to create individual disks for each instance. +# volumeClaimTemplates: [] +# # - name: data +# # labels: {} +# # annotations: {} +# # globalMounts: +# # - path: /data +# # accessMode: "ReadWriteOnce" +# # dataSourceRef: +# # apiGroup: snapshot.storage.k8s.io +# # kind: VolumeSnapshot +# # name: MySnapshot +# # size: 1Gi +# # - name: backup +# # labels: {} +# # annotations: {} +# # globalMounts: +# # - path: /backup +# # subPath: theSubPath +# # accessMode: "ReadWriteOnce" +# # size: 2Gi +# # storageClass: cheap-storage-class - # Controller-specific overrides for `defaultPodOptions` keys - pod: {} +# # Controller-specific overrides for `defaultPodOptions` keys +# pod: {} - containers: - main: - # -- Override the container name - nameOverride: +# containers: +# main: +# # -- Override the container name +# nameOverride: - # -- Override the default container order - # Containers get sorted alphanumerically by the `-` combination. - # @default -- 99 - order: 1 +# # -- Specify if this container depends on any other containers +# # This is used to determine the order in which the containers are rendered. +# dependsOn: [] - # -- Specify if this container depends on any other containers - # This is used to determine the order in which the containers are rendered. - # The use of "dependsOn" completely disables the "order" field within the controller. - dependsOn: [] +# image: +# # -- image repository +# repository: +# # -- image tag +# tag: +# # -- image pull policy +# pullPolicy: - image: - # -- image repository - repository: - # -- image tag - tag: - # -- image pull policy - pullPolicy: +# # -- Override the command(s) for the default container +# command: [] +# # -- Override the args for the default container +# args: [] +# # -- Override the working directory for the default container +# workingDir: - # -- Override the command(s) for the default container - command: [] - # -- Override the args for the default container - args: [] - # -- Override the working directory for the default container - workingDir: +# # -- Environment variables. Template enabled. +# # Syntax options: +# # A) TZ: UTC +# # B) PASSWD: '{{ .Release.Name }}' +# # B) TZ: +# # value: UTC +# # dependsOn: otherVar +# # D) PASSWD: +# # configMapKeyRef: +# # name: config-map-name +# # key: key-name +# # E) PASSWD: +# # dependsOn: +# # - otherVar1 +# # - otherVar2 +# # valueFrom: +# # secretKeyRef: +# # name: secret-name +# # key: key-name +# # ... +# # F) - name: TZ +# # value: UTC +# # G) - name: TZ +# # value: '{{ .Release.Name }}' +# env: - # -- Environment variables. Template enabled. - # Syntax options: - # A) TZ: UTC - # B) PASSWD: '{{ .Release.Name }}' - # B) TZ: - # value: UTC - # dependsOn: otherVar - # D) PASSWD: - # configMapKeyRef: - # name: config-map-name - # key: key-name - # E) PASSWD: - # dependsOn: - # - otherVar1 - # - otherVar2 - # valueFrom: - # secretKeyRef: - # name: secret-name - # key: key-name - # ... - # F) - name: TZ - # value: UTC - # G) - name: TZ - # value: '{{ .Release.Name }}' - env: +# # -- Secrets and/or ConfigMaps that will be loaded as environment variables. +# # Syntax options: +# # A) Pass an app-template configMap identifier: +# # - config: config +# # B) Pass any configMap name that is not also an identifier (Template enabled): +# # - config: random-configmap-name +# # C) Pass an app-template configMap identifier, explicit syntax: +# # - configMapRef: +# # identifier: config +# # D) Pass any configMap name, explicit syntax (Template enabled): +# # - configMapRef: +# # name: "{{ .Release.Name }}-config" +# # E) Pass an app-template secret identifier: +# # - secret: secret +# # F) Pass any secret name that is not also an identifier (Template enabled): +# # - secret: random-secret-name +# # G) Pass an app-template secret identifier, explicit syntax: +# # - secretRef: +# # identifier: secret +# # H) Pass any secret name, explicit syntax (Template enabled): +# # - secretRef: +# # name: "{{ .Release.Name }}-secret" +# envFrom: [] - # -- Secrets and/or ConfigMaps that will be loaded as environment variables. - # Syntax options: - # A) Pass an app-template configMap identifier: - # - config: config - # B) Pass any configMap name that is not also an identifier (Template enabled): - # - config: random-configmap-name - # C) Pass an app-template configMap identifier, explicit syntax: - # - configMapRef: - # identifier: config - # D) Pass any configMap name, explicit syntax (Template enabled): - # - configMapRef: - # name: "{{ .Release.Name }}-config" - # E) Pass an app-template secret identifier: - # - secret: secret - # F) Pass any secret name that is not also an identifier (Template enabled): - # - secret: random-secret-name - # G) Pass an app-template secret identifier, explicit syntax: - # - secretRef: - # identifier: secret - # H) Pass any secret name, explicit syntax (Template enabled): - # - secretRef: - # name: "{{ .Release.Name }}-secret" - envFrom: [] +# # -- Probe configuration +# # -- [[ref]](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) +# probes: +# # -- Liveness probe configuration +# # @default -- See below +# liveness: +# # -- Enable the liveness probe +# enabled: true +# # -- Set this to `true` if you wish to specify your own livenessProbe +# custom: false +# # -- sets the probe type when not using a custom probe +# # @default -- "TCP" +# type: TCP +# # -- The spec field contains the values for the default livenessProbe. +# # If you selected `custom: true`, this field holds the definition of the livenessProbe. +# # @default -- See below +# spec: +# initialDelaySeconds: 0 +# periodSeconds: 10 +# timeoutSeconds: 1 +# failureThreshold: 3 - # -- Probe configuration - # -- [[ref]](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) - # @default -- See below - probes: - # -- Liveness probe configuration - # @default -- See below - liveness: - # -- Enable the liveness probe - enabled: true - # -- Set this to `true` if you wish to specify your own livenessProbe - custom: false - # -- sets the probe type when not using a custom probe - # @default -- "TCP" - type: TCP - # -- The spec field contains the values for the default livenessProbe. - # If you selected `custom: true`, this field holds the definition of the livenessProbe. - # @default -- See below - spec: - initialDelaySeconds: 0 - periodSeconds: 10 - timeoutSeconds: 1 - failureThreshold: 3 +# # -- Readiness probe configuration +# readiness: +# # -- Enable the readiness probe +# enabled: true +# # -- Set this to `true` if you wish to specify your own readinessProbe +# custom: false +# # -- sets the probe type when not using a custom probe +# # @default -- "TCP" +# type: TCP +# # -- The spec field contains the values for the default readinessProbe. +# # If you selected `custom: true`, this field holds the definition of the readinessProbe. +# # @default -- See below +# spec: +# initialDelaySeconds: 0 +# periodSeconds: 10 +# timeoutSeconds: 1 +# failureThreshold: 3 - # -- Redainess probe configuration - # @default -- See below - readiness: - # -- Enable the readiness probe - enabled: true - # -- Set this to `true` if you wish to specify your own readinessProbe - custom: false - # -- sets the probe type when not using a custom probe - # @default -- "TCP" - type: TCP - # -- The spec field contains the values for the default readinessProbe. - # If you selected `custom: true`, this field holds the definition of the readinessProbe. - # @default -- See below - spec: - initialDelaySeconds: 0 - periodSeconds: 10 - timeoutSeconds: 1 - failureThreshold: 3 +# # -- Startup probe configuration +# startup: +# # -- Enable the startup probe +# enabled: true +# # -- Set this to `true` if you wish to specify your own startupProbe +# custom: false +# # -- sets the probe type when not using a custom probe +# # @default -- "TCP" +# type: TCP +# # -- The spec field contains the values for the default startupProbe. +# # If you selected `custom: true`, this field holds the definition of the startupProbe. +# # @default -- See below +# spec: +# initialDelaySeconds: 0 +# timeoutSeconds: 1 +# ## This means it has a maximum of 5*30=150 seconds to start up before it fails +# periodSeconds: 5 +# failureThreshold: 30 - # -- Startup probe configuration - # @default -- See below - startup: - # -- Enable the startup probe - enabled: true - # -- Set this to `true` if you wish to specify your own startupProbe - custom: false - # -- sets the probe type when not using a custom probe - # @default -- "TCP" - type: TCP - # -- The spec field contains the values for the default startupProbe. - # If you selected `custom: true`, this field holds the definition of the startupProbe. - # @default -- See below - spec: - initialDelaySeconds: 0 - timeoutSeconds: 1 - ## This means it has a maximum of 5*30=150 seconds to start up before it fails - periodSeconds: 5 - failureThreshold: 30 +# # -- Set the resource requests / limits for the container. +# resources: +# {} +# ## We usually recommend not to specify default resources and to leave this as a conscious +# ## choice for the user. This also increases chances charts run on environments with little +# ## resources, such as Minikube. If you do want to specify resources, uncomment the following +# ## lines, adjust them as necessary, and remove the curly braces after 'resources:'. +# # limits: +# # cpu: 100m +# # memory: 128Mi +# # requests: +# # cpu: 100m +# # memory: 128Mi - # -- Set the resource requests / limits for the container. - resources: - {} - ## We usually recommend not to specify default resources and to leave this as a conscious - ## choice for the user. This also increases chances charts run on environments with little - ## resources, such as Minikube. If you do want to specify resources, uncomment the following - ## lines, adjust them as necessary, and remove the curly braces after 'resources:'. - # limits: - # cpu: 100m - # memory: 128Mi - # requests: - # cpu: 100m - # memory: 128Mi +# # -- Configure the Security Context for the container +# securityContext: {} - # -- Configure the Security Context for the container - securityContext: {} +# # -- Configure the lifecycle event hooks for the container +# # -- [[ref](https://kubernetes.io/docs/tasks/configure-pod-container/attach-handler-lifecycle-event/)] +# lifecycle: {} - # -- Configure the lifecycle event hooks for the container - # -- [[ref](https://kubernetes.io/docs/tasks/configure-pod-container/attach-handler-lifecycle-event/)] - lifecycle: {} +# # -- Configure the path at which the file to which the containers termination message will be written. +# # -- [[ref](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#lifecycle-1)] +# terminationMessagePath: - # -- Configure the path at which the file to which the containers termination message will be written. - # -- [[ref](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#lifecycle-1)] - terminationMessagePath: +# # -- Indicate how the containers termination message should be populated. +# # Valid options are `File` and `FallbackToLogsOnError`. +# # -- [[ref](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#lifecycle-1)] +# terminationMessagePolicy: - # -- Indicate how the containers termination message should be populated. - # Valid options are `File` and `FallbackToLogsOnError`. - # -- [[ref](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#lifecycle-1)] - terminationMessagePolicy: - - # -- Specify any initContainers here as dictionary items. - # Each initContainer should have its own key - # initContainers get sorted alphanumerically by the `-` combination - # if no order or dependsOn has been configured for them. - initContainers: {} +# # -- Specify any initContainers here as dictionary items. +# # Each initContainer should have its own key +# # initContainers get sorted alphanumerically by the `-` combination +# # if no order or dependsOn has been configured for them. +# initContainers: {} serviceAccount: # -- Specifies whether a service account should be created @@ -405,344 +383,343 @@ serviceAccount: # Additional Secrets can be added by adding a dictionary key similar to the 'secret' object. # @default -- See below secrets: - secret: - # -- Enables or disables the Secret - enabled: false - # -- Labels to add to the Secret - labels: {} - # -- Annotations to add to the Secret - annotations: {} - # -- Secret stringData content. Helm template enabled. - stringData: - {} - # foo: bar + {} + # secret: + # # -- Enables or disables the Secret + # enabled: false + # # -- Labels to add to the Secret + # labels: {} + # # -- Annotations to add to the Secret + # annotations: {} + # # -- Secret stringData content. Helm template enabled. + # stringData: + # {} + # # foo: bar # -- Configure configMaps for the chart here. # Additional configMaps can be added by adding a dictionary key similar to the 'config' object. # @default -- See below configMaps: - config: - # -- Enables or disables the configMap - enabled: false - # -- Labels to add to the configMap - labels: {} - # -- Annotations to add to the configMap - annotations: {} - # -- configMap data content. Helm template enabled. - data: - {} - # foo: bar + {} + # config: + # # -- Enables or disables the configMap + # enabled: true + # # -- Labels to add to the configMap + # labels: {} + # # -- Annotations to add to the configMap + # annotations: {} + # # -- configMap data content. Helm template enabled. + # data: + # foo: bar # -- Configure the services for the chart here. # Additional services can be added by adding a dictionary key similar to the 'main' service. # @default -- See below service: - main: - # -- Enables or disables the service - enabled: true + {} + # main: + # # -- Enables or disables the service + # enabled: true - # -- Override the name suffix that is used for this service - nameOverride: + # # -- Override the name suffix that is used for this service + # nameOverride: "" - # -- Configure which controller this service should target - controller: main + # # -- Configure which controller this service should target + # controller: main - # -- Make this the primary service for this controller (used in probes, notes, etc...). - # If there is more than 1 service targeting the controller, make sure that only 1 service is - # marked as primary. - primary: true + # # -- Make this the primary service for this controller (used in probes, notes, etc...). + # # If there is more than 1 service targeting the controller, make sure that only 1 service is + # # marked as primary. + # primary: true - # -- Set the service type - type: ClusterIP + # # -- Set the service type + # type: ClusterIP - # -- Specify the externalTrafficPolicy for the service. Options: Cluster, Local - # -- [[ref](https://kubernetes.io/docs/tutorials/services/source-ip/)] - externalTrafficPolicy: + # # -- Specify the externalTrafficPolicy for the service. Options: Cluster, Local + # # -- [[ref](https://kubernetes.io/docs/tutorials/services/source-ip/)] + # externalTrafficPolicy: - # -- Specify the ip policy. Options: SingleStack, PreferDualStack, RequireDualStack - ipFamilyPolicy: - # -- The ip families that should be used. Options: IPv4, IPv6 - ipFamilies: [] + # # -- Specify the ip policy. Options: SingleStack, PreferDualStack, RequireDualStack + # ipFamilyPolicy: + # # -- The ip families that should be used. Options: IPv4, IPv6 + # ipFamilies: [] - # -- Provide additional annotations which may be required. - annotations: {} + # # -- Provide additional annotations which may be required. + # annotations: {} - # -- Provide additional labels which may be required. - labels: {} + # # -- Provide additional labels which may be required. + # labels: {} - # -- Allow adding additional match labels - extraSelectorLabels: {} + # # -- Allow adding additional match labels + # extraSelectorLabels: {} - # -- Configure the Service port information here. - # Additional ports can be added by adding a dictionary key similar to the 'http' service. - # @default -- See below - ports: - http: - # -- Enables or disables the port - enabled: true + # # -- Configure the Service port information here. + # # Additional ports can be added by adding a dictionary key similar to the 'http' service. + # # @default -- See below + # ports: + # http: + # # -- Enables or disables the port + # enabled: true - # -- Make this the primary port (used in probes, notes, etc...) - # If there is more than 1 service, make sure that only 1 port is marked as primary. - primary: true + # # -- Make this the primary port (used in probes, notes, etc...) + # # If there is more than 1 service, make sure that only 1 port is marked as primary. + # primary: true - # -- The port number - port: + # # -- The port number + # port: - # -- Port protocol. - # Support values are `HTTP`, `HTTPS`, `TCP` and `UDP`. - # HTTP and HTTPS spawn a TCP service and get used for internal URL and name generation - protocol: HTTP + # # -- Port protocol. + # # Support values are `HTTP`, `HTTPS`, `TCP` and `UDP`. + # # HTTP and HTTPS spawn a TCP service and get used for internal URL and name generation + # protocol: HTTP - # -- Specify a service targetPort if you wish to differ the service port from the application port. - # If `targetPort` is specified, this port number is used in the container definition instead of - # the `port` value. Therefore named ports are not supported for this field. - targetPort: + # # -- Specify a service targetPort if you wish to differ the service port from the application port. + # # If `targetPort` is specified, this port number is used in the container definition instead of + # # the `port` value. Therefore named ports are not supported for this field. + # targetPort: - # -- Specify the nodePort value for the LoadBalancer and NodePort service types. - # [[ref]](https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport) - nodePort: + # # -- Specify the nodePort value for the LoadBalancer and NodePort service types. + # # [[ref]](https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport) + # nodePort: - # -- Specify the appProtocol value for the Service. - # [[ref]](https://kubernetes.io/docs/concepts/services-networking/service/#application-protocol) - appProtocol: + # # -- Specify the appProtocol value for the Service. + # # [[ref]](https://kubernetes.io/docs/concepts/services-networking/service/#application-protocol) + # appProtocol: + +# -- Configure the ingresses for the chart here. +ingress: + {} + + # -- An example is shown below + # main: + # # -- Enables or disables the ingress + # enabled: true + + # # -- Override the name suffix that is used for this ingress. + # nameOverride: + + # # -- Provide additional annotations which may be required. + # annotations: {} + + # # -- Provide additional labels which may be required. + # labels: {} + + # # -- Set the ingressClass that is used for this ingress. + # className: + + # # -- Configure the defaultBackend for this ingress. This will disable any other rules for the ingress. + # defaultBackend: + + # ## Configure the hosts for the ingress + # hosts: + # - # -- Host address. Helm template can be passed. + # host: chart-example.local + # ## Configure the paths for the host + # paths: + # - # -- Path. Helm template can be passed. + # path: / + # pathType: Prefix + # service: + # # -- Overrides the service name reference for this path + # # This can be an actual service name, or reference a service identifier from this values.yaml + # name: main + # # -- Overrides the service port number reference for this path + # port: + + # # -- Configure TLS for the ingress. Both secretName and hosts can process a Helm template. + # tls: [] + # # - secretName: chart-example-tls + # # hosts: + # # - chart-example.local # -- Configure the ServiceMonitors for the chart here. # Additional ServiceMonitors can be added by adding a dictionary key similar to the 'main' ServiceMonitors. # @default -- See below serviceMonitor: - main: - # -- Enables or disables the serviceMonitor. - enabled: false + {} + # main: + # # -- Enables or disables the serviceMonitor. + # enabled: false - # -- Override the name suffix that is used for this serviceMonitor. - nameOverride: + # # -- Override the name suffix that is used for this serviceMonitor. + # nameOverride: "" - # -- Provide additional annotations which may be required. - annotations: {} + # # -- Provide additional annotations which may be required. + # annotations: {} - # -- Provide additional labels which may be required. - labels: {} + # # -- Provide additional labels which may be required. + # labels: {} - # -- Configures a custom selector for the serviceMonitor, this takes precedence over - # specifying a service name. - # Helm templates can be used. - selector: {} + # # -- Configures a custom selector for the serviceMonitor, this takes precedence over + # # specifying a service name. + # # Helm templates can be used. + # selector: {} - # -- Configures the target Service for the serviceMonitor. Helm templates can be used. - serviceName: '{{ include "bjw-s.common.lib.chart.names.fullname" $ }}' + # # -- Configures the target Service for the serviceMonitor. Helm templates can be used. + # serviceName: '{{ include "bjw-s.common.lib.chart.names.fullname" $ }}' - # -- Configures the endpoints for the serviceMonitor. - # @default -- See values.yaml - endpoints: - - port: http - scheme: http - path: /metrics - interval: 1m - scrapeTimeout: 10s + # # -- Configures the endpoints for the serviceMonitor. + # # @default -- See values.yaml + # endpoints: + # - port: http + # scheme: http + # path: /metrics + # interval: 1m + # scrapeTimeout: 10s - # -- Configures custom targetLabels for the serviceMonitor. (All collected - # meterics will have these labels, taking the value from the target service) - # [[ref]](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#servicemonitorspec/) - targetLabels: [] - -# -- Configure the ingresses for the chart here. -# Additional ingresses can be added by adding a dictionary key similar to the 'main' ingress. -# @default -- See below -ingress: - main: - # -- Enables or disables the ingress - enabled: false - - # -- Make this the primary ingress (used in probes, notes, etc...). - # If there is more than 1 ingress, make sure that only 1 ingress is marked as primary. - primary: true - - # -- Override the name suffix that is used for this ingress. - nameOverride: - - # -- Provide additional annotations which may be required. - annotations: - {} - # kubernetes.io/ingress.class: nginx - # kubernetes.io/tls-acme: "true" - - # -- Provide additional labels which may be required. - labels: {} - - # -- Set the ingressClass that is used for this ingress. - className: # "nginx" - - # -- Configure the defaultBackend for this ingress. This will disable any other rules for the ingress. - defaultBackend: - - ## Configure the hosts for the ingress - hosts: - - # -- Host address. Helm template can be passed. - host: chart-example.local - ## Configure the paths for the host - paths: - - # -- Path. Helm template can be passed. - path: / - pathType: Prefix - service: - # -- Overrides the service name reference for this path - # This can be an actual service name, or reference a service identifier - # from this values.yaml - name: main - # -- Overrides the service port number reference for this path - port: - - # -- Configure TLS for the ingress. Both secretName and hosts can process a Helm template. - tls: [] - # - secretName: chart-example-tls - # hosts: - # - chart-example.local + # # -- Configures custom targetLabels for the serviceMonitor. (All collected + # # meterics will have these labels, taking the value from the target service) + # # [[ref]](https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#servicemonitorspec/) + # targetLabels: [] # -- Configure the gateway routes for the chart here. # Additional routes can be added by adding a dictionary key similar to the 'main' route. # [[ref]](https://gateway-api.sigs.k8s.io/references/spec/) # @default -- See below route: - main: - # -- Enables or disables the route - enabled: false + {} + # main: + # # -- Enables or disables the route + # enabled: false - # -- Set the route kind - # Valid options are GRPCRoute, HTTPRoute, TCPRoute, TLSRoute, UDPRoute - kind: HTTPRoute + # # -- Set the route kind + # # Valid options are GRPCRoute, HTTPRoute, TCPRoute, TLSRoute, UDPRoute + # kind: HTTPRoute - # -- Override the name suffix that is used for this route. - nameOverride: + # # -- Override the name suffix that is used for this route. + # nameOverride: "" - # -- Provide additional annotations which may be required. - annotations: {} + # # -- Provide additional annotations which may be required. + # annotations: {} - # -- Provide additional labels which may be required. - labels: {} + # # -- Provide additional labels which may be required. + # labels: {} - # -- Configure the resource the route attaches to. - parentRefs: - - # Group of the referent resource. - group: gateway.networking.k8s.io - # Kind of the referent resource. - kind: Gateway - # Name of the referent resource - name: - # Namespace of the referent resource - namespace: - # Name of the section within the target resource. - sectionName: + # # -- Configure the resource the route attaches to. + # parentRefs: + # - # Group of the referent resource. + # group: gateway.networking.k8s.io + # # Kind of the referent resource. + # kind: Gateway + # # Name of the referent resource + # name: + # # Namespace of the referent resource + # namespace: + # # Name of the section within the target resource. + # sectionName: - # -- Host addresses. Helm template can be passed. - hostnames: [] + # # -- Host addresses. Helm template can be passed. + # hostnames: [] - # -- Configure rules for routing. Defaults to the primary service. - rules: - - # -- Configure backends where matching requests should be sent. - backendRefs: [] - ## Configure conditions used for matching incoming requests. Only for HTTPRoutes - matches: - - path: - type: PathPrefix - value: / - ## Request filters that are applied to the rules. - filters: [] - ## Request timeout that are applied to the rules. - timeouts: {} + # # -- Configure rules for routing. Defaults to the primary service. + # rules: + # - # -- Configure backends where matching requests should be sent. + # backendRefs: [] + # ## Configure conditions used for matching incoming requests. Only for HTTPRoutes + # matches: + # - path: + # type: PathPrefix + # value: / + # ## Request filters that are applied to the rules. + # filters: [] + # ## Request timeout that are applied to the rules. + # timeouts: {} # -- Configure persistence for the chart here. # Additional items can be added by adding a dictionary key similar to the 'config' key. # [[ref]](https://bjw-s.github.io/helm-charts/docs/common-library/common-library-storage) # @default -- See below persistence: - config: - # -- Enables or disables the persistence item. Defaults to true - enabled: false + {} + # config: + # # -- Enables or disables the persistence item. Defaults to true + # enabled: false - # -- Sets the persistence type - # Valid options are persistentVolumeClaim, emptyDir, nfs, hostPath, secret, configMap or custom - type: persistentVolumeClaim + # # -- Sets the persistence type + # # Valid options are persistentVolumeClaim, emptyDir, nfs, hostPath, secret, configMap or custom + # type: persistentVolumeClaim - # -- Storage Class for the config volume. - # If set to `-`, dynamic provisioning is disabled. - # If set to something else, the given storageClass is used. - # If undefined (the default) or set to null, no storageClassName spec is set, choosing the default provisioner. - storageClass: # "-" + # # -- Storage Class for the config volume. + # # If set to `-`, dynamic provisioning is disabled. + # # If set to something else, the given storageClass is used. + # # If undefined (the default) or set to null, no storageClassName spec is set, choosing the default provisioner. + # storageClass: # "-" - # -- If you want to reuse an existing claim, the name of the existing PVC can be passed here. - existingClaim: # your-claim + # # -- If you want to reuse an existing claim, the name of the existing PVC can be passed here. + # existingClaim: # your-claim - # -- The optional data source for the persistentVolumeClaim. - # [[ref]](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#volume-populators-and-data-sources) - dataSource: {} + # # -- The optional data source for the persistentVolumeClaim. + # # [[ref]](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#volume-populators-and-data-sources) + # dataSource: {} - # -- The optional volume populator for the persistentVolumeClaim. - # [[ref]](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#volume-populators-and-data-sources) - dataSourceRef: {} + # # -- The optional volume populator for the persistentVolumeClaim. + # # [[ref]](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#volume-populators-and-data-sources) + # dataSourceRef: {} - # -- AccessMode for the persistent volume. - # Make sure to select an access mode that is supported by your storage provider! - # [[ref]](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes) - accessMode: ReadWriteOnce + # # -- AccessMode for the persistent volume. + # # Make sure to select an access mode that is supported by your storage provider! + # # [[ref]](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes) + # accessMode: ReadWriteOnce - # -- The amount of storage that is requested for the persistent volume. - size: 1Gi + # # -- The amount of storage that is requested for the persistent volume. + # size: 1Gi - # -- Set to true to retain the PVC upon `helm uninstall` - retain: false + # # -- Set to true to retain the PVC upon `helm uninstall` + # retain: false - # -- Configure mounts to all controllers and containers. By default the persistence item - # will be mounted to `/`. - # Example: - # globalMounts: - # - path: /config - # readOnly: false - globalMounts: [] + # # -- Configure mounts to all controllers and containers. By default the persistence item + # # will be mounted to `/`. + # # Example: + # # globalMounts: + # # - path: /config + # # readOnly: false + # globalMounts: [] - # -- Explicitly configure mounts for specific controllers and containers. - # Example: - # advancedMounts: - # main: # the controller with the "main" identifier - # main: # the container with the "main" identifier - # - path: /data/config.yaml - # readOnly: true - # mountPropagation: None - # subPath: config.yaml - # second-container: # the container with the "second-container" identifier - # - path: /appdata/config - # readOnly: true - # second-controller: # the controller with the "second-controller" identifier - # main: # the container with the "main" identifier - # - path: /data/config.yaml - # readOnly: false - # subPath: config.yaml - advancedMounts: {} + # # -- Explicitly configure mounts for specific controllers and containers. + # # Example: + # # advancedMounts: + # # main: # the controller with the "main" identifier + # # main: # the container with the "main" identifier + # # - path: /data/config.yaml + # # readOnly: true + # # mountPropagation: None + # # subPath: config.yaml + # # second-container: # the container with the "second-container" identifier + # # - path: /appdata/config + # # readOnly: true + # # second-controller: # the controller with the "second-controller" identifier + # # main: # the container with the "main" identifier + # # - path: /data/config.yaml + # # readOnly: false + # # subPath: config.yaml + # advancedMounts: {} # -- Configure the networkPolicies for the chart here. # Additional networkPolicies can be added by adding a dictionary key similar to the 'main' networkPolicy. # @default -- See below networkpolicies: - main: - # -- Enables or disables the networkPolicy item. Defaults to true - enabled: false + {} + # main: + # # -- Enables or disables the networkPolicy item. Defaults to true + # enabled: false - # -- Configure which controller this networkPolicy should target - controller: main + # # -- Configure which controller this networkPolicy should target + # controller: main - # -- Define a custom podSelector for the networkPolicy. This takes precedence over targeting a controller. - # podSelector: {} + # # -- Define a custom podSelector for the networkPolicy. This takes precedence over targeting a controller. + # # podSelector: {} - # -- The policyTypes for this networkPolicy - policyTypes: - - Ingress - - Egress + # # -- The policyTypes for this networkPolicy + # policyTypes: + # - Ingress + # - Egress - # -- The rulesets for this networkPolicy - # [[ref]](https://kubernetes.io/docs/concepts/services-networking/network-policies/#networkpolicy-resource) - rules: - # -- The ingress rules for this networkPolicy. Allows all ingress traffic by default. - ingress: - - {} - # -- The egress rules for this networkPolicy. Allows all egress traffic by default. - egress: - - {} + # # -- The rulesets for this networkPolicy + # # [[ref]](https://kubernetes.io/docs/concepts/services-networking/network-policies/#networkpolicy-resource) + # rules: + # # -- The ingress rules for this networkPolicy. Allows all ingress traffic by default. + # ingress: + # - {} + # # -- The egress rules for this networkPolicy. Allows all egress traffic by default. + # egress: + # - {}