Skip to main content
Version: 1.19.1

Configure LiveData UI

Find details here for the configuration properties of LiveData Migrator UI. Properties are defined in the following file:

/etc/wandisco/ui/application-prod.properties

When adding new properties or changing existing values, restart the LiveData Migrator service.

General configuration#

Configure how the UI is run overall.

NameDetails
server.portSet the port on which the UI will be available. This is overridden by the server.ssl.port when TLS is enabled.

Default value: 8081
Allowed values: An integer value between 1024 and 65535

LiveData UI logging#

LiveData, Hive Migrator, and LiveData UI each have their own configuration file for logging:

Log ownerConfiguration file path
LiveData Migrator/etc/wandisco/livedata-migrator/logback-spring.xmlSee LiveData Migrator logging
Hive Migrator/etc/wandisco/hivemigrator/log4j2.yamlSee Hive Migrator logging
LiveData UI/etc/wandisco/ui/logback-spring.xml

/etc/wandisco/ui/application-prod.properties
See below

The LiveData Migrator UI configuration file (/etc/wandisco/ui/application-prod.properties) contains the following logging configuration properties:

NameDetails
logging.output.pathThe output path for all logging.

Default value: /var/log/wandisco/ui
Allowed values: The full path to a valid directory that is writable by the user running the UI. The user is typically hdfs.
logging.level.ROOTThe log level.

Default value: INFO
Allowed values: A valid log level: TRACE, DEBUG, INFO, WARN, ERROR, FATAL, or OFF.
logging.audit.output.filenameThe output filename for the audit log. This will be suffixed with the date in YYYY-MM-DD format.

Default value: livedata_ui_audit
Allowed values: A valid string.
logging.audit.days-keptThe amount of days that the audit log will be retained.

Default value: 90
Allowed values: An integer value for the number of days that logs are kept.

Configure the log output path for the UI#

  1. Open /etc/wandisco/ui/application-prod.properties.
  2. Edit the following line, replacing the default path /var/log/wandisco/ui with your own. For example:
    logging.output.path=/your/path/here
  3. Save the change.
  4. Restart LiveData Migrator.

Reset admin user password#

Reset the admin user's password for LiveData Migrator by creating a file named reset.password in the UI configuration directory (/etc/wandisco/ui by default).

Enter the following details in the file:

email=user@domain.compassword=newPassword

Restart the UI server after the file has been created.

When the LiveData UI restarts, it updates the password to the value entered in the file. The email address in the file must not be changed for this to successfully occur.

note

This process cannot be used for users other than the admin. It does not work for the admin user's email address, which cannot be changed.

Security#

Basic authentication compatibility#

If basic authentication is enabled on LiveData Migrator or Hive Migrator (or both), additional steps are required to maintain LiveData UI functionality.

LiveData Migrator#

Follow the steps below to configure the LiveData UI to work with LiveData Migrator basic authentication:

  1. On the LiveData UI host, run the following command:

    # livedata-ui encryptor
  2. Select option 3. Setup LDM Basic Auth.

  3. Enter the username and password values in plain text that were defined for the security.basic.user and security.basic.password properties in the application.properties file.

  4. Select the Exit option once complete.

  5. Restart all services to apply changes:

    service livedata-migrator restart; service hivemigrator restart; service livedata-ui restart

Hive Migrator#

Follow the steps below to configure the LiveData UI to work with Hive Migrator basic authentication:

  1. On the LiveData UI host, run the following command:

    # livedata-ui encryptor
  2. Select option 4. Setup HVM Basic Auth.

  3. In plain text, enter the Hive Migrator username and password values that appear in /etc/wandisco/hivemigrator/application.properties.

  4. Select Exit.

  5. Restart the LiveData UI for the updates to take effect:

service livedata-migrator restart; service hivemigrator restart; service livedata-ui restart

TLS#

Configure how the UI uses TLS, which is disabled by default.

NameDetails
server.ssl.enabledSet to true to enable TLS. If no other TLS values are set, this will use an internal keystore and a self-signed certificate to serve the UI.

Default value: false
Allowed values: true, false
server.ssl.portSet the port on which the UI should be available when TLS is enabled.

Default value: 8443
Allowed values: An integer value between 1024 and 65535
server.ssl.key-storeThe path to the key store which should be used instead of the internal default
server.ssl.key-store-passwordThe password to be used to access the key store
server.ssl.key-aliasThe alias of the certificate to be used
server.ssl.key-store-typeOptional: set the key store type. Defaults to PKCS12
application.liveMigratorV2.client.noCheckCertificateOptional: add this property and set the value to true if you want to implicitly trust certificates from remote LiveData Migrator instances.
Default value: false

Instead of using this property, we recommend that you import your server certificate into a truststore.
tip

The example command below will import a certificate file, certificate-file.crt into the Java truststore cacerts:

keytool -importcert -file /etc/wandisco/certificate-file.crt -keystore cacerts -alias key-alias

For more information about parameters, see Oracle's documentation.

Configure a truststore#

View and update the truststore used by LiveData Migrator through the REST API.

View a truststore#

View the existing truststore parameters with a GET query sent to /config/ldm.

For example:

Example
curl http://localhost:18080/config/ldm/

Update a truststore#

Change the existing truststore parameters with a POST query sent to /config/ldm.

For example:

Example
curl -X POST http://localhost:18080/config/ldm -H 'Content-Type: application/json' -d '{ "port":911,"useSsl":"true","username":"name@host.domain","password":"examplepassword1532","trust-store":{"path":"/ssl/path","password":"keypassword","type":"JKS"}}'

Directory structure#

The following directories are used for the LiveData UI:

LocationContent
/var/log/wandisco/uiLogs
/etc/wandisco/uiConfiguration files
/opt/wandisco/uiOperation files
/var/run/livedata-uiRuntime files