Skip to content

document missing secret name keys#64135

Closed
rjgoyln wants to merge 2 commits intoapache:mainfrom
rjgoyln:Include_key_names
Closed

document missing secret name keys#64135
rjgoyln wants to merge 2 commits intoapache:mainfrom
rjgoyln:Include_key_names

Conversation

@rjgoyln
Copy link
Copy Markdown
Contributor

@rjgoyln rjgoyln commented Mar 24, 2026

Summary

This PR adds missing documentation for several secret name parameters in values.yaml. These parameters were previously undocumented or lacked specific details regarding their required internal Kubernetes Secret keys and fallback behaviors.

Was generative AI tooling used to co-author this PR?
  • Yes (please specify the tool below)

  • Read the Pull Request Guidelines for more information. Note: commit author/co-author name and email in commits become permanently public when merged.
  • For fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
  • When adding dependency, check compliance with the ASF 3rd Party License Policy.
  • For significant user-facing changes create newsfragment: {pr_number}.significant.rst, in airflow-core/newsfragments. You can add this file in a follow-up commit after the PR is created so you know the PR number.

@boring-cyborg boring-cyborg bot added the area:helm-chart Airflow Helm Chart label Mar 24, 2026
@rjgoyln rjgoyln marked this pull request as ready for review March 24, 2026 04:17
@potiuk potiuk added the ready for maintainer review Set after triaging when all criteria pass. label Mar 24, 2026
Comment on lines 500 to +502
data:
# If secret names are provided, use those secrets
# These secrets must be created manually, eg:
#
# kind: Secret
# apiVersion: v1
# metadata:
# name: custom-airflow-metadata-secret
# type: Opaque
# data:
# connection: base64_encoded_connection_string

# Must contain a 'connection' key (e.g., postgresql://user:pass@host:5432/db).
# Optional: 'kedaConnection'. Note: URL-encode special characters in passwords.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure if and why your description is now better than the example before. The example before which you now are removing had an example. Yes it was not mentioning that the connection key is needed.

I'd favor keeping the example and marking the note that key(s) are needed.

# Must contain a 'connection' key. If not provided, it falls back to 'metadataSecretName'.
resultBackendSecretName: ~

# Must contain a 'connection' key (e.g., redis://:pass@host:6379/0).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

...and also I'd not repeat it here but propose to add this to the note that the key is relevant for all options below.

@jscheffl
Copy link
Copy Markdown
Contributor

PR #64136 was merged which is redundant to this one.

@jscheffl jscheffl closed this Mar 28, 2026
@rjgoyln rjgoyln deleted the Include_key_names branch March 29, 2026 00:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:helm-chart Airflow Helm Chart ready for maintainer review Set after triaging when all criteria pass.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Include key names for various secretName options in the documentation

4 participants