Skip to content

Update logging & doc for LocalFilesystem Secrets Backend #12597

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
kaxil merged 2 commits into from
Nov 25, 2020
Merged

Update logging & doc for LocalFilesystem Secrets Backend #12597

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
f22e98b
Update logging & doc for LocalFilesystem Secrets Backend
XD-DENG Nov 24, 2020
a45582c
Fixup. For static check
XD-DENG Nov 24, 2020
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
10 changes: 6 additions & 4 deletions airflow/secrets/local_filesystem.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,9 @@ def _parse_secret_file(file_path: str) -> Dict[str, Any]:
ext = file_path.rsplit(".", 2)[-1].lower()

if ext not in FILE_PARSERS:
raise AirflowException("Unsupported file format. The file must have the extension .env or .json")
raise AirflowException(
"Unsupported file format. The file must have the extension .env or .json or .yaml"
)

secrets, parse_errors = FILE_PARSERS[ext](file_path)

Expand Down Expand Up @@ -223,7 +225,7 @@ def load_variables(file_path: str) -> Dict[str, str]:
"""
Load variables from a text file.

Both ``JSON`` and ``.env`` files are supported.
``JSON``, `YAML` and ``.env`` files are supported.

:param file_path: The location of the file that will be processed.
:type file_path: str
Expand Down Expand Up @@ -254,7 +256,7 @@ def load_connections_dict(file_path: str) -> Dict[str, Any]:
"""
Load connection from text file.

Both ``JSON`` and ``.env`` files are supported.
``JSON``, `YAML` and ``.env`` files are supported.

:return: A dictionary where the key contains a connection ID and the value contains a list of connections.
:rtype: Dict[str, airflow.models.connection.Connection]
Expand Down Expand Up @@ -283,7 +285,7 @@ class LocalFilesystemBackend(BaseSecretsBackend, LoggingMixin):
"""
Retrieves Connection objects and Variables from local files

Both ``JSON`` and ``.env`` files are supported.
``JSON``, `YAML` and ``.env`` files are supported.

:param variables_file_path: File location with variables data.
:type variables_file_path: str
Expand Down
2 changes: 1 addition & 1 deletion docs/security/secrets/secrets-backend/local-filesystem-secrets-backend.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ The keys ``extra`` and ``extra_dejson`` are mutually exclusive.

The JSON file must contain an object where the key contains the connection ID and the value contains
the definition of one connection. The connection can be defined as a URI (string) or JSON object.
For a guide about defining a connection as a URI, see:: :ref:`generating_connection_uri`.
For a guide about defining a connection as a URI, see :ref:`generating_connection_uri`.
For a description of the connection object parameters see :class:`~airflow.models.connection.Connection`.
The following is a sample JSON file.

Expand Down