Migrate your database from AdminTools to VCluster

Migrate an AdminTools managed database to VCluster.

You can migrate an AdminTools managed database to VCluster, and then manage the database using the VCluster CLI or VCluster UI.

Prerequisites

  • A database created using AdminTools (Enterprise or Eon Mode)
  • Passwordless SSH access to all cluster nodes
  • Vertica version 24.3 or later (required for VCluster CLI migration)
  • Vertica version 25.3 or later (required for VCluster UI migration)
  • The following ports are open on all nodes:
    • 5554: Node Management Agent (NMA)
    • 8665: VCluster UI

Additional prerequisites for Eon Mode

  • Communal storage is configured (for example, S3 or S3-compatible storage such as MinIO)
  • Access key, secret key, and endpoint are available
  • Bucket path for communal storage (for example, s3:///)

Migrate your database from AdminTools to VCluster CLI

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

    for x in <host1> <host2> <host3>; do echo "host is $x"; ssh $x /opt/vertica/bin/manage_node_agent.sh start node_management_agent; done;
    
  2. Run the following command to convert the AdminTools managed database to VCluster:

    admintools -t convert_to_vcluster
    

    This command converts the AdminTools configuration to VCluster and generates the configuration file at /opt/vertica/config/vertica_cluster.yaml.

  3. After conversion, use VCluster CLI commands to manage the database. You can verify the conversion by stopping and starting the database:

    Stop the database:

    vcluster stop_db --db-name <db-name>
    

    Example output:

    ✔ Collect node information
    ✔ Collect cluster information
    ✔ Update node state from running database
    ✔ Collect information for all up nodes
    ✔ Stop database
    ✔ Verify database is not running
    [INFO] Successfully stopped a database with name <db-name>
    

    Start the database:

    vcluster start_db --db-name <db-name>
    

    Example output:

    ✔ Check NMA service health
    ✔ Verify database is running
    ✔ Collect nodes information
    ✔ Read catalog
    ✔ Check Vertica version
    ✔ Get contents of vertica.conf
    ✔ Get contents of spread.conf
    ✔ Start 3 node(s)
    ✔ Wait for 3 node(s) to come up: all nodes are up
    ✔ Collect node information
    ✔ Collect cluster information
    ✔ Update node state from running database
    [INFO] Started database <db-name>
    

    These commands confirm that the database is now managed by VCluster.

Migrate 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
    

    This command registers the database with the VCluster Framework and generates the configuration file at /opt/vertica/config/vertica_cluster.yaml.

  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 vcluster_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 password for the default certificate is vertica.

  6. Launch the VCluster Web UI by navigating to https://<hostname>:8665. When prompted, select the certificate that you just imported and click OK.