Skip to content

Commit 02da40c

Browse files
authored
Merge pull request SensorsIot#529 from Paraphraser/20220327-mariadb-doco-master
20220327 MariaDB documentation
2 parents 3524764 + 17fe822 commit 02da40c

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

docs/Containers/MariaDB.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# MariaDB
2+
23
## Source
34

45
* [Docker hub](https://hub.docker.com/r/linuxserver/mariadb/)
@@ -18,7 +19,7 @@ The port is 3306. It exists inside the docker network so you can connect via `ma
1819

1920
Before starting the stack, edit the `docker-compose.yml` file and check your environment variables. In particular:
2021

21-
```
22+
```yaml
2223
environment:
2324
- TZ=Etc/UTC
2425
- MYSQL_ROOT_PASSWORD=
@@ -67,9 +68,9 @@ To close the terminal session, either:
6768
* type "exit" and press <kbd>return</kbd>; or
6869
* press <kbd>control</kbd>+<kbd>d</kbd>.
6970

70-
## Container health check
71+
## <a name="healthCheck"></a>Container health check
7172

72-
### theory of operation
73+
### <a name="healthCheckTheory"></a>theory of operation
7374

7475
A script , or "agent", to assess the health of the MariaDB container has been added to the *local image* via the *Dockerfile*. In other words, the script is specific to IOTstack.
7576

@@ -87,11 +88,11 @@ The agent is invoked 30 seconds after the container starts, and every 30 seconds
8788
mysqld is alive
8889
```
8990

90-
3. If the command returned the expected response, the agent tests the responsiveness of the TCP port the `mysqld` daemon should be listening on (see [customising health-check](#customising-health-check)).
91+
3. If the command returned the expected response, the agent tests the responsiveness of the TCP port the `mysqld` daemon should be listening on (see [customising health-check](#healthCheckCustom)).
9192

9293
4. If all of those steps succeed, the agent concludes that MariaDB is functioning properly and returns "healthy".
9394

94-
### monitoring health-check
95+
### <a name="healthCheckMonitor"></a>monitoring health-check
9596

9697
Portainer's *Containers* display contains a *Status* column which shows health-check results for all containers that support the feature.
9798

@@ -124,7 +125,7 @@ Possible reply patterns are:
124125
mariadb Up About a minute (unhealthy)
125126
```
126127

127-
### customising health-check
128+
### <a name="healthCheckCustom"></a>customising health-check
128129

129130
You can customise the operation of the health-check agent by editing the `mariadb` service definition in your *Compose* file:
130131

0 commit comments

Comments
 (0)