Deploying the Management Console

This article describes the necessary steps for configuring and running the DuraCloud Management Console. The Management Console is a web application that enables users to manage DuraCloud account and user information as well as global configuration settings for a DuraCloud installation. More information about the capabilities of the DuraCloud Management Console is available here.

If you are not yet familiar with the DuraCloud Management Console please refer to the DuraCloud Architecture document, which describes how the Management Console fits into the DuraCloud ecosystem. 

Requirements

1. Java: Version 8 required
   
   1. The Oracle JDK is recommended for building DuraCloud, as this is the JDK used for DuraCloud testing.
2. Maven 3.x
3. Tomcat 8.x
4. Git
5. MySQL database
6. AWS account and credentials (allowing use of SES and SNS for notifications)

Download, Build, Configure

1. Check out latest stable release from the GitHub repository. Determine the release number of the latest stable release by going to https://github.com/duracloud/management-console/releases and making a note of the tag name of the most current release.

   git clone https://github.com/duracloud/management-console.git
   cd management-console
   git checkout <latest-release-tag>

2. Configure MySQL
   1. Create an empty MySQL database for the management console, with a user with read and write permissions.
   2. Create the database schema using management-console/resources/schema.sql (found in the management-console code baseline.)
3. Create a configuration file.
   1. Now that you've built the management console and created the database, we need to set up a configuration file that can be used by the various components of the system. A template of this configuration file can be found in the code at account-management-app/src/main/webapp/WEB-INF/config/mc-config.properties
      1. Copy the example mc-config.properties file to a permanent location

      2. Edit the file to configure the connections to the management console database and AWS (for notifications):

         ###################
         # MC DATABASE
         ###################
         # Config for the management console database - used to retrieve accounts and storage provider credentials
         db.host=[fill in]
         db.port=[fill in]
         db.name=[fill in]
         # User must have read permission
         db.user=[fill in]
         db.pass=[fill in]
          
         mc.host=<hostname>
         mc.port=443
         mc.context=<e.g. /ama> # leave blank if the mc is deployed in the root context.
         notification.user=<aws access key id>
         notification.pass=<aws secret key>
         notification.from-address=<email address>
         notification.admin-address=<admin email address>

4. Configure Tomcat

   1. Follow the instructions here under "Configure Tomcat"

5. On the command line, build the MC codebase

6. Create an SNS topic

   1. Log into the AWS account associated with the Management Console application.

   2. In SNS add a topic.
   3. Ensure that the AWS credentials associated with the Management Console has permission to publish to that topic.

7. In a web browser, go to https://<yourhost>/<context>

8. Click on "Create New User" under the login form.
9. Create a new user (this will be your root user).
10. Verify that you can log in with your new user. You will not have access to any accounts yet.
11. Edit management-console/resources/sql/make-user-root.sql by replacing the text 'your-root-username-here' with the username you just created.
12. Login with the user you created
13. Click on Root Console link in the upper right corner.
14. Click on Global Properties
15. Click Edit, enter the ARN of the topic you created above as well as the CloudFront settings and click save.  
    1. NB: the CloudFront key path can refer to an s3 url:  ie s3://<bucket>/path/to/item.
    2. Also be sure that the AWS credentials have access to the specified bucket.
16. Click DuraCloud Mill tab and enter the appropriate settings.
17. Create an account via the Accounts tab.