Merge pull request #117 from samdulam/upgrade-docs

Upgrade documentation provided by Sam
pull/118/head
Anthony McMahon 2021-02-05 13:58:09 +13:00 committed by GitHub
commit 80c484a396
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 171 additions and 0 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 87 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 44 KiB

View File

@ -0,0 +1,40 @@
# Upgrade a Stanalone Docker Deployment
### Docker Standalone
Assuming you've used our recommended deployment scripts: when upgrading to the latest version of Portainer, use the following commands:
```shell
docker stop portainer
```
```shell
docker rm portainer
```
Those 2 commands will stop and remove the container respectively. Doing this will NOT remove your other applications/containers/etc.
Now that you have stopped and removed the old version of Portainer, you can run this command
<pre><code> > 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</code></pre>
That will deploy the newest version of Portainer on your system, using the persistent data and upgrade the DB
Now you can go to http://your-server-address:9000 and login. You should notice that the bottom left corner looks different than it did before. There is no more update nag and the version is no longer shown next to the Portainer logo.
### Agent Only Upgrade
When upgrading to the latest version of Portainer Agent, use the following commands:
```shell
docker stop portainer_agent
```
```shell
docker rm portainer_agent
```
Those 2 commands will stop and remove the container respectively. Doing this will NOT remove your other applications/containers/etc.
Now that you have stopped and removed the old version of Portainer Agent, you can run this command
```shell
docker run -d -p 9001:9001 --name portainer_agent --restart=always -v /var/run/docker.sock:/var/run/docker.sock -v /var/lib/docker/volumes:/var/lib/docker/volumes portainer/agent
```

View File

@ -0,0 +1,88 @@
# Upgrade Kubernetes Deployment
Steps to upgrade Portainer and or Portainer agent deployed into Kubernetes. Upgrade method depends on the original install method used.
## Using Helm
Add Portianer helm repo running the following, ignore any warning about the repo being there already.
```shell
helm repo add portainer https://portainer.github.io/k8s/
```
```shell
helm repo update
```
Run the command below to upgrade to latest version of Portainer
```shell
helm upgrade -n portainer portainer portainer/portainer --reuse-values
```
<!-- #### For NodePort
Using the following command, Portainer will run in the port 30777
```shell
helm upgrade -n portainer portainer portainer/portainer
```
#### For Load Balancer
Using the following command, Portainer will run in the port 9000.
```shell
helm upgrade -n portainer portainer portainer/portainer --set service.type=LoadBalancer
```
#### For Ingress
<pre><code> helm install -n portainer portainer portainer/portainer --set service.type=ClusterIP</code></pre> -->
## Using YAML Manifest
### Method 1:
Easiest way to upgrade is to use Portainer UI and use manifest files..
Copy the contents of manifest file from
#### For NodePort
```shell
https://raw.githubusercontent.com/portainer/k8s/master/deploy/manifests/portainer/portainer.yaml
```
> ##### Agent Only
> https://raw.githubusercontent.com/portainer/k8s/master/deploy/manifests/agent/portainer-agent-k8s-nodeport.yaml
#### For LoadBalancer
```shell
https://raw.githubusercontent.com/portainer/k8s/master/deploy/manifests/portainer/portainer-lb.yaml
```
> ##### Agent Only
> https://raw.githubusercontent.com/portainer/k8s/master/deploy/manifests/agent/portainer-agent-k8s-lb.yaml
Login to portainer, in Kubernetes endpoint where portainer is installed go to Applications --> Advanced Deployment. Paste the yaml content.
![alt Manifest Deployment](assets/k8s-manifest-nodeport.png "Manifest Deployment")
Paste the yaml content and click Deploy.
Portainer should come back to a login page in a few seconds.
![alt Manifest Deployment](assets/k8s-manifest-deploy.png "Manifest Deployment")
### Method 2:
#### For NodePort
```shell
kubectl apply -n portainer -f https://raw.githubusercontent.com/portainer/k8s/master/deploy/manifests/portainer/portainer.yaml
```
#### For Load Balancer
```shell
kubectl apply -n portainer -f https://raw.githubusercontent.com/portainer/k8s/master/deploy/manifests/portainer/portainer-lb.yaml
```
Now you can go to portainer url and login. You should notice that the bottom left corner looks different than it did before. There is no more update nag and the version is no longer shown next to the Portainer logo.

View File

@ -0,0 +1,22 @@
# Upgrade a Docker Swarm Deployment
### Docker Swarm
Steps to upgrade Portainer and or Portainer agent deployed into Dcoker Swarm as a service.
Run the following on manager node of your docker swarm cluster
<pre><code>docker service ls </code></pre>
![alt dcokerservice](assets/docker service ls.png "Docker Service List")
Make note of the service names for Portainer
To upgrade Portainer to the latest version, run the command below (You may need to replace Service Name portainer_portainer to match your setup)
<pre><code>docker service update --image portainer/portainer-ce --force portainer_portainer </code></pre>
To upgrade Portainer Agent to the latest version, run the command below (You may need to replace Service Name portainer_agent to match your setup)
<pre><code>docker service update --image portainer/agent --force portainer_agent </code></pre>
That will deploy the newest version of Portainer on your system, using the persistent data and upgrade the DB
Now you can go to http://your-server-address:9000 and login. You should notice that the bottom left corner looks different than it did before. There is no more update nag and the version is no longer shown next to the Portainer logo.

View File

@ -0,0 +1,16 @@
# Portainer Version Upgrade Path
We have tested and validated Portainer Version Upgrade from 1.24.0 to the latest (2.1.1). Although un-tested, it is possible an upgrade path that has not been validated might work.
You are recommended to test any upgrade path, validated or non-validated on an non critical system before applying it to your active production systems.
You can find Requirements for different versions of Portainer [here](../../deploy/requirements/)
Upgrade Instructions for different deployments below...
[Docker](../upddocker/)
[DockerSwarm](../updswarm/)
[Kubernetes](../updk8s/)

View File

@ -12,6 +12,11 @@ nav:
- 'Deploying on Windows 10' : 'v2.0/deploy/windows10.md'
- 'Using SSL with Portainer' : 'v2.0/deploy/ssl.md'
- 'Initial Setup' : 'v2.0/deploy/initial.md'
- Upgrading Portainer:
- 'Upgrade Path': 'v2.0/upgrade/upgrade.md'
- 'Upgrading on Docker': 'v2.0/upgrade/upddocker.md'
- 'Upgrading on DockerSwarm': 'v2.0/upgrade/updswarm.md'
- 'Upgrading on Kubernetes': 'v2.0/upgrade/updk8s.md'
- Managing Endpoints:
- 'Add Local Endpoint' : 'v2.0/endpoints/local.md'
- 'Add Docker Endpoint' : 'v2.0/endpoints/docker.md'