1
0
mirror of synced 2025-12-19 18:14:56 -05:00
Files
airbyte/docusaurus/platform_versioned_docs/version-2.0/operator-guides/upgrading-airbyte.md
devin-ai-integration[bot] f488a04b69 docs: regenerate platform version 2.0 from latest Next version (#68191)
## What

Regenerates platform documentation version 2.0 from the latest Next
(unreleased) version. This publishes all recent documentation updates
that have been made to the Next version as the stable 2.0 release.

Requested by Ian Alton (@ian-at-airbyte) via Slack thread:
https://airbytehq-team.slack.com/archives/D08FX8EC9L0/p1760747793195139?thread_ts=1760747793.195139

Link to Devin session:
https://app.devin.ai/sessions/edbc303b017445de9731080a55c04586

## How

1. Deleted the existing `version-2.0` directory from
`platform_versioned_docs/`
2. Deleted the `version-2.0-sidebars.json` from
`platform_versioned_sidebars/`
3. Temporarily removed `"2.0"` from `platform_versions.json`
4. Ran `pnpm docusaurus docs:version:platform 2.0` to regenerate version
2.0 from the current Next version
5. Verified the build succeeds locally

## Review guide

1. **New content**:
`platform_versioned_docs/version-2.0/understanding-airbyte/cdc-best-practices.md`
- Comprehensive new CDC configuration best practices guide. Review for
technical accuracy.
2. **Sidebar changes**:
`platform_versioned_sidebars/version-2.0-sidebars.json` - CDC content
reorganized under "Sync Modes" section. Verify navigation makes sense.
3. **Terminology updates** throughout various files:
   - "Airbyte Open Source" → "Core" 
   - "Cloud Teams" → "Cloud Pro"
   - "Self-Managed Community" → "Core"
   - Verify these align with actual product naming conventions
4. **Content improvements** in access management, API documentation,
connector development, enterprise setup, and quickstart guides

## User Impact

Users viewing the version 2.0 platform documentation will see the latest
content updates, including:
- New comprehensive CDC best practices documentation
- Updated terminology reflecting current product names
- Improved clarity and accuracy throughout documentation
- Better organization of CDC-related content

No negative side effects expected - this is a documentation-only update.

## Can this PR be safely reverted and rolled back?

- [x] YES 💚

This is a documentation change only. Reverting would restore the
previous version 2.0 documentation content.

---------

Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: ian.alton@airbyte.io <ian.alton@airbyte.io>
Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
2025-10-17 18:03:38 -07:00

3.0 KiB

products
products
oss-*

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

Upgrading Airbyte

Upgrades require temporarily turning off Airbyte. During upgrades, Airbyte will attempt to upgrade some connector versions. The following rules determine which connectors may be automatically upgraded:

  1. If you're not using a connector, Airbyte upgrades it to the latest version.

  2. If you're using a connector, Airbyte does not upgrade it, to avoid disrupting your work. If you want to upgrade a specific connector, do so from the settings page.

Refer to Managing Connector Updates for more details about keeping connectors updated.

Upgrading Airbyte deployed on Kubernetes with Helm

Upgrade by updating your values.yaml file and redeploying Airbyte. If you're not using a values.yaml to deploy Airbyte using Helm, you can jump directly to step 4.

  1. If you're not sure which chart versions you're running, run helm list -n <NAMESPACE>.

  2. Check the release notes to see what versions are available and review any requirements to upgrade. You can also see which Helm chart versions are available in the Airbyte ArtifactHub.

  3. Update your values.yaml file if necessary. In most cases, you only need to do this if you want to implement a new feature from the new version.

  4. Run the following command to upgrade.

    helm upgrade --install <RELEASE-NAME> airbyte/airbyte --values <VALUES.YAML> --version <HELM-APP-VERSION>
    
    helm upgrade airbyte airbyte-v2/airbyte \
    --namespace airbyte-v2 \       # Target Kubernetes namespace
    --values ./values.yaml \       # Custom configuration values
    --version 2.0.3 \              # Helm chart version to use
    --set global.image.tag=1.7.0   # Airbyte version to use
    

    After 5 minutes, Helm prints a message showing how to port-forward Airbyte. This may take longer on Kubernetes clusters with slow internet connections. In general the message is as follows:

    Get the application URL by running these commands:
    
    echo "Visit http://127.0.0.1:8080 to use your application"
    kubectl -n airbyte port-forward deployment/airbyte-server 8080:8001
    

Upgrading Airbyte deployed with abctl

abctl streamlines the way you manage a local installation of Airbyte Core.

Run abctl local install to upgrade to the latest version of Airbyte. If you'd like to ensure you're running the latest version of Airbyte, you can check the value of the Helm Chart's app version by running abctl local status.

Upgrade abctl

Occasionally, you need to update abctl to the latest version. Do that by running brew upgrade abctl. This is separate from upgrading Airbyte. It only upgrades the command line tool.