Addons /
Addon Configuration
The Addon header contains information about the type, version, storage capacity, and status. You can Redeploy or Pause the Addon using the buttons:
Redeploy
You can manually redeploy the running instances of the Addon, which will deploy new instances and terminate the current instances.
Pause
You can Pause an Addon which will terminate all running instances of the Addon. This will not affect the Addon's storage, and you will still be billed for the volume usage. To remove an Addon completely, go to Billing. Addons can easily be restarted using the Resume button.
Connection details
Displays the user connection strings for your Addon, depending on type.
Click View all or go to Connection details to view connection strings and secrets.
Containers
Displays the running Containers for your Addon. Click View all or go to Containers to see more.
Displays connection strings and secrets that can be used to connect and access your Addon. Values can be unhidden and hidden by clicking the eye icon, and copied by clicking the box containing the value.
For the majority of Addons there are two user types:
User: This user only has read/write access to the initially created user database. You should use this account to connect to the Addon in your application.
Administrator: has full administrator rights to all user databases and slightly reduced rights to system databases. You can use this account for database administration, e.g. to create a new database, but you should not use it to connect services to the Addon.
You can manage backups of your database from the Backups page.
important
Redis and MinIO Addons currently do not support backups.Create a backup
- Click Create Backup in the Backups page
- Enter a name for your backup, or use the default
- Click Create Backup
The backup will be scheduled for creation, check the Backups page to view its status.
Import backup
You can import a backup you have previously downloaded, or restore from another source.
important
You should always create a new backup of your data before restoring.You can import backup from the following sources:
URL
You can restore a backup from a file by providing the URL to the hosted file, for example https://yourdomain.com/backups/data.db.gz. The file must end in .gz, but does not necessarily need be a zipped archive.
Please note:
- All existing user databases will be removed. The default admin and access users and system databases will not be affected.
- All databases from the backup source will be imported
- The default admin and access users will have full access to the imported database. If these users have been deleted they will be recreated before restoring.
- If the source includes user manipulation commands (create user, grant permissions), they will be executed unless they grant too many rights
Connection string
You can restore from another database by providing a connection string with relevant credentials and parameters.
Please note:
- All existing user databases will be removed. The default admin and access users and system databases will not be affected.
- All databases, except users, from the backup source will be imported (depending on the access of the specified user when importing by connection string)
- The default admin and access users will have full access to the imported database. If these users have been deleted they will be recreated before restoring.
| Application | Connection string syntax example |
|---|---|
| MongoDB | mongodb://user:password@mongodb0.yourdomain.com:port |
| Redis | Currently unsupported |
| MySQL | mysql://user:password@yourdomain.com:port |
| PostgreSQL | postgresql://user:password@yourdomain.com:port |
| MinIO | Currently unsupported |
How to import a backup
important
When you import a backup, it will immediately schedule a restoration with the provided data.- Click Import backup in the top-right of the Backups page
- Enter a name for your backup, or use the default
- Select the source to import from, URL or Connection string
- Enter the URL or Connection string for the backup you want to restore from
- Click Import backup
Your imported backup is now scheduled for restoration and will appear in the list of backups.
Manage backups
The Backups page will display a list of backups with the name, status, completion time, size, number of restores, creation date, and controls. You can click on the entry in the list to view the restore history, view the logs of each restoration, and abort scheduled restorations. You can access the following controls using the buttons on each entry:
Logs
Displays the logs of the backup.
Download
Download the backup as a gzip (.gz) archive file.
Restore
Select to restore from this backup. Your backup will be scheduled and executed shortly.
Delete
Removes the backup.
You can set the resources dedicated to your Addon in the Resources page.
note
Addons require minimum resources and some plans may not be available.Resources
Select your desired plan with the vCPU power and RAM to deploy in each of your replicas for the Addon. You should consider increasing this if your Addon is taking a long time to respond to requests.
Storage
You can set the amount of storage available to your Addon. You should increase this if you are running out of space.
Replica count
You can select the number of replica sets your Addon will use to increase availability.
Replica sets contain a copy of the database to improve availability.
In the case of MongoDB: if a primary node becomes unavailable one of the replica nodes will be promoted to primary, supporting read/write operations.
In the case of Redis, Postgres, and MySQL: if a primary node becomes unavailable only read operations will be supported by replica nodes. Write operations will only be restored once the primary node is restored.
MinIO uses a forward error correction algorithm for optimal storage usage. Half of the replicas can become unavailable before the addon becomes inaccessible. MinIO does not support the scaling of replicas on a running Addon.