Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -305,6 +305,20 @@ export default withMermaid(
items: [
{ text: "Update to latest version", link: "/self-hosting/manage/upgrade-plane" },
{ text: "For versions before 0.14.0", link: "/self-hosting/manage/upgrade-from-0.13.2-0.14.0" },
{
text: "Airgapped Edition",
collapsed: true,
items: [
{
text: "On Docker",
link: "/self-hosting/manage/update-plane/airgapped-edition/update-airgapped-docker",
},
{
text: "On Kubernetes",
link: "/self-hosting/manage/update-plane/airgapped-edition/update-airgapped-kubernetes",
},
],
},
],
},
{
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
title: Upgrade Airgapped Edition (Docker)
description: Upgrade your airgapped Plane instance running on Docker by cloning images, replacing configuration files, and uploading a new license.
---
Comment thread
coderabbitai[bot] marked this conversation as resolved.

# Update Airgapped Edition on Docker

Since airgapped instances can't pull updates from the internet, updating the version requires manually transferring the latest Docker images and configuration files from a machine with internet access.

## Prerequisites

- A machine with internet access to download images and files.
- Access to your airgapped Docker registry.
- Your current `plane.env` file backed up.

## Update Plane

1. On a machine with internet access, pull the latest Plane images and push them to your airgapped Docker registry. Follow the guide for [cloning and pushing Plane Docker images](https://developers.plane.so/self-hosting/methods/clone-docker-images).

Once complete, the latest Plane images are available in your internal registry.

2. On the same machine with internet access, download the updated `docker-compose.yml` and environment template for your target version.

```bash
# Download docker-compose.yml
curl -fsSL https://prime.plane.so/releases/<plane_version>/docker-compose-airgapped.yml -o docker-compose.yml

# Download environment template
curl -fsSL https://prime.plane.so/releases/<plane_version>/variables-airgapped.env -o plane.env
```

Transfer both files to your airgapped instance and replace the existing ones. If you've made custom changes to your `plane.env`, merge them into the new template before replacing.

:::info
Replace `<plane_version>` with the version you're upgrading to (e.g., v2.5.2). Check the [release notes](https://plane.so/changelog?category=self-hosted) for the latest available release version.
:::

3. Download the latest license file for the new version from [prime.plane.so](https://prime.plane.so). Follow [this guide](https://developers.plane.so/self-hosting/manage/manage-licenses/activate-airgapped) to activate license.

4. Restart the instance to bring the instance back up with the new configuration.

```bash
docker compose up -d
```

Verify the upgrade by checking the version in your Plane application.
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
title: Upgrade Airgapped Edition on Kubernetes
description: Upgrade your airgapped Plane instance running on Kubernetes by cloning images, updating the Helm chart, and redeploying.
---
Comment thread
coderabbitai[bot] marked this conversation as resolved.

# Update Airgapped Edition on Kubernetes

Since airgapped clusters can't pull updates from the internet, upgrading requires manually transferring Docker images to your private registry and updating the Helm chart.

## Prerequisites

- A machine with internet access to download images and the Helm chart.
- Access to your airgapped Docker registry used by the cluster.
- Your current Helm `values.yaml` file backed up.

## Update Plane

1. On a machine with internet access, pull the latest Plane images and push them to your air-gapped Docker registry. Follow the guide for [cloning and pushing Plane Docker images](https://developers.plane.so/self-hosting/methods/clone-docker-images).

Once complete, the latest Plane images are available in your internal registry.

2. Download the latest Plane Enterprise Helm chart. You can check the most recent version on [Artifact Hub](https://artifacthub.io/packages/helm/makeplane/plane-enterprise).

```bash
# Using wget
wget https://github.com/makeplane/helm-charts/releases/download/plane-enterprise-<chart_version>/plane-enterprise-<chart_version>.tgz

# Using curl
curl -L -O https://github.com/makeplane/helm-charts/releases/download/plane-enterprise-<chart_version>/plane-enterprise-<chart_version>.tgz
```

Transfer the `.tgz` file to a machine that can access the cluster.

:::info
Replace <chart_version> with the latest Helm chart version (e.g., 2.2.4). You can check the most recent version on [Artifact Hub](https://artifacthub.io/packages/helm/makeplane/plane-enterprise).
:::

3. In your `values.yaml`, update `planeVersion` to match the version of Plane images you pushed to the registry:

```yaml
planeVersion: <plane_version>
```

:::info
Replace `<plane_version>` with the version you're upgrading to (e.g., v2.5.2). Check the [release notes](https://plane.so/changelog?category=self-hosted) for the latest available release version.
:::

4. Once the Helm chart and `values.yaml` file are updated, redeploy the Helm release in your Kubernetes cluster to complete the update.

Verify the upgrade by checking the version in your Plane application.
Loading