Portainer Business Edition
Learn how store Portainer Business Edition backups on the ScPrime distributed datacenter using the XNS Relayer
Overview
Portainer Business Edition is a universal container management tool that helps users deploy and manage container-based applications. Portainer Business Edition can use S3 protocol targets to store Portainer backups, so it makes a good match for XNS storage.
Read this guide for how to configure Portainer Business Edition to store Portainer backups with XNS.
Prerequisites
- A working instance of Portainer Business Edition
- A working instance of the XNS Relayer
- Configured XNS Relayer Endpoint Access Key and Endpoint Secret Key
Considerations
- Portainer Business Edition requires a valid SSL certificate to use the XNS Relayer as an HTTPS endpoint. Please configure the XNS Relayer with a valid SSL certificate or change the Endpoint Certificate Type to not require SSL. These settings can be accessed in the Relayer UI by going to Configuration > General Configuration and editing the Select Endpoint Certificate Type setting to ‘No SSL’.
Application Version Used in Guide
Portainer Business Edition 2.17.1
Setup Guide
Step 1: Open Settings
Open Portainer Business Edition and click on Settings.
Step 2: Configure the Backup
Scroll to the “Backup Portainer” section of Settings. Then click on Store in S3. After you have completed configuring your backup, click Export backup.
| Schedule automatic backups | Enable this to schedule an automatic backup of your configuration. | |
| Cron Rule | If you have enabled automatic backups, you will have to define how often you want the backup to run using the cron format.
For example, the following would run a backup at 3:41AM every Tuesday:
| |
| Access Key ID | [Endpoint Access Key (Username)] | This is defined in the XNS Relayer General Configuration. |
| Secret Access Key | [Endpoint Secret Key (Password)] | This is defined in the XNS Relayer General Configuration. |
| Region | Leave blank | |
| Bucket Name | [Your Bucket Name] | Enter the name of your S3 bucket. This Bucket must be configured on the XNS Relayer first. |
| S3 compatible host | http(s)://[Your IP]:[S3 API port (9000)] | The location of the XNS Relayer. The use of HTTP and HTTPS must align to the settings on the XNS Relayer. Portainer Business Edition requires a valid SSL certificate. If you do not have a valid SSL certificate, use ‘No SSL’ option in XNS Relayer and use HTTP in Portainer Business Edition as this example shows. n.b., Portainer Business Edition can be configured to encrypt data prior to sending over the network to mitigate the usage of HTTP. |
| Password protect | Enable this to protect your backups with a password. | |
| Password | Enter the password to set on your backups. |
Step 3: Validate Successful Backup
If your backup configuration works, a “Success” message will appear. You can then save your configuration by clicking Save backup settings.
