Skip to main content

Python commandline tool to make deployment of Airflow projects easier.

Project description

afctl

The proposed CLI tool is being authored to make creating and deployment of airflow projects faster and smoother. As of now, there is no tool out there that can empower the user to create a boilerplate code structure for airflow projects and make development + deployment of projects seamless.

Installation

Create a new python virtualenv. You can use the following command.

python3 -m venv <name>

Activate your virtualenv

source /path_to_venv/bin/activate
pip3 install afctl

or

Clone the repository.
Step into the afctl directory and run

pip3 install .

Requirements

Python 3.5+ Docker

Usage

Commands right now supported are

  • init
  • config
  • deploy
  • list
  • generate

To learn more, run

afctl <command> -h

Initialize a new afctl project.

The project is created in your present working directory. Along with this a configuration file with the same name is generated in /home/.afctl_configs directory.

afctl init “name of the project”
  • Creates a new project directory.
  • Creates a config file in the home directory
afctl init .
  • Initialize the current directory as a project
  • If the directory is already a git repository then the global configs will get automatically set.

Manage configurations

The configuration file is used for deployment.

global:
-git:
--origin:
deployment:
-qubole:
--local:
---compose:

TYPES:
   add - add a config for your deployment.
   update - update an existing config for your deployment.
       Arguments:
           -d : Deployment Type
           -p : Project
            [ Qubole ]
               -n : name of deployment
               -e : name of environment
               -c : cluster label
               -t : auth token
            [ docker-local ]
               Cannot add/update configs.
   global
       Arguments:
           -p : Project
           -o : Set git origin for deployment
           -t : Set personal access token
   show -  Show the config file on console
       No arguments.

positional arguments:
  {add,update,show,global}

optional arguments:
  -h, --help            show this help message and exit
  -d {qubole}
  -o O
  -p P
  -n N
  -e E
  -c C
  -t T
afctl config global -o <origin>
  • Will set the git origin for your project.
  • Supports both inline arguments as well as promoting for input.
afctl configs add -d <deployment>
  • Prompts the user to input connector related values.
  • Can also provide values as inline arguments.
afctl configs update -d <deployment>
  • Prompts the user to update the values
  • Can also provide inline arguments.

Deploy projects

TYPES:
   [qubole] - Deploy your project to QDS.
       Arguments:
           -n : Name of the deployment
   [local] - Deploy your project to local docker.
       Arguments:
           -d : To run in daemon mode

positional arguments:
  {qubole,local}

optional arguments:
  -h, --help            show this help message and exit
  -d
  -n N
  • To Deploy on local docker
afctl deploy local
  • To deploy on remote machine
afctl deploy <deployment> -n <name of deployment>
  • Fetches the latest commit in remote origin.
  • Deploys the repository with the last commit as shown.
afctl config show
  • Prints the configuration file on the console.

Example

  • Qubole
afctl config add -d qubole -n <name> -e https://<env>.qubole.com -c <cluster-label> -t <auth-token>
afctl deploy qubole -n name

Caution

Not yet ported for Windows.

Credits

Docker-compose file : https://github.com/puckel/docker-airflow

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for afctl, version 0.1.6
Filename, size File type Python version Upload date Hashes
Filename, size afctl-0.1.6.tar.gz (29.5 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page