Quickstart clarifications based on feedback (#54712)
This commit is contained in:
Ian Alton
@@ -13,39 +13,46 @@ This quickstart guides you through deploying a local instance of Airbyte Self-Ma
|
||||
|
||||
## Overview
|
||||
|
||||
This quickstart is for most people who want to manage their own Airbyte instance. It assumes you have basic knowledge of command-line tools. It's also helpful, but not necessary, to understand the basics of Docker.
|
||||
|
||||
This quickstart shows you how to:
|
||||
|
||||
- [Install abctl](#part-1-install-abctl)
|
||||
- [Run Airbyte](#part-2-run-airbyte)
|
||||
- [Set up authentication](#part-3-set-up-authentication)
|
||||
- [Install Docker Desktop](#part-1-install-docker-desktop)
|
||||
- [Install abctl](#part-2-install-abctl)
|
||||
- [Run Airbyte](#part-3-run-airbyte)
|
||||
- [Set up authentication](#part-4-set-up-authentication)
|
||||
- [Decide on your next steps](#whats-next)
|
||||
|
||||
This is intended for most people who want to manage their own Airbyte instance, but it assumes you have basic knowledge of:
|
||||
If you don't want to self-manage Airbyte, skip this guide. Sign up for an [Airbyte Cloud](https://cloud.airbyte.com/signup) trial and [start syncing data](add-a-source.md) now.
|
||||
|
||||
- Docker
|
||||
- Command-line tools
|
||||
If you want to use Python to move data, Airbyte's Python library, [PyAirbyte](../pyairbyte/getting-started.mdx), might be the best fit for you. It's a good choice if you're using Jupyter Notebook or iterating on an early prototype for a large data project and don't need to run your own server.
|
||||
|
||||
If you do not want to self-manage Airbyte, skip this guide. Sign up for an [Airbyte Cloud](https://cloud.airbyte.com/signup) trial and [start syncing data](add-a-source.md) now.
|
||||
## Suggested resources {#suggested-resources}
|
||||
|
||||
If you want to use Python to move data, our Python library, [PyAirbyte](../pyairbyte/getting-started.mdx), might be the best fit for you. It's a good choice if you're using Jupyter Notebook or iterating on an early prototype for a large data project and don't need to run a server.
|
||||
For best performance, run Airbyte on a machine with 4 or more CPUs and at least 8-GB of memory. Airbyte also runs with 2 CPUs and 8-GB of memory in low-resource mode. This guide explains how to do both. Follow this [Github discussion](https://github.com/airbytehq/airbyte/discussions/44391) to up-vote and track progress toward supporting lower resource environments.
|
||||
|
||||
## Before you start
|
||||
## Part 1: Install Docker Desktop
|
||||
|
||||
Before running this quickstart, complete the following prerequisites:
|
||||
Install Docker Desktop on your machine, if you haven't already. Follow the steps for your operating system in Docker's online help, linked below.
|
||||
|
||||
1. Install Docker Desktop on your machine: [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/).
|
||||
2. Make sure you have enough computing power (see Suggested resources, below).
|
||||
- [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/)
|
||||
|
||||
### Suggested resources {#suggested-resources}
|
||||
You don't need to do anything with Docker, but you do need to run it in the background. Once it's open, minimize it and proceed to Part 2.
|
||||
|
||||
For best performance, run Airbyte on a machine with 4 or more CPUs and at least 8GB of memory. We also support running Airbyte with 2 CPUs and 8GM of memory in low-resource mode. This guide explains how to do both. Follow this [Github discussion](https://github.com/airbytehq/airbyte/discussions/44391) to upvote and track progress toward supporting lower resource environments.
|
||||
:::info Why do you need Docker?
|
||||
Airbyte runs on Kubernetes. When you deploy Airbyte locally, it uses Docker to create a Kubernetes cluster on your computer.
|
||||
:::
|
||||
|
||||
## Part 1: Install abctl
|
||||
## Part 2: Install abctl
|
||||
|
||||
abctl is Airbyte's command-line tool for deploying and managing Airbyte.
|
||||
abctl is Airbyte's command-line tool for deploying and managing Airbyte.
|
||||
|
||||
### Install abctl the fast way (Mac, Linux)
|
||||
|
||||
This is the best way to get abctl, but this method doesn't work on Windows.
|
||||
|
||||
1. Open a terminal and run the following command.
|
||||
|
||||
```shell
|
||||
@@ -54,7 +61,7 @@ abctl is Airbyte's command-line tool for deploying and managing Airbyte.
|
||||
|
||||
2. If your terminal asks you to enter your password, do so.
|
||||
|
||||
When installation completes, you'll see `abctl install succeeded.`
|
||||
When installation completes, you see `abctl install succeeded.`
|
||||
|
||||
### Install abctl manually (Mac, Linux, Windows)
|
||||
|
||||
@@ -67,7 +74,7 @@ Use [Homebrew](https://brew.sh/) to install abctl.
|
||||
|
||||
1. Install Homebrew, if you haven't already.
|
||||
|
||||
2. Run the following commands after Homebrew is installed.
|
||||
2. Run the following commands after you install Homebrew.
|
||||
|
||||
```bash
|
||||
brew tap airbytehq/tap
|
||||
@@ -115,9 +122,9 @@ Use [Homebrew](https://brew.sh/) to install abctl.
|
||||
|
||||
6. Verify the installation. If this command prints the installed version of abctl, you can now use it to manage a local Airbyte instance.
|
||||
|
||||
```bash
|
||||
abctl version
|
||||
```
|
||||
```bash
|
||||
abctl version
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="abctl-windows" label="Windows" default>
|
||||
@@ -146,7 +153,7 @@ abctl version
|
||||
|
||||
4. Find the Path variable and click **Edit**.
|
||||
|
||||
5. Click **New**, then paste the filepath you saved in step 3.
|
||||
5. Click **New**, then paste the file path you saved in step 3.
|
||||
|
||||
6. Click **OK**, then click **OK**, then close the System Properties.
|
||||
|
||||
@@ -161,13 +168,11 @@ abctl version
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Part 2: Run Airbyte
|
||||
## Part 3: Run Airbyte
|
||||
|
||||
1. Run Docker Desktop.
|
||||
1. Open Docker Desktop, [which you installed previously](#part-1-install-docker-desktop).
|
||||
|
||||
2. Install Airbyte.
|
||||
|
||||
To run Airbyte with on a machine with the recommended resources (4 or more CPUs), use this command:
|
||||
2. Install Airbyte. To do this, open a terminal and run the following command.
|
||||
|
||||
```bash
|
||||
abctl local install
|
||||
@@ -188,14 +193,16 @@ abctl version
|
||||
```
|
||||
|
||||
:::note
|
||||
If you see the warning `Encountered an issue deploying Airbyte` with the message `Readiness probe failed: HTTP probe failed with statuscode: 503`, allow installation to continue. You may need to allocate more resources for Airbyte, but installation will complete anyway. See [Suggested resources](#suggested-resources).
|
||||
If you see the warning `Encountered an issue deploying Airbyte` with the message `Readiness probe failed: HTTP probe failed with statuscode: 503`, allow installation to continue. You may need to allocate more resources for Airbyte, but installation can complete anyway. See [Suggested resources](#suggested-resources).
|
||||
:::
|
||||
|
||||
Installation may take up to 15 minutes depending on your internet connection. When it completes, your Airbyte instance opens in your web browser at [http://localhost:8000](http://localhost:8000). As long as your Docker Desktop daemon is running in the background, use Airbyte by returning to [http://localhost:8000](http://localhost:8000). If you quit Docker Desktop and want to return to Airbyte, start Docker Desktop again. Once your containers are running, you can access Airbyte normally.
|
||||
Installation may take up to 30 minutes depending on your internet connection. When it completes, your Airbyte instance opens in your web browser at [http://localhost:8000](http://localhost:8000). As long as Docker Desktop is running in the background, use Airbyte by returning to [http://localhost:8000](http://localhost:8000). If you quit Docker Desktop and want to return to Airbyte, start Docker Desktop again. Once your containers are running, you can access Airbyte normally.
|
||||
|
||||
3. Enter your **Email** and **Organization name**, then click **Get Started**. Airbyte asks you to log in with a password.
|
||||
3. Enter your **Email** and **Organization name**, then click **Get Started**.
|
||||
|
||||
## Part 3: Set up authentication
|
||||
Airbyte asks you to log in with a password, but you don't have one yet. Proceed to Part 4 to get one.
|
||||
|
||||
## Part 4: Set up authentication
|
||||
|
||||
To access your Airbyte instance, you need a password.
|
||||
|
||||
@@ -211,7 +218,7 @@ To access your Airbyte instance, you need a password.
|
||||
Credentials:
|
||||
Email: user@example.com
|
||||
// highlight-next-line
|
||||
Password: random_password
|
||||
Password: a-random-password
|
||||
Client-Id: 03ef466c-5558-4ca5-856b-4960ba7c161b
|
||||
Client-Secret: m2UjnDO4iyBQ3IsRiy5GG3LaZWP6xs9I
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user