airflow-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF subversion and git services (JIRA)" <>
Subject [jira] [Commented] (AIRFLOW-2710) Configuration documentation is misleading to the uninitiated
Date Sun, 08 Jul 2018 18:53:00 GMT


ASF subversion and git services commented on AIRFLOW-2710:

Commit 6b7645261b5df69b01936838f38f7f701a667518 in incubator-airflow's branch refs/heads/master
from [~mthorley]
[;h=6b76452 ]

[AIRFLOW-2710] Clarify fernet key value in documentation

Closes #3574 from padwasabimasala/AIRFLOW-2710

> Configuration documentation is misleading to the uninitiated
> ------------------------------------------------------------
>                 Key: AIRFLOW-2710
>                 URL:
>             Project: Apache Airflow
>          Issue Type: Bug
>          Components: Documentation
>            Reporter: Matthew Thorley
>            Priority: Major
> The documentation on this page on the configuration page [] is
slightly misleading 
> It reads
> 2. Generate fernet_key, using this code snippet below. fernet_key must be a base64-encoded
32-byte key.
> from cryptography.fernet import Fernet fernet_key= Fernet.generate_key() print(fernet_key)
# your fernet_key, keep it in secured place!
>  3. Replace {{airflow.cfg}} fernet_key value with the one from step 2.
> The value returned in step one is something like  _b'K_8Yv52REP1qsa7OPupKYJe_CzngMI_KqwfM-2qAyVs='_
> which lead me to believe the config was suppose to be
> fernet_key = b'K_8Yv52REP1qsa7OPupKYJe_CzngMI_KqwfM-2qAyVs='
> When in fact it should be 
> fernet_key = K_8Yv52REP1qsa7OPupKYJe_CzngMI_KqwfM-2qAyVs=
> I assumed the config parse needed to know it was a byte string and would handle the value
correctly. After wasting 30mins I was able to figure out the solution, and probably could
have arrived at it sooner had I been more familiar with python.
> But I recommend changing the docs as below to avoid confusion for other new users.
>  _from cryptography.fernet import Fernet fernet_key= Fernet.generate_key() print(fernet_key.decode()) #
your fernet_key, keep it in secured place!_
> I'll submit a pr for this shortly.

This message was sent by Atlassian JIRA

View raw message