1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
---
stage: Verify
group: Runner
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
type: reference
---
# Using MySQL
Many applications depend on MySQL as their database, and you may
need it for your tests to run.
## Use MySQL with the Docker executor
If you want to use a MySQL container, you can use [GitLab Runner](../runners/README.md) with the Docker executor.
1. [Create CI/CD variables](../variables/README.md#custom-cicd-variables) for your
MySQL database and password by going to **Settings > CI/CD**, expanding **Variables**,
and clicking **Add Variable**.
This example uses `$MYSQL_DB` and `$MYSQL_PASS` as the keys.
1. To specify a MySQL image, add the following to your `.gitlab-ci.yml` file:
```yaml
services:
- mysql:latest
```
- You can use any Docker image available on [Docker Hub](https://hub.docker.com/_/mysql/).
For example, to use MySQL 5.5, use `mysql:5.5`.
- The `mysql` image can accept environment variables. For more information, view
the [Docker Hub documentation](https://hub.docker.com/_/mysql/).
1. To include the database name and password, add the following to your `.gitlab-ci.yml` file:
```yaml
variables:
# Configure mysql environment variables (https://hub.docker.com/_/mysql/)
MYSQL_DATABASE: $MYSQL_DB
MYSQL_ROOT_PASSWORD: $MYSQL_PASS
```
The MySQL container uses `MYSQL_DATABASE` and `MYSQL_ROOT_PASSWORD` to connect to the database.
Pass these values by using variables (`$MYSQL_DB` and `$MYSQL_PASS`),
[rather than calling them directly](https://gitlab.com/gitlab-org/gitlab/-/issues/30178).
1. Configure your application to use the database, for example:
```yaml
Host: mysql
User: runner
Password: <your_mysql_password>
Database: <your_mysql_database>
```
## Use MySQL with the Shell executor
You can also use MySQL on manually-configured servers that use
GitLab Runner with the Shell executor.
1. Install the MySQL server:
```shell
sudo apt-get install -y mysql-server mysql-client libmysqlclient-dev
```
1. Choose a MySQL root password and type it twice when asked.
NOTE:
As a security measure, you can run `mysql_secure_installation` to
remove anonymous users, drop the test database, and disable remote logins by
the root user.
1. Create a user by logging in to MySQL as root:
```shell
mysql -u root -p
```
1. Create a user (in this case, `runner`) that is used by your
application. Change `$password` in the command to a strong password.
At the `mysql>` prompt, type:
```sql
CREATE USER 'runner'@'localhost' IDENTIFIED BY '$password';
```
1. Create the database:
```sql
CREATE DATABASE IF NOT EXISTS `<your_mysql_database>` DEFAULT CHARACTER SET `utf8` \
COLLATE `utf8_unicode_ci`;
```
1. Grant the necessary permissions on the database:
```sql
GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, CREATE TEMPORARY TABLES, DROP, INDEX, ALTER, LOCK TABLES ON `<your_mysql_database>`.* TO 'runner'@'localhost';
```
1. If all went well, you can quit the database session:
```shell
\q
```
1. Connect to the newly-created database to check that everything is
in place:
```shell
mysql -u runner -p -D <your_mysql_database>
```
1. Configure your application to use the database, for example:
```shell
Host: localhost
User: runner
Password: $password
Database: <your_mysql_database>
```
## Example project
To view a MySQL example, create a fork of this [sample project](https://gitlab.com/gitlab-examples/mysql).
This project uses publicly-available [shared runners](../runners/README.md) on [GitLab.com](https://gitlab.com).
Update the README.md file, commit your changes, and view the CI/CD pipeline to see it in action.
|
