mirror of
https://github.com/portainer/portainer-docs.git
synced 2026-03-27 04:48:31 +07:00
GITBOOK-7: Add lifecycle policy and Portainer 1.x update instructions
This commit is contained in:
James Carppe
committed by
gitbook-bot
gitbook-bot
parent
a705914288
commit
4e9ccea6c7
BIN
.gitbook/assets/portainer-lifecycle-releases.png
Normal file
BIN
.gitbook/assets/portainer-lifecycle-releases.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 45 KiB |
@@ -8,6 +8,7 @@
|
||||
|
||||
* [Introduction](start/intro.md)
|
||||
* [Portainer architecture](start/architecture.md)
|
||||
* [Lifecycle policy](start/lifecycle.md)
|
||||
* [Requirements and prerequisites](start/requirements-and-prerequisites.md)
|
||||
* [Install Portainer BE](start/install/README.md)
|
||||
* [Set up a new Portainer BE Server installation](start/install/server/README.md)
|
||||
@@ -49,6 +50,7 @@
|
||||
* [Updating on Kubernetes](start/upgrade/kubernetes.md)
|
||||
* [Updating on Nomad](start/upgrade/nomad.md)
|
||||
* [Updating the Edge Agent](start/upgrade/edge.md)
|
||||
* [Updating from Portainer 1.x](start/upgrade/from-1.x.md)
|
||||
* [Switching to Portainer Business Edition](start/upgrade/tobe/README.md)
|
||||
* [Upgrade to Business Edition from within Portainer Community Edition](start/upgrade/tobe/inapp.md)
|
||||
* [Docker Standalone](start/upgrade/tobe/docker.md)
|
||||
@@ -321,7 +323,7 @@
|
||||
* [Portainer Academy](https://academy.portainer.io)
|
||||
* [YouTube](https://www.youtube.com/channel/UC7diMJcrULjDseq5yhSUZgg/videos)
|
||||
* [GitHub](https://github.com/orgs/portainer/discussions)
|
||||
* [Slack](https://join.slack.com/t/portainer/shared\_invite/zt-21zpww5ab-mG\_lA7UXbWL3HW3sPqjqEA)
|
||||
* [Slack](https://join.slack.com/t/portainer/shared_invite/zt-21zpww5ab-mG_lA7UXbWL3HW3sPqjqEA)
|
||||
* [Discord](https://discord.com/invite/j8fVken)
|
||||
* [Open a support request](https://www.portainer.io/portainer-business-support)
|
||||
|
||||
|
||||
@@ -28,6 +28,6 @@ Portainer runs exclusively on your servers, within your network, behind your own
|
||||
|
||||
While we do (optionally) collect anonymous usage analytics from Portainer installations, we remain compliant with GDPR. Data collection can be disabled when you install the product, or at any time after that. If your installation is air-gapped, collection will silently fail without any adverse effects.
|
||||
|
||||
{% content-ref url="requirements-and-prerequisites.md" %}
|
||||
[requirements-and-prerequisites.md](requirements-and-prerequisites.md)
|
||||
{% content-ref url="lifecycle.md" %}
|
||||
[lifecycle.md](lifecycle.md)
|
||||
{% endcontent-ref %}
|
||||
|
||||
104
start/lifecycle.md
Normal file
104
start/lifecycle.md
Normal file
@@ -0,0 +1,104 @@
|
||||
# Lifecycle policy
|
||||
|
||||
Portainer makes this policy public so customers and partners can effectively plan, deploy, and support their container management infrastructure effectively using Portainer. It is published in an effort to provide as much transparency as possible but Portainer has the discretion to make exceptions from this policy should that be in Portainer’s or our customer’s best interests.
|
||||
|
||||
Any release dates are provided for guidance only and the exact dates may change.
|
||||
|
||||
## The Portainer lifecycle
|
||||
|
||||
Portainer releases approximately follow a monthly cadence for minor releases (X.Y) which can introduce feature enhancements and new features but endeavor to maintain backward compatibility.
|
||||
|
||||
Micro or patch releases (X.Y.z) are released as needed and are limited to backward compatible bug fixes only.
|
||||
|
||||
Major versions (X) will be much less frequent, will include potential breaking changes, and may require an upgrade or migration process from previous versions.
|
||||
|
||||
All releases are cumulative - all previous enhancements and fixes are included in each release.
|
||||
|
||||
## Terminology
|
||||
|
||||
### Supported versus maintained
|
||||
|
||||
When we say “supported”, we are referring to the commercial support that is included with Portainer Business Edition subscriptions at the Scale and Enterprise level. This includes access to all STS and LTS releases and patches. Our [support terms](https://www.portainer.io/support-terms) have more detail on what is and isn’t covered by our support.
|
||||
|
||||
For Starter, Home & Student, our free Business Edition offerings, and our Community Edition, support is provided through our [community support channels](https://www.portainer.io/get-support-for-portainer).
|
||||
|
||||
The term “maintained” refers to the act of releasing updated versions of our releases, for example patches to resolve bugs or security issues. All editions of Business Edition and Community Edition will be maintained according to each release’s respective lifecycle.
|
||||
|
||||
Portainer always recommends updating to the latest version in the release stream to ensure you have the latest security fixes, bug fixes, and performance improvements. It is at Portainer’s discretion to backport fixes to any version outside of the supported version window.
|
||||
|
||||
### STS versus LTS
|
||||
|
||||
Portainer has two release streams, STS and LTS and it’s important you know the differences so you can choose accordingly.
|
||||
|
||||
#### **Short Term Support (STS) releases**
|
||||
|
||||
Short Term Support releases are identified with an “STS” suffix.
|
||||
|
||||
These are supported and maintained until the release of the next STS or LTS version. Use STS versions if you are interested in getting the latest features faster and don’t mind upgrading more frequently.
|
||||
|
||||
#### **Long Term Support (LTS) releases**
|
||||
|
||||
Long Term Support releases are identified with an “LTS” suffix.
|
||||
|
||||
These releases are supported and maintained until the release of the next LTS version plus a three month migration window so are more suitable for environments where adding new features on a frequent basis is less desirable.
|
||||
|
||||
{% hint style="info" %}
|
||||
Portainer LTS releases focus less on new features and more on stability so Portainer recommends LTS releases for production workloads.
|
||||
{% endhint %}
|
||||
|
||||
## Current and planned releases
|
||||
|
||||
Each stream (LTS and STS) will have a number of patch releases throughout it’s life.
|
||||
|
||||
### Current releases
|
||||
|
||||
| Release | Release Date | End of support/maintenance |
|
||||
| ------------ | ------------ | -------------------------- |
|
||||
| **2.21 LTS** | **Aug 2024** | **Jul 2025** |
|
||||
| 2.24 STS | Nov 2024 | Dec 2024 |
|
||||
|
||||
### Planned releases
|
||||
|
||||
| Release | Release Date | End of support/maintenance |
|
||||
| ------------ | ------------ | -------------------------- |
|
||||
| 2.25 STS | Dec 2024 | Jan 2025 |
|
||||
| 2.26 STS | Jan 2025 | Feb 2025 |
|
||||
| **2.27 LTS** | **Feb 2025** | **Nov 2025** |
|
||||
|
||||
<figure><img src="../.gitbook/assets/portainer-lifecycle-releases.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
Sitting on an older release that is no longer maintained or supported is strongly discouraged and customers take full responsibility for doing so. Customers are strongly encouraged to ensure they are running the latest patch release for a given stream.
|
||||
|
||||
## Older releases that are no longer supported or maintained
|
||||
|
||||
The following releases have passed the end of support date and are no longer maintained or supported. If you are using one of these versions (or older), we recommend that you [update](upgrade/) as soon as possible.
|
||||
|
||||
| Release | Release Date | End of support/maintenance |
|
||||
| -------- | ------------ | -------------------------- |
|
||||
| 2.17 | Feb 2023 | Apr 2023 |
|
||||
| 2.18 | Apr 2023 | Aug 2023 |
|
||||
| 2.19 | Aug 2023 | Aug 2024 |
|
||||
| 2.20 STS | Mar 2024 | Aug 2024 |
|
||||
| 2.22 STS | Sep 2024 | Oct 2024 |
|
||||
| 2.23 STS | Oct 2024 | Nov 2024 |
|
||||
|
||||
## Notes
|
||||
|
||||
Portainer uses the [semantic versioning scheme](https://semver.org/) and while Portainer endeavors to follow best practices, we reserve the right to make exceptions should that be in Portainer’s and our customer’s best interests.
|
||||
|
||||
For information on the available options and best practices for updating Portainer deployments, [refer to our update documentation](upgrade/).
|
||||
|
||||
{% content-ref url="requirements-and-prerequisites.md" %}
|
||||
[requirements-and-prerequisites.md](requirements-and-prerequisites.md)
|
||||
{% endcontent-ref %}
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
Always match the agent version to the Portainer Server version. In other words, when you're installing or updating to Portainer 2.24.0 make sure all of the agents are also on version 2.24.0.
|
||||
{% endhint %}
|
||||
|
||||
{% hint style="danger" %}
|
||||
If you are updating from the 1.x version of Portainer, you **must** first [update to 2.0.0](from-1.x.md) **before** updating to the newest version or you will run into issues.
|
||||
{% endhint %}
|
||||
|
||||
{% hint style="danger" %}
|
||||
Before beginning any update, we highly recommend [taking a backup](https://github.com/portainer/portainer-docs/blob/2.21/admin/settings/general/README.md#back-up-portainer) of your current Portainer configuration.
|
||||
{% endhint %}
|
||||
|
||||
75
start/upgrade/from-1.x.md
Normal file
75
start/upgrade/from-1.x.md
Normal file
@@ -0,0 +1,75 @@
|
||||
# Updating from Portainer 1.x
|
||||
|
||||
If you are updating a Portainer install that is currently running an image from the 1.x series, there are additional steps you must first take before updating to the most recent version. This document covers the steps depending on your current version - start from the instructions for your current version and work your way down.
|
||||
|
||||
* [Version 1.24.0 or older](from-1.x.md#updating-from-versions-older-than-1.24.1)
|
||||
* [Version 1.24.1 or 1.24.2](from-1.x.md#updating-from-1.24.1-and-1.24.2)
|
||||
|
||||
{% hint style="info" %}
|
||||
We only provide instructions for Docker Standalone and Docker Swarm environments here, as Portainer 1.x did not support Kubernetes environments.
|
||||
{% endhint %}
|
||||
|
||||
## **Updating from versions older than 1.24.1** <a href="#updating-from-versions-older-than-1.24.1" id="updating-from-versions-older-than-1.24.1"></a>
|
||||
|
||||
If you are running a version prior to 1.24.1, you must first update to `portainer/portainer:1.24.2`. Your other applications/containers will not be removed.
|
||||
|
||||
### Docker Standalone <a href="#docker-standalone" id="docker-standalone"></a>
|
||||
|
||||
Use the following commands to stop then remove the old version, then run Portainer release 1.24.2.
|
||||
|
||||
```
|
||||
docker stop portainer
|
||||
|
||||
docker rm portainer
|
||||
|
||||
docker run -d -p 8000:8000 -p 9000:9000 --name=portainer --restart=always -v /var/run/docker.sock:/var/run/docker.sock -v portainer_data:/data portainer/portainer:1.24.2
|
||||
```
|
||||
|
||||
### Docker Swarm <a href="#docker-swarm" id="docker-swarm"></a>
|
||||
|
||||
Run the following command to update the Portainer service to 1.24.2. This assumes your service is named `portainer_portainer` (you can confirm this by checking the output of `docker service ls`).
|
||||
|
||||
```
|
||||
docker service update --image portainer/portainer:1.24.2 --force portainer_portainer
|
||||
```
|
||||
|
||||
Verify that you are running version 1.24.2 by logging into Portainer and reading the version number on the bottom-left of the UI. You should now proceed to [update to version 2.0.0](from-1.x.md#updating-from-1.24.1-and-1.24.2).
|
||||
|
||||
## Updating from 1.24.1 and 1.24.2 <a href="#updating-from-1.24.1-and-1.24.2" id="updating-from-1.24.1-and-1.24.2"></a>
|
||||
|
||||
If you are running version 1.24.1 or 1.24.2 and want to update to the latest Portainer release, you must first update to `portainer/portainer-ce:2.0.0`. Use the following commands to stop then remove the old version. Your other applications/containers will not be removed.
|
||||
|
||||
### Docker Standalone <a href="#docker-standalone-1" id="docker-standalone-1"></a>
|
||||
|
||||
```
|
||||
docker stop portainer
|
||||
docker rm portainer
|
||||
```
|
||||
|
||||
Now that you have stopped and removed the old version of Portainer, you must ensure that you have the latest version of the 2.0.0 image locally. You can do this with a `docker pull` command:
|
||||
|
||||
```
|
||||
docker pull portainer/portainer-ce:2.0.0
|
||||
```
|
||||
|
||||
Finally, deploy the updated version of Portainer:
|
||||
|
||||
```
|
||||
docker run -d -p 8000:8000 -p 9000:9000 --name=portainer --restart=always -v /var/run/docker.sock:/var/run/docker.sock -v portainer_data:/data portainer/portainer-ce:2.0.0
|
||||
```
|
||||
|
||||
### Docker Swarm <a href="#docker-swarm-1" id="docker-swarm-1"></a>
|
||||
|
||||
Run the following command to update the Portainer service to 2.0.0. This assumes your service is named `portainer_portainer` (you can confirm this by checking the output of `docker service ls`).
|
||||
|
||||
```
|
||||
docker service update --image portainer/portainer-ce:2.0.0 --force portainer_portainer
|
||||
```
|
||||
|
||||
Portainer CE 2.0.0 will now be deployed on your system, using the persistent data from the previous version, and will also update the Portainer database to the new version.
|
||||
|
||||
When the deployment is finished, go to `http://your-server-address:9000` and log in. Verify that you are running version 2.0.0 by logging into Portainer and reading the version number on the bottom-left of the UI.
|
||||
|
||||
## Updating from 2.0.0 <a href="#updating-from-2.0.0" id="updating-from-2.0.0"></a>
|
||||
|
||||
Once you have updated to 2.0.0 you can proceed with the [standard update instructions](./) for your platform, or if you are moving to Business Edition you can follow the [upgrade instructions](tobe/).
|
||||
@@ -10,6 +10,10 @@ Starting from Portainer CE 2.9 and BE 2.10, HTTPS is enabled by default on port
|
||||
Before you make Portainer HTTPS only, make sure you have all your Agents and Edge Agents already communicating with Portainer using HTTPS. 
|
||||
{% endhint %}
|
||||
|
||||
{% hint style="danger" %}
|
||||
If you are updating from the 1.x version of Portainer, you **must** first [update to 2.0.0](from-1.x.md) **before** updating to the newest version or you will run into issues.
|
||||
{% endhint %}
|
||||
|
||||
{% hint style="danger" %}
|
||||
Before beginning any update, we highly recommend [taking a backup](../../admin/settings/#backup-portainer) of your current Portainer configuration.
|
||||
{% endhint %}
|
||||
|
||||
Reference in New Issue
Block a user