Skip to content

document missing secret name keys#64135

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

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

Conversation

@rjgoyln
Copy link
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
# Add custom annotations to the api secret
apiSecretAnnotations: {}
# Must contain an 'api-secret-key' key (suggested: random 32-char string).
# Note: Values in K8s Secrets must be Base64 encoded.
Copy link

@plaes plaes Mar 24, 2026

Choose a reason for hiding this comment

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

This is somewhat confusing. It kinda tells me that I should base64 the value before adding it to secret...

kubectl create --dry-run=client secret generic \
  admin --from-literal=api-secret-key=$(echo -n really-secret | base64) -oyaml

And k8s re-encodes it in base64:

data:
  api-secret-key: Y21WaGJHeDVMWE5sWTNKbGRBPT0=

It probably should mention to create a "generic" secret within data field, instead of stringData.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

OK, got it. Thank you so much🙏🙏.
I’ve removed the comments that might cause confusion. Please let me know if there’s anything else I should change.

Copy link

Choose a reason for hiding this comment

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

This is excellent! 👍

@potiuk potiuk added the ready for maintainer review Set after triaging when all criteria pass. label Mar 24, 2026
@rjgoyln rjgoyln force-pushed the Include_key_names branch from 888870e to 04c954a Compare March 24, 2026 13:46
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

3 participants