This is an automated email from the ASF dual-hosted git repository.
taragolis pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new 1ab7b08f7d Add Apache Livy connection documentation (#36412)
1ab7b08f7d is described below
commit 1ab7b08f7d9ab329538999e7717367dbbd07383b
Author: shohamy7 <[email protected]>
AuthorDate: Mon Dec 25 11:09:19 2023 +0200
Add Apache Livy connection documentation (#36412)
* Add Apache Livy connection documentation
* fix typos in livy connection docs
---
.../connections.rst | 59 ++++++++++++++++++++++
.../apache-airflow-providers-apache-livy/index.rst | 1 +
2 files changed, 60 insertions(+)
diff --git a/docs/apache-airflow-providers-apache-livy/connections.rst
b/docs/apache-airflow-providers-apache-livy/connections.rst
new file mode 100644
index 0000000000..14f9046f37
--- /dev/null
+++ b/docs/apache-airflow-providers-apache-livy/connections.rst
@@ -0,0 +1,59 @@
+ .. 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"); 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, 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.
+
+Apache Livy Connection
+======================
+
+The Apache Livy connection type enables connection to Apache Livy.
+The Apache Livy connection uses the Http connection under the hood.
+
+Default Connection IDs
+----------------------
+
+Livy Hook uses parameter ``livy_conn_id`` for Connection IDs and the value of
the
+parameter as ``livy_default`` by default.
+
+Configuring the Connection
+--------------------------
+Host
+ The http host of the Livy server. You may add the scheme in the ``Host``
field or give it in the ``Schema`` field.
+
+Port
+ Specify the port in case of host be an URL of the Apache Livy server.
+
+Schema (optional)
+ Specify the service type etc: http/https.
+
+Login (optional)
+ Specify the login for the Apache Livy server you would like to connect too.
+
+Password (optional)
+ Specify the password for the Apache Livy server you would like to connect
too.
+
+Extras (optional)
+ Specify headers in json format.
+
+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_CONN_LIVY_DEFAULT='http://username:[email protected]:80?headers=header'
diff --git a/docs/apache-airflow-providers-apache-livy/index.rst
b/docs/apache-airflow-providers-apache-livy/index.rst
index 8879c35582..8d9b917872 100644
--- a/docs/apache-airflow-providers-apache-livy/index.rst
+++ b/docs/apache-airflow-providers-apache-livy/index.rst
@@ -33,6 +33,7 @@
:maxdepth: 1
:caption: Guides
+ Connection types <connections>
Operators <operators>
.. toctree::
