Merge pull request #1035 from garethhallnz/mariadb-documentation-update

Improved MySQL Documentation
uselagoon · Apr 10, 2019 · ddd01e7 · ddd01e7
2 parents 67083de + bb30671
commit ddd01e7
Showing 1 changed file with 51 additions and 0 deletions.
diff --git a/docs/using_lagoon/drupal/services/mariadb.md b/docs/using_lagoon/drupal/services/mariadb.md
@@ -36,3 +36,54 @@ During the course of development, it may be necessary to enable either query
 logging or slow query logging. To do so just set the environment variables
 `MARIADB_LOG_SLOW` or `MARIADB_LOG_QUERIES`. This can be done in
 `docker-compose.yaml`.
+
+
+
+### Connecting to MySQL's container from the host
+
+If you like to connect to MySQL's Database inside the Docker container with an external Tool like [Sequel Pro](http://www.sequelpro.com/), [MySQL Workbench](http://www.mysql.com/products/workbench/), [HeidiSQL](http://www.heidisql.com/), [DBeaver](http://dbeaver.jkiss.org/), just plain old `mysql-cli` or anything else.
+
+#### Get published MySQL port from the container
+
+By default, Docker assigns a randomly published port for MySQL during each container start. This is done to prevent port collisions.
+
+To get the published port via `docker`:
+
+Run: ```docker port[container_name]```
+
+    $ docker port drupal_example_mariadb_1    
+    3306/tcp -> 0.0.0.0:32797
+
+Or via `docker-compose` inside a Drupal repository
+
+Run: ```docker-compose port [service_name] [interal_port]```
+
+    $ docker-compose port mariab 3306
+    0.0.0.0:32797
+
+### Setting a static port (not recommended)
+
+During development, if you are using an external database tool it may become cumbersome to continually check and set MySQL connection port.
+
+To set a static port; edit your service definition in your `docker-compose.yml`
+
+```
+  mariadb:
+    ...
+    ports:
+      - "33772:3306" # exposes port 3306 with a 33772 on the host port. Note by doing this you are responsible for managing port collisions`
+```
+**Note**
+
+By setting a static port you become responsible for maniging port collisions.
+
+
+#### Connect to MySQL
+
+|          | Linux                         | OS X                          |
+|----------|-------------------------------|-------------------------------|
+| IP/Host  | ip from container             | `docker.amazee.io`            |
+| Port     | published port from container | published port from container |
+| Username | `drupal`                      | `drupal`                      |
+| Password | `drupal`                      | `drupal`                      |
+| Database | `drupal`                      | `drupal`                      |