Ark Console Installation Options

The Installation options dialog displays the deployment properties of the selected console. To open the dialog, right-click on a console name and select Installation options from the context menu.

The first tab of the Installation options dialog displays provider-specific details about the console deployment:

ARK server installation options dialog provider tab

The properties displayed may include:

Option Action
AWS cross account accesskey The Amazon access key ID associated with the AWS role that will be used for account.
AWS cross account secretkey The Amazon secret key associated with the AWS role that will be used for account administration.
Service account externalid The Amazon external ID that should be used by the Ark service user.
Service account rolearn The Amazon Role ARN (resource name) that should be used by the Ark service user when performing management functions on behalf of Ark.
Enable self registration If the Ark console should allow self-registration for Ark users.
Azure application registration ID The application ID associated with the Azure account that hosts the Ark console.
Azure active directory ID The directory ID associated with the Azure account that hosts the Ark console.
Azure storage account The Azure block storage account you wish to use with this Ark server.
Azure subscription ID The Azure account that hosts the Ark console.
Service account ID The name of the service account on the console’s backing database.
Service account password The password for the postgres user on the console’s backing database.

The General tab displays details about behavior related aspects of the console deployment:

ARK server installation options dialog general tab

The properties displayed may include:

Option Action
API timeout The number of minutes that an authorization token will be valid for use with the API.
Contact email address The email address that will be included in the body of cluster status notification emails.
Dashboard docs url The location of the content that will be displayed on the Dashboard tab of the Ark console.
Dashboard hot topics url The location of the content that will be displayed on the Dashboard tab of the Ark console.
Database backup tenant The name of the tenant in which the database backup will reside.
Database name The name of the console database.
Directory to store backups The directory in which backups will be stored.
Enable console switcher If the console should display console switcher functionality.
Enable PostgreSQL authentication If Ark will enforce the authentication method configured on the backing Postgres server.
Folder to store backups The name of the backup folder within the storage bucket.
Notification email The email address to which email notifications about the status of the Ark console will be sent.
Reply-to email address The return email address used on cluster status notification emails.
Template restrict new users Indicates if the Ark console will make any new user a Template Only user by default.
WAL archive container The name of the container in which WAL archives are stored.

The PEM integration tab displays details about behavior related to PEM:

ARK server installation options dialog pem tab

The properties displayed may include:

Option Action
PEM server mode The location of the PEM server; a LOCAL server resides on the monitored PEM instance, while a REMOTE server is on a different host.
PEM sync mode If enabled, all roles/groups/tenants that are accessible by the role that creates the console are added to the PEM server as a member of a non-login group role.
PEM synchronisation interval The number of minutes between PEM/Ark synchronisations.

The Console database backup tab displays details about backup behavior:

ARK server installation options dialog backup tab

The properties displayed may include:

Option Action
Backup script The complete path to the backup script on the console host.
Backup storage directory The complete path to the backup script on the console host.
Console backup folder The name of the console database.
Database name The name of the console database.
Database user name The name of the database superuser.
Backup storage directory The directory in which backups will be stored.
Folder to store backups The name of the backup folder within the storage bucket.
Storage bucket The name of the container in which backups will be stored.
Storage tenant The name of the tenant in which the database backup will reside.