2.2.1 MySQL AI GUI Installation

To run the MySQL AI installer GUI, start the installer GUI in the folder where you have extracted the RPMs with the following command:

$> sudo mysql-ai-setup

Note

You must run the installer in the same directory as the extracted RPMs.

The installer guides you through the following configuration pages:

1. Introduction: Click Continue.

2. System Requirements: Checks your system for hardware requirements. Click Continue to proceed if your system meets all the minimum requirements.

   A report is given if the minimum requirements are not satisfied. In that case, choose Continue Anyway or Cancel.

   Warning

   MySQL AI might not work or experience performance issues if installed on a system that does not satisfy the minimum requirements.

   The installer also checks if any default ports used for communication with the MySQL AI components are already in use, and reports to you if that is the case.

3. User & password: Define a user name and password for the MySQL root user. The password must satisfy the MEDIUM level policy of the validate_password component.

   You can choose to Only allow local connections for this user (see the Warning near the beginning of Chapter 2, Installing MySQL AI).

   Click Continue to proceed.

4. MySQL Studio: Install and configure the MySQL Studio.

   You can replace the default port number (8080). A warning is displayed if the port you entered is already in use or will be used by another MySQL AI component.

5. Router & Shell: Install and configure the MySQL Shell GUI and MySQL Router for MySQL AI

   Note

   Check Warning before proceeding with the installation of the MySQL Shell GUI and MySQL Router (MySQL REST Service).

   Select to install both, either, or neither, by going through the following pages:

   • MySQL Shell GUI: Select Install the MySQL Shell GUI web service to install the component.

     You can replace the default port number (8000) with another number for MySQL Shell GUI web server to listen for connections. A warning is displayed if the port you entered is already in use or will be used by another MySQL AI component.

   • MySQL Router (MySQL REST Service): Select Install MySQL Router and configure it for MySQL REST Service to install the component.

     You can replace the default HTTPS port number (8443) with another number for the MySQL REST Service web server to listen to connections. A warning is displayed if the port you entered is already in use or will be used by another MySQL AI component.

     You can enter a secret for JSON Web Secret (JWS) tokens. If you do not enter one, a random secret will be created.

   Click Continue to proceed.

6. Vector Store: Specify the directory for loading documents into the vector store. The location must be configured by the server system variable secure_file_priv for mysqld to import data securely from it. The default location is /var/lib/mysql-files. If you specify a directory that does not exist, it will be created.

   Click Continue to proceed.

7. Certificates: Configure TLS certificates for encrypted communication with each of the following components of MySQL AI.

   Note

   • The certificates and keys you provide must satisfy MySQL requirements. See Creating SSL and RSA Certificates and Keys.

   • The certificate, key, and bundle files specified must be readable by the root user who installs MySQL AI; adjust their file permissions if needed.

   • The certificate, key, and bundle files must not be passphrase protected.

   • A file path to a certificate bundle file is expected in the certificate field. However, the path can also point to either a certificate file or a bundle file that does not contain the private key, in which case a separate field appears for you to provide the file path for the private key or, for the PEM format only, the actual key string (pasted keys are represented by icons on the screen).

   • The Common Name (CN) for your certificate is shown. The user can verify that the CN is correct and, for the MySQL AI plugin and MySQL Machine Learning Services, correct it if the installer misreads it.

   • MySQL Server: Provide the path to the certificate bundle in PEM or PKSC#12 format for communication between the server and other components using the mysql and mysqlx protocols. If no certificate is supplied, a self-signed certificate is generated.

   • MySQL Server Plugin (for MySQL AI) and MySQL Machine Learning Services: Provide paths to the certificate bundles in PEM or PKSC#12 format. Two distinct certificate bundles are required for the two components. If no certificates are provided, encrypted communication between MySQL AI components will be disabled.

   • MySQL Studio,MySQL Shell GUI and MySQL REST Service: Provide the paths to the certificate bundles in PEM or PKSC#12 format. If either of the certificates is not supplied, a self-signed certificate will be created for the respective service.

   Click Continue to proceed.

8. Finalize Installation: Confirm selections and begin the installation procedure. The following issues are reported if they occur:

   • Networking ports are assigned multiple times. Use the Previous button to go back to earlier pages and correct the port assignments.

   • Internal communication between MySQL Server and the Machine Learning and AI subsystem should not be encrypted because no certificates were given. Use the Previous button to go back and supply the certificates, or select the note to confirm this.

   Click Finalize to start installation of MySQL AI.

Finalizing Installation

The installer completes and presents a message containing information on URLs and endpoints for the selected components.

For example, if you selected MySQL Studio, MySQL Shell Workbench, and MySQL Router (MySQL REST Service):

==============================================================================
Installation finished.
==============================================================================

To access MySQL Studio, navigate to the following
URL in a web browser:

    https://hostAddress:8080/

To access a SQL shell for this MySQL AI instance, navigate to the following
URL in a web browser:

    https://hostAddress:8000/

The MySQL REST Service endpoint is:

    https://hostAddress:8443/


==============================================================================

Customizing the GUI Installer

The installer GUI can also take command-line installer options to populate fields, skip specific elements of the installation, and so on. The following example instructs the installer to run without the option to install MySQL Studio and MySQL Router, and sets the root username to John:

        sudo mysql-ai-setup --skip-mysql-studio --skip-mysql-router --mysql-root-user=John