Creating an Ark User Template

A template contains a predefined set of server options that determine the configuration of a database cluster. A template can simplify creation of clusters that use a common configuration, or limit user access to costly resources such as large server classes.

You must be an administrative user to create a template.

An administrative user can specify that a user is a template only user. A template only user must adhere to cluster definitions provided in a template when deploying an Ark cluster. A template only user will have access to only those templates that specify a role or tenant in which they have membership in the Select Roles (on Amazon or Azure) or Select Tenants (on OpenStack) section of the Add Template dialog.

If a user is specified as a Template Only user:

  • They must use a template when deploying a cluster.
  • They will be restricted to the scaling policies defined in the template.
  • They cannot modify a manually-defined cluster created by another user.
  • They can only create clusters in a server class that exists in an available template.
  • They must use a template when cloning or restoring from backup.
  • They may only delete backups of template created clusters.
  • They may not delete last backup of a template created cluster if the cluster had been deleted (removing the last artifact of any cluster).

To define a new template, right click on the Templates node, and select Create then Templates… from the context menu.

ARK create template general tab

Use fields on the General tab to specify general behavioral preferences for the template:

  • Provide a user-friendly name for the template in the Template name field.
  • Use the Description field to provide a description of the template.
  • Use the drop-down listbox in the Engine version field to select the version of the Postgres engine that you wish to use on clusters configured by the template.
  • Use the drop-down listbox in the Server class field to specify the size of each cluster node. The server class determines the size and type (compute power and RAM) of any cluster configured by the template.
  • If your cluster resides on an OpenStack host, use the drop-down listbox in the Virtual network field to specify the identity of the network in which clusters configured by the template should reside.
  • If your cluster resides on an Amazon AMI, use the drop-down listbox in the VPC field to specify the identity of the network in which clusters configured by the template should reside.
  • If your cluster resides on an OpenStack host, use the drop-down listbox in the Floating IP pool field to select the address pool in which clusters configured by the template should reside.
  • Use the drop-down listbox in the Number of nodes field to specify the number of nodes that should be created in each cluster.
  • Use the Storage GB field to specify the initial size of the data space (in Gigabytes).
  • Set the Disabled slider to Yes to indicate that the template is disabled.
ARK create template backup retention tab

Use fields on the Backup Retention tab to specify the backup policies that will be applied for the template:

  • Use the Number of automatic backups to retain field to specify the number of backups that will be retained for the cluster. When the specified number of server backups is reached, EDB Ark will delete the oldest backup to make room for a new backup.
  • Use the Backup Window drop-down listbox to specify a time that it is convenient to perform a cluster backup.
  • Set the Continuous Archiving (Point-in-Time Recovery) slider to Yes to enable point-in-time recovery for the cluster. When enabled, a base backup is automatically performed that can to be used to restore to a specific point in time. All subsequent automatic scheduled backups will also support point-in-time recovery.
ARK create template availablity tab

Use the Availability tab to specify the users that will have access to the template:

  • Specify one or more tenants, roles, or groups that will be allowed to use the template in the Available to tenant/role/group field.
ARK create template advanced tab

Use fields on the Advanced tab to specify additional template policies:

  • Set the Encrypted slider to Yes to indicate that the cluster should be encrypted. EDB Ark uses the aes-xts-plain (512-bit) cipher suite to provide an encryption environment that is both secure and transparent to connecting clients. When encryption is enabled, everything residing on the cluster is encrypted except for the root filesystem.
  • Set the Perform OS and Software update slider to Yes to specify that a software update should be performed whenever the cluster is provisioned. Please note: this option is disabled if the cluster uses a statically provisioned server.
  • Use the Scaling Options sliders to indicate which options will be available to template users: * Set the Manually scale replicas slider to Yes to specify that users of this template will be allowed to manually scale replica nodes configured by this template. * Set the Manually scale storage slider to Yes to specify that users of this template will be allowed to manually scale storage on clusters configured by this template. * Set the Auto scale replicas slider to Yes to specify that users of this template will be able to configure automatic node scaling for clusters configured by this template. * Set the Auto scale storage slider to Yes to specify that users of this template will be able to configure automatic storage scaling for clusters configured by this template.