Database management with VCluster UI

Database management with VCluster UI

The VCluster UI is a tool for administering your database. This tool is bundled with OpenText™ Analytics Database installations. VCluster UI works with the VCluster CLI to manage your database. It works with both the EON and Enterprise database types.

Setting up VCluster UI

Setting up the VCluster UI for your system depends on whether you already have a database set up and how you created your database: AdminTools or VCluster CLI. Use the section below that corresponds to your setup:

Setting up a new database in VCluster UI

To setup VCluster UI and create a new database:

  1. Start the node management agent on all of the nodes:

    $  /opt/vertica/bin/manage_node_agent.sh start node_management_agent

    Here is an example script that can be used to start the node management agent on multiple nodes:

    for x in 10.20.71.10 10.20.71.11 10.20.71.12 10.20.71.13; do echo "host is $x"; ssh $x /opt/vertica/bin/manage_node_agent.sh 
start node_management_agent; done;

  2. Start the VCluster service on one of the hosts (this is the host that you will connect to in order to use VCluster):

    $  /opt/vertica/bin/manage_vcluster_server.sh start vluster_server

    This will create a certificate for the UI that you need to import into your browser.

  3. Navigate to /opt/vertica/config/vcluster_server and download the admin.p12 certificate to the local machine where you intend to access the VCluster Web UI.

  4. In a browser, import the certificate by going to Settings > Manage Certificate and add the admin.p12 certificate. The default password for the certificate is vertica.

  5. Using the server IP or hostname of the database host where you started the VCluster service, navigate to https://<hostname>:9090 and accept the certificate prompts to enable the VCluster UI health metrics.

  6. Launch the VCluster Web UI by going to https://<hostname>:8665.

  7. Click on the link in the Dashboard to create your database.

  1. Specify the details for your database.

  2. Continue with Accessing the VCluster UI.

Configuring your VCluster CLI database to use to VCluster UI

Follow these steps if your database was created using the VCluster CLI:

  1. Start the node management agent on all of the nodes:

    $  /opt/vertica/bin/manage_node_agent.sh start node_management_agent

    Here is an example script that can be used to start the node management agent on multiple nodes:

    for x in 10.20.71.10 10.20.71.11 10.20.71.12 10.20.71.13; do echo "host is $x"; ssh $x /opt/vertica/bin/manage_node_agent.sh 
start node_management_agent; done;

  2. Start the VCluster service on one of the hosts (this is the host that you will connect to in order to use VCluster):

    $  /opt/vertica/bin/manage_vcluster_server.sh start vluster_server

    This will create a certificate for the UI that you need to import into your browser.

  3. Navigate to /opt/vertica/config/vcluster_server and download the admin.p12 certificate to the local machine where you intend to access the VCluster Web UI.

  4. In a browser, import the certificate by going to Settings > Manage Certificate and add the admin.p12 certificate. The default password for the certificate is vertica.

  5. Using the server IP or hostname of the database host where you started the VCluster service, navigate to https://<hostname>:9090 and accept the certificate prompts to enable the VCluster UI health metrics.

  6. The VCluster Web Server leverages an embedded HTTPS service, which requires TLS authentication for secure access. Run the following to enable TLS:

    vsql -c "create authentication tls_for_all method 'tls' host tls '0.0.0.0/0';" 
vsql -c "grant authentication tls_for_all to public;"

  7. Continue with Accessing the VCluster UI.

Migrating your database from AdminTools to VCluster UI

Follow these steps if your database was created using AdminTools:

  1. Start the node management agent on all of the nodes:

    $  /opt/vertica/bin/manage_node_agent.sh start node_management_agent

    Here is an example script that can be used to start the node management agent on multiple nodes:

    for x in 10.20.71.10 10.20.71.11 10.20.71.12 10.20.71.13; do echo "host is $x"; ssh $x /opt/vertica/bin/manage_node_agent.sh 
start node_management_agent; done;

  2. Run the following script to convert the database configuration to be compatible with VCluster:

    /opt/vertica/bin/vcluster manage_config recover --db-name migrate_to_vcluster --hosts <list of node IP address separated by commas> --catalog-path /scratch_b/disk_a  --depot-path /scratch_b/disk_a

  3. Start the VCluster service on one of the hosts (this is the host that you will connect to in order to use VCluster):

    $  /opt/vertica/bin/manage_vcluster_server.sh start vluster_server

    This will create a certificate for the UI that you need to import into your browser.

  4. Navigate to /opt/vertica/config/vcluster_server and download the admin.p12 certificate to the local machine where you intend to access the VCluster Web UI.

  5. In a browser, import the certificate by going to Settings > Manage Certificate and add the admin.p12 certificate. The default password for the certificate is vertica.

  6. Using the server IP or hostname of the database host where you started the VCluster service, navigate to https://<hostname>:9090 and accept the certificate prompts to enable the VCluster UI health metrics.

  7. Continue with Accessing the VCluster UI.

Accessing the VCluster UI

To access VCluster UI, navigate to https://<hostname>:8665 using the server IP of the database host where you started the VCluster service. You are prompted to select the server certificate you imported to your browser previously.

Understanding the VCluster UI

  • 1 - OpenText™ Analytics Database Version Information: displays the current version of the database.

  • 2 - Api Docs Link: access to the help system for the VCluster UI.

  • 3 - Left Navigation: shows the availabe pages and highlights the current page.

  • 4 - Page View: displays the current page.

  • 5 - VCluster Chatbot: get help with tasks in the interface.

In this section