Oracle Cloud Infrastructure Documentation

Register an External MySQL DB System

You can register an External MySQL DB system by creating a resource in Database Management. This resource acts as a handle to which you connect the External MySQL DB system.

The External MySQL DB system is deployed on premises and in the process of registering it, you:

  • Create a resource that represents the External MySQL DB system in Database Management.
  • Create a connector to connect to the External MySQL DB system.
  • Enable Database Management for the External MySQL DB system.

Before you register an External MySQL DB system, you must:

To register an External MySQL DB system:

  1. Sign in to the Oracle Cloud Infrastructure console.
  2. Open the navigation menu, click Observability & Management. Under Database Management, click Administration.
  3. On the left pane, click MySQL Databases, select a compartment in the Compartment drop-down list and External in the Deployment type filter.
  4. On the MySQL DB systems page, click Register External MySQL DB system.
  5. In the Register External MySQL DB system panel:
    1. Specify the following details to register the External MySQL DB system:
      1. Destination compartment: Select the compartment in which you want the External MySQL DB system resource to reside. By default, the compartment selected on the MySQL DB systems page is displayed, however, you can select another compartment in the drop-down list, if required.
      2. External MySQL DB system name: Enter a user-friendly name to easily identify the External MySQL DB system resource. Note that a name in the following format is already displayed in this field and you can change it, if required:
        mysql_<YYYYMMDDHHMMSS in UTC>
    2. Specify the following details to create a connector:
      1. Connector name: Enter a user-friendly name to easily identify the connector resource. Note that a name in the following format is already displayed in this field and you can change it, if required:
        DBConnector_<YYYYMMDDHHMMSS in UTC>
      2. Agent: Select a Management Agent to connect to the External MySQL DB system.
      3. Host name: Enter the fully-qualified domain name (FQDN) or IP address for the External MySQL DB system deployed on premises. The queries from the Management Agent will connect to the MySQL server instance using the host name, and this host name should match the host name specified when the MySQL user was created. For information, see Perform External MySQL DB System-related Prerequisite Tasks.
      4. Port: Enter the port number being used by the External MySQL DB system for connections.
      5. Network protocol: Select a network protocol to connect to the External MySQL DB system.
        • TCP: Transmission Control Protocol, which is a fundamental network protocol used to exchange data.
        • TCP with SSL: Transmission Control Protocol with Secure Sockets Layer, which is a more secure option to exchange data as SSL encrypts data before it's transmitted.
        • Sockets: Endpoints used for sending and receiving data across a network.
      6. Secret: Select the secret that contains the network protocol credentials and details. Note that a network protocol credentials secret created in the Vault service directly is only displayed in this drop-down list if the following free-form tags are associated with the secret:
        • Secret for TCP credentials: TCP_SECRET_MYSQL
        • Secret for TCP with SSL credentials: TLS_SECRET_MYSQL
        • Secret for socket credentials: SOCKET_SECRET_MYSQL

        For information on how to create a secret in the Vault service, see Creating a Secret in a Vault.

        If an existing secret is not available, then select Create new secret... in the drop-down list and create a new secret. For information, see Create a Network Protocol Secret.

    3. Optionally, click Test connection to confirm if the connection to the External MySQL DB system is established. Note that the test connection process may take a few minutes to complete and you must not exit or refresh the page.
    4. Click Submit to create a connector, register the External MySQL DB system, and enable Database Management.
The Register External MySQL DB system panel remains open till the entire registration process is complete and automatically closes after Database Management is enabled successfully. If the connector is not created successfully and an error is displayed, then you can review the information you've provided in the Register External MySQL DB system panel, make changes, and click Submit again. The newly registered External MySQL DB system is listed on the MySQL DB systems page. If the connector creation step fails and you've closed the Register External MySQL DB system panel, then you can click Register External MySQL DB system and start the registration process again. While re-registering the External MySQL DB system, you can provide the same name for the External MySQL DB system and it will replace the previous registration for which the connector creation had failed.

You can click the Actions icon (Actions) for the External MySQL DB system and perform the following tasks:

  • View work request: Click to monitor the work request and view the associated log and error messages.
  • View connector: Click to go to the Connector details page and view connector information.
  • Disable Database Management: Click to disable Database Management. If you disable Database Management and want to enable it again, click Enable Database Management in the Management status column, select a connector, and click Enable.
  • Copy OCID: Click to copy the OCID of the External MySQL DB system resource.
  • Deregister: Click to deregister the External MySQL DB system.