1
0
mirror of synced 2025-12-19 18:14:56 -05:00
Files
airbyte/docs/platform/operator-guides/upgrading-airbyte.md
Ian Alton 4f97ee2dab docs: update plan names in docs content (#67573)
## What
<!--
* Describe what the change is solving. Link all GitHub issues related to
this change.
-->

This pull request updates plan names across most of the Documentation so
they're consistent with our current plan names.

## How
<!--
* Describe how code changes achieve the solution.
-->

My original plan was to convert free text to MDX variables so we only
had to make future updates to names in one place. While broadly
successful, there were numerous edge cases that made rolling this out
almost impossible. There were too many ways and places you couldn't use
variables due to a variety of limitations in Docusaurus and Airbyte's
internal MarkDown processor. Explaining how to properly use them made me
realize how prohibitively insufficient this was. In the end, I opted to
return to using free text for plan names.

Scope is now broadly reduced. This PR:

- Converts remaining instances of old plan names to new plan names. In
most cases, I replaced old plan names with new plan names directly. In
some cases, sentences were rewritten to make a bit more sense or be more
maintainable in the future.

- Removes previously added preprocessor variables from Docusaurus
configuration.

- Update Vale styles or various artifacts of content based on linter
findings.

## Review guide
<!--
1. `x.py`
2. `y.py`
-->

Spot check updated pages to ensure plan names appear appropriately. It's
probably not necessary to check every single instance in detail.

For Platform docs, changes only apply to the Next/Cloud version. After
merging, I'll regenerate 2.0 docs based on this. 1.8 and before won't be
updated.

## User Impact
<!--
* What is the end result perceived by the user?
* If there are negative side effects, please list them. 
-->

People can see correct plan names in docs content.

## Can this PR be safely reverted and rolled back?
<!--
* If unsure, leave it blank.
-->
- [x] YES 💚
- [ ] NO 

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-10-17 17:34:29 -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.