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 a single 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:
Configure VCluster server
To setup VCluster UI and create a new database:
-
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;
-
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.
-
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.
Note
If you need to create your own certificate, use the `vcluster_server --init` command.
-
In a browser, import the certificate by going to Settings > Manage Certificate and add the admin.p12 certificate. The password for the default certificate is vertica.
-
Launch the VCluster Web UI by navigating to https://<hostname>:8665. When prompted, select the certificate that you just imported and click OK.
-
Click the link in the Dashboard to create your database.
Create a database from VCluster UI
- After you click the link to create a database, you are directed to the Create Database page.
- Choose Eon or Enterprise as the database type. The available fields change based on your selection.
- Specify the details of your database.
Note
- Configuration parameters are mandatory when creating an Eon Mode database.
- The default time for **Startup Timeout** is 5 minutes.
- Click Create.
- In the Job Satus page, you can view the status of your new database.
- Continue with Accessing the VCluster UI.
Follow these steps if your database was created using the VCluster CLI:
-
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;
-
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.
-
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.
Note
If you need to create your own certificate, use the `vcluster_server --init` command.
-
In a browser, import the certificate by going to Settings > Manage Certificate and add the admin.p12 certificate. The password for the default certificate is vertica.
-
Launch the VCluster Web UI by navigating to https://<hostname>:9090. When prompted, select the certificate that you just imported and click OK.
-
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;"
-
Continue with Accessing the VCluster UI.
Follow these steps if your database was created using AdminTools:
-
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;
-
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
-
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.
-
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.
Note
If you need to create your own certificate, use the `vcluster_server --init` command.
-
In a browser, import the certificate by going to Settings > Manage Certificate and add the admin.p12 certificate. The password for the default certificate is vertica.
-
Launch the VCluster Web UI by navigating to https://<hostname>:9090. When prompted, select the certificate that you just imported and click OK.
-
Continue with Accessing the VCluster UI.
Access 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 VCluster UI
-
OpenText™ Analytics Database version information: Displays the current version of the database.
-
Help: Access the VCluster UI documentation and swagger documentation.
-
Left navigation: Shows the available pages and highlights the current page.
-
Landing page: Displays the different tiles to manage your database.
1 - Dashboard
VCluster UI Dashboard page
The VCluster UI Dashboard is the default landing page of the interface. It provides quick access to health metrics and other key sections allowing you to navigate and manage your database efficiently.
Access Health Metrics
-
Click Health Metrics.
The Connect Vcluster to Prometheus modal appears.
-
Provide OpenText™ Analytics Database's embedded HTTPS server port number and click Start Prometheus. The default is 8443.
-
Click Accept to authorize the Prometheus connection.
-
Click Confirm.
VCluster is now connected to Prometheus to scrape metrics.
You will be directed to the Dashboard which displays health metrics such as CPU Usage by Node, Memory Usage by Node, Disk I/O Usage by Node, and Free Disk Space by Node. Click any chart to open a modal where you can filter by time and node.
-
You can set the Refresh Interval to automatically update the health charts at your preferred frequency.
-
Click Other Health Data to access Health Watchdog and Cluster Health pages.
-
Clicking Health Metrics keeps the dashboard in health metrics view during your browser session. To go back to the default dashboard, click Stop Health Metrics and then click Confirm.
Important
Health metrics only work if you have enabled them by navigating to port 9090 and accepting the certificate prompt.
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.
Node Details for a subcluster enables you to view the node name, address, state, catalog path, and primary node.
3 - Database
VCluster UI Database page
The Database page shows you the name of your database along with the nodes, IP Address, and status. You can also view more details for each node such as node name, catalog path, data path, depot path, and communal storage location.
The following options are available on this page:
Note
If you do not have an existing database, only the Create Database and Revive Database options are available.
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.
Note
- The Add Node screen lets you choose between Regular and Compute node types. This option is available only for databases running in Eon Mode.
- You can select any node and click Stop Node. In the Stop Nodes screen, you can enable Force Kill which terminates the node using
SIGKILL instead of a graceful shutdown.
Caution
Use this option only if a graceful shutdown fails as it may result in data loss.
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 - Health Watchdog
VCluster UI Health Watchdog page
The Health Watchdog page lets you monitor your database using Health Watchdog. It displays the health of your database and mergeout queue size, lets you set configuration parameters for your database, and view blocked transactions.
Database Status
The Database Status page shows you your cluster state and has charts to track the different health metrics. You can set the chart to display recently elapsed time window or for a fixed time range.
Configuration Parameters
The Configuration Parameters page lets you configure the health metrics for your database. It displays the current value for the health metric and lets you input new values if you need to adjust your settings. You can also select whether transactions are blocked or not.
Blocked Transactions
The Blocked Transactions page lets you view any transactions that have been blocked and lets you cancel any transactions that you select.
9 - 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.
