Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Reverted from v. 24

...

Software Requirements for Universal Template and Universal Task

Requires Python 3.7.0 or higher. Tested with the Universal Agent bundled Python distribution.

Software Requirements for Universal Agent

...

  1. This Universal Task requires the theĀ Resolvable Credentials feature. Check that the Resolvable Credentials Permitted system property has been set to true.

  2. To import the Universal Template into your Controller, follow the instructions here.

  3. When the files have been imported successfully, refresh the Universal Templates list; the Universal Template will appear on the list.

Modifications of this integration, applied by users or customers, before or after import, might affect the supportability of this integration. For more information refer to Integration Modifications.

Configure Universal Task

...

Example of Universal Task for getting information on Standalone Airflow Task instance. HTTPS Proxy , CA Bundle , SSL Verification are used.

Read_Task_Instance_Info.pngImage RemovedImage Added

Task Output

Output Only Fields

...

The Extension Output below refers to Trigger DAG Run (Standalone) task example.

Panel
{
    "exit_code": 22,
    "status_description": "FAIL: DAG Run was triggered, but the status of DAG Run is 'Failed'.",
    "changed": true,
    "invocation": {
        "extension": "ue-airflow",
        "version": "2.0.0",
        "fields": {
            "connect_to": "standalone_airflow_server",
            "credentials_type_google": null,
            "service_account_key": null,
            "base_url": "http://airlfow_url:8080/api/v1",
            "credentials_user": "****",
            "credentials_password": "****",
            "use_ssl": false,
            "ssl_verify": false,
            "trusted_certificate_file": null,
            "ssl_hostname_check": false,
            "private_key_certificate": null,
            "public_key_certificate": null,
            "use_proxy": false,
            "proxies": null,
            "action": "trigger_dag_run",
            "dag_id": "example_bash_operator",
            "dag_run_id": "manual__2023-02-09T20:20:39.820239+00:00",
            "task_id": null,
            "wait_for_success_or_failure": true,
            "polling_interval": 1,
            "configuration_parameters": {
                "conf": {
                    "test": "parameter"
                }
            },
            "dag_run_id_output": null
        }
    },
    "result": {
        "conf": {
            "test": "parameter"
        },
        "dag_id": "example_bash_operator",
        "dag_run_id": "manual__2023-02-09T20:20:39.820239+00:00",
        "end_date": "2023-02-09T20:20:54.717256+00:00",
        "execution_date": "2023-02-09T20:20:39.820239+00:00",
        "external_trigger": true,
        "logical_date": "2023-02-09T20:20:39.820239+00:00",
        "start_date": "2023-02-09T20:20:40.022415+00:00",
        "state": "failed"
    }
}

...

The Extension Output below refers to Read Airflow Task Instance information task example.

Panel
{
    "exit_code": 0,
    "status_description": "SUCCESS: Successful Task Execution!",
    "changed": false,
    "invocation": {
        "extension": "ue-airflow",
        "version": "2.0.0",
        "fields": {
            "connect_to": "standalone_airflow_server",
            "credentials_type_google": null,
            "service_account_key": null,
            "base_url": "http://airflow_url:8080/api/v1",
            "credentials_user": "****",
            "credentials_password": "****",
            "use_ssl": true,
            "ssl_verify": true,
            "trusted_certificate_file": "****",
            "ssl_hostname_check": false,
            "private_key_certificate": null,
            "public_key_certificate": null,
            "use_proxy": true,
            "proxies": "https://ue-proxy-dev-noauth-ssl.stonebranch.org:3128",
            "action": "get_task_instance",
            "dag_id": "example_bash_operator",
            "dag_run_id": "manual__2023-02-09T15:42:00.467617+00:00",
            "task_id": "run_this_last",
            "wait_for_success_or_failure": false,
            "polling_interval": 1,
            "configuration_parameters": {
                "conf": {}
            },
            "dag_run_id_output": null
        }
    },
    "result": {
        "dag_id": "example_bash_operator",
        "duration": 0.0,
        "end_date": "2023-01-10T09:26:55.661975+00:00",
        "execution_date": "2023-01-09T14:16:48.856712+00:00",
        "executor_config": "{}",
        "hostname": "",
        "max_tries": 0,
        "operator": "DummyOperator",
        "pid": null,
        "pool": "default_pool",
        "pool_slots": 1,
        "priority_weight": 1,
        "queue": "default",
        "queued_when": null,
        "sla_miss": null,
        "start_date": "2023-01-10T09:26:55.661975+00:00",
        "state": "upstream_failed",
        "task_id": "run_this_last",
        "try_number": 0,
        "unixname": "****"
    }
}

...

STDOUT and STDERR provide additional information to User. The populated content can be changed in future versions of this extension without notice. Backward compatibility is not guaranteed.

Anchor
Integration Modification
Integration Modification

Integration Modifications

...

This document references the following documents.

Document LinkDescription
Universal TemplatesUser documentation for creating, working with and understanding Universal Templates and Integrations.
Universal TasksUser documentation for creating Universal Tasks in the Universal Controller user interface.
CredentialsUser documentation for creating and working with credentials.
Resolvable Credentials Permitted PropertyUser documentation for Resolvable Credentials Permitted Property.
Apache Airflow DocumentationUser documentation for Apache Airflow.
Apache Airflow API DocumentationUser Documentation for Airflow REST API.
Google Cloud Composer AirflowUser Documentation for Google Cloud Composer.

Changelog

ue-airflow-2.0.0 (2023-02-24)

...