Skip to content

Commit

Permalink
Update upgrading Airbyte with the new workflow and move it to Operato…
Browse files Browse the repository at this point in the history
…r Guides (#4517)

* Move Upgrading Airbyte to Operator Guides now that issues will be less common

* Formatting changes

Co-authored-by: Abhi Vaidyanatha <abhivaidyanatha@Abhis-MacBook-Pro.local>
  • Loading branch information
avaidyanatha and Abhi Vaidyanatha committed Jul 3, 2021
1 parent 6fb2bd3 commit 637d939
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 10 deletions.
1 change: 1 addition & 0 deletions .gitbook.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,4 @@ redirects:
tutorials/tutorials/build-a-connector-the-hard-way: ./contributing-to-airbyte/building-new-connector/tutorials/build-a-connector-the-hard-way.md
tutorials/tutorials/adding-incremental-sync: ./contributing-to-airbyte/building-new-connector/tutorials/adding-incremental-sync.md
tutorials/tutorials/building-a-python-source: ./contributing-to-airbyte/building-new-connector/tutorials/building-a-python-source.md
upgrading-airbyte: ./operator-guides/upgrading-airbyte.md
4 changes: 2 additions & 2 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,9 @@
* [On Kubernetes \(Beta\)](deploying-airbyte/on-kubernetes.md)
* [On AWS ECS \(Coming Soon\)](deploying-airbyte/on-aws-ecs.md)
* [Operator Guides](operator-guides/README.md)
* [Upgrading Airbyte](operator-guides/upgrading-airbyte.md)
* [Resetting Your Data](operator-guides/reset.md)
* [Configuring the Airbyte Database](operator-guides/configuring-airbyte-db.md)
* [Resetting Your Data](operator-guides/reset.md)
* [Browsing Output Logs](operator-guides/browsing-output-logs.md)
* [Using the Airflow Airbyte Operator](operator-guides/using-the-airflow-airbyte-operator.md)
* [Windows - Browsing Local File Output](operator-guides/locating-files-local-destination.md)
Expand Down Expand Up @@ -107,7 +108,6 @@
* [S3](integrations/destinations/s3.md)
* [Snowflake](integrations/destinations/snowflake.md)
* [Custom or New Connector](integrations/custom-connectors.md)
* [Upgrading Airbyte](operator-guides/upgrading-airbyte.md)
* [Contributing to Airbyte](contributing-to-airbyte/README.md)
* [Code of Conduct](contributing-to-airbyte/code-of-conduct.md)
* [Developing Locally](contributing-to-airbyte/developing-locally.md)
Expand Down
13 changes: 5 additions & 8 deletions docs/operator-guides/upgrading-airbyte.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,11 @@ This tutorial will describe how to determine if you need to run this upgrade pro

## Determining if you need to Upgrade

All minor and major version releases requiring updating the data that Airbyte stores internally. We follow standard [Semantic Versioning](https://semver.org/) conventions. You can always find the latest stable version of Airbyte in our repository [here](https://github.com/airbytehq/airbyte/blob/master/.env#L1). If you are upgrading to a new major or minor version follow the steps below to upgrade your configuration data.
Airbyte intelligently performs upgrades automatically based off of your version defined in your `.env` file and will handle data migration for you.

{% hint style="info" %}
If you inadvertently upgrade to a version of Airbyte that is not compatible with your data, the docker containers will not start up and will log an error stating the incompatibility. In these cases, you should downgrade to the previous version that worked and follow the steps below. On the other hand, if you don't mind losing your current Airbyte configuration or have never setup any proper connections yet, you can skip the migrating operations and jump directly to step 5 below.
{% endhint %}
If you are running [Airbyte on Kubernetes](../deploying-airbyte/on-kubernetes.md), you will need to use one of the two processes defined [here](https://docs.airbyte.io/upgrading-airbyte#upgrading-k-8-s) that differ based on your Airbyte version.

## Upgrading \(Docker\)
## Upgrading on Docker

1. In a terminal, on the host where Airbyte is running, turn off Airbyte.

Expand All @@ -32,7 +30,7 @@ If you inadvertently upgrade to a version of Airbyte that is not compatible with
docker-compose up
```

## Upgrading \(K8s\)
## Upgrading on K8s (0.27.0-alpha and above)

If you are upgrading from (i.e. your current version of Airbyte is) Airbyte version **0.27.0-alpha or above** on Kubernetes :

Expand All @@ -56,6 +54,7 @@ If you are upgrading from (i.e. your current version of Airbyte is) Airbyte vers

Run `kubectl port-forward svc/airbyte-webapp-svc 8000:80` to allow access to the UI/API.

## Upgrading on K8s (0.26.4-alpha and below)
If you are upgrading from (i.e. your current version of Airbyte is) Airbyte version **before 0.27.0-alpha** on Kubernetes we **do not** support automatic migration. Please follow the following steps to upgrade your Airbyte Kubernetes deployment.

1. Switching over to your browser, navigate to the Admin page in the UI. Then go to the Configuration Tab. Click Export. This will download a compressed back-up archive \(gzipped tarball\) of all of your Airbyte configuration data and sync history locally.
Expand Down Expand Up @@ -98,8 +97,6 @@ If you are upgrading from (i.e. your current version of Airbyte is) Airbyte ver
```
6. Follow **Step 8** in the [Docker upgrade process](#Upgrading-\(Docker\)) to upload your migrated Archive and restore your configuration and data.

## API Instruction

If you prefer to import and export your data via API instead the UI, follow these instructions:

1. Instead of Step 3 above use the following curl command to export the archive:
Expand Down

0 comments on commit 637d939

Please sign in to comment.