jprdonnelly/airbyte
1
0
Fork 0
mirror of synced 2025-12-25 02:09:19 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: add a section to the quickstart document that describes how to use the values.yaml file (#42428)

Browse Source 
Co-authored-by: Audrey Maldonado <audrey.maldonado@gmail.com>
This commit is contained in:
Bryce Groff
2024-07-22 23:00:42 -07:00
committed by GitHub
parent 14bfd1458f
commit 0bbb10d6de
1 changed files with 18 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/using-airbyte/getting-started/oss-quickstart.md
View File

@@ -164,18 +164,18 @@ To set your own username and password, use command line flags or variables. For
abctl local install --username foo --password bar
```
Or, if setting these values in the .env file, you'd add the following:
Or, if setting these values from environment variables, you'd export the following:
```
ABCTL_LOCAL_INSTALL_PASSWORD=foo
ABCTL_LOCAL_INSTALL_USERNAME=bar
export ABCTL_LOCAL_INSTALL_PASSWORD=foo
export 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.
If you quit Docker Desktop 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
@@ -187,6 +187,20 @@ In the Building Connections section, you'll learn how to start moving data. Gene
3: [Set up a Connection](./set-up-a-connection.md)
## Customizing your Installation with a Values file
Optionally, you can use a `values.yaml` file to customize your installation of Airbyte. Create the `values.yaml` on your local storage. Then, apply the values you've defined by running the following command and adjusting the path to the `values.yaml` file as needed:
```shell
abctl local install --values ./values.yaml
```
Here's a list of common customizations.
- [External Database](../../deploying-airbyte/integrations/database)
- [State and Logging Storage](../../deploying-airbyte/integrations/storage)
- [Secret Management](../../deploying-airbyte/integrations/secrets)
## Migrating from Docker Compose (Optional)
If you have data that you would like to migrate from an existing docker compose instance follow the steps below: