This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

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.

1 - Dashboard

VCluster UI Dashboard page

The VCluster UI Dashboard is the default page for the UI. It allows you to show health metrics for your database and links to the other pages in the interface.

If you click Health Metrics, your dashboard is replaced with the health metrics for your database. Health metrics include: CPU Usage by Node, Memory Usage by Node, Disk I/O by Node, and Free Disk Space by Node. After clicking Health Metrics, anytime you navigate back to the dashboard during that browser session, the health metrics is displayed. To switch back to the default dashboard, click Stop Health Metrics.

2 - Subcluster

VCluster UI Subcluster page

The VCluster UI Subcluster page displays a list of your subclusters and the number of nodes in each subcluster. You can also add, remove, start, stop, sandbox, and unsandbox subclusters.

Clicking on the Node Details on a subcluster row lets you see the following about the nodes of that subcluster:

  • Name
  • Address
  • State
  • Catalog Path
  • Primary Node

3 - Database

VCluster UI Database page

The Database page shows you the name of your database along with your nodes, their IP Address, and their status.

The folloiwng options are available on this page:

  • Start Database
  • Stop Database
  • Re-IP Database
  • Drop Database
  • Revive Database

4 - Nodes

VCluster UI Nodes page

The Nodes page shows you all of your database nodes. You can add, remove, start, and stop nodes on this page.

5 - Job Status

VCluster UI Job Status page

The Job Status page shows you the status of your database jobs and the Workload Replay captures and replays:

Database

Database shows you the status of jobs from the Database, SubCluster, and Nodes pages. This includes adding a node or subcluster, changing the IP of the database, creating the database, and the other options.

Workload Replay

6 - Workload Replay

VCluster UI Workload Replay page

The Workload Replay page lets you view your database workload by viewing database queries and how long they take.

This page is used for the following:

  • Evaluating the performance of a new database version before deploying it to the production environment.

  • Assessing changes to the system configuration or test the database with new knobs or code changes.

  • Assessing the performance of upgrading hardware components or switching to a different operating system.

It uses three tabs to help you perform the assessment: Capture Workload, Replay Workload, and Reports.

Capture

Capture is used to capture a query or multiple queries to see their performance. You specify a start and stop timestamp when the query/queries you want to capture were run. Then click Capture Worload to capture the query/queries. You are redirected to the Job Status > Workload Replay page to see the status of the capture. The job name will be capture-workload and once the status shows successful you can replay the workload. You need to note the file path for the capture job to run the replay.

Replay Workload

After running a capture, Replay Workload is used to compare the first query run time with a new query run time. Select a sandbox from the dropdown to use for the replay. If no sandbox is present in the dropdown, you can create a sandbox using Create sandbox. You need to know the file path from the Job Status > Workload Replay page to select the capture you want to run against. Select that in the Workload File drop down. In the Sandbox drop down, select the sandbox you are using for the replay, then click Replay Workload. You are redirected to the Job Status > Workload Replay page to see the status of the capture.

The job name will be replay-workload and once the status shows successful you can replay the workload. You need to note the file path for the replay job to run the report.

If you want to cancel the replay that is running, hit the Cancel Replay Workload button.

Reports

After running the replay, Reports lets you view the query/queries from both the capture and the replay side by side. In the Workload Replay Report File, make sure the replay file you want to view is selected. It can be found on the Job Status > Workload Replay page. You can see a chart of the original time and the replay time which can be customized to how you want to view it. Scrolling down also shows you a table of the results.

7 - Cluster Health

VCluster UI Cluster Health page

The Cluster Health page lets you monitor the health of your database. There are three sections on this page:

  • Event Detailed Info - displays the details of an event if you click on it in the Slow Event Duration Over Time chart. You can click on the event details to see additional details about the event.

  • Events Statistics - displays the number of slow events, the longest and average event time, and lets you run a manual slow event check over a specified time period.

  • Slow Event Duration Over Time - displays the events from the preview day, 7 days, or 30 days (per your selection) in a chart.

8 - Certificate Management

VCluster UI Job Status page

The Certificate Management page shows you your certificate information and manage your certificates.

The following options are available to manage certificates:

  • Pending Certs list: shows a list of the status of server and client certificates.

  • Issued Certs list: shows a list of the issued certficates.

  • Revoked Certs list: shows a list of the revoked certificates.

  • Renew Server Cert: lets you renew your server certificate.

  • Apply Client Cert: use this option to apply for a client certificate.