chore: complete initial version

joseluisq · joseluisq · commit 29e136f3ee0a · 2020-02-27T12:08:20.000+01:00
diff --git a/.dockerignore b/.dockerignore
@@ -11,3 +11,4 @@
 .gitignore
 *docker-compose*
 Makefile
+*.md
diff --git a/.drone.yml b/.drone.yml
@@ -0,0 +1,21 @@
+pipeline:
+    publish:
+        image: plugins/docker
+        group: production
+        repo: joseluisq/alpine-mysql-client
+        dockerfile: ./docker/Dockerfile
+        username:
+            from_secret: dockerhub_username
+        password:
+            from_secret: dockerhub_password
+        auto_tag: true
+        when:
+            event: tag
+
+    notification:
+        image: plugins/slack
+        webhook:
+            from_secret: slack_webhook
+        channel: ci-cd
+        when:
+            status: [success, failure]
diff --git a/Dockerfile b/Dockerfile
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Jose Quintana <https://git.io/joseluisq>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/Makefile b/Makefile
@@ -1,16 +1,27 @@
-run:
-	@bash -c "./test.sh"
-.PHONY: run
-
 build:
-	@docker build -t alpine-mysql-client:latest .
+	@docker build -t alpine-mysql-client:latest -f docker/Dockerfile .
 .PHONY: build
 
 exec:
 	@docker run --rm -it \
+		--user mysql \
 		--name alpine-mysql-client \
-		--volume $(PWD):/root/sample \
-		--workdir /root/sample \
+		--volume $(PWD):/home/mysql/sample \
+		--workdir /home/mysql/sample \
 			alpine-mysql-client:latest \
 			mysql_exporter .env
 .PHONY: exec
+
+release:
+	# 1. Get latest git tag
+	$(eval GIT_TAG := $(shell git tag -l --contains HEAD))
+
+	# 2. Update docker files to latest tag
+	./docker/version.sh $(GIT_TAG)
+
+	# 3. Commit and push to latest tag
+	git add docker/Dockerfile
+	git commit docker/Dockerfile -m "$(GIT_TAG)"
+	git push origin master
+	git push origin $(GIT_TAG)
+.ONESHELL: release
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Alpine / MySQL Client
+# Alpine / MySQL Client 
 
 > [MySQL client](https://dev.mysql.com/doc/refman/8.0/en/programs-client.html) tools on top of [Alpine Linux x86_64](https://hub.docker.com/_/alpine).
 
@@ -21,24 +21,28 @@ mysqldumpslow
 mysqlshow
 ```
 
-**Note:** For more details take a look at:
+For more details check it out:
 
 - [MariaDB 10 - Clients & Utilities](https://mariadb.com/kb/en/clients-utilities/)
 - [MySQL 8 - Client Programs](https://dev.mysql.com/doc/refman/8.0/en/programs-client.html)
 
+## User privileges
+
+- Default user (unprivileged) is `mysql`.
+- `mysql` home directory is located at `/home/mysql`.
+- If you want a full privileged user try `root`. E.g append a `--user root` argument to `docker run`.
+
 ## Additional Tools
 
-This image comes with some additional tools:
+This image comes with some additional tools.
 
 ### Exporter
 
 `mysql_exporter` is a custom tool which exports a database script using `mysqldump`. Additionally it support gzip compression.
-It can be configured via a `.env` file.
+It can be configured via environment variables or using `.env` file.
 
 #### Setup via environment variables
 
-Setup can be done using a `.env` file.
-
 ```env
 DB_PROTOCOL=TCP
 DB_HOST=127.0.0.1
@@ -48,23 +52,69 @@ DB_EXPORT_FILE_PATH=database.sql.gz
 DB_EXPORT_GZIP=true
 DB_NAME=db
 DB_USERNAME=root
-DB_PASSWORD=""
+DB_PASSWORD="xyz"
 DB_ARGS=
 ```
 
-**Notes: **
+**Notes:**
 
-- `DB_EXPORT_GZIP=true`: Compress the sql file using Gzip (optional)
+- `DB_EXPORT_GZIP=true`: Compress the sql file using Gzip (optional). If `false` or not defined then the exported file will be a `.sql` file.
+- `DB_ARGS`: can be used in order to pass more `mysqldump` arguments (optional). 
+- An `.env` example file can be found at [./mysql_exporter.env](./mysql_exporter.env)
 
-#### Export database using a Docker container
+#### Exporting a database using a Docker container
+
+The following Docker commands create a container in order to export a database and then remove such container automatically.
+
+**Note:** `mysql_exporter` supports enviroment variables or a `.env` file passed as argument.
 
 ```sh
 docker run --rm -it \
-    --name joseluisq/alpine-mysql-client \
-    --volume $(PWD):/root/sample \
-    --workdir /root/sample \
-    joseluisq/alpine-mysql-client \
-    mysql_exporter .env
+    --volume $(PWD):/home/mysql/sample \
+    --workdir /home/mysql/sample \
+        joseluisq/alpine-mysql-client:1 \
+        mysql_exporter production.env
+
+# Alpine / MySQL Client - Exporter
+# ================================
+# mysqldump  Ver 10.17 Distrib 10.4.12-MariaDB, for Linux (x86_64)
+# Exporting database `mydb` to `mydb.sql.gz` file...
+# Database `mydb` was exported successfully!
+# 2.0M	mydb.sql.gz
 ```
 
-__Note:__ `.env` is a custom file with the corresponding environment variables passed as argument.
+__Notes:__
+
+- `--volume $(PWD):/home/mysql/sample` specificy a [bind mount directory](https://docs.docker.com/storage/bind-mounts/) from host to container.
+- `$(PWD)` is just my host working directory. Use your own path.
+- `/home/mysql/` is default home directory user (optional). View [User privileges](#user-privileges) section above.
+- `/home/mysql/sample` is a container directory that Docker will create for us.
+- `--workdir /home/mysql/sample` specificy the working directory used by default inside the container.
+- `production.env` is a custom env file path with the corresponding environment variables passed as argument. That file shoud available in your host working directory. E.g `$PWD` in my case.
+
+#### Exporting a database using a Docker compose file
+
+```yaml
+version: "3.3"
+
+services:
+  exporter:
+    image: joseluisq/alpine-mysql-client:1
+    env_file: .env
+    command: mysql_exporter
+    working_dir: /home/mysql/sample
+    volumes:
+      - ./:/home/mysql/sample
+    networks:
+      - default
+```
+
+## Contributions
+
+Feel free to send a [pull request](https://github.com/joseluisq/alpine-mysql-client/pulls) or file some [issue](https://github.com/joseluisq/alpine-mysql-client/issues).
+
+## License
+
+MIT license
+
+© 2020 [Jose Quintana](https://git.io/joseluisq)
diff --git a/__mysqldump.sh b/__mysqldump.sh
@@ -31,14 +31,14 @@ MYEXPORT="\
 --password=\"$DB_PASSWORD\" \
 $DB_ARGS $DB_NAME $XDB_EXPORT"
 
-echo "MySQL Tools - Exporter"
-echo "======================="
+echo "Alpine / MySQL Client - Exporter"
+echo "================================"
 
 mysqldump --version
 
 echo "Exporting database \`$DB_NAME\` to \`$XDB_EXPORT_FILE\` file..."
 
 eval mysqldump $MYEXPORT
 
-echo "Database \`$DB_NAME\` were exported successfully!"
+echo "Database \`$DB_NAME\` was exported successfully!"
 du -sh $XDB_EXPORT_FILE
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -0,0 +1,18 @@
+version: "3.3"
+
+services:
+  exporter:
+    image: alpine-mysql-client:latest
+    
+    # Uses on development
+    env_file: .env
+
+    # Or uses on production
+    # environment:
+
+    command: mysql_exporter
+    working_dir: /home/mysql/sample
+    volumes:
+      - ./:/home/mysql/sample
+    networks:
+      - default
diff --git a/docker/tmpl.Dockerfile b/docker/tmpl.Dockerfile
@@ -0,0 +1,53 @@
+FROM alpine:$ALPINE_VERSION
+
+LABEL maintainer="Jose Quintana <git.io/joseluisq>"
+
+ARG USER_NAME
+ARG USER_HOME_DIR
+
+ENV BUILD_DEPS="gettext" \
+    RUNTIME_DEPS="libintl" \
+    \
+    USER_NAME=${USER_NAME:-mysql} \
+    USER_HOME_DIR=${USER_HOME_DIR:-/home/${USER_NAME}}
+
+RUN adduser -h ${USER_HOME_DIR} -s /sbin/nologin -u 1000 -D ${USER_NAME} && \
+    \
+    apk --no-cache add ca-certificates tzdata mysql-client nano dumb-init && \
+    \
+    set -ex; \
+    apkArch="$(apk --print-arch)"; \
+    case "$apkArch" in \
+        armhf) arch='arm' ;; \
+        aarch64) arch='arm64' ;; \
+        x86_64) arch='amd64' ;; \
+        *) echo >&2 "error: unsupported architecture: $apkArch"; exit 1 ;; \
+    esac; \
+    \
+    apk add --update $RUNTIME_DEPS && \
+    apk add --virtual build_deps $BUILD_DEPS && \
+    \
+    cp /usr/bin/envsubst /usr/local/bin/envsubst && \
+    apk del build_deps
+
+COPY ./__mysqldump.sh /usr/local/bin/__mysqldump.sh
+COPY ./mysql_exporter /usr/local/bin/mysql_exporter
+
+RUN chmod +x /usr/local/bin/__mysqldump.sh && \
+    chmod +x /usr/local/bin/mysql_exporter
+
+USER ${USER_NAME}
+WORKDIR ${USER_HOME_DIR}
+VOLUME ${USER_HOME_DIR}
+EXPOSE 3306
+
+ENTRYPOINT [ "/usr/bin/dumb-init" ]
+CMD [ "mysql" ]
+
+# Metadata
+LABEL org.opencontainers.image.vendor="Jose Quintana" \
+    org.opencontainers.image.url="https://github.com/joseluisq/alpine-mysql-client" \
+    org.opencontainers.image.title="Alpine / MySQL Client" \
+    org.opencontainers.image.description="MySQL client tools on top of Alpine Linux x86_64." \
+    org.opencontainers.image.version="$VERSION" \
+    org.opencontainers.image.documentation="https://github.com/joseluisq/alpine-mysql-client/blob/master/README.md"
diff --git a/docker/version.sh b/docker/version.sh
@@ -0,0 +1,28 @@
+#!/bin/sh
+
+set -e
+set -u
+
+LATEST_TAG=$1
+BASE_PATH="$(pwd)/docker"
+
+if [ $# -eq 0 ]; then
+    echo "Usage: ./version.sh <tag or branch>"
+    exit
+fi
+
+export VERSION=$LATEST_TAG
+export ALPINE_VERSION=3.11
+
+if [ ! -d "$BASE_PATH" ]; then
+    echo "Directory no found for \"${BASE_PATH}\""
+    exit 1
+fi
+
+echo "Generating Dockerfile for Alpine Linux v$ALPINE_VERSION x86_64"
+
+rm -rf "${BASE_PATH}/Dockerfile"
+
+envsubst \$ALPINE_VERSION,\$VERSION <"${BASE_PATH}/tmpl.Dockerfile" >"${BASE_PATH}/Dockerfile"
+
+echo "Dockerfile $VERSION were created successfully!"
diff --git a/mysql_exporter b/mysql_exporter
@@ -5,8 +5,8 @@ set -e
 FILE_ENV=$1
 
 if [ -z "$FILE_ENV" ]; then
-    echo 'A .env file is required as argument'
-    exit 1
+    __mysqldump.sh
+    exit 0
 fi
 
 if [ -f $FILE_ENV ]; then
diff --git a/mysql_exporter.env b/mysql_exporter.env
@@ -1,3 +1,5 @@
+## MySQL Export template settings
+
 DB_PROTOCOL=TCP
 DB_HOST=127.0.0.1
 DB_PORT=3306
