-
Notifications
You must be signed in to change notification settings - Fork 10
Update Airgapped Edition #255
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
47 changes: 47 additions & 0 deletions
47
docs/self-hosting/manage/update-plane/airgapped-edition/update-airgapped-docker.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| --- | ||
| 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. | ||
| keywords: plane airgapped upgrade, air-gapped docker upgrade, plane offline update | ||
| --- | ||
|
|
||
| # 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. 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. | ||
|
|
||
| :::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. | ||
53 changes: 53 additions & 0 deletions
53
...lf-hosting/manage/update-plane/airgapped-edition/update-airgapped-kubernetes.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| --- | ||
| title: Upgrade Airgapped Edition on Kubernetes | ||
| description: Upgrade your airgapped Plane instance running on Kubernetes by cloning images, updating the Helm chart, and redeploying. | ||
| keywords: plane airgapped kubernetes upgrade, air-gapped helm chart upgrade, plane offline k8s update | ||
| --- | ||
coderabbitai[bot] marked this conversation as resolved.
Show resolved
Hide 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). | ||
| ::: | ||
|
|
||
| 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. | ||
|
|
||
| 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. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.