Page tree

This documentation space is deprecated. Please make all updates to DuraCloud documentation on the live DuraCloud documentation space.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

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. To start,  clone and build the latest release of the mill

    git clone https://github.com/duracloud/management-console.git
    cd management-console
    mvn clean install
  2. Create the empty management console database, add credentials and than create the schema using management-console/resources/schema.sql (found in the management-console code baseline.)
  3. Execute the management-console/resources/add-root-user.sql to add a root user account,  changing the default username and/or password as you wish.
  4. Create a configuration file.
    1. Now that you've built the mill 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 mill/resources/mill-config-sample.properties
      1. Copy and rename the file to mill-config.properties
      2. Configure the database connections to the mill database as well as the management console database:

        ###################
        # 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>
  5. Log into the AWS account associated with the Management Console application.

  6. In SNS add a topic.
  7. Ensure that the AWS credentials associated with the Management Console has permission to publish to that topic.
  8. Goto into https://<yourhost>/<context>

  9. Click on "Create New User" under the login form.
  10. Create a new user (this will be your root user).
  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 your new root credentials.
  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.

There is no content with the specified labels

  • No labels