ab-docker/ab-mariadb-alpine
1
0
Fork 0
Code Issues Pull Requests Releases Activity

docs(README): use dockerhub as primary reference

Browse Source
This commit is contained in:
Asif Bacchus 2021-01-05 16:39:20 -07:00
parent 797777d547
commit 402e5217a3
1 changed files with 26 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@ -1,6 +1,9 @@
# MariaDB on Alpine Linux (dockerized) # MariaDB on Alpine Linux (dockerized)
Fully functional dockerized installation of MariaDB server and client running on Alpine Linux. This container is roughly half the size of the official MariaDB container which runs on Ubuntu but still aims to mimic all its features while adding a few extra ;-) Fully functional dockerized installation of MariaDB server and client running on Alpine Linux. This container is roughly
half the size of the official MariaDB container which runs on Ubuntu but still aims to mimic all its features while
adding a few extra ;-) Note that this container is built against the Alpine EDGE repository for newer versions of
mariaDB.
- [Quick Start](#quick-start) - [Quick Start](#quick-start)
- [Pull the image](#pull-the-image) - [Pull the image](#pull-the-image)
@ -37,11 +40,12 @@ ## Quick Start
### Pull the image ### Pull the image
The latest images are on my private Docker Repo but I also try to keep the ones on Dockerhub updated within a few days. As such, you have two choices: The latest images are on my private docker registry but, I also try to keep the ones on Dockerhub updated within a few
days. If you need signed containers, you will have to use my private registry. As such, you have two choices:
```bash ```bash
# my private repo # my private repo
docker pull docker.asifbacchus.app/mariadb/ab-mariadb-alpine:latest docker pull asifbacchus/ab-mariadb-alpine:latest
``` ```
or or
@ -51,7 +55,8 @@ # dockerhub
docker pull asifbacchus/ab-mariadb-alpine:latest docker pull asifbacchus/ab-mariadb-alpine:latest
``` ```
All the examples in this document will refer to my repo, but you can use Dockerhub if you prefer. The examples in this document will refer to dockerhub, but know that anywhere you
see `asifbacchus/ab-mariadb-alpine:tag` you can use `asifbacchus/ab-mariadb-alpine:tag` to use my registry instead.
### Run the image ### Run the image
@ -64,7 +69,7 @@ ### Run the image
-e MYSQL_DATABASE='CompanyX' \ -e MYSQL_DATABASE='CompanyX' \
-e MYSQL_USER='JaneDoe' \ -e MYSQL_USER='JaneDoe' \
-e MYSQL_PASSWORD='JanesPa$$w0rd' \ -e MYSQL_PASSWORD='JanesPa$$w0rd' \
docker.asifbacchus.app/mariadb/ab-mariadb-alpine asifbacchus/ab-mariadb-alpine
``` ```
Let's take a quick overview of the options used above: Let's take a quick overview of the options used above:
@ -74,7 +79,7 @@ ### Create a database
Assuming an existing database does not exist in the container's data directory already, it will create an empty database for you. The name of this database is controlled by the environment variable `MYSQL_DATABASE`. This defaults to 'myData'. If you would like to create a database called 'CompanyX', for example, you would set the environment variable as follows: Assuming an existing database does not exist in the container's data directory already, it will create an empty database for you. The name of this database is controlled by the environment variable `MYSQL_DATABASE`. This defaults to 'myData'. If you would like to create a database called 'CompanyX', for example, you would set the environment variable as follows:
```bash ```bash
docker run -d -e MYSQL_DATABASE='CompanyX' docker.asifbacchus.app/mariadb/ab-mariadb-alpine docker run -d -e MYSQL_DATABASE='CompanyX' asifbacchus/ab-mariadb-alpine
``` ```
#### Root password #### Root password
@ -84,7 +89,7 @@ #### Root password
In normal usage, you will want to set the root password instead of having it generated for you. This is accomplished by setting the environment variable `MYSQL_ROOT_PASSWORD`. The command would look something like: In normal usage, you will want to set the root password instead of having it generated for you. This is accomplished by setting the environment variable `MYSQL_ROOT_PASSWORD`. The command would look something like:
```bash ```bash
docker run -d -e MYSQL_ROOT_PASSWORD='SuPeR$ecurEP@$$w0rd' docker.asifbacchus.app/mariadb/ab-mariadb-alpine docker run -d -e MYSQL_ROOT_PASSWORD='SuPeR$ecurEP@$$w0rd' asifbacchus/ab-mariadb-alpine
``` ```
#### User password #### User password
@ -92,7 +97,7 @@ #### User password
If you would like a user account created for you with FULL privileges to the database created by the container, you must set two environment variables: `MYSQL_USER` and `MYSQL_PASSWORD`. You can do that as follows: If you would like a user account created for you with FULL privileges to the database created by the container, you must set two environment variables: `MYSQL_USER` and `MYSQL_PASSWORD`. You can do that as follows:
```bash ```bash
docker run -d -e MYSQL_USER='JaneDoe' -e MYSQL_PASSWORD='JanesPa$$w0rd' docker.asifbacchus.app/mariadb/ab-mariadb-alpine docker run -d -e MYSQL_USER='JaneDoe' -e MYSQL_PASSWORD='JanesPa$$w0rd' asifbacchus/ab-mariadb-alpine
``` ```
## Connecting as a client ## Connecting as a client
@ -114,7 +119,7 @@ ### Separate Container
You can launch another instance of the container and use that as a client to connect to your server container or any other remote MariaDB/mySQL instance. In this case, we don't want to pass any environment variables, but we want to pass a separate CMD parameter as follows: You can launch another instance of the container and use that as a client to connect to your server container or any other remote MariaDB/mySQL instance. In this case, we don't want to pass any environment variables, but we want to pass a separate CMD parameter as follows:
```bash ```bash
docker run -it --rm docker.asifbacchus.app/mariadb/ab-mariadb-alpine mysql -hmysql.host.tld -uusername -ppassword docker run -it --rm asifbacchus/ab-mariadb-alpine mysql -hmysql.host.tld -uusername -ppassword
``` ```
**N.B.* I used the `--rm` Docker parameter to automatically remove the container on exit. This is optional. **N.B.* I used the `--rm` Docker parameter to automatically remove the container on exit. This is optional.
@ -194,10 +199,10 @@ ## Data Persistence
```bash ```bash
# create a volume or use an existing named-volume # create a volume or use an existing named-volume
docker run -d -v mydatabase:/var/lib/mysql docker.asifbacchus.app/mariadb/ab-mariadb-alpine docker run -d -v mydatabase:/var/lib/mysql asifbacchus/ab-mariadb-alpine
# use a bind-mount location # use a bind-mount location
docker run -d -v /my/local/dir:/var/lib/mysql docker.asifbacchus.app/mariadb/ab-mariadb-alpine docker run -d -v /my/local/dir:/var/lib/mysql asifbacchus/ab-mariadb-alpine
``` ```
## Data instantiation/import ## Data instantiation/import
@ -207,7 +212,7 @@ ### Existing DB (mysql directory)
The entrypoint script of the container simply checks to see if the */var/lib/mysql* directory is empty and, if so, creates a new database for you. Thus, if you want to import an existing database, you simply have to mount a valid *mysql* subdirectory: The entrypoint script of the container simply checks to see if the */var/lib/mysql* directory is empty and, if so, creates a new database for you. Thus, if you want to import an existing database, you simply have to mount a valid *mysql* subdirectory:
```bash ```bash
docker run -d -v /existing/mysql:/var/lib/mysql docker.asifbacchus.app/mariadb/ab-mariadb-alpine docker run -d -v /existing/mysql:/var/lib/mysql asifbacchus/ab-mariadb-alpine
``` ```
### Instantiation ### Instantiation
@ -215,13 +220,13 @@ ### Instantiation
If you want to 'instantiate' your newly created database (add tables, some default data, set privileges, etc.) then you can import SQL files with commands preloaded. Any *.sql* or *.sql.gz* files mounted in the container's */docker-entrypoint-initdb.d* folder will be imported after the new database is created. If you want to 'instantiate' your newly created database (add tables, some default data, set privileges, etc.) then you can import SQL files with commands preloaded. Any *.sql* or *.sql.gz* files mounted in the container's */docker-entrypoint-initdb.d* folder will be imported after the new database is created.
```bash ```bash
docker run -d -v /sql/import/scripts:/docker-entrypoint-initdb.d docker.asifbacchus.app/mariadb/ab-mariadb-alpine docker run -d -v /sql/import/scripts:/docker-entrypoint-initdb.d asifbacchus/ab-mariadb-alpine
``` ```
You should review the logs when doing this to see if MariaDB throws any errors due to syntax errors or other mistakes in your SQL files. An easy way to do this is: You should review the logs when doing this to see if MariaDB throws any errors due to syntax errors or other mistakes in your SQL files. An easy way to do this is:
```bash ```bash
docker run -d --name db -v /sql/import/scripts:/docker-entrypoint-initdb.d docker.asifbacchus.app/mariadb/ab-mariadb-alpine && docker logs -f db docker run -d --name db -v /sql/import/scripts:/docker-entrypoint-initdb.d asifbacchus/ab-mariadb-alpine && docker logs -f db
``` ```
You can, of course, name your container anything you like. Just change *'db'* in both places to whatever you choose. You can, of course, name your container anything you like. Just change *'db'* in both places to whatever you choose.
@ -238,7 +243,7 @@ ## Custom Scripts
docker run -d \ docker run -d \
-v /my/pre-init/scripts:/docker-entrypoint-preinit.d \ -v /my/pre-init/scripts:/docker-entrypoint-preinit.d \
-v /my/post-init/scripts:/docker-entrypoint-postinit.d \ -v /my/post-init/scripts:/docker-entrypoint-postinit.d \
docker.asifbacchus.app/mariadb/ab-mariadb-alpine asifbacchus/ab-mariadb-alpine
``` ```
### Entrypoint Task Order ### Entrypoint Task Order
@ -267,7 +272,7 @@ ### Command-line parameters
You can pass MariaDB command-line parameters to your container just as your would with a regular *mysqld* instance. For example: You can pass MariaDB command-line parameters to your container just as your would with a regular *mysqld* instance. For example:
```bash ```bash
docker run -d docker.asifbacchus.app/mariadb/ab-mariadb-alpine --innodb-ft-min-token-size=2 docker run -d asifbacchus/ab-mariadb-alpine --innodb-ft-min-token-size=2
``` ```
The container will concatenate any parameters your supply with the default ones of *--console --user=mysql*. Note that command-line parameters override environment variable parameters supplied to the container. The container will concatenate any parameters your supply with the default ones of *--console --user=mysql*. Note that command-line parameters override environment variable parameters supplied to the container.
@ -280,12 +285,12 @@ ### Configuration file(s)
# custom my.cnf # custom my.cnf
docker run -d \ docker run -d \
-v /mysql/configuration/my.cnf:/etc/my.cnf \ -v /mysql/configuration/my.cnf:/etc/my.cnf \
docker.asifbacchus.app/mariadb/ab-mariadb-alpine asifbacchus/ab-mariadb-alpine
# custom server-related files # custom server-related files
docker run -d \ docker run -d \
-v /mysql/server-config:/etc/my.cnf.d \ -v /mysql/server-config:/etc/my.cnf.d \
docker.asifbacchus.app/mariadb/ab-mariadb-alpine asifbacchus/ab-mariadb-alpine
# complex configuration using custom my.cnf # complex configuration using custom my.cnf
# this completely depends on how you specify things in my.cnf # this completely depends on how you specify things in my.cnf
@ -293,7 +298,7 @@ # this completely depends on how you specify things in my.cnf
-v /mysql/config/my.cnf:/etc/my.cnf \ -v /mysql/config/my.cnf:/etc/my.cnf \
-v /mysql/other-config:/etc/mysql/some-directory \ -v /mysql/other-config:/etc/mysql/some-directory \
-v /mysql/more-configs:/etc/mysql/cnf/another-dir \ -v /mysql/more-configs:/etc/mysql/cnf/another-dir \
docker.asifbacchus.app/mariadb/ab-mariadb-alpine asifbacchus/ab-mariadb-alpine
``` ```
You should be aware that the container passes *'--console --user=mysql'* command-line parameters to *mysqld* by default and that will override parameters specified in *my.cnf* or any other configuration file. If you need to override these defaults, you will have to pass the *mysqld* command manually: You should be aware that the container passes *'--console --user=mysql'* command-line parameters to *mysqld* by default and that will override parameters specified in *my.cnf* or any other configuration file. If you need to override these defaults, you will have to pass the *mysqld* command manually:
@ -301,7 +306,7 @@ # this completely depends on how you specify things in my.cnf
```bash ```bash
docker run -d \ docker run -d \
-v /mysql/configuration/my.cnf:/etc/my.cnf \ -v /mysql/configuration/my.cnf:/etc/my.cnf \
docker.asifbacchus.app/mariadb/ab-mariadb-alpine \ asifbacchus/ab-mariadb-alpine \
mysqld --user=anotheruser mysqld --user=anotheruser
``` ```
@ -340,4 +345,4 @@ ## Source
## Final Thoughts ## Final Thoughts
I hope this container is useful to you and helps you run a database where memory may be at a premium. I do my best to make sure everything runs properly and as much like the official container as possible. If you find any bugs, implementation issues or have any suggestions, please file an issue and let me know! I am *NOT* affiliated with MariaDB in any way and this container is strictly my implementation of their software. Please **do not** bother them with any issues you have with this container, let me know instead! Happy dockerizing :-) I hope this container is useful to you and helps you run a database where memory may be at a premium. I do my best to make sure everything runs properly and as much like the official container as possible. If you find any bugs, implementation issues or have any suggestions, please file an issue and let me know! I am *NOT* affiliated with MariaDB in any way and this container is strictly my implementation of their software. Please **do not** bother them with any issues you have with this container, let me know instead! Happy dockerizing :-)