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_1200
combine.txt
1,200
512
should specify it using URI syntax. Note that all components of the URI should be URL-encoded. For example: .. code-block:: bash export AIRFLOW_CONN_DOCKER_DEFAULT='docker://username:password@https%3A%2F%2Findex.docker.io%2Fv1:80?email=myemail%40my.com&reauth=False' <|file|>airflow/providers/docker/docs/decora...
combine_chunk_1201
combine.txt
1,201
512
Environment variables to set in the container. (templated) private_environment Private environment variables to set in the container. These are not templated, and hidden from the website. env_file Relative path to the ``.env`` file with environment variables to set in the container. Overridden by v...
combine_chunk_1202
combine.txt
1,202
512
container/path', '/host/path2:/container/path2:ro']``. working_dir Working directory to set on the container (equivalent to the -w switch the docker client) entrypoint Overwrite the default ENTRYPOINT of the image xcom_all Push all the stdout or just the last line. The default is False (last line). docker_c...
combine_chunk_1203
combine.txt
1,203
512
with ``"host"`` in ``network_mode``. ulimits List of ulimit options to set for the container. Each item should be a ``docker.types.Ulimit`` instance. Usage Example ------------- .. exampleinclude:: /../tests/system/docker/example_taskflow_api_docker_virtualenv.py :language: python :start-after: [STA...
combine_chunk_1204
combine.txt
1,204
512
, YOU SHOULD MODIFY THE TEMPLATE ``PROVIDER_README_TEMPLATE.rst.jinja2`` IN the ``dev/breeze/src/airflow_breeze/templates`` DIRECTORY Package ``apache-airflow-providers-slack`` Release: ``9.11.1`` `Slack <https://slack.com/>`__ services integration including: - `Slack API <https://api.slack.com/>`__ - `Slac...
combine_chunk_1205
combine.txt
1,205
512
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 applicable law or agreed to in writing, so...
combine_chunk_1206
combine.txt
1,206
512
Provider package ---------------- This package is for the ``slack`` provider. All classes for this package are included in the ``airflow.providers.slack`` python package. Installation ------------ You can install this package on top of an existing Airflow installation via ``pip install apache-airflow-providers-sla...
combine_chunk_1207
combine.txt
1,207
512
-py3-none-any.whl.sha512>`__) <|file|>airflow/providers/slack/docs/operators/sql_to_slack.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...
combine_chunk_1208
combine.txt
1,208
512
** - additional permission for API method **conversations.list** * **im:read** - additional permission for API method **conversations.list** .. seealso:: - `Slack SDK 3.19.0 Release Notes <https://github.com/slackapi/python-slack-sdk/releases/tag/v3.19.0>`_ - `conversations.list API <https://ap...
combine_chunk_1209
combine.txt
1,209
512
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 applicable law or agreed to in writing, ...
combine_chunk_1210
combine.txt
1,210
512
See the License for the specific language governing permissions and limitations under the License. Slack Incoming Webhook Operators ================================ SlackWebhookOperator -------------------- Use the :class:`~airflow.providers.slack.operators.slack_webhook.SlackWebhookOperator` to post messa...
combine_chunk_1211
combine.txt
1,211
512
.operators.slack.SlackAPIPostOperator` to post messages to a Slack channel. Using the Operator ^^^^^^^^^^^^^^^^^^ You could send simple text message .. exampleinclude:: /../../slack/tests/system/slack/example_slack.py :language: python :dedent: 4 :start-after: [START slack_api_post_operator_text_howto_g...
combine_chunk_1212
combine.txt
1,212
512
api/python-slack-sdk/releases/tag/v3.19.0>`_ - `conversations.list API <https://api.slack.com/methods/conversations.list>`_ - `files.upload retires in March 2025 <https://api.slack.com/changelog/2024-04-a-better-way-to-upload-files-is-here-to-stay>`_ You could send file attachment by specifying file pa...
combine_chunk_1213
combine.txt
1,213
512
"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. .. NOTE! THIS FILE IS AUTOMATICALLY GENERATED AND WILL BE OVERWRITTEN! .. IF YOU WANT TO MODIFY THIS FILE, YOU SHOU...
combine_chunk_1214
combine.txt
1,214
512
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 applicable law or agreed to in writin...
combine_chunk_1215
combine.txt
1,215
512
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 applicable law or agreed to in writing, software distrib...
combine_chunk_1216
combine.txt
1,216
512
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:: /../../../devel-common/src/sphinx_exts/in...
combine_chunk_1217
combine.txt
1,217
512
----------------------- Authenticate to Slack using a `Slack API token <https://slack.com/help/articles/215770388-Create-and-regenerate-API-tokens>`_. Default Connection ID ---------------------- The default Slack API Connection ID is ``slack_api_default``. Configuring the Connection -------------------------- ...
combine_chunk_1218
combine.txt
1,218
512
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 applicable law or agreed to in writing, ...
combine_chunk_1219
combine.txt
1,219
512
/webhook/index.html>`_. All parameters are optional. * ``timeout``: The maximum number of seconds the client will wait to connect and receive a response from Slack Incoming Webhook. * ``proxy``: Proxy to make the Slack Incoming Webhook call. If you are configuring the connection via a URI, ensure th...
combine_chunk_1220
combine.txt
1,220
512
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 applicable law or agr...
combine_chunk_1221
combine.txt
1,221
512
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"); you may not use this file e...
combine_chunk_1222
combine.txt
1,222
512
`` provider. All classes for this package are included in the ``airflow.providers.telegram`` python package. Installation ------------ You can install this package on top of an existing Airflow installation via ``pip install apache-airflow-providers-telegram``. For the minimum Airflow version supported, see ``Require...
combine_chunk_1223
combine.txt
1,223
512
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, WITHOUT WARRANTI...
combine_chunk_1224
combine.txt
1,224
512
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"); you may not use this file except in compliance with the License. You may obtain a copy of the License at .. http://www.apac...
combine_chunk_1225
combine.txt
1,225
512
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, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the ...
combine_chunk_1226
combine.txt
1,226
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" BASI...
combine_chunk_1227
combine.txt
1,227
512
|>airflow/providers/vespa/docs/index.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 you under the Apache L...
combine_chunk_1228
combine.txt
1,228
512
You can install this package on top of an existing Airflow installation via ``pip install apache-airflow-providers-vespa``. For the minimum Airflow version supported, see ``Requirements`` below. Requirements ------------ The minimum Apache Airflow version supported by this provider distribution is ``2.11.0``. ====...
combine_chunk_1229
combine.txt
1,229
512
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 applicable law or agreed to in writing, software distributed under the L...
combine_chunk_1230
combine.txt
1,230
512
, 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. .. NOTE! THIS FILE IS AUTOMATICALLY GENERATED AN...
combine_chunk_1231
combine.txt
1,231
512
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, WITHOUT WARRANTIES OR CO...
combine_chunk_1232
combine.txt
1,232
512
this work for additional information 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/L...
combine_chunk_1233
combine.txt
1,233
512
/5.5.1/>`_. Installation ------------ 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-mongo`` The package supports the following python versions: 3.11,3.12,3.13,3.14 Requirements...
combine_chunk_1234
combine.txt
1,234
512
:caption: Resources PyPI Repository <https://pypi.org/project/apache-airflow-providers-mongo/> Installing from sources <installing-providers-from-sources> .. THE REMAINDER OF THE FILE IS AUTOMATICALLY GENERATED. IT WILL BE OVERWRITTEN AT RELEASE TIME! .. toctree:: :hidden: :maxdepth: 1 :caption...
combine_chunk_1235
combine.txt
1,235
512
<https://downloads.apache.org/airflow/providers/apache_airflow_providers_mongo-5.5.1-py3-none-any.whl.asc>`__, `sha512 <https://downloads.apache.org/airflow/providers/apache_airflow_providers_mongo-5.5.1-py3-none-any.whl.sha512>`__) <|file|>airflow/providers/mongo/docs/commits.rst .. Licensed to the Apache Software...
combine_chunk_1236
combine.txt
1,236
512
. 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, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. Se...
combine_chunk_1237
combine.txt
1,237
512
/manual/reference/connection-string/#mongodb-urioption-urioption.authSource>`_. Extra (optional) Specify the extra parameters (as json dictionary) that can be used in Azure connection. The following parameters are all optional: * ``srv``: (bool) Specify if to use srv to indicate that the hostname co...
combine_chunk_1238
combine.txt
1,238
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, WI...
combine_chunk_1239
combine.txt
1,239
512
``>=1.4.1; python_version == "3.11" and (sys_platform != "darwin" or platform_machine != "arm64")`` ``jpype1`` ``>=1.5.0,!=1.7.0; python_version == "3.12" and sys_platform == "darwin" and platform_machine == "arm64"`` ``jpype1`` ...
combine_chunk_1240
combine.txt
1,240
512
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"); you may not use this file except in compliance with the License. You may obtain a copy of the License at .. http:/...
combine_chunk_1241
combine.txt
1,241
512
ree:: :hidden: :maxdepth: 1 :caption: System tests System Tests <_api/tests/system/jdbc/index> .. toctree:: :hidden: :maxdepth: 1 :caption: Resources Example Dags <https://github.com/apache/airflow/tree/providers-jdbc/|version|/providers/jdbc/tests/system/jdbc> PyPI Repository <ht...
combine_chunk_1242
combine.txt
1,242
512
!=1.7.0; python_version == "3.12" and sys_platform == "darwin" and platform_machine == "arm64"`` ``jpype1`` ``>=1.5.0; python_version == "3.12" and (sys_platform != "darwin" or platform_machine != "arm64")`` ``jpype1`` ``>=1.5.1,!=1.7.0; python_version =...
combine_chunk_1243
combine.txt
1,243
512
>`_ (`asc <https://downloads.apache.org/airflow/providers/apache_airflow_providers_jdbc-5.6.1.tar.gz.asc>`__, `sha512 <https://downloads.apache.org/airflow/providers/apache_airflow_providers_jdbc-5.6.1.tar.gz.sha512>`__) * `The apache-airflow-providers-jdbc 5.6.1 wheel package <https://downloads.apache.org/airflow/prov...
combine_chunk_1244
combine.txt
1,244
512
package: ``jdbc``. For high-level changelog, see :doc:`package information including changelog <index>`. .. airflow-providers-commits:: <|file|>airflow/providers/jdbc/docs/installing-providers-from-sources.rst .. Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. ...
combine_chunk_1245
combine.txt
1,245
512
required) Specify the password to connect to. Port (optional) Port of host to connect to. Not user in ``JdbcOperator``. Extra (optional) Specify the extra parameters (as json dictionary) that can be used in JDBC connection. The following parameters out of the standard python parameters are supported: ...
combine_chunk_1246
combine.txt
1,246
512
governing permissions and limitations under the License. .. _howto/operator:JdbcOperator: JdbcOperator ============ Java Database Connectivity (JDBC) is an application programming interface (API) for the programming language Java, which defines how a client may access a database. .. warning:: Previously, J...
combine_chunk_1247
combine.txt
1,247
512
a template file. Template reference are recognized by ending in '.sql'. The parameter ``autocommit`` if set to ``True`` will execute a commit after each command (default is ``False``) Templating ---------- You can use :ref:`Jinja templates <concepts:jinja-templating>` to parameterize ``sql``. .. exampleinclude:: /...
combine_chunk_1248
combine.txt
1,248
512
under the License. Accepting New Community Providers ================================== .. contents:: Table of Contents :depth: 3 :local: The Airflow community welcomes new provider contributions. All new providers enter through the **Incubation** stage (unless specifically accelerated by the PMC) to ensur...
combine_chunk_1249
combine.txt
1,249
512
~~ Use the following template when opening your ``[DISCUSS]`` thread on the devlist: .. code-block:: text Subject: [DISCUSS] New Community Provider: <name/service> Hi Airflow community, I'd like to propose adding a new community provider for <Service/Tool Name>. Integration overview ---------------...
combine_chunk_1250
combine.txt
1,250
512
House <https://lists.apache.org/thread/dpcfv6k60sw2xwmrf6mtokhfwr85n278>`_ Historical examples (pre policy simplification) ------------------------------------- * Akeyless - `[PROPOSAL] New community provider: apache-airflow-providers-akeyless <https://lists.apache.org/thread/ztf1mqbkoc39qz6o419lynttk4fhoz0t>`_, `[VO...
combine_chunk_1251
combine.txt
1,251
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 applicable ...
combine_chunk_1252
combine.txt
1,252
512
>airflow/providers/datadog/docs/index.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 you under the Apache ...
combine_chunk_1253
combine.txt
1,253
512
installation via ``pip install apache-airflow-providers-datadog``. For the minimum Airflow version supported, see ``Requirements`` below. Requirements ------------ The minimum Apache Airflow version supported by this provider distribution is ``2.11.0``. ========================================== ==================...
combine_chunk_1254
combine.txt
1,254
512
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 language gov...
combine_chunk_1255
combine.txt
1,255
512
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 applicable law or agreed t...
combine_chunk_1256
combine.txt
1,256
512
": "environment-region-application.domain.com" } <|file|>airflow/providers/datadog/docs/security.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 owners...
combine_chunk_1257
combine.txt
1,257
512
. At least two individuals willing to serve as stewards 2. Sponsorship from at least one existing Airflow Committer (if none of the stewards are a committer) 3. A commitment to meeting the incubation health metrics within 6 months 4. A plan to participate in quarterly governance updates on the devlist Include this inf...
combine_chunk_1258
combine.txt
1,258
512
│ ├── __init__.py │ │ └── *.py │ ├── operators/ │ │ ├── __init__.py │...
combine_chunk_1259
combine.txt
1,259
512
-docs/03b_contributors_quick_start_seasoned_developers.rst#prek>`_. Key files in the Airflow source tree that affect providers: * The ``pyproject.toml`` in root Airflow folder is automatically generated based on content of ``provider.yaml`` file in each provider when ``prek hook`` is run. * Files such as ``extra-pa...
combine_chunk_1260
combine.txt
1,260
512
:start-after: [START howto_operator_<PROVIDER>] :end-before: [END howto_operator_<PROVIDER>] Copy from another, similar provider the docs: ``docs/*.rst``. At least these docs should be present: * security.rst * changelog.rst * commits.rst * index.rst * installing-providers-from-sources.rst * configura...
combine_chunk_1261
combine.txt
1,261
512
CI omits the provider from the ``3.14`` test lane. The entry ``"3.11.0"`` excludes only that patch prefix from provider metadata. Root extras use ``python_full_version``. CI keeps the ``3.11`` test lane. Use a patch entry when a dependency needs ``>=3.11.1`` but the provider otherwise supports Python 3.11. The...
combine_chunk_1262
combine.txt
1,262
512
a big deal to maintain it. * There is a potential risk of one provider importing the same ``AIRFLOW_V_X_Y_PLUS`` from another provider (and introduce accidental dependency) or from test code (which should not happen), but we are preventing it via prek hook ``check-imports-in-providers`` that will fail if the ``v...
combine_chunk_1263
combine.txt
1,263
512
possibility to suspend individual providers, so that they are not holding back dependencies for Airflow and other providers. The criteria and process for suspending providers is described in `Suspending releases for providers <SUSPENDING_AND_REMOVING_PROVIDERS.rst#suspending-releases-for-providers>`_. Technical steps...
combine_chunk_1264
combine.txt
1,264
512
** Most tests for the suspended provider will be automatically excluded by pytest collection. However, if another provider depends on the suspended one, its tests might fail to be collected. In such cases, add ``pytest.importorskip`` at the top of the failing test module. Example failing collection after ``google`` p...
combine_chunk_1265
combine.txt
1,265
512
.providers.amazon' or: .. code-block:: txt Error: The ``airflow.providers.microsoft.azure.transfers.azure_blob_to_gcs`` object in transfers list in airflow/providers/microsoft/azure/provider.yaml does not exist or is not a module: No module named 'gcloud.aio.storage' Fix by turning the feature into an o...
combine_chunk_1266
combine.txt
1,266
512
s`` For all those commands, release manager needs to specify ``--include-removed-providers`` when all providers are built or must add the provider id explicitly during the release process. Except the changelog that needs to be maintained manually, all other documentation (main page of the provider documentation, PyPI ...
combine_chunk_1267
combine.txt
1,267
512
3.12,3.13,3.14 Requirements ------------ ========================================== ================== PIP package Version required ========================================== ================== ``apache-airflow`` ``>=2.11.0`` ``apache-airflow-providers-common...
combine_chunk_1268
combine.txt
1,268
512
notifications/pagerduty_notifier_howto_guide> .. THE REMAINDER OF THE FILE IS AUTOMATICALLY GENERATED. IT WILL BE OVERWRITTEN AT RELEASE TIME! .. toctree:: :hidden: :maxdepth: 1 :caption: Commits Detailed list of commits <commits> apache-airflow-providers-pagerduty package ------------------------...
combine_chunk_1269
combine.txt
1,269
512
airflow/providers/apache_airflow_providers_pagerduty-5.3.1-py3-none-any.whl.asc>`__, `sha512 <https://downloads.apache.org/airflow/providers/apache_airflow_providers_pagerduty-5.3.1-py3-none-any.whl.sha512>`__) <|file|>airflow/providers/pagerduty/docs/commits.rst .. Licensed to the Apache Software Foundation (ASF) u...
combine_chunk_1270
combine.txt
1,270
512
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, WITHOUT WARRANTI...
combine_chunk_1271
combine.txt
1,271
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 ap...
combine_chunk_1272
combine.txt
1,272
512
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 language governing permissions and limitations under the License....
combine_chunk_1273
combine.txt
1,273
512
note:: The Pagerduty Routing key is deprecated. Please use the :ref:`PagerDutyEvents connection <howto/connection:pagerduty_events>` instead. <|file|>airflow/providers/pagerduty/docs/security.rst .. Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See th...
combine_chunk_1274
combine.txt
1,274
512
.1`` `Segment <https://segment.com/>`__ Provider package ---------------- This is a provider package for ``segment`` provider. All classes for this provider package are in ``airflow.providers.segment`` python package. You can find package information and changelog for the provider in the `documentation <https://a...
combine_chunk_1275
combine.txt
1,275
512
<security> .. toctree:: :hidden: :maxdepth: 1 :caption: References Python API <_api/airflow/providers/segment/index> .. toctree:: :hidden: :maxdepth: 1 :caption: Resources PyPI Repository <https://pypi.org/project/apache-airflow-providers-segment/> Installing from sources <insta...
combine_chunk_1276
combine.txt
1,276
512
10.1 wheel package <https://downloads.apache.org/airflow/providers/apache_airflow_providers_segment-3.10.1-py3-none-any.whl>`_ (`asc <https://downloads.apache.org/airflow/providers/apache_airflow_providers_segment-3.10.1-py3-none-any.whl.asc>`__, `sha512 <https://downloads.apache.org/airflow/providers/apache_airflow_pr...
combine_chunk_1277
combine.txt
1,277
512
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 applicable law or agreed to in writing, software distributed u...
combine_chunk_1278
combine.txt
1,278
512
KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. .. NOTE! THIS FILE IS AUTOMATICALLY GENERATED AND WILL BE OVERWRITTEN! .. IF YOU WANT TO MODIFY TEMPLATE FOR THIS FILE, YOU SHOULD MODIFY THE TEMPLATE ``PROVIDER_README_TEM...
combine_chunk_1279
combine.txt
1,279
512
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 language governing permissions and limitations under the License....
combine_chunk_1280
combine.txt
1,280
512
-providers-imap package ------------------------------------------------------ `Internet Message Access Protocol (IMAP) <https://tools.ietf.org/html/rfc3501>`__ Release: 3.13.1 Provider package ---------------- This package is for the ``imap`` provider. All classes for this package are included in the ``airflow.pr...
combine_chunk_1281
combine.txt
1,281
512
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"); 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/licen...
combine_chunk_1282
combine.txt
1,282
512
/installing-providers-from-sources.rst <|file|>airflow/providers/imap/docs/connections/imap.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. Th...
combine_chunk_1283
combine.txt
1,283
512
with the fallback to "email". "ssl_context" configuration. If none of it is specified, "default" is used. When specifying the connection in environment variable you should specify it using URI syntax. Note that all components of the URI should be URL-encoded. For example: .. code-block:: bash export AIRFLOW_CO...
combine_chunk_1284
combine.txt
1,284
512
"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. .. NOTE! THIS FILE IS AUTOMATICALLY GENERATED AND WILL BE OVERWRITTEN! .. IF YOU WANT TO MODIFY TEMPLATE FOR THIS FIL...
combine_chunk_1285
combine.txt
1,285
512
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 language governing per...
combine_chunk_1286
combine.txt
1,286
512
PyPI Repository <https://pypi.org/project/apache-airflow-providers-keycloak/> Installing from sources <installing-providers-from-sources> .. THE REMAINDER OF THE FILE IS AUTOMATICALLY GENERATED. IT WILL BE OVERWRITTEN AT RELEASE TIME! .. toctree:: :hidden: :maxdepth: 1 :caption: Commits Deta...
combine_chunk_1287
combine.txt
1,287
512
y3-none-any.whl.asc>`__, `sha512 <https://downloads.apache.org/airflow/providers/apache_airflow_providers_keycloak-0.12.0-py3-none-any.whl.sha512>`__) <|file|>airflow/providers/keycloak/docs/commits.rst .. Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the...
combine_chunk_1288
combine.txt
1,288
512
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 language governing permissions and limitations under the License. .. include...
combine_chunk_1289
combine.txt
1,289
512
specific language governing permissions and limitations under the License. Keycloak Command Line Interface =============================== Provider CLI has been integrated with Apache Airflow CLI ``airflow`` command. .. argparse:: :module: airflow.providers.keycloak.cli.definition :func: get_parser ...
combine_chunk_1290
combine.txt
1,290
512
specific language governing permissions and limitations under the License. ===================== Keycloak auth manager ===================== .. warning:: The Keycloak auth manager is alpha/experimental at the moment and may be subject to change without warning. The Keycloak auth manager is an authenticati...
combine_chunk_1291
combine.txt
1,291
512
the specific language governing permissions and limitations under the License. ============================ Setup a Keycloak environment ============================ To use the Keycloak auth manager, you must have a running Keycloak environment. This is where you define users, groups, roles, and permissions....
combine_chunk_1292
combine.txt
1,292
512
configuration options available, which can either be set directly in the airflow.cfg file under an ``keycloak_auth_manager`` section or via environment variables using the ``AIRFLOW__KEYCLOAK_AUTH_MANAGER__<OPTION_NAME>`` format, for example ``AIRFLOW__KEYCLOAK_AUTH_MANAGER__REALM = "Airflow"``. For more information o...
combine_chunk_1293
combine.txt
1,293
512
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"); you may not use this...
combine_chunk_1294
combine.txt
1,294
512
(so Keycloak can enforce per-team access) pass ``--teams``: .. code-block:: bash airflow keycloak-auth-manager create-all --teams team-a,team-b Step-by-step creation of permissions ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ First we need to create scopes for the permissions. These scopes later will be used in Keycloak...
combine_chunk_1295
combine.txt
1,295
512
-- audit log entries not tied to a Dag, import errors for files with no registered Dag, reparsing such files, and Dag bundles (from Airflow 3.4.1) -- are checked against the ``AdminView`` resource, which the CLI grants to ``SuperAdmin`` only. The other views are checked against the ``View`` resource, which every team ...
combine_chunk_1296
combine.txt
1,296
512
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 applicable law or agreed to in writing, ...
combine_chunk_1297
combine.txt
1,297
512
:widths: 30 40 * - Field - Production Value * - Root URL - https://yourcompany.airflow.com * - Home URL - https://yourcompany.airflow.com * - Valid Redirect URIs - https://yourcompany.airflow.com/* * - Valid Post Logout Redirect URIs - https://yourcompany.airflow.com/* * ...
combine_chunk_1298
combine.txt
1,298
512
If a user or service needs to interact with the Airflow public API, they can create a token using their credentials. - ``/auth/token``: Create token using username and password, client credentials, or a Keycloak-issued JWT assertion, with a ``[config][api_auth]jwt_expiration_time`` expiration time. - ``/auth/token/cli...
combine_chunk_1299
combine.txt
1,299
512
it can exchange the resulting Keycloak access token for an Airflow token without re-authenticating to Keycloak through Airflow. Airflow does not obtain the assertion on the client's behalf, it verifies the assertion and calls Keycloak's ``/userinfo`` endpoint to validate it and retrieve user information. The assertio...