Skip to content

Commit

Permalink
Am/quickstartdocs (#39437)
Browse files Browse the repository at this point in the history
  • Loading branch information
Adorism committed Jun 28, 2024
1 parent 6c980bd commit 1d744f0
Show file tree
Hide file tree
Showing 5 changed files with 274 additions and 72 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
products: all
---

# Configuring Connections
# Data Transfer Options

A connection links a source to a destination and defines how your data will sync. After you have created a connection, you can modify any of the configuration settings or stream settings.

Expand Down
191 changes: 191 additions & 0 deletions docs/using-airbyte/getting-started/oss-quickstart.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,191 @@
---
products: oss-community
---

import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";



# Quickstart

Airbyte Open Source is a reliable and extensible open source data pipeline.

If you're getting started with Airbyte Cloud, you can skip ahead to moving data by [adding your first source](add-a-source.md).

This quickstart guides you through creating a locally deployed instance of Airbyte in just minutes using `abctl` ([Airbyte Command Line Tool](https://github.com/airbytehq/abctl)). You'll be able to move data with minimal setup while you're exploring what Airbyte can do!

:::tip
**When you're ready to put an Airbyte instance into production, you'll want to review our guides on deployment.**

For the best experience, we recommend [Deploying Airbyte on Kubernetes via Helm](../../deploying-airbyte/on-kubernetes-via-helm.md).
:::

## Prerequisites

- To use `abctl`, you'll need to have **Docker Desktop** installed. See Docker's instructions for installation: [Mac](https://docs.docker.com/desktop/install/mac-install/), [Windows](https://docs.docker.com/desktop/install/windows-install/), [Linux](https://docs.docker.com/desktop/install/linux-install/)

## 1: Install `abctl`

Follow the instructions for your operating system:

<Tabs
defaultValue="abctl-mac">
<TabItem value="abctl-mac" label="Mac">

We recommend that Mac users use Brew to install the `abctl` command.

```bash
brew tap airbytehq/tap
brew install abctl
```

With Brew, you can keep abctl up to date easily, by running:
```bash
brew upgrade abctl
```

</TabItem>
<TabItem value="abctl-linux" label="Linux" default>

**1: Download the latest release of `abctl` [here](https://github.com/airbytehq/abctl/releases)**

:::info
Be sure to download the file that is compatible with your machine's processor architecture.
:::

You'll see two options: `linux-amd64` and `linux-arm64`
If you're unsure which one you need, running the following command will help:

```bash
uname -m
```

- If the output is `x86_64`, you have an x86-64 processor.
- If the output is `aarch64` or something similar, you have an ARM-based processor.

**2: Extract the archive**

This will create a directory named abctl which contains the executable along with other needed files.

```bash
tar -xvzf {name-of-file-downloaded.linux-*.tar.gz}
```

**3: Make the extracted executable accessible**

This will allow you to run `abctl` as a command

```bash
chmod +x abctl/abctl
```

**4: Add `abctl` to your PATH**

This will allow you to run `abctl` from any directory in your terminal.

```bash
sudo mv abctl /usr/local/bin
```
**5: Verify the installation**

```bash
abctl --version
```

If this command prints the installed version of the Airbyte Command Line Tool, it confirm that you are now ready to manage a local Airbyte instance using `abctl`.


</TabItem>
<TabItem value="abctl-windows" label="Windows" default>

**1: Download the latest release of `abctl` [here](https://github.com/airbytehq/abctl/releases)**

**2: Extract the archive**
- Right click the zip file you've downloaded and select `Extract All...`, then choose a destination folder.

This creates a folder called abctl containing the abctl executable and other reqired files.

**3: Add the executable to your PATH**
- In the "System Properties" window (you can find this by searching for "enviornment variables" in the Start menu), click the `Environment Variables` button
- Under System variables, find the path and click to `Edit`
- Click `New` and add the path to the folder you extracted the abctl files to in the previous step.
- Click `OK` to save these changes.

**4: Open a new Command Prompt or PowerShell window**

This is important because changes to your PATH will only take effect in a newly opened window.

**5: Verify the installation**

```bash
abctl --version
```

If this command prints the installed version of the Airbyte Command Line Tool, it confirm that you are now ready to manage a local Airbyte instance using `abctl`.


</TabItem>

</Tabs>

## 2: Run Airbyte

Ensure that Docker Desktop is up and running. Then, with abctl installed, the following command gets Airbyte running:

```
abctl local install
```

Your browser may open automatically to the Airbyte Application. If not, access it by visiting [http://localhost:8000](http://localhost:8000).

When prompted for a username and password, enter the following default values:
- username: `airbyte`
- password: `password`

To set your own username and password, use command line flags or variables. For example, to set the username and password to foo and bar respectively, you can run the following command:

```bash
abctl local install --username foo --password bar
```

Or, if setting these values in the .env file, you'd add the following:

```
ABCTL_LOCAL_INSTALL_PASSWORD=foo
ABCTL_LOCAL_INSTALL_USERNAME=bar
```

After supplying a username and password, you'll see the Airbyte workspace. Using this interface, you can set up and manage all your connections and move data with ease!

As long as your Docker Desktop daemon is running in the background, you can use Airbyte by returning to [http://localhost8000](http://localhost8000).

If you quit Docker Decktop and want to return to your local Airbyte workspace, just start Docker Desktop again. Once Docker finishes restarting, you'll be able to access Airbyte's local installation as normal.

## 3: Move Data

In the Building Connections section, you'll learn how to start moving data. Generally, there are three steps:

1: [Set up a Source](./add-a-source)

2: [Set up a Destination](./add-a-destination.md)

3: [Set up a Connection](./set-up-a-connection.md)

## Troubleshooting

There are several channels for community support of local setup and deployment.

**GitHub Airbyte Forum's Getting Started FAQ:**<br/>Search the questions others have asked or ask a new question of your own in the [GitHub forum](https://github.com/airbytehq/airbyte/discussions/categories/questions).

**Airbyte Knowledge Base:**<br/>While support services are limited to Cloud and Enterprise customers, anyone may search the support team's [Help Center](https://support.airbyte.com/hc).

**Community Slack:**<br/>Helpful channels for troubleshooting include:<br/>
- [#ask-community-for-troubleshooting](https://airbytehq.slack.com/archives/C021JANJ6TY): Where members of the Airbyte community can ask and answer questions.
- [#ask-ai](https://airbytehq.slack.com/archives/C01AHCD885S): For quick answers sourced from documentation and open support channels, you can have a chat with our virtual Airbyte assistant.

**Introductory Course:**<br/>
On Udemy, [The Complete Hands-on Introduction to Airbyte](https://www.udemy.com/course/the-complete-hands-on-introduction-to-airbyte/) is a convenient and hands-on introduction to Airbyte that includes setting up example source and destination configurations. You'll also go on to use it in conjunction with Apache Airflow, Snowflake, dbt, and more.

**Bug Reports:**<br/>If you find an issue with the `abctl` command, please report it as a github
issue [here](https://github.com/airbytehq/airbyte/issues) with the type of `🐛 [abctl] Report an issue with the abctl tool`.
47 changes: 22 additions & 25 deletions docs/using-airbyte/getting-started/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,45 +2,42 @@
products: all
---

# Getting Started
# Airbyte Overview

Getting started with Airbyte takes only a few steps! This page guides you through the initial steps to get started and you'll learn how to setup your first connection on the following pages.
Airbyte is an open-source data integration platform designed to help you consolidate data from various sources into your data warehouses, lakes, and databases.

You have two options to run Airbyte: Use **Airbyte Cloud** (recommended) or **self-manage Airbyte** in your infrastructure.
Whether you're part of a large organization managing complex data pipelines or an individual analyst consolidating data for a personal project, Airbyte can work for you! We offer flexibility and scalability that's easy to tailor to your specific needs, from one-off jobs to enterprise-grade solutions.

There are two options to consider for running Airbyte:
- **Airbyte Cloud** (recommended): allows you to focus on moving data while we take care of managing the infrastructure.
- **Self-managed Airbyte**: can be deployed either locally or in an infrastructure you've set up. Our OSS can be used as a free Community product or implemented with support of Enterprise operations.

:::tip
If you are have already deployed Airbyte or signed up for Airbyte Cloud, jump ahead to [set up a source](./add-a-source.md).
If you have already deployed Airbyte or you've signed up to use Airbyte Cloud, and you're familiar with [Airbyte's core concepts](../../using-airbyte/core-concepts/), jump ahead to [Building Connections](../../cloud/managing-airbyte-cloud/configuring-connections.md).
:::

## Sign Up for Airbyte Cloud
## Airbyte Cloud

To use Airbyte Cloud, [sign up](https://cloud.airbyte.io/signup) with your email address, Google login, or GitHub login. Upon signing up, you'll be taken to your workspace, which lets you collaborate with team members and share resources across your team under a shared billing account.
To use Airbyte Cloud, [sign up](https://cloud.airbyte.io/signup) with your email address, Google login, or GitHub login. Upon signing up, you'll be taken to your workspace. There, you can collaborate with team members and share resources across your team under a single billing account.

Airbyte Cloud offers a 14-day free trial that begins after your first successful sync. For more details on our pricing model, see our [pricing page](https://www.airbyte.com/pricing).
Airbyte Cloud offers a 14-day free trial that begins after your first successful sync. You can find more details about Airbyte Cloud for practitioners and teams, as well as a tool for evaluating costs on our [pricing page](https://www.airbyte.com/pricing).

To start setting up a data pipeline, see how to [set up a source](./add-a-source.md).

## Deploy Airbyte (Self-Managed)

When self-managing Airbyte, your data never leaves your premises. Get started immediately by deploying locally using Docker.
## Open Source Community (OSS)

### Self-Managed Community (Open Source)
When self-managing Airbyte, your data never leaves your premises. You can use our [OSS Quickstart](oss-quickstart.md) to get started immediately by deploying locally using abctl.

With Airbyte Self-Managed Community (Open Source), you can use one of the following options in your infrastructure:
:::tip
If you're trying Airbyte out for the first time, we'd recommend you sign up for the [Airbyte Cloud trial](https://cloud.airbyte.io/signup) or deploy OSS locally.
:::

- [Local Deployment](/deploying-airbyte/quickstart.md) (recommended when trying out Airbyte)
- [On AWS](/deploying-airbyte/on-aws-ec2.md)
- [On Azure VM Cloud Shell](/deploying-airbyte/on-azure-vm-cloud-shell.md)
- [On Digital Ocean Droplet](/deploying-airbyte/on-digitalocean-droplet.md)
- [On GCP](/deploying-airbyte/on-gcp-compute-engine.md)
- [On Kubernetes](/deploying-airbyte/on-kubernetes-via-helm.md)
- [On OCI VM](/deploying-airbyte/on-oci-vm.md)
- [On Restack](/deploying-airbyte/on-restack.md)
- [On Plural](/deploying-airbyte/on-plural.md)
- [On AWS ECS](/deploying-airbyte/on-aws-ecs.md) (Spoiler alert: it doesn't work)
To deploy Airbyte in production, Airbyte recommends deploying on [Kubernetes via Helm](../../deploying-airbyte/on-kubernetes-via-helm.md).

### Self-Managed Enterprise
## Open Source Enterprise

Airbyte Self-Managed Enterprise is the best way to run Airbyte yourself. You get all 300+ pre-built connectors, data never leaves your environment, and Airbyte becomes self-serve in your organization with new tools to manage multiple users, and multiple teams using Airbyte all in one place.
Airbyte Self-Managed Enterprise is the most robust way to run Airbyte yourself. With this option, you'll have access to all 300+ pre-built connectors and data will never need to leave your environment. Enterprise setup means that Airbyte becomes self-serve in your organization with new tools to manage multiple users, and the ability to set up multiple teams using Airbyte all in one place.

To start with Self-Managed Enterprise, navigate to our [Enterprise setup guide](/enterprise-setup/README.md).
:::tip
To start with Self-Managed Enterprise, you'll need a licence key. [Talk to sales](https://airbyte.com/company/talk-to-sales) to get started with Enterprise. For more details, review our [Enterprise setup guide](/enterprise-setup/README.md).
:::
2 changes: 2 additions & 0 deletions docs/using-airbyte/getting-started/set-up-a-connection.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,8 @@ If you are using Airbyte on Windows with WSL2 and Docker, refer to [this guide](

Congratulations on successfully setting up your first connection using Airbyte! We hope that this will be just the first step on your journey with us. We support a large, ever-growing [catalog of sources and destinations](/integrations/), and you can even [contribute your own](/connector-development/).

If you'd like an in-depth introduction to Airbyte that includes setting up example source and destination configurations, we recommend the Udemy course [The Complete Hands-on Introduction to Airbyte](https://www.udemy.com/course/the-complete-hands-on-introduction-to-airbyte/).

If you have any questions at all, please reach out to us on [Slack](https://slack.airbyte.io/). If you would like to see a missing feature or connector added, please create an issue on our [Github](https://github.com/airbytehq/airbyte). Our community's participation is invaluable in helping us grow and improve every day, and we always welcome your feedback.

Thank you, and we hope you enjoy using Airbyte!
Loading

0 comments on commit 1d744f0

Please sign in to comment.