Skip to content

Commit 38c3e4a

Browse files
authored
Merge pull request #255 from makeplane/update-airgapped-edition
Update Airgapped Edition
2 parents 9ea2d66 + b37d96d commit 38c3e4a

File tree

6 files changed

+134
-7
lines changed

6 files changed

+134
-7
lines changed

docs/.vitepress/config.mts

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -235,8 +235,8 @@ export default withMermaid(
235235
collapsed: true,
236236
items: [
237237
{ text: "Overview", link: "/self-hosting/methods/airgapped-requirements" },
238-
{ text: "For Docker", link: "/self-hosting/methods/airgapped-edition" },
239-
{ text: "For Kubernetes", link: "/self-hosting/methods/airgapped-edition-kubernetes" },
238+
{ text: "On Docker", link: "/self-hosting/methods/airgapped-edition" },
239+
{ text: "On Kubernetes", link: "/self-hosting/methods/airgapped-edition-kubernetes" },
240240
{ text: "Clone Docker Images", link: "/self-hosting/methods/clone-docker-images" },
241241
],
242242
},
@@ -305,6 +305,20 @@ export default withMermaid(
305305
items: [
306306
{ text: "Update to latest version", link: "/self-hosting/manage/upgrade-plane" },
307307
{ text: "For versions before 0.14.0", link: "/self-hosting/manage/upgrade-from-0.13.2-0.14.0" },
308+
{
309+
text: "Airgapped Edition",
310+
collapsed: true,
311+
items: [
312+
{
313+
text: "On Docker",
314+
link: "/self-hosting/manage/update-plane/airgapped-edition/update-airgapped-docker",
315+
},
316+
{
317+
text: "On Kubernetes",
318+
link: "/self-hosting/manage/update-plane/airgapped-edition/update-airgapped-kubernetes",
319+
},
320+
],
321+
},
308322
],
309323
},
310324
{
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: Upgrade Airgapped Edition (Docker)
3+
description: Upgrade your airgapped Plane instance running on Docker by cloning images, replacing configuration files, and uploading a new license.
4+
keywords: plane airgapped upgrade, air-gapped docker upgrade, plane offline update
5+
---
6+
7+
# Update Airgapped Edition on Docker
8+
9+
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.
10+
11+
## Prerequisites
12+
13+
- A machine with internet access to download images and files.
14+
- Access to your airgapped Docker registry.
15+
- Your current `plane.env` file backed up.
16+
17+
## Update Plane
18+
19+
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).
20+
21+
Once complete, the latest Plane images are available in your internal registry.
22+
23+
2. On the same machine with internet access, download the updated `docker-compose.yml` and environment template for your target version.
24+
25+
```bash
26+
# Download docker-compose.yml
27+
curl -fsSL https://prime.plane.so/releases/<plane_version>/docker-compose-airgapped.yml -o docker-compose.yml
28+
29+
# Download environment template
30+
curl -fsSL https://prime.plane.so/releases/<plane_version>/variables-airgapped.env -o plane.env
31+
```
32+
33+
Transfer both files to your airgapped instance and replace the existing ones. Before replacing your existing `plane.env`, compare it with the new template. Copy over any custom values from your old plane.env into the new template. The new template may include additional variables required by the latest version, so always use the new file as the base and bring your existing values into it.
34+
35+
:::info
36+
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.
37+
:::
38+
39+
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.
40+
41+
4. Restart the instance to bring the instance back up with the new configuration.
42+
43+
```bash
44+
docker compose up -d
45+
```
46+
47+
Verify the upgrade by checking the version in your Plane application.
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
title: Upgrade Airgapped Edition on Kubernetes
3+
description: Upgrade your airgapped Plane instance running on Kubernetes by cloning images, updating the Helm chart, and redeploying.
4+
keywords: plane airgapped kubernetes upgrade, air-gapped helm chart upgrade, plane offline k8s update
5+
---
6+
7+
# Update Airgapped Edition on Kubernetes
8+
9+
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.
10+
11+
## Prerequisites
12+
13+
- A machine with internet access to download images and the Helm chart.
14+
- Access to your airgapped Docker registry used by the cluster.
15+
- Your current Helm `values.yaml` file backed up.
16+
17+
## Update Plane
18+
19+
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).
20+
21+
Once complete, the latest Plane images are available in your internal registry.
22+
23+
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).
24+
25+
```bash
26+
# Using wget
27+
wget https://github.com/makeplane/helm-charts/releases/download/plane-enterprise-<chart_version>/plane-enterprise-<chart_version>.tgz
28+
29+
# Using curl
30+
curl -L -O https://github.com/makeplane/helm-charts/releases/download/plane-enterprise-<chart_version>/plane-enterprise-<chart_version>.tgz
31+
```
32+
33+
Transfer the `.tgz` file to a machine that can access the cluster.
34+
35+
:::info
36+
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).
37+
:::
38+
39+
Before replacing your existing `values.yaml`, compare it with the new Helm chart's default values. Copy over any custom configuration from your old `values.yaml` into the new template. The new chart version may include additional or renamed fields, so always use the new default values as the base and bring your existing configuration into it.
40+
41+
3. In your `values.yaml`, update `planeVersion` to match the version of Plane images you pushed to the registry.
42+
43+
```yaml
44+
planeVersion: <plane_version>
45+
```
46+
47+
:::info
48+
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.
49+
:::
50+
51+
4. Once the Helm chart and `values.yaml` file are updated, redeploy the Helm release in your Kubernetes cluster to complete the update.
52+
53+
Verify the upgrade by checking the version in your Plane application.

docs/self-hosting/methods/airgapped-edition-kubernetes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ description: Deploy Plane on Kubernetes using Helm charts. Complete guide for pr
44
keywords: plane airgapped kubernetes, offline k8s deployment, air-gapped helm, kubernetes offline, plane helm airgapped, self-hosting
55
---
66

7-
# Deploy Plane with airgapped Kubernetes <Badge type="tip" text="Business" />
7+
# Deploy Plane Airgapped on Kubernetes <Badge type="warning" text="Enterprise Grid" />
88

99
::: info
10-
Airgapped deployments are available exclusively for Business plan customers. Contact our [sales team](mailto:sales@plane.so) for pricing and licensing information.
10+
Airgapped deployments are available exclusively for Enterprise Grid customers with a minimum commitment of 100 seats. Contact our [sales team](mailto:sales@plane.so) for trials, tailor-made pricing for lesser seats, and license information.
1111
:::
1212

1313
This guide walks you through deploying Plane Commercial in an airgapped Kubernetes environment using Helm charts and pre-packaged Docker images.

docs/self-hosting/methods/airgapped-edition.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ description: Deploy Plane in airgapped environment without internet access. Comp
44
keywords: plane airgapped, offline deployment, air-gapped docker, plane offline install, disconnected environment, self-hosting
55
---
66

7-
# Deploy Plane with Airgapped Docker <Badge type="tip" text="Business" />
7+
# Deploy Plane Airgapped on Docker <Badge type="warning" text="Enterprise Grid" />
88

99
:::info
10-
Airgapped deployments are available exclusively for Business plan customers. Contact our [sales team](mailto:sales@plane.so) for pricing and licensing information.
10+
Airgapped deployments are available exclusively for Enterprise Grid customers with a minimum commitment of 100 seats. Contact our [sales team](mailto:sales@plane.so) for trials, tailor-made pricing for lesser seats, and license information.
1111
:::
1212

1313
This guide walks you through deploying Plane Commercial in an airgapped Docker environment using Docker Compose and pre-configured images from your private registry.

docs/self-hosting/methods/airgapped-requirements.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ keywords: plane airgapped requirements, air-gapped architecture, offline prerequ
77
# Airgapped deployment architecture
88

99
::: info
10-
Airgapped deployments are available exclusively for Business plan customers. Contact our [sales team](mailto:sales@plane.so) for pricing and licensing information.
10+
Airgapped deployments are available exclusively for Enterprise Grid customers with a minimum commitment of 100 seats. Contact our [sales team](mailto:sales@plane.so) for trials, tailor-made pricing for lesser seats, and license information.
1111
:::
1212

1313
This document explains Plane's architecture and specific requirements for airgapped deployments. Review this before beginning your airgapped installation on [Docker](/self-hosting/methods/airgapped-edition) or [Kubernetes](/self-hosting/methods/airgapped-edition-kubernetes).
@@ -18,6 +18,19 @@ An airgapped deployment operates in a completely isolated network environment wi
1818

1919
Plane supports fully airgapped deployments where all components - application services, databases, storage, and integrations - operate entirely within your isolated network perimeter.
2020

21+
## Deployment methods
22+
23+
Plane's Airgapped Edition can be deployed using Docker or Kubernetes. Choose the method that best fits your infrastructure.
24+
25+
<CardGroup>
26+
<Card title="Docker" icon="docker" href="/self-hosting/methods/airgapped-edition">
27+
Deploy on a single machine using Docker.
28+
</Card>
29+
<Card title="Kubernetes" icon="kubernetes" href="/self-hosting/methods/airgapped-edition-kubernetes">
30+
Deploy on a Kubernetes cluster using Helm charts.
31+
</Card>
32+
</CardGroup>
33+
2134
## Airgapped cluster architecture
2235

2336
Here's how Plane operates in an airgapped environment with internal enterprise applications:

0 commit comments

Comments
 (0)