id stringlengths 15 25 | source stringclasses 1
value | chunk_index int64 0 393k | token_count int32 449 512 | content stringlengths 203 7.95k |
|---|---|---|---|---|
combine_chunk_100 | combine.txt | 100 | 512 | Identity, environment variables, authentication through Azure CLI...
Default Connection IDs
----------------------
All hooks and operators related to Microsoft Azure Data Factory use ``azure_data_factory_default`` by default.
Configuring the Connection
--------------------------
Client ID
Specify the ``client_... |
combine_chunk_101 | combine.txt | 101 | 512 | name'
.. code-block:: bash
export AIRFLOW_CONN_AZURE_DATA_FACTORY_DEFAULT='azure-data-factory://applicationid:serviceprincipalpassword@?tenantId=tenant+id&subscriptionId=subscription+id'
.. _DefaultAzureCredential: https://docs.microsoft.com/en-us/python/api/overview/azure/identity-readme?view=azure-python#defau... |
combine_chunk_102 | combine.txt | 102 | 512 | on how to generate connection string in azure service bus
`Get connection string`_
Use the key ``connection_string`` to pass in the Connection ID .
It can be left out to fall back on DefaultAzureCredential_.
Fully Qualified Namespace (optional)
Specify the fully qualified Service Bus namespace that the... |
combine_chunk_103 | combine.txt | 103 | 512 | _explorer:
Microsoft Azure Data Explorer
=============================
The ``Azure Data Explorer`` connection type enables Azure Data Explorer (ADX) integrations in Airflow.
Authenticating to Azure Data Explorer
---------------------------------------
There are five ways to connect to Azure Data Explorer using Airf... |
combine_chunk_104 | combine.txt | 104 | 512 | this option, you'll need to authenticate for every new instance that is initialized. It is highly recommended to create one instance and use it for all queries.
* AZURE_TOKEN_CRED: Authentication with DefaultAzureCredential_. This includes a mechanism to try different options to authenticate: Managed System Ident... |
combine_chunk_105 | combine.txt | 105 | 512 | "License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
.. http://www.apache.org/licenses/LICENSE-2.0
.. Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, ... |
combine_chunk_106 | combine.txt | 106 | 512 | Extra (optional)
Specify the extra parameters (as json dictionary) that can be used in Azure connection.
The following parameters are all optional:
* ``tenant_id``: Specify the tenant to use. Needed for Active Directory (token) authentication. It can be left out to fall back on DefaultAzureCredential_.
... |
combine_chunk_107 | combine.txt | 107 | 512 | Sensor`
use this connection.
Default Connection ID
---------------------
The default connection ID is ``azure_analysis_services_default``.
Configuring the Connection
--------------------------
Region Endpoint
Specify the rollout endpoint in ``host``, for example ``westus.asazure.windows.net``. Do not include
... |
combine_chunk_108 | combine.txt | 108 | 512 | ag-bundles`.
WasbDagBundle
=============
Use the :class:`~airflow.providers.microsoft.azure.bundles.wasb.WasbDagBundle` to configure an Azure Blob
Storage bundle in your Airflow's ``[dag_processor] dag_bundle_config_list``. The bundle does not support
versioning; tasks always use the latest blobs synced to the local ... |
combine_chunk_109 | combine.txt | 109 | 512 | regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
.. http://www.apache.org/licenses/LICENSE-2.0
.. Unless required by app... |
combine_chunk_110 | combine.txt | 110 | 512 | type ``Microsoft Graph API``. See
:ref:`Microsoft Graph API Connection <howto/connection:msgraph>` for how to configure it.
The app registration behind the connection needs the ``Mail.Send`` permission. When application
permissions are used, an administrator has to grant the application access to the sending mailb... |
combine_chunk_111 | combine.txt | 111 | 512 |
remote_base_log_folder = wasb://path/to/logs
[azure_remote_logging]
remote_wasb_log_container = my-container
.. note::
If you are using environment variables, the equivalent configuration is:
.. code-block:: bash
export AIRFLOW__LOGGING__REMOTE_LOGGING=True
export AIRFLOW__LOGGI... |
combine_chunk_112 | combine.txt | 112 | 512 |
.. Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); ... |
combine_chunk_113 | combine.txt | 113 | 512 | further information, look at:
* `Using the Power BI REST APIs <https://learn.microsoft.com/en-us/rest/api/power-bi/>`__
<|file|>airflow/providers/microsoft/azure/docs/sensors/wasb_sensors.rst
.. Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE fi... |
combine_chunk_114 | combine.txt | 114 | 512 | -after: [START wasb_prefix_sensor]
:end-before: [END wasb_prefix_sensor]
<|file|>airflow/providers/microsoft/azure/docs/sensors/cosmos_document_sensor.rst
.. Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work f... |
combine_chunk_115 | combine.txt | 115 | 512 | of the License at
.. http://www.apache.org/licenses/LICENSE-2.0
.. Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
... |
combine_chunk_116 | combine.txt | 116 | 512 | lookup
"""""""""""""""
Optionally connections, variables, or config may be looked up exclusive of each other or in any combination.
This will prevent requests being sent to Azure Key Vault for the excluded type.
If you want to look up some and not others in Azure Key Vault you may do so by setting the relevant ``*_p... |
combine_chunk_117 | combine.txt | 117 | 512 | before falling back to ``airflow-connections-my-db``.
Authentication
""""""""""""""
There are 3 ways to authenticate Azure Key Vault backend.
1. Set ``tenant_id``, ``client_id``, ``client_secret`` (using `ClientSecretCredential <https://learn.microsoft.com/en-us/python/api/azure-identity/azure.identity.clientsecre... |
combine_chunk_118 | combine.txt | 118 | 512 | capabilities via the
`PowerShell Remoting Protocol (PSRP)
<https://docs.microsoft.com/openspecs/windows_protocols/ms-psrp/>`__.
Provider package
----------------
This is a provider package for ``microsoft.psrp`` provider. All classes for this provider package
are in ``airflow.providers.microsoft.psrp`` python packa... |
combine_chunk_119 | combine.txt | 119 | 512 |
.. toctree::
:hidden:
:maxdepth: 1
:caption: Basics
Home <self>
Changelog <changelog>
Security <security>
.. toctree::
:hidden:
:maxdepth: 1
:caption: Guides
Operators <operators/index>
.. toctree::
:hidden:
:maxdepth: 1
:caption: References
Python API <_a... |
combine_chunk_120 | combine.txt | 120 | 512 | -providers-microsoft-psrp 4.0.1 sdist package <https://downloads.apache.org/airflow/providers/apache_airflow_providers_microsoft_psrp-4.0.1.tar.gz>`_ (`asc <https://downloads.apache.org/airflow/providers/apache_airflow_providers_microsoft_psrp-4.0.1.tar.gz.asc>`__, `sha512 <https://downloads.apache.org/airflow/provider... |
combine_chunk_121 | combine.txt | 121 | 512 | srp.operators.psrp.PsrpOperator`
operator implements such client capabilities, enabling the
scheduling of Windows jobs from Airflow. Internally, it makes use of
the `pypsrp <https://pypi.org/project/pypsrp/>`__ client library.
Compared to
:class:`~airflow.providers.microsoft.winrm.operators.winrm.WinRMOperator`,
using... |
combine_chunk_122 | combine.txt | 122 | 512 | output is converted to JSON using the ``ConvertTo-Json`` cmdlet
and then decoded on the client-side by the operator such that the
operator's return value is compatible with the serialization required
by XComs.
When XComs are not enabled (that is, ``do_xcom_push`` is set to
false), the shell output is instead logged l... |
combine_chunk_123 | combine.txt | 123 | 512 | WRITTEN!
Package apache-airflow-providers-microsoft-psrp
------------------------------------------------------
This package provides remote execution capabilities via the
`PowerShell Remoting Protocol (PSRP)
<https://docs.microsoft.com/openspecs/windows_protocols/ms-psrp/>`__.
This is detailed commit list of chang... |
combine_chunk_124 | combine.txt | 124 | 512 | .. include:: /../../../../devel-common/src/sphinx_exts/includes/security.rst
<|file|>airflow/providers/cncf/kubernetes/README.rst
.. Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
re... |
combine_chunk_125 | combine.txt | 125 | 512 | .11.0``
``apache-airflow-providers-common-compat`` ``>=1.15.0``
``asgiref`` ``>=3.5.2; python_version < "3.14"``
``asgiref`` ``>=3.11.1; python_version >= "3.14"``
``cryptography`` ``>=44.0.3``
``kubernetes`` ... |
combine_chunk_126 | combine.txt | 126 | 512 | the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
.. http://www.apache.org/licenses/LICENSE-2.0
.. Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" ... |
combine_chunk_127 | combine.txt | 127 | 512 | 1
:caption: Basics
Home <self>
Changelog <changelog>
Security <security>
.. toctree::
:hidden:
:maxdepth: 1
:caption: Executors
KubernetesExecutor details <kubernetes_executor>
LocalKubernetesExecutor details <local_kubernetes_executor>
.. toctree::
:hidden:
:maxdepth: 1... |
combine_chunk_128 | combine.txt | 128 | 512 | distribution is ``2.11.0``.
========================================== ======================================
PIP package Version required
========================================== ======================================
``aiofiles`` ``>=23.2.0``
``apac... |
combine_chunk_129 | combine.txt | 129 | 512 |
.. Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); ... |
combine_chunk_130 | combine.txt | 130 | 512 | "Succeeded" from k8s watcher thread
.. @enduml
.. image:: img/k8s-happy-path.png
Configuration
-------------
.. _concepts:pod_template_file:
pod_template_file
~~~~~~~~~~~~~~~~~
To customize the pod used for k8s executor worker processes, you may create a pod template file. You must provide
the path to the template... |
combine_chunk_131 | combine.txt | 131 | 512 | f/kubernetes/pod_template_file_examples/dags_in_volume_template.yaml
:language: yaml
:start-after: [START template_with_dags_in_volume]
:end-before: [END template_with_dags_in_volume]
Pulling Dags from ``git``:
.. literalinclude:: /../src/airflow/providers/cncf/kubernetes/pod_template_file_examples/git_sy... |
combine_chunk_132 | combine.txt | 132 | 512 | import AIRFLOW_HOME
from kubernetes.client import models as k8s
with DAG(
dag_id="example_pod_template_file",
schedule=None,
start_date=pendulum.datetime(2021, 1, 1, tz="UTC"),
catchup=False,
tags=["example3"],
) as dag:
executor_config_template = {
... |
combine_chunk_133 | combine.txt | 133 | 512 | _team = True
executor = LocalExecutor;team_a=KubernetesExecutor;team_b=KubernetesExecutor
[team_a=kubernetes_executor]
in_cluster = False
config_file = /opt/airflow/kube/clusters.yaml
cluster_context = cluster-a
namespace = team-a
[team_b=kubernetes_executor]
in_cluster = False
con... |
combine_chunk_134 | combine.txt | 134 | 512 | have less task latency because the worker pod is already up and running when the task is queued. On the
other hand, because multiple tasks are running in the same pod, with Celery you may have to be more mindful about resource utilization
in your task design, particularly memory consumption.
One scenario where Kubern... |
combine_chunk_135 | combine.txt | 135 | 512 | od.png
A Kubernetes watcher is a thread that can subscribe to every change that occurs in Kubernetes' database. It is alerted when pods start, run, end, and fail.
By monitoring this stream, the KubernetesExecutor can discover that the worker crashed and correctly report the task as failed.
But What About Cases Wher... |
combine_chunk_136 | combine.txt | 136 | 512 | VIDER_COMMITS_TEMPLATE.rst.jinja2` IN the `dev/breeze/src/airflow_breeze/templates` DIRECTORY
.. THE REMAINDER OF THE FILE IS AUTOMATICALLY GENERATED. IT WILL BE OVERWRITTEN!
Package apache-airflow-providers-cncf-kubernetes
------------------------------------------------------
`Kubernetes <https://kubernetes.io/>`... |
combine_chunk_137 | combine.txt | 137 | 512 | See the License for the
specific language governing permissions and limitations
under the License.
.. _howto/connection:kubernetes:
Kubernetes cluster Connection
=============================
The Kubernetes cluster Connection type enables connection to a Kubernetes cluster by :class:`~airflow.providers.cnc... |
combine_chunk_138 | combine.txt | 138 | 512 | container as a JSON object, e.g.
``{"allowPrivilegeEscalation": false, "readOnlyRootFilesystem": true, "seccompProfile": {"type": "RuntimeDefault"}}``.
Useful when clusters enforce Pod Security Standards or admission policies (e.g. OPA/Gatekeeper) on the
injected sidecar. ``KubernetesPodOperator`` Dag authors ca... |
combine_chunk_139 | combine.txt | 139 | 512 | <howto/operator:GKEStartPodOperator>` operator for `Google Kubernetes Engine <https://cloud.google.com/kubernetes-engine/>`__,
- :ref:`EksPodOperator <howto/operator:EksPodOperator>` operator for `AWS Elastic Kubernetes Engine <https://aws.amazon.com/eks/>`__.
.. note::
The :doc:`Kubernetes executor <kubernetes_... |
combine_chunk_140 | combine.txt | 140 | 512 | warnings such as ``FailedScheduling``). This logging is
best-effort: if the events API fails, the operator logs one warning, stops reading events, and the task
continues.
In synchronous mode each poll is a ``list`` of ``Event`` objects with a field selector. Deferrable
mode keeps a watch open instead, which costs les... |
combine_chunk_141 | combine.txt | 141 | 512 | methods, then we'll first try to
get the current namespace (if the task is already running in kubernetes) and failing that we'll use
the ``default`` namespace.
For pod name, if not provided explicitly, we'll use the task_id. A random suffix is added by default so the pod
name is not generally of great consequence.
H... |
combine_chunk_142 | combine.txt | 142 | 512 | a
Kubernetes Secret that represents the credentials for accessing images from the private registry that is ultimately
specified in the ``image_pull_secrets`` parameter.
Create the Secret using ``kubectl``:
.. code-block:: none
kubectl create secret docker-registry testquay \
--docker-server=quay.io \
... |
combine_chunk_143 | combine.txt | 143 | 512 |
k = KubernetesPodOperator(
task_id="long_running_task",
image="my-image:latest",
on_finish_action="delete_pod",
on_kill_action="keep_pod", # pod will NOT be deleted when the task is killed
)
The ``termination_grace_period`` parameter is also respected during cleanup, giving t... |
combine_chunk_144 | combine.txt | 144 | 512 | The persisted pod identity is only removed by ``airflow state-store clean`` (retention-based) or,
when ``[state_store] clear_on_success`` is enabled (``False`` by default), automatically as soon as
the task instance succeeds -- see the :doc:`task state store <apache-airflow:core-concepts/task-state-store>`
docs. If a t... |
combine_chunk_145 | combine.txt | 145 | 512 | rejected unless it declares a security context. Set a cluster-wide default via
the ``xcom_sidecar_container_security_context`` field on the Kubernetes connection, or override it per task
with the ``xcom_sidecar_container_security_context`` argument of ``KubernetesPodOperator``.
See the following example on how t... |
combine_chunk_146 | combine.txt | 146 | 512 | in containers without the need to leave
a TaskFlow context.
How does this decorator work?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
See the following examples on how the decorator works:
.. exampleinclude:: /../tests/system/cncf/kubernetes/example_kubernetes_cmd_decorator.py
:language: python
:start-after: [START howto_... |
combine_chunk_147 | combine.txt | 147 | 512 | _operator_resuming``, ``on_pod_completion``, ``on_pod_teardown`` and ``on_pod_cleanup``.
``on_pod_starting`` is not invoked, because the triggerer -- not the operator -- observes pod
startup. The ``mode`` argument is currently always ``sync``.
Example:
~~~~~~~~
.. code-block:: python
import kubernetes.client as k... |
combine_chunk_148 | combine.txt | 148 | 512 |
^^^^^^^^^
For further information, look at:
* `Kubernetes Documentation <https://kubernetes.io/docs/home/>`__
* `Pull an Image from a Private Registry <https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/>`__
.. _howto/operator:KubernetesPodExecOperator:
KubernetesPodExecOperator
==... |
combine_chunk_149 | combine.txt | 149 | 512 | github.com/GoogleCloudPlatform/spark-on-k8s-operator>`__ project.
This operator simplifies the interface and accepts different parameters to configure and run spark application on Kubernetes.
Similar to the KubernetesOperator, we have added the logic to wait for a job after submission,
manage error handling, retrieve ... |
combine_chunk_150 | combine.txt | 150 | 512 | null
memory:
request: null
limit: null
kubernetes:
# example:
# env_vars:
# - name: TEST_NAME
# value: TEST_VALUE
env_vars: []
# example:
# env_from:
# - name: test
# valueFrom:
# secretKeyRef:
# ... |
combine_chunk_151 | combine.txt | 151 | 512 | _cluster: true
conn_id: kubernetes_default
kube_config_file: null
cluster_context: null
.. important::
* The template file consists of two primary categories: ``spark`` and ``kubernetes``.
* spark: This segment encompasses the task's Spark configuration, mirroring the structure of the Spark A... |
combine_chunk_152 | combine.txt | 152 | 512 | ": 0
},
"cpu": {
"request": null,
"limit": null
},
"memory": {
"request": null,
"limit": null
}
}
},
"executor": {
"instances": 1,
... |
combine_chunk_153 | combine.txt | 153 | 512 | If you use a managed Kubernetes consider using a specialize KJO operator as it simplifies the Kubernetes authorization process :
- ``GKEStartJobOperator`` operator for `Google Kubernetes Engine <https://cloud.google.com/kubernetes-engine/>`__.
.. note::
The :doc:`Kubernetes executor <kubernetes_executor>` is **n... |
combine_chunk_154 | combine.txt | 154 | 512 | .kubernetes.operators.pod.KubernetesPodOperator`.
It means that user can use all parameters from :class:`~airflow.providers.cncf.kubernetes.operators.pod.KubernetesPodOperator` in :class:`~airflow.providers.cncf.kubernetes.operators.job.KubernetesJobOperator`.
More information about the Jobs here: `Kubernetes Job Docu... |
combine_chunk_155 | combine.txt | 155 | 512 | START howto_operator_update_job]
:end-before: [END howto_operator_update_job]
.. _howto/operator:KubernetesInstallKueueOperator:
KubernetesInstallKueueOperator
==============================
The :class:`~airflow.providers.cncf.kubernetes.operators.kueue.KubernetesInstallKueueOperator` allows
you to install the ... |
combine_chunk_156 | combine.txt | 156 | 512 | agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
.. include:: /../../../../de... |
combine_chunk_157 | combine.txt | 157 | 512 | service account has permission to list secrets in the target namespace (by default, the namespace where Airflow runs).
Enabling the secret backend
"""""""""""""""""""""""""""
To enable the Kubernetes secrets backend, specify
:py:class:`~airflow.providers.cncf.kubernetes.secrets.kubernetes_secrets_backend.KubernetesS... |
combine_chunk_158 | combine.txt | 158 | 512 | [secrets]
backend = airflow.providers.cncf.kubernetes.secrets.kubernetes_secrets_backend.KubernetesSecretsBackend
backend_kwargs = {"connections_label": "my-org.io/connection", "variables_label": "my-org.io/variable"}
Authentication
""""""""""""""
The backend uses in-cluster Kubernetes authentication directl... |
combine_chunk_159 | combine.txt | 159 | 512 | >` of the connection object.
Example secret YAML for a connection named ``smtp_default``:
.. code-block:: yaml
apiVersion: v1
kind: Secret
metadata:
name: my-smtp-secret # name can be anything
labels:
airflow.apache.org/connection-id: smtp_default
data:
value: <base64-... |
combine_chunk_160 | combine.txt | 160 | 512 | identifier label matches the requested connection or variable and whose ``team_label`` matches the
current team. If no team-scoped secret is found, it falls back to a global secret with the same
identifier label and no team label.
To use this mode, keep the backend enabled as usual and make sure your Kubernetes secret... |
combine_chunk_161 | combine.txt | 161 | 512 | Secret Manager, Azure Key Vault, etc.)
into Kubernetes secrets. This backend works seamlessly with ESO -- simply configure ESO to add the
appropriate Airflow label to the generated Kubernetes secret, and Airflow will discover it
automatically. The secret name does not matter, only the label.
For example, an ESO ``Ext... |
combine_chunk_162 | combine.txt | 162 | 512 | flow 2.7.0+.
Previously they were part of the core Airflow, so if you are using Airflow below 2.7.0 look at
the core Airflow documentation for the list of CLI commands and parameters available.
.. argparse::
:module: airflow.providers.cncf.kubernetes.cli.definition
:func: get_parser
:prog: airflow
<|fi... |
combine_chunk_163 | combine.txt | 163 | 512 |
apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
metadata:
name: airflow-pod-launcher-binding
namespace: airflow
subjects:
- kind: ServiceAccount
name: airflow-worker
namespace: airflow
roleRef:
apiGroup: rbac.authorization.k8s.io
kind: Role
name: a... |
combine_chunk_164 | combine.txt | 164 | 512 | rbac.authorization.k8s.io/v1
kind: Role
metadata:
name: airflow-job-launcher
namespace: airflow
rules:
- apiGroups: ["batch"]
resources: ["jobs"]
verbs: ["create", "get", "list", "watch", "patch", "delete"]
- apiGroups: ["batch"]
resources: ["jobs/status"]
verbs... |
combine_chunk_165 | combine.txt | 165 | 512 | .k8s.io"]
resources: ["sparkapplications/status"]
verbs: ["get"]
* ``KubernetesCreateResourceOperator`` and ``KubernetesDeleteResourceOperator``
create or delete the resources from the YAML you provide. Grant permissions
for every Kubernetes resource kind in that YAML.
* ``KubernetesInstallKueueOpera... |
combine_chunk_166 | combine.txt | 166 | 512 |
------------
You can install this package on top of an existing Airflow installation (see ``Requirements`` below
for the minimum Airflow version supported) via
``pip install apache-airflow-providers-fab``
The package supports the following python versions: 3.11,3.12,3.13,3.14
Requirements
------------
============... |
combine_chunk_167 | combine.txt | 167 | 512 | _.
<|file|>airflow/providers/fab/docs/configurations-ref.rst
.. Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to yo... |
combine_chunk_168 | combine.txt | 168 | 512 | toctree::
:hidden:
:caption: Internal DB details
Database Migrations <migrations-ref>
Database ERD Schema <database-erd-ref>
.. toctree::
:hidden:
:caption: References
Fab auth manager API <api-ref/fab-api-ref>
.. toctree::
:hidden:
:maxdepth: 1
:caption: References
Con... |
combine_chunk_169 | combine.txt | 169 | 512 | >= "3.14"``
``flask-session`` ``>=0.8.0``
``msgpack`` ``>=1.0.0``
``flask-sqlalchemy`` ``>=3.0.5``
``flask-wtf`` ``>=1.1.0; python_version < "3.14"``
``flask-wtf`` ``>=1.2.2; pyt... |
combine_chunk_170 | combine.txt | 170 | 512 | _airflow_providers_fab-3.11.0-py3-none-any.whl.asc>`__, `sha512 <https://downloads.apache.org/airflow/providers/apache_airflow_providers_fab-3.11.0-py3-none-any.whl.sha512>`__)
<|file|>airflow/providers/fab/docs/commits.rst
.. Licensed to the Apache Software Foundation (ASF) under one
or more contributor license... |
combine_chunk_171 | combine.txt | 171 | 512 | the License at
.. http://www.apache.org/licenses/LICENSE-2.0
.. Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
s... |
combine_chunk_172 | combine.txt | 172 | 512 | at
.. http://www.apache.org/licenses/LICENSE-2.0
.. Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific lang... |
combine_chunk_173 | combine.txt | 173 | 512 | airflow fab-db downgrade -help``.
Resetting the FAB database
==========================
If you need to reset the FAB database, you can do this by running the reset command, example ``airflow fab-db reset``.
This command will drop all tables in the FAB database and recreate them. This command is only available if you a... |
combine_chunk_174 | combine.txt | 174 | 512 | ER diagram shows the snapshot of the database structure valid for version |version| and it
should be treated as an internal detail. It might be changed at any time and you should not directly
access the database to retrieve information from it or modify the data.
The main purpose of this diagram is to help wi... |
combine_chunk_175 | combine.txt | 175 | 512 | IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
.. include:: /../../../devel-common/src/sphinx_exts/includes/security.rst
<|file|>airflow/providers/fab/docs/cli-ref.rst
... |
combine_chunk_176 | combine.txt | 176 | 512 | : fab-auth-manager-api-ref
:page-title: FAB auth manager token API
:swagger-options: { "tryItOutEnabled": "false", "supportedSubmitMethods": [] }
<|file|>airflow/providers/fab/docs/auth-manager/index.rst
.. Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. ... |
combine_chunk_177 | combine.txt | 177 | 512 | depth: 1
:glob:
*
<|file|>airflow/providers/fab/docs/auth-manager/webserver-authentication.rst
.. Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright owner... |
combine_chunk_178 | combine.txt | 178 | 512 | otherwise Airflow might leak these
passwords on a config parser exception to a log.
Password
''''''''
One of the simplest mechanisms for authentication is requiring users to specify a password before logging in.
Please use command line interface ``airflow users create`` to create accounts, or do that in the UI.
... |
combine_chunk_179 | combine.txt | 179 | 512 | :
def __init__(self, wsgi_app: Callable) -> None:
self.wsgi_app = wsgi_app
def __call__(self, environ: dict, start_response: Callable) -> Any:
# Custom authenticating logic here
# ...
environ["REMOTE_USER"] = "username"
return self.wsgi_app(en... |
combine_chunk_180 | combine.txt | 180 | 512 | _manager.override import FabAirflowSecurityManagerOverride
from flask_appbuilder.security.manager import AUTH_OAUTH
import os
AUTH_TYPE = AUTH_OAUTH
AUTH_ROLES_SYNC_AT_LOGIN = True # Checks roles on every login
AUTH_USER_REGISTRATION = True # allow users who are not already in the FAB DB to regis... |
combine_chunk_181 | combine.txt | 181 | 512 | here.
return [team["id"] for team in team_payload]
def map_roles(team_list: list[int]) -> list[str]:
# Associate the team IDs with Roles here.
# The expected output is a list of roles that FAB will use to Authorize the user.
team_role_map = {
TEAM_ID_A_FROM_GITHUB: FA... |
combine_chunk_182 | combine.txt | 182 | 512 | LES_MAPPING = {
"Azure-Admins": ["Admin"],
"Azure-Users": ["User"],
"Azure-Viewers": ["Viewer"],
}
OAUTH_PROVIDERS = [
{
"name": "azure",
"icon": "fa-windows",
"token_key": "access_token",
"remote_app": {
"client_id... |
combine_chunk_183 | combine.txt | 183 | 512 | Airflow RBAC roles.
Example using team based Authorization with KeyCloak
''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Here is an example of what you might have in your webserver_config.py:
.. code-block:: python
import logging
from base64 import b64decode
import jwt
import requests
from crypt... |
combine_chunk_184 | combine.txt | 184 | 512 | _oauth_user_info(self, provider, response):
if provider == "keycloak":
token = response["access_token"]
me = jwt.decode(token, public_key, algorithms=["HS256", "RS256"], audience="account")
# Extract roles from resource access
realm_access = me.get("rea... |
combine_chunk_185 | combine.txt | 185 | 512 | User, Op, Viewer, and Public.
By default, only ``Admin`` users can configure/alter permissions for roles. However,
it is recommended that these default roles remain unaltered, and instead ``Admin`` users
create new roles with the desired permissions if changes are necessary.
Public
^^^^^^
``Public`` users (anonymous)... |
combine_chunk_186 | combine.txt | 186 | 512 | a list of permission objects
containing exactly ``action`` and ``resource``. Use actual FAB names such as ``can_edit`` and
``DAGs``, not Python constant names such as ``ACTION_CAN_EDIT`` or a ``permission`` key.
Names must be non-empty strings: role names support up to 64 characters, actions up to 100,
and resources u... |
combine_chunk_187 | combine.txt | 187 | 512 | _control=...)``
configuration rather than managing those permissions here.
Dag Level Role
^^^^^^^^^^^^^^
``Admin`` can create a set of roles which are only allowed to view a certain set of Dags. This is called Dag level access. Each Dag defined in the Dag model table
is treated as a ``View`` which has two permissions ... |
combine_chunk_188 | combine.txt | 188 | 512 | Task``, and
``Connection``. Actions include ``can_create``, ``can_read``, ``can_edit``, and ``can_delete``.
Permissions (each consistent of a resource + action pair) are then added to roles.
**To access an endpoint, the user needs all permissions assigned to that endpoint**
There are five default roles: Public, View... |
combine_chunk_189 | combine.txt | 189 | 512 |
- Assets.can_read
- Viewer
* - ``/api/v2/assets/events``
- POST
- Assets.can_create
- User
* - ``/api/v2/assets/{asset_id}``
- GET
- Asset Aliases.can_read
- Viewer
* - ``/api/v2/assets/{asset_id}``
- GET
- Assets.can_read
- Viewer
* - ``/api/v2/assets... |
combine_chunk_190 | combine.txt | 190 | 512 | - ``/api/v2/backfills/{backfill_id}``
- GET
- DAGs.can_read, DAG Runs.can_read
- Viewer
* - ``/api/v2/backfills/{backfill_id}/cancel``
- PUT
- DAGs.can_edit, DAG Runs.can_edit
- User
* - ``/api/v2/backfills/{backfill_id}/dag_runs``
- GET
- DAGs.can_read, DAG Runs.can_read
... |
combine_chunk_191 | combine.txt | 191 | 512 | - ``/api/v2/dagBundles``
- GET
- Dag Bundles.can_read
- Op
* - ``/api/v2/dagBundles/{bundle_name}``
- GET
- Dag Bundles.can_read
- Op
* - ``/api/v2/dagBundles/{bundle_name}/files``
- GET
- Dag Bundles.can_read
- Op
* - ``/api/v2/dagSources/{dag_id}``
- GET
... |
combine_chunk_192 | combine.txt | 192 | 512 | - GET
- DAGs.can_read
- Viewer
* - ``/api/v2/dags/{dag_id}/assets/{asset_id}/queuedEvents``
- DELETE
- Assets.can_delete
- Op
* - ``/api/v2/dags/{dag_id}/assets/{asset_id}/queuedEvents``
- DELETE
- DAGs.can_edit
- User
* - ``/api/v2/dags/{dag_id}/assets/{asset_id}/queue... |
combine_chunk_193 | combine.txt | 193 | 512 |
* - ``/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}``
- PATCH
- DAGs.can_edit, DAG Runs.can_edit
- User
* - ``/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/clear``
- POST
- DAGs.can_edit, DAG Runs.can_edit
- User
* - ``/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/hitlDetails``
- GET... |
combine_chunk_194 | combine.txt | 194 | 512 | Instances/{task_id}``
- PATCH
- DAGs.can_edit, DAG Runs.can_edit, Task Instances.can_edit
- User
* - ``/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/dependencies``
- GET
- DAGs.can_read, DAG Runs.can_read, Task Instances.can_read
- Viewer
* - ``/api/v2/dags/{dag_... |
combine_chunk_195 | combine.txt | 195 | 512 | Runs.can_delete, Task Instances.can_delete
- User
* - ``/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/state-store/{key}``
- GET
- DAGs.can_read, DAG Runs.can_read, Task Instances.can_read
- Viewer
* - ``/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/st... |
combine_chunk_196 | combine.txt | 196 | 512 | _read
- Viewer
* - ``/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries/{xcom_key}``
- PATCH
- DAGs.can_edit, XComs.can_edit
- Op
* - ``/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}``
- GET
- DAGs.can_read, DAG Runs.can_rea... |
combine_chunk_197 | combine.txt | 197 | 512 | _id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}/tries/{task_try_number}``
- GET
- DAGs.can_read, DAG Runs.can_read, Task Instances.can_read
- Viewer
* - ``/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/upstreamAssetEvents``
- GET
- Assets.can_read
- Viewer
* - ``/api/v2/dag... |
combine_chunk_198 | combine.txt | 198 | 512 | `
- GET
- DAGs.can_read, Audit Logs.can_read
- Admin
* - ``/api/v2/importErrors``
- GET
- ImportError.can_read
- Viewer
* - ``/api/v2/importErrors/{import_error_id}``
- GET
- ImportError.can_read
- Viewer
* - ``/api/v2/jobs``
- GET
- Jobs.can_read
- V... |
combine_chunk_199 | combine.txt | 199 | 512 | Task Instances.can_read, or DAGs.can_read and DAG Runs.can_read, or Assets.can_read
- Viewer
* - ``/api/v2/variables``
- GET
- Variables.can_read
- Op
* - ``/api/v2/variables``
- PATCH
- Variables.can_read
- Op
* - ``/api/v2/variables``
- POST
- Variables.can_creat... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.