This site will be decommissioned on December 31st 2024. After that date content will be available at techdocs.broadcom.com.

 

You use the Data Management for VMware Tanzu console to provision a database Service Instance on an Onboarded Cluster. You can also provision a database Service Instance using the Data Management for VMware Tanzu API.

When you configure a database Service Instance for provisioning, you specify:

  • The database engine type and version.
  • The amount of CPU, memory, and storage resources to allot to the instance.
  • Backup and software update management rules and policies.
  • Database-engine-specific runtime properties including the server port number, administrative user credentials, time zone, and connection limits.

You can configure the database yourself, or you can choose to create a database Service Instance using the default database configuration. In some cases, the configuration properties available and their default values vary depending upon the database engine and version that you select for provisioning.

Note: You are responsible for ensuring that the infrastructure in which you provision the Service Instance has enough storage resources; Data Management for VMware Tanzu does not validate this for you.

Prerequisites

Before you provision a database Service Instance, ensure that you can identify:

  • The host name or IP address of the Data Management for VMware Tanzu console.
  • Your Organization Administrator or Organization User user credentials for the Data Management for VMware Tanzu console.
  • The vSphere environment that represents the Onboarded Cluster on which you will provision the database Service Instance.
  • The data storage configuration for the database Service Instance VM.
  • The network on which client applications will access the instance.

You must perform this task on a host that has network connectivity to the Data Management for VMware Tanzu console.

Other Considerations

Also consider and be prepared to identify:

  • The database engine type that you want to provision, and the version.
  • The amout of CPU, memory, and disk resources you want to allot to the instance.
  • Which of the backup, update, and maintenance window management policies you wish to opt-in to, under what schedule, and with what rules.
  • Certain runtime characteristics of the database Service Instance, including the default database name, server port number, and the administrative user credentials.
  • Security requirements for the database Service Instance and clients.

Procedure

Perform the following procedure to provision a database Service Instance with Data Management for VMware Tanzu.

  1. Log in to the Data Management for VMware Tanzu console.
  2. Configure the database Service Instance.
  3. Monitor database Service Instance creation.

Logging In

Perform the following procedure to log in to the Data Management for VMware Tanzu console:

  1. Open a browser window, and enter the Data Management for VMware Tanzu console URL. For example, if the service is running on a host with IP address10.10.10.11 enter:

    https://10.10.10.11/login

    The login screen displays.

  2. Log in to the Data Management for VMware Tanzu console using your assigned user credentials. If this is your first time logging in, DMS will prompt you to change your password and re-log in.

    The User Dashboard displays. See About the User Console for more information about the metrics and information available on this view.

Configuring the Database Service Instance

When you configure a database Service Instance, you must identify the database engine type and version, the Onboarded Cluster in which to provision the instance, and a name for the instance. After you select or enter these values, you can choose to configure the individual database Service Instance settings yourself, or you can choose to invoke the Data Management for VMware Tanzu quick create, a single-click action that creates the database for you using the default configuration.

Note: The Create Database Configuration Reference describes each of the database Service Instance configuration properties and provides the default value for each.

Perform these steps to configure the database Service Instance:

  1. Click Databases in the left navigation pane of the console.

    The Databases view opens. This page displays a list of the provisioned database Service Instances, and provides information about the database engine type, version, and environment, as well as the status of each instance.

  2. Click the CREATE DB button located in the upper right-hand corner of the view.

    This action displays the Create Database form, and automatically expands the Select Database [Database and Version] configuration pane.

    You identify the database engine type, name the database Service Instance, and identify the Onboarded Cluster vSphere environment and the database version by setting or selecting values for these properties:

    Property Name Value
    Database Choose either MySQL or PostgreSQL.
    Instance Name Enter a unique name for this database Service Instance, or retain the default name.
    Environment Use the dropdown menu to select the Onboarded Cluster in which to provision the database Service Instance.
    Database Version Use the dropdown menu to select from the available template versions of the database.

    You must set or select a value for each property identified above.

  3. At this point, you either choose to create the database with the default configuration, or you can configure the individual database Service Instance settings yourself.

    1. If you choose to create the database with the default configuration, click CREATE DB WITH DEFAULT CONFIGURATION, and skip ahead to Monitoring Database Service Instance Creation.

      Note: When you create a Service Instance with the default configuration, Data Management for VMware Tanzu uses default values for certain database-specific configuration parameters. Refer to:

      for more information about these settings. (You can change these settings after Service Instance deployment as described in Changing Database Options.)

    2. If you choose to configure the database Service Instance settings yourself, continue on to the next step.

  4. Click VM SETTINGS to expand the Resource Configuration [vCPU, Memory and Storage Configuration] pane and size your database virtual machine.

    1. Use the sliders or the dropdown menu to select the vCPU and Memory settings that best represent your instance resource requirements.
    2. Use the slider to select the disk Storage size (GBs) for the database Service Instance.

  5. Click MANAGEMENT SETTINGS to expand the Management Configuration [Monitoring and Backup] pane. You configure these properties to select the level of monitoring Data Management for VMware Tanzu performs on the database Service Instance, and to opt in or opt out of certain database management and backup policies. (You configure the rules for each opted-in policy in the next step.)

    Select the monitoring level, and opt in or out of management policies as desired:

    Property Name Value
    Monitoring Type Use the slider to choose either NORMAL or ENHANCED monitoring.
    Enable Data Protection Click the checkbox to enable or disable automated database backups.
    Enable Auto Minor Version Upgrade Click the checkbox to enable or disable automated minor version software updates to the database Service Instance.
    Customize Maintenance Window Click the checkbox to enable or disable customizing the maintenance window for the database Service Instance.

    Note: Click the tooltip next to a value checkbox for additional information about that property.

  6. Click ADDITIONAL SETTINGS to expand the Additional Configuration [Database Instance, Environment & Backup Configuration] pane. Several configuration categories are represented in this pane, and certain categories will be present only if you opted-in to the related management policy in MANAGEMENT SETTINGS.

    1. Database Instance Configuration - Configure the default database, server port number and administrator credentials for the database Service Instance.

      The default values for database Service Instance properties are database engine-type-specific. Set these properties for your instance:

      Property Name Value
      Database Name The name of the default database.
      Database Port No The port number on which the database server runs. (Read-only)
      Admin Username The database administrator user name.
      Admin Password The password for the database adminstrator.

    2. Environment Configuration - Configure the vSphere environment for the provisioned database Service Instance VM.

      You configure these properties to identify the VM disk and network configuration.

      Property Name Value
      VM Datastore Retain the default value.
      Application Network Retain the default value.

    3. Backup Configuration - Configure the backup schedule and retention policies for the database Service Instance if you opted in to Enable Data Protection.

      Set or select each property value as specified:

      Property Name Value
      Daily Backup Time Use the dropdown menus to select the time of day to back up the database.
      Local Backup Days Use the dropdown menu to specify the number of days to retain a backup on local storage.
      Remote Backup Days Use the dropdown menu to specify the number of days to retain a backup on cloud/remote storage.

    4. Maintenance Configuration - Configure the maintenance window for software updates for the database Service Instance if you opted in to Customize Maintenance Window and Enable Auto Minor Version Upgrade.

      Set or select each property value as specified:

      Property Name Value
      Start Day Use the dropdown menus to select the maintenance window day of the week.
      Start Time Use the dropdown menus to select the time of day in which to start the maintenance window.
      Duration Use the dropdown menu to specify the duration of the maintenance window (hours).

      When Customize Maintenance Window is off and Enable Auto Minor Version Upgrade is on, software updates are applied in the default maintenance window (6 hours starting each Saturday at 23:59).

    5. TLS Configuration - Configure the TLS requirements for database clients.

      If you want the database Service Instance to reject non-secure connections and require Transport Layer Security certificate verification for clients, enable by clicking the Require Client TLS checkbox.

    6. DB Options Configuration - Configure database engine-specific options:

    7. Click SUMMARY to review the configuration of your database Service Instance.

    8. Finally, click CREATE DATABASE in the bottom left of the Summary pane to create and provision the database Service Instance.

    Data Management for VMware Tanzu generates a management operation of type CREATE_DB.

    Note: Creating and provisioning a database Service Instance may take some time.

Monitoring Database Service Instance Creation

Monitor the status of the database Service Instance creation and provisioning operation in the Database Operations view:

  1. Locate the CREATE_DB operation type.
  2. The Status progress bar displays the subtasks that Data Management for VMware Tanzu performs for the operation.
  3. Click the CREATE_DB operation type.
  4. Select the State History tab to view the subtasks and their status.

Results

If Data Management for VMware Tanzu encounters an error when provisioning the database, the Database Operations view Status for the CREATE DB operation displays FAILED, and error information is returned in the Error Info tab.

When Data Management for VMware Tanzu successfully provisions a database Service Instance, the Database Operations view Status for the CREATE DB operation displays SUCCESS, and the Databases view Status for the database is ONLINE. Additionally, DMS automatically takes a full local and cloud backup of the database Service Instance. As described in the monitoring section above, you can similarly examine the BACKUP DB operation details.

Note: In some cases, creating a new Service Instance with Enable Data Protection set to on does not actually enable automated backups for the instance. Be sure to examine the status of all operations and tasks associated with the creation of the Service Instance, and enable protection after provisioning if required.

Next Steps

You successfully created and provisioned a database Service Instance. Next, you may want to:

check-circle-line exclamation-circle-line close-line
Scroll to top icon