backup and restore docs
Sam Dulam
parent
2cf30b070f
commit
03d18c59ab
Binary file not shown.
|
After Width: | Height: | Size: 24 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 82 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 99 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 84 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 88 KiB |
|
|
@ -0,0 +1,78 @@
|
|||
# :material-backup-restore: Backup Portainer
|
||||
|
||||
!!! Note "**Backup and Restore** feature is introduced in Portainer Business Version 2.4"
|
||||
|
||||
Backup includes all information that Portainer stores on the /data volume, archived in a tar.gz file and optionally encrypted with a provided password. This archive is all you need to restore Portainer.
|
||||
|
||||
Logged in as an Admin, you will find the Backup option under Settings menu in Portainer. You have several options for backups; i.e., Backup to local disk, Manual Backup to S3 and Automated Scheduled Backups to S3.
|
||||
|
||||
## :material-harddisk: Backup to Local Disk
|
||||
|
||||
!!! Abstract ""
|
||||
|
||||
|
||||
Login as an Admin User into Portainer
|
||||
|
||||
Click on Settings in the menu
|
||||
|
||||
Scroll down to Backup Portainer Option
|
||||
|
||||
**Download backup file** is the default option, you can toggle the Password protect on and enter a password to encrypt the backup file
|
||||
|
||||
Click on **Download backup**
|
||||
|
||||
*A tar.gz file will be downloaded through your browser.*
|
||||
|
||||
|
||||
## :fontawesome-brands-aws: Manual Backup to S3
|
||||
|
||||
!!! Abstract ""
|
||||
|
||||
|
||||
Login as an Admin User into Portainer
|
||||
|
||||
Click on Settings in the menu
|
||||
|
||||
Scroll down to Backup Portainer Option
|
||||
|
||||
Select **Store in S3** option
|
||||
|
||||
Enter Access Key ID, Secret Access Key, Region and Bucket name for your S3 storage
|
||||
|
||||
Optionally, Enable Password protect and enter a password to protect the backup (recommended)
|
||||
|
||||
Click **Export backup** to export the backup file to S3 Bucket
|
||||
|
||||
|
||||
|
||||
|
||||
## :material-calendar-multiselect: Scheduled Backups to S3
|
||||
|
||||
!!! Abstract ""
|
||||
|
||||
|
||||
|
||||
Login as an Admin User into Portainer
|
||||
|
||||
Click on Settings in the menu
|
||||
|
||||
Scroll down to Backup Portainer Option
|
||||
|
||||
Select **Store in S3** option
|
||||
|
||||
Enable Schedule automatic backups and enter a Cron rule for your schedule
|
||||
|
||||
Enter Access Key ID, Secret Access Key, Region and Bucket name for your S3 storage
|
||||
|
||||
Optionally, Enable Password protect and enter a password to protect the backup (recommended)
|
||||
|
||||
Click **Save backup settings** to save the schedule.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## :material-note-text: Notes
|
||||
|
||||
[Contribute to these docs](https://github.com/portainer/portainer-docs/blob/master/contributing.md){target=\_blank}
|
||||
|
|
@ -0,0 +1,43 @@
|
|||
# :material-backup-restore: Restore Portainer
|
||||
|
||||
!!! Note "**Backup and Restore** feature is introduced in Portainer Business Version 2.4"
|
||||
|
||||
Restore could be only performed on a fresh instance of Portainer, during its' initialization stage. When you need to restore portainer, deploy a fresh instance of Portainer with an empty data volume and choose the **Restore Portainer from backup** option on the initialization page of the new instance. You can perform a restore from either a file available locally or direct from S3 bucket.
|
||||
|
||||
## :material-harddisk: Restore from local file
|
||||
|
||||
!!! Abstract ""
|
||||
|
||||
|
||||
On the initialization page, expand Restore Portainer from backup option
|
||||
|
||||
Click on **Select file**, browse to and select the tar.gz backup file
|
||||
|
||||
Enter the password if the backup was originally encrypted
|
||||
|
||||
Click **Restore Portainer**
|
||||
|
||||
*Restore may take a few moments. Once complete you will be redirected to the login page. You should now be able to login with your previous credentials. All your Portainer config should be restored.*
|
||||
|
||||
|
||||
## :fontawesome-brands-aws: Restore from S3
|
||||
|
||||
!!! Abstract ""
|
||||
|
||||
On the initialization page, expand Restore Portainer from backup option
|
||||
|
||||
Click on **Retrieve from S3** option
|
||||
|
||||
Enter the details to retrieve backup file from S3 bucket
|
||||
|
||||
Enter the password if the backup was originally encrypted
|
||||
|
||||
Click **Restore Portainer**
|
||||
|
||||
*Restore may take a few moments. Once complete you will be redirected to the login page. You should now be able to login with your previous credentials. All your Portainer config should be restored.*
|
||||
|
||||
|
||||
|
||||
## :material-note-text: Notes
|
||||
|
||||
[Contribute to these docs](https://github.com/portainer/portainer-docs/blob/master/contributing.md){target=\_blank}
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 24 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 82 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 99 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 84 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 88 KiB |
|
|
@ -0,0 +1,30 @@
|
|||
# :material-backup-restore: Backup Portainer
|
||||
|
||||
!!! Note "**Backup and Restore** feature is introduced in Portainer CE Version 2.5"
|
||||
|
||||
Backup includes all information that Portainer stores on the /data volume, archived in a tar.gz file and optionally encrypted with a provided password. This archive is all you need to restore Portainer.
|
||||
|
||||
Logged in as an Admin, you will find the Backup option under Settings menu in Portainer.
|
||||
|
||||
## :material-harddisk: Backup to Local Disk
|
||||
|
||||
!!! Abstract ""
|
||||
|
||||
|
||||
Login as an Admin User into Portainer
|
||||
|
||||
Click on Settings in the menu
|
||||
|
||||
Scroll down to Backup Portainer Option
|
||||
|
||||
**Download backup file** is the default option, you can toggle the Password protect on and enter a password to encrypt the backup file
|
||||
|
||||
Click on **Download backup**
|
||||
|
||||
*A tar.gz file will be downloaded through your browser.*
|
||||
|
||||
|
||||
|
||||
## :material-note-text: Notes
|
||||
|
||||
[Contribute to these docs](https://github.com/portainer/portainer-docs/blob/master/contributing.md){target=\_blank}
|
||||
|
|
@ -0,0 +1,25 @@
|
|||
# :material-backup-restore: Restore Portainer
|
||||
|
||||
!!! Note "**Backup and Restore** feature is introduced in Portainer CE Version 2.5"
|
||||
|
||||
Restore could be only performed on a fresh instance of Portainer, during its' initialization stage. When you need to restore portainer, deploy a fresh instance of Portainer with an empty data volume and choose the **Restore Portainer from backup** option on the initialization page of the new instance.
|
||||
|
||||
## :material-harddisk: Restore from local file
|
||||
|
||||
!!! Abstract ""
|
||||
|
||||
|
||||
On the initialization page, expand Restore Portainer from backup option
|
||||
|
||||
Click on **Select file**, browse to and select the tar.gz backup file
|
||||
|
||||
Enter the password if the backup was originally encrypted
|
||||
|
||||
Click **Restore Portainer**
|
||||
|
||||
*Restore may take a few moments. Once complete you will be redirected to the login page. You should now be able to login with your previous credentials. All your Portainer config should be restored.*
|
||||
|
||||
|
||||
## :material-note-text: Notes
|
||||
|
||||
[Contribute to these docs](https://github.com/portainer/portainer-docs/blob/master/contributing.md){target=\_blank}
|
||||
|
|
@ -10,15 +10,15 @@ To try and alleviate confusion as to what we test against, we have documented th
|
|||
|
||||
## :fontawesome-solid-check-double: Validated Configurations
|
||||
|
||||
| Portainer Version | Release Date | Docker Version | Kubernetes Version | Architectures | Operating Systems |
|
||||
|--------------------------|----------------|----------------|------------------------------|----------------------|----------------------------------------------------------------------------------------------------------|
|
||||
| Portainer Version | Release Date | Docker Version | Kubernetes Version | Architectures | Operating Systems |
|
||||
|--------------------|--------------|----------------|--------------------|---------------|-------------------|
|
||||
| Community 2.5 (latest) | May 18, 2021 | 20.10.5 | 1.19 1.20.2 1.21 | ARM64, x86_64 | Ubuntu 21.04*, Ubuntu 18.04 LTS, Windows 10 (version 1809) + WSL2, Windows Server 2019 (version 1809) + Windows Containers |
|
||||
| 1.23.2 | March 25, 2020 | 19.03.6 | N/A | ARM32, ARM64, x86_64 | Windows 10 Windows Containers, WSL1 Windows Server 2019, Release 1809 Ubuntu 18.04 & CentOS7 |
|
||||
| 1.24.0 | June 2, 2020 | 19.03.10 | N/A | ARM32, ARM64, x86_64 | Windows 10 Windows Containers, WSL1 Windows Server 2019, Release 1809 Ubuntu 18.04 & CentOS7 |
|
||||
| 1.24.1. | July 23, 2020 | 19.03.12 | N/A | ARM32, ARM64, x86_64 | Windows 10 Windows Containers, WSL1 Windows Server 2019, Release 1809 Ubuntu 18.04 & CentOS 7 |
|
||||
| Community 2.0 | Aug 31, 2020 | 19.03.12 | 1.17.13 1.18.6 1.18.9 1.19.3 | ARM64, x86_64 | Windows 10 WSL2 "Docker Desktop Default Distro" Windows Server 2019 Release 1809 Ubuntu 18.04 |
|
||||
| Community 2.0.1 | Jan 7, 2021 | 20.10.0 | 1.17.13 1.18.9 1.19.3 1.20.0 | ARM64, x86_64 | Windows 10 WSL2 "Docker Desktop Default Distro" Windows Server 2019 release 1809 Ubuntu 18.04 |
|
||||
| Community 2.1.x | Feb 2, 2021 | 20.10.2 | 1.20.0 | ARM64, x86_64 | Windows 10 WSL2 "Docker Desktop Default Distro" Windows Server 2019 release 1809 Ubuntu 18.04 |
|
||||
| Community 2.0.1 | Jan 7, 2021 | 20.10.0 | 1.17.13 1.18.9 1.19.3 1.20.0 | ARM64, x86_64 | Windows 10 WSL2 "Docker Desktop Default Distro" Windows Server 2019 release 1809 Ubuntu 18.04 |
|
||||
| Community 2.0 | Aug 31, 2020 | 19.03.12 | 1.17.13 1.18.6 1.18.9 1.19.3 | ARM64, x86_64 | Windows 10 WSL2 "Docker Desktop Default Distro" Windows Server 2019 Release 1809 Ubuntu 18.04 |
|
||||
| 1.24.1. | July 23, 2020 | 19.03.12 | N/A | ARM32, ARM64, x86_64 | Windows 10 Windows Containers, WSL1 Windows Server 2019, Release 1809 Ubuntu 18.04 & CentOS 7 |
|
||||
| 1.24.0 | June 2, 2020 | 19.03.10 | N/A | ARM32, ARM64, x86_64 | Windows 10 Windows Containers, WSL1 Windows Server 2019, Release 1809 Ubuntu 18.04 & CentOS7 |
|
||||
| 1.23.2 | March 25, 2020 | 19.03.6 | N/A | ARM32, ARM64, x86_64 | Windows 10 Windows Containers, WSL1 Windows Server 2019, Release 1809 Ubuntu 18.04 & CentOS7 |
|
||||
|
||||
## :material-note-text: Notes
|
||||
|
||||
|
|
|
|||
|
|
@ -53,6 +53,9 @@ nav:
|
|||
- 'Enable Edge Computing' : 'v2.0/settings/edge.md'
|
||||
- 'App Templates' : 'v2.0/settings/apps.md'
|
||||
- 'Enable Host Management Features' : 'v2.0/settings/host_management.md'
|
||||
- Backup and Restore:
|
||||
- 'Backup': 'v2.0/backup/backup.md'
|
||||
- 'Restore': 'v2.0/backup/restore.md'
|
||||
- Advanced Deployments:
|
||||
- 'Using Portainer with Reverse Proxies':
|
||||
- 'Traefik' : 'v2.0/ad/traefik/rp-traefik.md'
|
||||
|
|
@ -102,6 +105,9 @@ nav:
|
|||
- 'Enable Edge Computing' : 'v2.0-be/settings/edge.md'
|
||||
- 'App Templates' : 'v2.0-be/settings/apps.md'
|
||||
- 'Enable Host Management Features' : 'v2.0-be/settings/host_management.md'
|
||||
- Backup and Restore:
|
||||
- 'Backup': 'v2.0-be/backup/backup.md'
|
||||
- 'Restore': 'v2.0-be/backup/restore.md'
|
||||
- Downgrading:
|
||||
- 'Downgrade from BE to CE': 'v2.0-be/downgrade/be-to-ce.md'
|
||||
- Advanced Deployments:
|
||||
|
|
|
|||
Loading…
Reference in New Issue