Package: sas-airflow-provider
SAS® Airflow ProviderCurrent major capabilities of the SAS® Studio Flow OperatorExecute a SAS Studio Flow stored either on the File System or in SAS ContentSelect the Compute Context to be used for execution of a SAS Studio FlowSpecify whether SAS logs of a SAS Studio Flow execution should be returned and displayed in AirflowSpecify parameters (init_code, wrap_code) to be used for code generationHonor return code of a SAS Studio Flow in Airflow. In particular, if a SAS Studio Flow fails, Airflow raises an exception as well and stops executionAuthenticate via oauth token or via user/password (i.e. generation of oauth token prior to each call)Getting startedPlease note that this file is no substitute for reading and understanding the Airflow documentation. This file is only intended to provide a quick start for the SAS providers. Unless an issue relates specifically to the SAS providers, the Airflow documentation should be consulted.Install AirflowFollow instructions athttps://airflow.apache.org/docs/apache-airflow/stable/installation/index.htmlto install Airflow.
If you just want to evaluate the SAS providers, then the simplest path would be to install via PYPI and run Airflow on the local machine in a virtual environment.Install the SAS providerIf you want to build the package from these sources, install the build module usingpip install buildand then runpython -m buildfrom the root of the repository which will create a wheel file in the dist subdirectory.Installing in a local virtual environmentThe SAS provider is available as a package published in PyPI. To install it, switch to the Python environment where Airflow is installed, and run the following command:pip install sas-airflow-providerIf you would like to install the provider from a package you built locally, run:pip install dist/sas_airflow_provider_xxxxx.whlInstalling in a containerThere are a few ways to provide the package:Environment variable:_PIP_ADDITIONAL_REQUIREMENTSSet this variable to the command line that will be passed topip installCreate a dockerfile that adds the pip install command to the base image and edit the docker-compose file to use "build" (there is a comment in the docker compose file where you can change it)Create a connection to SASIn order to connect to SAS Viya from the Airflow operator, you will need to create a connection. The easiest way to do this is to go into the Airflow UI under Admin/Connections and create a new connection using the blue + button. Select SAS from the list of connection types, and enter sas_default as the name. The applicable fields are host (http or https url to your SAS Viya install), login and password. It is also possible to specify an OAuth token by creating a json body in the extra field. For example{"token": "oauth_token_here"}. If a token is found it is used instead of the user/password.
Please be aware of security considerations when storing sensitive information in a
connection. Consulthttps://airflow.apache.org/docs/apache-airflow/stable/security/index.htmlfor details.
TLS verification can be disabled (not recommended) by specifying the following in
the extra field{"ssl_certificate_verification": false }In addition, a custom TLS CA certificate bundle file can be used as follows:{"ssl_certificate_verification": "/path/to/trustedcerts.pem"}Running a DAG with a SAS providerSee example files in the src/sas_airflow_provider/example_dags directory. These dags can be modified and
placed in your Airflow dags directory.Mac note: If you are running Airflow standalone on a Mac, there is a known issue regarding how process forking works.
This causes issues with the urllib which is used by the operator. To get around it set NO_PROXY=* in your environment
prior to running Airflow in standalone mode.
Eg:export NO_PROXY="*"Prerequisites for running demo DAGsYou will need to create a SAS Studio Flow or a Job Definition before you can reference it from a DAG. The easiest way is to use the SAS Studio UI to do this.ContributingWe welcome your contributions! Please readCONTRIBUTING.mdfor
details on how to submit contributions to this project.LicenseThis project is licensed under theApache 2.0 License.