Skip to content

Chart: be consisent with denoting templated params #46481

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
potiuk merged 2 commits into from
Feb 6, 2025
Merged

Chart: be consisent with denoting templated params #46481

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a25edf5
Chart: be consisent with denoting templated params
jedcunningham Feb 5, 2025
f2bd60e
Merge branch 'main' into chart_consistent_templating_description
jedcunningham Feb 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions chart/values.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -657,7 +657,7 @@
}
},
"airflowLocalSettings": {
"description": "`airflow_local_settings` file as a string (can be templated).",
"description": "`airflow_local_settings` file as a string (templated).",
"type": [
"string",
"null"
Expand Down Expand Up @@ -1102,7 +1102,7 @@
}
},
"extraEnv": {
"description": "Extra env 'items' that will be added to the definition of Airflow containers; a string is expected (can be templated).",
"description": "Extra env 'items' that will be added to the definition of Airflow containers; a string is expected (templated).",
"type": [
"null",
"string"
Expand All @@ -1114,7 +1114,7 @@
]
},
"extraEnvFrom": {
"description": "Extra envFrom 'items' that will be added to the definition of Airflow containers; a string is expected (can be templated).",
"description": "Extra envFrom 'items' that will be added to the definition of Airflow containers; a string is expected (templated).",
"type": [
"null",
"string"
Expand Down Expand Up @@ -1168,7 +1168,7 @@
"x-docsSection": "Kubernetes",
"default": {},
"additionalProperties": {
"description": "Name of the secret (can be templated).",
"description": "Name of the secret (templated).",
"type": "object",
"minProperties": 1,
"additionalProperties": false,
Expand Down Expand Up @@ -1199,11 +1199,11 @@
"default": true
},
"data": {
"description": "Content **as string** for the 'data' item of the secret (can be templated)",
"description": "Content **as string** for the 'data' item of the secret (templated)",
"type": "string"
},
"stringData": {
"description": "Content **as string** for the 'stringData' item of the secret (can be templated)",
"description": "Content **as string** for the 'stringData' item of the secret (templated)",
"type": "string"
}
}
Expand All @@ -1223,7 +1223,7 @@
"x-docsSection": "Kubernetes",
"default": {},
"additionalProperties": {
"description": "Name of the configMap (can be templated).",
"description": "Name of the configMap (templated).",
"type": "object",
"minProperties": 1,
"additionalProperties": false,
Expand All @@ -1250,7 +1250,7 @@
"default": true
},
"data": {
"description": "Content **as string** for the 'data' item of the configmap (can be templated)",
"description": "Content **as string** for the 'data' item of the configmap (templated)",
"type": "string"
}
}
Expand Down Expand Up @@ -1790,7 +1790,7 @@
"default": "100Gi"
},
"storageClassName": {
"description": "If using a custom StorageClass, pass name ref to all StatefulSets here (can be templated).",
"description": "If using a custom StorageClass, pass name ref to all StatefulSets here (templated).",
"type": [
"string",
"null"
Expand Down Expand Up @@ -3161,7 +3161,7 @@
"description": "PersistentVolumeClaim retention policy to be used in the lifecycle of a StatefulSet"
},
"storageClassName": {
"description": "If using a custom StorageClass, pass name ref to all StatefulSets here (can be templated).",
"description": "If using a custom StorageClass, pass name ref to all StatefulSets here (templated).",
"type": [
"string",
"null"
Expand Down Expand Up @@ -5884,7 +5884,7 @@
}
},
"webserverConfig": {
"description": "This string (can be templated) will be mounted into the Airflow webserver as a custom `webserver_config.py`. You can bake a `webserver_config.py` in to your image instead or specify a configmap containing the webserver_config.py.",
"description": "This string (templated) will be mounted into the Airflow webserver as a custom `webserver_config.py`. You can bake a `webserver_config.py` in to your image instead or specify a configmap containing the webserver_config.py.",
"type": [
"string",
"null"
Expand Down Expand Up @@ -7736,7 +7736,7 @@
"default": "1Gi"
},
"storageClassName": {
"description": "If using a custom StorageClass, pass name ref to all StatefulSets here (can be templated).",
"description": "If using a custom StorageClass, pass name ref to all StatefulSets here (templated).",
"type": [
"string",
"null"
Expand Down Expand Up @@ -8668,7 +8668,7 @@
"default": "1Gi"
},
"storageClassName": {
"description": "If using a custom StorageClass, pass name here (can be templated).",
"description": "If using a custom StorageClass, pass name here (templated).",
"type": [
"string",
"null"
Expand Down Expand Up @@ -8922,7 +8922,7 @@
]
},
"envFrom": {
"description": "Extra envFrom 'items' that will be added to the definition of Airflow gitSync containers; a string or array are expected (can be templated).",
"description": "Extra envFrom 'items' that will be added to the definition of Airflow gitSync containers; a string or array are expected (templated).",
"type": [
"null",
"string"
Expand Down Expand Up @@ -8977,7 +8977,7 @@
"default": "100Gi"
},
"storageClassName": {
"description": "If using a custom StorageClass, pass name here (can be templated).",
"description": "If using a custom StorageClass, pass name here (templated).",
"type": [
"string",
"null"
Expand Down
24 changes: 12 additions & 12 deletions chart/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ ingress:

# The hostnames or hosts configuration for the web Ingress
hosts: []
# # The hostname for the web Ingress (can be templated)
# # The hostname for the web Ingress (templated)
# - name: ""
# # configs for web Ingress TLS
# tls:
Expand Down Expand Up @@ -204,7 +204,7 @@ ingress:

# The hostnames or hosts configuration for the flower Ingress
hosts: []
# # The hostname for the flower Ingress (can be templated)
# # The hostname for the flower Ingress (templated)
# - name: ""
# tls:
# # Enable TLS termination for the flower Ingress
Expand Down Expand Up @@ -241,7 +241,7 @@ ingress:

# The hostnames or hosts configuration for the statsd Ingress
hosts: []
# # The hostname for the statsd Ingress (can be templated)
# # The hostname for the statsd Ingress (templated)
# - name: ""
# tls:
# # Enable TLS termination for the statsd Ingress
Expand Down Expand Up @@ -271,7 +271,7 @@ ingress:

# The hostnames or hosts configuration for the pgbouncer Ingress
hosts: []
# # The hostname for the statsd Ingress (can be templated)
# # The hostname for the statsd Ingress (templated)
# - name: ""
# tls:
# # Enable TLS termination for the pgbouncer Ingress
Expand All @@ -295,7 +295,7 @@ airflowPodAnnotations: {}
# main Airflow configmap
airflowConfigAnnotations: {}

# `airflow_local_settings` file as a string (can be templated).
# `airflow_local_settings` file as a string (templated).
airflowLocalSettings: |-
{{- if semverCompare ">=2.2.0" .Values.airflowVersion }}
{{- if not (or .Values.webserverSecretKey .Values.webserverSecretKeySecretName) }}
Expand Down Expand Up @@ -386,9 +386,9 @@ priorityClasses: []
# Extra secrets that will be managed by the chart
# (You can use them with extraEnv or extraEnvFrom or some of the extraVolumes values).
# The format for secret data is "key/value" where
# * key (can be templated) is the name of the secret that will be created
# * key (templated) is the name of the secret that will be created
# * value: an object with the standard 'data' or 'stringData' key (or both).
# The value associated with those keys must be a string (can be templated)
# The value associated with those keys must be a string (templated)
extraSecrets: {}
# eg:
# extraSecrets:
Expand All @@ -413,9 +413,9 @@ extraSecrets: {}
# Extra ConfigMaps that will be managed by the chart
# (You can use them with extraEnv or extraEnvFrom or some of the extraVolumes values).
# The format for configmap data is "key/value" where
# * key (can be templated) is the name of the configmap that will be created
# * key (templated) is the name of the configmap that will be created
# * value: an object with the standard 'data' key.
# The value associated with this keys must be a string (can be templated)
# The value associated with this keys must be a string (templated)
extraConfigMaps: {}
# eg:
# extraConfigMaps:
Expand All @@ -427,7 +427,7 @@ extraConfigMaps: {}
# AIRFLOW_VAR_KUBERNETES_NAMESPACE: "{{ .Release.Namespace }}"

# Extra env 'items' that will be added to the definition of airflow containers
# a string is expected (can be templated).
# a string is expected (templated).
# TODO: difference from `env`? This is a templated string. Probably should template `env` and remove this.
extraEnv: ~
# eg:
Expand All @@ -436,7 +436,7 @@ extraEnv: ~
# value: 'True'

# Extra envFrom 'items' that will be added to the definition of airflow containers
# A string is expected (can be templated).
# A string is expected (templated).
extraEnvFrom: ~
# eg:
# extraEnvFrom: |
Expand Down Expand Up @@ -1505,7 +1505,7 @@ webserver:
extraVolumes: []
extraVolumeMounts: []

# This string (can be templated) will be mounted into the Airflow Webserver
# This string (templated) will be mounted into the Airflow Webserver
# as a custom webserver_config.py. You can bake a webserver_config.py in to
# your image instead or specify a configmap containing the
# webserver_config.py.
Expand Down