- Provisioning the Addon
- Advanced Postgres with PG Plugin
All postgresql plans are maintained and backed up automatically, to provision a new postgresql instace use the service
akkeris-postgresql. The postgres plans are spread across different tiers: hobby, standard and premium. To choose a plan you may
want to consider the following:
- How much planned downtime is acceptable? Hobby instances may have up to 4 hours a month, which may be acceptable, even in production depending on your workload.
- How complex are the queries in your app? If its typical join, orders of a few tables, a lower plan hobby or standard (0 or 1) would be fine. For reporitng purposes where aggregation and complex sub-queries are needed you may want to consider a high memory system such as a premium-1.
- What storage requirements do you have? Applications with large amounts of data should consider picking a standard (1 or 2) plan.
- Does your data have compliance requirements (e.g., does it contain PII)? If your application has special compliance needs see the on-premises plans.
Standard & Hobby Instances
The hobby tier is great for systems like blogs and tooling apps (such as a header dump) and light-weight apps. Standard tier is great for some smaller production applications and development systems. Hobby databases are not encrypted, however all standard instances are both are highly available and burstable. You should not use hobby or standard instances if you require creating extensions, access as a postgres super user or the ability to create read replicas, and access database logs.
|Rollback||None||1 Day||4 Days||4 Days|
Premium instances are dedicated postgres servers, they provide superuser access in addition to more control over the database. Premium instances are great for production apps that require extensions or super user database access. They're also great for systems that consistently use a high amount of database CPU and I/O. Premium instances include the ability to restart the database, fetch logs, create extensions and create read replicas. While premium's are always dedicated instances, premium instances are not burstable (unlike standard instances).
|Rollback||1 Day||4 Days||4 Days|
Postgres V9, V10 and V11
Different postgres database engine versions are available with plans that have the version as a suffix, such as
-v9 depending on the current default version.
Provisioning the Addon
aka addons:create akkeris-postgresql:[hobby|standard-0|standard-1|standard-2|premium-0|premium-1|premium-2] -a [app-space]
Once provisioned, the postgres database url in the format of
postgres://user:email@example.com:5432/dbname is added as the config var
DATABASE_URL to the app.
If your app's requirements eventually outgrow the resources provided by the initial plan you select, you can upgrade your database as well (note, this may result in a small amount of downtime). To upgrade your database retrieve the ID of the addon from
aka addons -a [app-space]. Then run the upgrade with the new plan as the option
aka addons:upgrade -a [app-space] a3bf4f1b-2b0b-822c-d15d-6c15b0f00a08 akkeris-postgresql:premium-0. If the addon
a3bf4f1b-2b0b-822c-d15d-6c15b0f00a08 in the example before was a standard-0 it would be upgraded to a dedicated premium-0.
Apps are placed into maintence mode while the applications database is upgraded.
In addition to upgrading you can downgrade a plan using
aka addons:downgrade, note if their is insufficient space to downgrade your plan the operation will fail and revert back to the existing plan.
Advanced Postgres with PG Plugin
pg plugin allows users to perform advanced analysis and admninistration of postgres databases. Before starting ensure you have the postgres database plugin installed by running:
aka plugins:install pg
This is not an exhaustive list of commands, but the popular ones. There are dozens of commands to inspect statistics and metrics from queries as well. See the pg plugin help via
aka --help for more information.
List available backups (amount depends on your database plan). This feature is not available on standard or hobby instances.
aka pg:backups -a app-space
Creating a Backup
Immediately capture a database backup. This feature is not available on standard or hobby instances. This may cause passive database table locks during the backup.
aka pg:backups:capture -a app-space
Restoring a Backup
Note: You can get the
[backup id] below from the
aka pg:backups command. This command is only available on premium instances.
aka pg:backups:restore [backup id] -a app-space
Get Database Logs
Pull the last day of logs from a postgres premium instance. Note that this feature is not available on hobby or standard instances.
aka pg:logs -a app-space
Restart a database. Note this feature is not available on hobby or standard instances.
aka pg:restart -a app-space
Create Read Only Credentials
Create read only credentials for a postgres database (even for
prod spaces). This is available on all database plans.
aka pg:credentials:create -a app-space
Remove Read Only Credentials
Once your finished you can remove them by running. This is available on all database instance types.
aka pg:credentials:destroy -a app-space [credential name]