Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kilna/liquibase-mariadb-docker

Docker for applying Liquibase changes against MariaDB databases
https://github.com/kilna/liquibase-mariadb-docker

docker docker-image liquibase mariadb mariadb-database mariadb-server

Last synced: 27 days ago
JSON representation

Docker for applying Liquibase changes against MariaDB databases

Awesome Lists containing this project

README 

        
# liquibase-mariadb-docker



[![](https://images.microbadger.com/badges/image/kilna/liquibase-mariadb.svg)](https://microbadger.com/images/kilna/liquibase-mariadb)

[![](https://img.shields.io/docker/pulls/kilna/liquibase-mariadb.svg?style=plastic)](https://hub.docker.com/r/kilna/liquibase-mariadb/)

[![](https://img.shields.io/docker/stars/kilna/liquibase-mariadb.svg?style=plastic)](https://hub.docker.com/r/kilna/liquibase-mariadb/)

[![](https://img.shields.io/badge/docker_build-automated-blue.svg?style=plastic)](https://cloud.docker.com/swarm/kilna/repository/docker/kilna/liquibase-mariadb/builds)



**A lightweight Docker for running [Liquibase](https://www.liquibase.org) with [MariaDB](http://www.mariadb.org) databases**



DockerHub: [liquibase-mariadb](https://hub.docker.com/r/kilna/liquibase-mariadb/) - GitHub: [liquibase-mariadb-docker](https://github.com/kilna/liquibase-mariadb-docker)



# Usage



## Using your own derived Dockerfile



You can use this image by creating your own `Dockerfile` which inherits using a FROM line:



```

FROM kilna/liquibase-mariadb

ENV LIQUIBASE_HOST=database.server

ENV LIQUIBASE_DATABASE=dbname

ENV LIQUIBASE_USERNAME=user

ENV LIQUIBASE_PASSWORD=pass

COPY changelog.xml /workspace

```



Make sure to create an appropriate [changelog.xml](http://www.liquibase.org/documentation/xml_format.html) in the same directory as your Dockerfile.



Then you can build your derived Dockerfile to an image tagged 'changelog-image':



```

$ docker build --tag changelog-image .

```



Any time you make changes to the example project, you'll need to re-run the `docker build` command above, or you can using docker volumes as described below to sync local filesystem changes into the container. To run liquibase using the new image you can:



```

$ docker run changelog-image liquibase updateTestingRollback

```



Since the working directory within the container is /workspace, and since the entrypoint generates a a liquibase.properties file using the provided environment variables, it will know to look for _changelog.xml_ by default and apply the change.  See the environment variables below to change this behavior.



## Using the image directly with a mounted docker volume



If you'd like to apply a changelog to a MariaDB database without deriving your own container, run the contiainer

appropriate to your database like so... where _/local/path/to/changelog/_ is the directory where a valid [changelog.xml](http://www.liquibase.org/documentation/xml_format.html) exists:



```

$ docker run -e LIQUIBASE_HOST=database.server -e LIQUIBASE_USERNAME=user -e LIQUIBASE_PASSWORD=pass \

    -e LIQUIBASE_DATABASE=dbname -v /local/path/to/changelog/:/workspace/ kilna/liquibase-mariadb \

    liquibase updateTestingRollback

```



# Environment Variables and liquibase.properties



This docker image has a working Liquibase executable in the path, and an entrypoint which auto-generates a [liquibase.properties](http://www.liquibase.org/documentation/liquibase.properties.html) file.



In order to create the liquibase.properties file, it uses the follow environment variables when the image is started with 'docker run':



| Environment Variable | Purpose | Default |

|----------------------|---------|---------|

| LIQUIBASE_HOST       | Database host to connect to | db |

| LIQUIBASE_PORT       | Database port to connect to | 3306 |

| LIQUIBASE_DATABASE   | Database name to connect to | liquibase |

| LIQUIBASE_USERNAME   | Username to connect to database as | liquibase |

| LIQUIBASE_PASSWORD   | Password for username | liquibase |

| LIQUIBASE_CHANGELOG  | Default changelog filename to use | changelog.xml |

| LIQUIBASE_LOGLEVEL   | Log level as defined by Liquibase 
 _Valid values: debug, info, warning, severe, off_ | info |

| LIQUIBASE_CLASSPATH  | JDBC driver filename | /opt/jdbc/mariadb-jdbc.jar |

| LIQUIBASE_DRIVER     | JDBC object path | org.mariadb.jdbc.Driver |

| LIQUIBASE_URL        | JDBC URL for connection | jdbc:mariadb://${HOST}:${PORT}/${DATABASE} |

| LIQUIBASE_DEBUG      | If set to 'yes', when _docker run_ is executed, will show the values of all LIQUIBASE_* environment variables and describes any substitutions performed on _liquibase.properties_ | _unset_ |



The generated _liquibase.properties_ file is loaded into the default working dir _/workspace_ (which is also shared as a docker volume). The _/workspace/liquibase.properties_ file will have any variables substituted each time a 'docker run' command is performed...  so you can load your own _/workspace/liquibase.properties_ file and put `${HOST}` in it, and it will be replaced with the LIQUIBASE_HOST environment variable.



If you want to see what the contents of the generated _liquibase.properties_ file are, you can:



```

$ docker run image-name cat liquibase.properties

```