Uploaded image for project: 'CloverDX'
  1. CloverDX
  2. CLO-6258

Server setup improvements

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Critical
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: rel-4-1-0
    • Component/s: Server
    • Security Level: Users (General product issues)
    • Branch:
    • QA Testing:
      UNDECIDED
    • Additional information:
      Hide

      Documentation: <add link once documentation is ready>
      Motivation
      Having installed CloverETL server, user ends up with a piece of software that needs some configuration to be usable and useful at all. The old way of configuration used to be similar to this:

      • install server
      • run id and find out that the licence is missing
      • study documentation to find out that the configuration file with path to licence has to be specified and that the connection to the database should be set
      • creating the config. file
      • attempts to find how specify system property to the config. file under particular application server; ends up with setting it via environment variable
      • restarting server - failure to start due to some typo in database URL
      • fixing properties in configuration file
      • restarting server to verify the connection to database is OK

      Moreover, an attempt to configure other server service (e.g. where the sandboxes will reside, SMTP server for e-mail notifications, LDAP for user authentication, ...) leads again to documentation study, manual editing of the configuration file and restarting the server to find whether the settings are correct and with hope that the log will contain some information to correct the config. file before next round. Doable but painful.

      Answer
      Is the Setup. It used to be simple tool to gather configuration information from user, and with help of validation creating likely-to-be-correct configuration file. The necessity to restart the server remained.
      The latest version works differently - there are forms to configure each subsystem individually (Licence, Database, Sandboxes, Encryption, E-mail server, LDAP, Cluster and editor for manual changes in the configuration file). The setup page is divided into three section: on the left side menu to select particular section, in the middle there is a form to configure selected subsystem, to perform validation of provided settings and to save them; and on the right side is displayed current status of the subsystem. The setup tracks status of the subsystems and presents to user a notification (in form of menu decoration) in case there is some problem.

      The screenshot shows Setup screen just after clean server installation without any configuration, three problems are mentioned in the menu decoration that is always visible (orange color indicates that they at worst warnings):

      • the configuration file is not specified
      • the licence is missing
      • there is some warning about database

      The page displayed suggests to specify the configuration file - it provides information how to do it for particular application server. User is expected to provide the configuration file for the Setup works as editor of this file - using information provided in particular forms writes properties to the configuration file and re-initializes the configuration on the fly. The need to restart server is reduced only to changes in Database and Clustering.

      This screenshot shows validation of database configuration, the user does not have to know what is exact name of the database driver - it is (along with other configuration options) automatically deduced from selected database and its presence on classpath is checked as well. Note the advice where to put the JAR file with the driver. The floppy disk icon indicates that there are unsaved changes on the page.

      The users that wished to have encrypted passwords in the configuration file had to use command line secure-config-tool (that in turn requires own configuration file to use stronger encryption) to encrypt passwords manually. This is done automatically in setup - just enable the Encryption and the passwords entered in other configuration sections will be automatically encrypted. The encrypted configuration properties are automatically re-encrypted if one has changed encryption provider and/or encryption algorithm.

      LDAP authentication used be quite difficult to configure due to number of required configuration properties. The LDAP viewer on this page helps the user to specify where are the users and their groups are found in the LDAP directory - user drags and drops elements from LDAP view into specified fields and is allowed to verify the settings whether really lead to correct user lookup.

      Tips

      • configure Database section before Licence because the licence is stored in the database
      • although the Setup forms advice to restart application server/domain after certain changes, this is actually necessary only when adding JAR files to server classpath - restart of the CloverETL web application should be enough in other cases
      Show
      Documentation : <add link once documentation is ready> Motivation Having installed CloverETL server, user ends up with a piece of software that needs some configuration to be usable and useful at all. The old way of configuration used to be similar to this: install server run id and find out that the licence is missing study documentation to find out that the configuration file with path to licence has to be specified and that the connection to the database should be set creating the config. file attempts to find how specify system property to the config. file under particular application server; ends up with setting it via environment variable restarting server - failure to start due to some typo in database URL fixing properties in configuration file restarting server to verify the connection to database is OK Moreover, an attempt to configure other server service (e.g. where the sandboxes will reside, SMTP server for e-mail notifications, LDAP for user authentication, ...) leads again to documentation study, manual editing of the configuration file and restarting the server to find whether the settings are correct and with hope that the log will contain some information to correct the config. file before next round. Doable but painful. Answer Is the Setup. It used to be simple tool to gather configuration information from user, and with help of validation creating likely-to-be-correct configuration file. The necessity to restart the server remained. The latest version works differently - there are forms to configure each subsystem individually (Licence, Database, Sandboxes, Encryption, E-mail server, LDAP, Cluster and editor for manual changes in the configuration file). The setup page is divided into three section: on the left side menu to select particular section, in the middle there is a form to configure selected subsystem, to perform validation of provided settings and to save them; and on the right side is displayed current status of the subsystem. The setup tracks status of the subsystems and presents to user a notification (in form of menu decoration) in case there is some problem. The screenshot shows Setup screen just after clean server installation without any configuration, three problems are mentioned in the menu decoration that is always visible (orange color indicates that they at worst warnings): the configuration file is not specified the licence is missing there is some warning about database The page displayed suggests to specify the configuration file - it provides information how to do it for particular application server. User is expected to provide the configuration file for the Setup works as editor of this file - using information provided in particular forms writes properties to the configuration file and re-initializes the configuration on the fly . The need to restart server is reduced only to changes in Database and Clustering. This screenshot shows validation of database configuration , the user does not have to know what is exact name of the database driver - it is (along with other configuration options) automatically deduced from selected database and its presence on classpath is checked as well. Note the advice where to put the JAR file with the driver. The floppy disk icon indicates that there are unsaved changes on the page. The users that wished to have encrypted passwords in the configuration file had to use command line secure-config-tool (that in turn requires own configuration file to use stronger encryption) to encrypt passwords manually. This is done automatically in setup - just enable the Encryption and the passwords entered in other configuration sections will be automatically encrypted. The encrypted configuration properties are automatically re-encrypted if one has changed encryption provider and/or encryption algorithm. LDAP authentication used be quite difficult to configure due to number of required configuration properties. The LDAP viewer on this page helps the user to specify where are the users and their groups are found in the LDAP directory - user drags and drops elements from LDAP view into specified fields and is allowed to verify the settings whether really lead to correct user lookup. Tips configure Database section before Licence because the licence is stored in the database although the Setup forms advice to restart application server/domain after certain changes, this is actually necessary only when adding JAR files to server classpath - restart of the CloverETL web application should be enough in other cases

      Description

      • server should detect it is not configured and offer link to setup (similar how missing licence is handled)
      • support for Profiler's Reporting Console?
      • improve documentation
        • reflect improvements
        • add screenshots
        • better explain the motivation

        Attachments

        1. cluster_status.screen
          3 kB
        2. clusterName.png
          clusterName.png
          13 kB
        3. server_status.screen
          5 kB
        4. setup_screen.screen
          7 kB
        5. setup-db.png
          setup-db.png
          80 kB
        6. setup-enc.png
          setup-enc.png
          80 kB
        7. setup-ldap.png
          setup-ldap.png
          85 kB
        8. setup-start.png
          setup-start.png
          45 kB

          Issue Links

            Activity

              People

              Assignee:
              korbelj Jan Korbel
              Reporter:
              michalicaj Jano Michalica (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              9 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved: