MySQL Source Management

MySQL Source Management

General

A source host is a server that hosts the source databases. A test data environment(TDE) includes definition of Golden Image (GI) to one source database. This section describes how to create and manage a Test Data Environment.

A Golden Image (GI) refers to a pre-configured dataset of a database environment. This dataset encapsulates a snapshot of the database including its schema and data. It serves as a master copy from which multiple instances of the database (VDB) can be rapidly deployed, ensuring consistency, reliability, and quick scalability across different environments.

Supported types of Golden Images for MySQL database

Each type of Golden Image for MySQL databases serves a specific set of needs, from real-time replication to disaster recovery and cloud-based management. The choice of GI should align with the operational objectives and the specific environment.

XtraBackup Golden Image (XtraBackup GI)

An XtraBackup GI is a backup-based image created using XtraBackup utility. It includes all critical components of the database, such as data files, captured at a specific point in time.

Sources(TDE) management

  1. On the navigation bar, click Sources.

The Source Hosts view is displayed, listing all source hosts that have been added to the system

image-20250507-140920.png

You can quickly locate a source host by typing its letters on the Search bar. The list updates promptly.

Add a source host

To add a source host, see Install source agent

The source host maybe Linux only.

Modify, see details or delete a source host

To modify, see details or delete a source host, see Manage source agent

Create a test data environment(TDE)

  1. On the navigation bar, click Sources.

The Source Management window appears.

image-20250507-141210.png
  1. Select the required agent

  2. Click the (+) sign in the right panel

  3. Select DB type.

    image-20250507-141245.png
  4. Enter a Name and an optional description.

    image-20250507-141326.png
  5. Now , choose the GI type

    image-20250507-141407.png

     

XtraBackup GI

Create an XtraBackup GI

  1. Enter the TDE details

    image-20250507-141518.png

     

    • Golden Image Type - XtraBackup GI

    • Source Host - choose the source host that was installed earlier

    • Force creation - if selected then ignore other GI refresh jobs

    • Storage Type - always NFS

    • Snapshot policy

      • Activate snapshots - select if you want automatic snapshots of the GI to be created

      • Repeat every - choose snapshot frequency

      • Start from - when to start creating snapshots

      • Snapshot retention period - how many days to keep the snapshots, they will be deleted automatically afterwards (if no dependent objects exist)

  2. Enter the details of the source database:

    image-20250507-142037.png

    User - MySQL user with DBA privilege
    Password - password for the above user
    VDB password - a new password that will be applied to the above user on each VDB
    Port - port of the MySQL database
    OS user - OS user that runs the database instance
    MySQL binaries path - location of MySQL installation on the source server
    MySQL parameter file path - location of the MySQL main parameter file on the source server, usually named my.cnf
    PXB binaries path - location of the XtraBackup utility on the source server
    Parallel Processes No. - number of parallel processes for the XtraBackup jobs
    Refresh Immediately - if selected then the first refresh (initial load) will be executed immediately, if not selected then only the configuration of GI will be created, but no refresh will be done, it should be initiated later manually.
    Test Connection - verifies the connection to the database

  1. Open the VDB Management window.

    image-20250421-143955.png
  2. Select the TDE. If “Refresh Immediately” option was not selected, then click Create MySQL GI here.

    image-20250507-142559.png
  3. Enter a Name.

    image-20250507-142725.png

     

  4. Click Create.

After the GI is created, the following message appears: XtraBackup GI has been created.

  1. The VDB Management window displays the XtraBackup GI that was created.

    image-20250507-142839.png

     

Modify an XtraBackup GI

  1. From the Sources screen, click the change (pencil) icon of TDE

    image-20250507-143115.png
  2. If needed - update Snapshot Policy

    image-20250507-143138.png
  3. If needed - update source database parameters

    image-20250507-143213.png
  4. To save your changes, click Modify.

Test Data Environment (TDE)

See information about a test data environment

  1. Select the test data environment.

  2. Click Test Data Environment Info.

    image-20250507-143455.png

    The Info window appears:

image-20250507-143512.png

The info window shows the next details:

  • IP-address - IP address of the source host

  • Name - name of the TDE

  • Description - description of the TDE

  • Port - port of the source database

  • OS User - OS user that runs the source database

  • MySQL binaries path - location of MySQL installation on the source server

  • MySQL parameter file path - location of the MySQL main parameter file on the source server, usually named my.cnf

  • PXB binaries path - location of the XtraBackup utility on the source server

  • User - MySQL user in the source database

  • Version - version of the source MySQL database

  • Type - type of the GI (as explained earlier)

  • DB size - size of the source database

3. To return to the main Source Management work area, click Close.

Remove a test data environment

  1. Select the test data environment.

  2. Click Remove Test Data Environment.

    image-20250507-143858.png
  3. Click Remove to confirm the deletion or Cancel to exit with deleting the test data environment.

After the database is removed, the following message appears: Test Data Environment database has been removed.

 

Related content