Welcome
Welcome to the Airplane docs! These pages will cover lessons, references, and more to get you up and
running on the Airplane platform.
Getting started
Check out the Airplane overview for background on what Airplane
actually does and why we built it.
For a fast walkthrough that gives you a feel for Airplane, our
Quickstart guide will get you deploying and running tasks
in a few minutes.
Creating tasks
Tasks are the core building blocks on Airplane. You can easily
convert a SQL query you've been running into a SQL task, or write and deploy
your own JavaScript script as a task. See the relevant task documentation
page for details:
Creating runbooks
Runbooks are multi-step workflows that can be composed out of
multiple tasks. For details, see Getting started with runbooks.
Resources
Resources are systems like databases and external APIs that you want to
connect to Airplane. Once configured, a resource can be attached to and used by runbooks and tasks.
A SQL task, for example, requires a PostgreSQL, MySQL, or Snowflake resource
to be attached in order to connect.
Airplane currently supports the following resources—support for a broader set of resources is under
development and coming soon!
- Databases: BigQuery, Microsoft SQL Server, MongoDB, MySQL, PostgreSQL, Redshift, Snowflake
- REST APIs
- Email providers: SendGrid, Mailgun, SMTP
And more
Once you've set up the basics, the full Airplane platform offers permissions, notifications, and
other integrations to provide a robust tooling platform.
You might be interested in:
- Self-host the agent: If you have security and compliance requirements, you can self-host the Airplane agent to run tasks in your own network.
- Whitelist Airplane IP addresses: If you need to connect to resources behind a firewall, you'll need to allow connections from Airplane's IPs.
- Slack integration: Airplane's Slack integration makes it easy to get notifications, approve requests, and even execute tasks directly from Slack.
- GitHub integration: The GitHub integration automatically deploys modified tasks when they are pushed to GitHub.
Don't see what you're looking for? Shoot us a note at
hello@airplane.dev.