MySQL
Supported Databases
MySQL Community Server
Versions: 8.0.x series
JDBC Driver Version: For the 8.0.x series Download here
Prerequisites
Check whether your version of MySQL is supported.
Have an installation of MySQL ready.
Ensure the JDBC driver is stored locally on the Application Server where Zephyr will be installed.
Configure the MySQL Database
The following steps will need to be followed:
Step 1: Login to your MySQL Server
Open the command prompt and navigate to your MySQL installation folder ( C:\Program Files\MySQL\MySQL Server 8.0.x\bin)
Establish connection to your MySQL server by using the command:
mysql.exe -uroot
In this example the username is root.In a new MySQL instance, root is the default user and can be logged in without a password. If you are using an existing MySQL Server instance, the username and password may be different.
Step 2: Create a new user for Zephyr
Create a new database user which Zephyr will connect as. The command to create a new user is seen below:
CREATE USER 'zephyrDBuser'@'localhost' IDENTIFIED BY 'zephyrDBuserPass';
Step 3: Set permissions for remote access
Now type the below command to make the Database accessible remotely.
GRANT ALL ON *.* TO 'zephyrDBuser'@'localhost';
zephyrDBuser represents the username and ZephyrDBuserPass is the password for the newly created user from Step 2.
The '*.*' is granting permissions to all databases. Replace 127.0.01 with the IP address of the server Zephyr will be installed on. This command will grant access to ALL databases for the IP addresses given. The minimum permission requirement are the privileges to create and populate tables.
If you are installing the database with data center in mind, you will need to grant permissions for each node in the cluster.
Now you an access your MySQL database remotely from the designated IP(s).
Step 4: Set Memory and Max Connections
Navigate to the my.ini file (Windows) or my.cnf (Linux), the default locations are the MySQL root folders. Run the following command:
SET GLOBAL max_connections = 500;
If no lines contain these parameters, then create new lines for them.
Step 5: Install Zephyr and Connect to the Database
Now the MySQL database is ready, open the Zephyr installer. The wizard will take you through the setup steps.
By default the binary logging is enabled in MySQL 8.0. Customers need to disable it while upgrading their MySQL from 5.7.x to 8.0.
By default, MySQL 8.x has the binary logging feature enabled, which can consume a significant amount of memory and negatively affect database performance. If you are upgrading to MySQL 8.x, make sure to disable binary logging. It's important to verify that binary logging is disabled for all existing customer environments.
To disable the database log perform the following steps:
Delete the binary logs by executing (it requires root privileges) the following command:
PURGE BINARY LOGS BEFORE NOW();
Stop the MySQL Service using the following command:
sudo systemctl stop mysql.service
Take a backup of
my.cnf
file.In the configuration file
my.cnf
append the option skip-log-bin under the section (mysqld).[mysqld] ... ... ... skip-log-bin
Restart the MySQL service by running the following command:
sudo systemctl start mysql.service
Check if the binary logs are disabled by running the following query. The result should be "OFF."
SHOW VARIABLES LIKE 'log_bin';
Note
MySQL Logging
If you are having problems with your MySQL database after making these changes, please consult your OS's application logs for issue details.