From 9dddf83b8877f290171fe8ccb756e48f3a90a0a9 Mon Sep 17 00:00:00 2001 From: Aaryan Mahajan Date: Wed, 29 Jul 2026 02:33:01 +0530 Subject: [PATCH] [chart/v1-2x-test] Document how to rotate the Fernet key with the Helm chart (#70242) * Document how to rotate the Fernet key with the Helm chart The Helm chart docs explained how to point at a custom Fernet key Secret but never how to safely rotate one. The chart also generates the Fernet key Secret via a pre-install hook, which means it cannot be updated through helm upgrade, so a self-managed Secret plus the standard prepend/rotate/trim procedure is required. Document that gap so operators aren't left guessing or reverse-engineering the chart templates. closes: #18509 * Address review feedback on Fernet key rotation docs Reviewers pointed out three gaps: the plaintext-key warning didn't explicitly say not to commit values.yaml to version control, the kubectl-created Secret example didn't mention that it needs to be managed as infrastructure so it survives a cluster migration or redeploy, and the rotation steps described updating the Secret's value without ever showing the command to do it. Rename the newsfragment to the PR number (70242) instead of the issue number (18509) per towncrier convention. * Address review feedback on Fernet key rotation docs Tighten the wording per reviewer suggestions and drop the newsfragment, since a docs-only addition does not need one. (cherry picked from commit 88f95c706eb4851f3fb5107d0b883c7a87e86b67) Co-authored-by: Aaryan Mahajan --- chart/docs/production-guide.rst | 71 +++++++++++++++++++++++++++++++++ 1 file changed, 71 insertions(+) diff --git a/chart/docs/production-guide.rst b/chart/docs/production-guide.rst index 8c03421aae575..402088692ebbc 100644 --- a/chart/docs/production-guide.rst +++ b/chart/docs/production-guide.rst @@ -265,6 +265,77 @@ generated using the secret key has a short expiry time though. Make sure that ti that you run Airflow components on is synchronized (for example using ntpd). You might get "forbidden" errors when the logs are accessed otherwise. +Fernet Key +---------- + +Airflow uses a Fernet key to encrypt sensitive data, such as connection passwords, stored in the metadata database. +See :doc:`Fernet ` for background on how this works. If you do not provide a +key, the chart generates one and stores it in the ``-fernet-key`` Kubernetes Secret the first time you +run ``helm install``. + +.. warning:: + + The chart only creates that Secret on ``helm install`` -- it is not re-created or otherwise updated by + ``helm upgrade``. This applies both to the auto-generated key and to a key you pass through ``fernetKey`` in the values file. To rotate the Fernet key, you need to manage the Secret yourself, as described below. + +To provide your own key, either set ``fernetKey`` in the values file: + +.. code-block:: yaml + :caption: values.yaml + + fernetKey: + +.. warning:: + + Due to security concerns, it is advised to use a Kubernetes Secret instead of setting the Fernet key directly in + the values file. Never commit a ``values.yaml`` containing a plaintext Fernet key to version control. + +or create your own Kubernetes Secret containing a ``fernet-key`` key with a base64-encoded value, and point the chart at it with ``fernetKeySecretName``: + +.. code-block:: bash + + kubectl create secret generic my-fernet-key --from-literal="fernet-key=" + +.. code-block:: yaml + :caption: values.yaml + + fernetKeySecretName: my-fernet-key + +.. note:: + + ``kubectl create secret`` only creates an object in the cluster -- it is not tracked anywhere else. Manage this + Secret through your Infrastructure-as-a-Code process (for example, a GitOps repository, a Sealed Secret, or + an External Secrets Operator resource) so it is not lost on a cluster migration or a full redeploy. + +Rotating the Fernet key +^^^^^^^^^^^^^^^^^^^^^^^^ + +Once connections, variables and triggers have been encrypted with a Fernet key, changing the key outright makes the +existing encrypted values unreadable. To rotate the key without losing access to them, follow the same procedure as +:doc:`Rotating encryption keys `, applied to the Kubernetes Secret that backs +``AIRFLOW__CORE__FERNET_KEY``: + +#. Make sure you are using a self-managed Secret through ``fernetKeySecretName`` +#. Update the ``fernet-key`` value in that Secret to a comma-separated list ``new_fernet_key,old_fernet_key``, using + the same ``kubectl create secret`` command as above with ``--dry-run=client -o yaml`` piped into ``kubectl apply`` + so it updates the existing Secret in place instead of failing because it already exists: + + .. code-block:: bash + + kubectl create secret generic my-fernet-key \ + --from-literal="fernet-key=new_fernet_key,old_fernet_key" \ + --dry-run=client -o yaml | kubectl apply -f - + + Then restart the Airflow components (for example with ``kubectl rollout restart``) so they pick up the new value +#. Run ``airflow rotate-fernet-key``, in one of the Airflow components pods, to re-encrypt existing connections, variables and triggers with the new key. +#. Update the Secret, so it only contains ``new_fernet_key``, and restart the components once more: + + .. code-block:: bash + + kubectl create secret generic my-fernet-key \ + --from-literal="fernet-key=new_fernet_key" \ + --dry-run=client -o yaml | kubectl apply -f - + JWT Secret ----------