Common Tasks

This section describes common tasks the DMS Administrator may need to perform as part of installation, configuration, deployment, or maintenace.

Updating a Configuration

The DMS Installer currently does not support configuring or updating specific inputs (fields/questions) or specific services. When the configuration is built, the entire questionnaire must be completed, for all services. Hence to do an update, the entire configuration must be built and deployed again.

The cluster can be stopped without destroying the data volumes, allowing you to deploy a new configuration without deleting the existing data (see Stopping Your Cluster).

The Overture roadmap includes a future feature enhancement to allow updates to specific service configurations. However, until such time, this is the update process that is supoprted. It is NOT recommended for an administrator manually edit the ~/.dms/config.yaml, because not all values can be modified and updated this way and may cause the cluster to be unrecoverable.

To update a configuration:

  1. Stop your cluster without destroying the data volumes:
$ dms cluster stop
Stopping cluster..
Finished stopping cluster
  1. Run the configuration questionnaire fresh and complete all sections and inputs like before (see here):
$ dms config build
<...and so on...>
  1. Deploy the updated configuration to your cluster:
$ dms cluster start
<...and so on...>
  1. Verify that the changes have been reflected.

Starting Your Cluster

Starting your cluster is equivalent to deploying your configurations from your current ~/.dms/config.yaml file to your cluster.

For details, see Deploying Your Cluster.

Stopping Your Cluster

In some scenarios you may need to stop your cluster and its services without deleting the data volumes. For example, to build and deploy an updated configuration

To stop your cluster without deleting volumes:

$ dms cluster stop
Stopping cluster..
Finished stopping cluster

Destroying Your Cluster

In some scenarios you may need to entirely destroy your cluster, its services, and all the data volumes. For example, to deploy the DMS platform from scratch with a new configuration and completely fresh data.

NOTE: The DMS platform does NOT currently support automatic backup of the data volumes are deployment. Although such a facility may be considered for DMS future releases, DMS administrators are currently responsible for determining and executing the most appropriate data backup strategy, as required.

  1. To destroy your cluster with a confirmation requested as a precaution:
$ dms cluster destroy
Starting cluster destruction: force=false
Are you sure you want to destroy the volumes for all services, all data will be lost and This is IRREVERSIBLE ? (Y/N) [N]:

To proceed, answer Y.

  1. However, to destroy your cluster forcefully without any confirmation requested:
$ dms cluster destroy -f
Starting cluster destruction: force=true
  1. In both scenarios, if cluster destruction proceeds and is successful, the following is displayed:
Forcefully destroying all volumes!
Finished cluster destruction
  1. You can verify that all services and volumes have been removed by checking that the docker service list is completely blank:
$ docker service ls

Customizing the Look of the Data Portal

Currently, only these parts of the Data Portal's look-and-feel can be customized:

  • The logo image displayed in the header of the Data Portal, beside the portal name
  • The name of the Data Portal displayed in the header, beside the logo

These items can only be customized as part of building a configuration via the interactive questionnaire. Customizing the logo is actually a prerequisite step to running the questionnaire, while customizing the portal name is done during the questionnaire itself. For details on how to perform these tasks, see these sections: