Merge pull request #27 from sergey-shambir/docs-for-docker-compose-use-case

Documented usage with docker-compose

.gitignore

@@ -1,5 +1,4 @@
 .idea
 *.iml
 
-home_dir
 config.json

Dockerfile

@@ -1,8 +1,9 @@
 FROM library/docker:stable
 
 ENV HOME_DIR=/opt/crontab
-RUN apk add --no-cache --virtual .run-deps bash jq \
+RUN apk add --no-cache --virtual .run-deps gettext bash jq \
-    && mkdir -p ${HOME_DIR}/jobs ${HOME_DIR}/projects
+    && mkdir -p ${HOME_DIR}/jobs ${HOME_DIR}/projects \
+    && adduser -S docker -D
 
 COPY docker-entrypoint /
 ENTRYPOINT ["/docker-entrypoint"]
@@ -10,4 +11,4 @@ ENTRYPOINT ["/docker-entrypoint"]
 HEALTHCHECK --interval=5s --timeout=3s \
     CMD ps aux | grep '[c]rond' || exit 1
 
-CMD ["crond","-f"]
+CMD ["crond", "-f", "-d", "6", "-c", "/etc/crontabs"]

README.md

@@ -22,9 +22,9 @@ A great project, don't get me wrong. It was just missing certain key enterprise
 - Ability to trigger scripts in other containers on completion cron job using `trigger`.
 
 ## Config.json
-- `name`: Human readable name that will be used as teh job filename. Optional.
+- `name`: Human readable name that will be used as the job filename. Will be converted into a slug. Optional.
 - `comment`: Comments to be included with crontab entry. Optional.
-- `schedule`: Crontab schedule syntax as described in https://godoc.org/github.com/robfig/cron. Ex `@hourly`, `@every 1h30m`, `* * * * * *`. Required.
+- `schedule`: Crontab schedule syntax as described in https://en.wikipedia.org/wiki/Cron. Ex `@hourly`, `@every 1h30m`, `* * * * *`. Required.
 - `command`: Command to be run on in crontab container or docker container/image. Required.
 - `image`: Docker images name (ex `library/alpine:3.5`). Optional.
 - `project`: Docker Compose/Swarm project name. Optional, only applies when `contain` is included.
@@ -57,6 +57,7 @@ See [`config.sample.json`](https://github.com/willfarrell/docker-crontab/blob/ma
 ## How to use
 
 ### Command Line
+
 ```bash
 docker build -t crontab .
 docker run -d \
@@ -67,7 +68,19 @@ docker run -d \
     crontab
 ```
 
+### Use with docker-compose
+
+1. Figure out which network name used for your docker-compose containers
+	* use `docker network ls` to see existing networks
+	* if your `docker-compose.yml` is in `my_dir` directory, you probably has network `my_dir_default`
+	* otherwise [read the docker-compose docs](https://docs.docker.com/compose/networking/)
+2. Add `dockerargs` to your docker-crontab `config.json`
+	* use `--network NETWORK_NAME` to connect new container into docker-compose network
+	* use `--rm --name NAME` to use named container
+	* e.g. `"dockerargs": "--network my_dir_default --rm --name my-best-cron-job"`
+
 ### Dockerfile
+
 ```Dockerfile
 FROM willfarrell/crontab
 
@@ -76,6 +89,7 @@ COPY config.json ${HOME_DIR}/
 ```
 
 ### Logrotate Dockerfile
+
 ```Dockerfile
 FROM willfarrell/crontab
 
@@ -87,15 +101,15 @@ CMD ["crond", "-f"]
 ```
 
 ### Logging - In Dev
+
 All `stdout` is captured, formatted, and saved to `/var/log/crontab/jobs.log`. Set `LOG_FILE` to `/dev/null` to disable logging.
 
 example: `e6ced859-1563-493b-b1b1-5a190b29e938 2017-06-18T01:27:10+0000 [info] Start Cronjob **map-a-vol** map a volume`
 
 grok: `CRONTABLOG %{DATA:request_id} %{TIMESTAMP_ISO8601:timestamp} \[%{LOGLEVEL:severity}\] %{GREEDYDATA:message}`
 
-
 ## TODO
 - [ ] Have ability to auto regenerate crontab on file change (signal HUP?)
 - [ ] Run commands on host machine (w/ --privileged?)
 - [ ] Write tests
-- [ ] Setup TravisCI
+- [ ] Setup TravisCI

docker-compose.yml

@@ -12,4 +12,4 @@ services:
     volumes:
      - "/var/run/docker.sock:/var/run/docker.sock:ro"
     # - "/usr/bin/docker:/usr/bin/docker:ro"
-     - "/Users/willfarrell/Development/docker/docker-crontab/home_dir:/opt/crontab:rw"
+     - "/Users/willfarrell/Development/docker/docker-crontab/config.json:/opt/crontab/config.json:rw"

docker-entrypoint

@@ -12,7 +12,7 @@ if [ "${LOG_FILE}" == "" ]; then
     LOG_DIR=/var/log/crontab
 	LOG_FILE=${LOG_DIR}/jobs.log
 	mkdir -p ${LOG_DIR}
-	touch ${LOG_FILE}
+    touch ${LOG_FILE}
 fi
 
 CONFIG=${HOME_DIR}/config.json
@@ -22,11 +22,35 @@ CRONTAB_FILE=/etc/crontabs/docker
 # Ensure dir exist - in case of volume mapping
 mkdir -p ${HOME_DIR}/jobs ${HOME_DIR}/projects
 
+ensure_docker_socket_accessible() {
+    if ! grep -q "^docker:" /etc/group; then
+        # Ensure 'docker' user has permissions for docker socket (without changing permissions)
+        DOCKER_GID=$(stat -c '%g' ${DOCKER_SOCK})
+        if [ "${DOCKER_GID}" != "0" ]; then
+            if ! grep -qE "^[^:]+:[^:]+:${DOCKER_GID}:" /etc/group; then
+                # No group with such gid exists - create group docker
+                addgroup -g ${DOCKER_GID} docker
+                adduser docker docker
+            else
+                # Group with such gid exists - add user "docker" to this group
+                DOCKER_GROUP_NAME=`getent group "${DOCKER_GID}" | awk -F':' '{{ print $1 }}'`
+                adduser docker $DOCKER_GROUP_NAME
+            fi
+        else
+            # Docker socket belongs to "root" group - add user "docker" to this group
+            adduser docker root
+        fi
+    fi
+}
+
+slugify() {
+    echo "$@" | iconv -t ascii | sed -r s/[~\^]+//g | sed -r s/[^a-zA-Z0-9]+/-/g | sed -r s/^-+\|-+$//g | tr A-Z a-z
+}
 
 make_image_cmd() {
     DOCKERARGS=$(echo ${1} | jq -r .dockerargs)
     if [ "${DOCKERARGS}" == "null" ]; then DOCKERARGS=; fi
-    IMAGE=$(echo ${1} | jq -r .image)
+    IMAGE=$(echo ${1} | jq -r .image | envsubst)
     TMP_COMMAND=$(echo ${1} | jq -r .command)
     echo "docker run ${DOCKERARGS} ${IMAGE} ${TMP_COMMAND}"
 }
@@ -35,8 +59,9 @@ make_container_cmd() {
     DOCKERARGS=$(echo ${1} | jq -r .dockerargs)
     if [ "${DOCKERARGS}" == "null" ]; then DOCKERARGS=; fi
     SCRIPT_NAME=$(echo ${1} | jq -r .name)
+    SCRIPT_NAME=$(slugify $SCRIPT_NAME)
     PROJECT=$(echo ${1} | jq -r .project)
-    CONTAINER=$(echo ${1} | jq -r .container)
+    CONTAINER=$(echo ${1} | jq -r .container | envsubst)
     TMP_COMMAND=$(echo ${1} | jq -r .command)
 
     if [ "${PROJECT}" != "null" ]; then
@@ -49,7 +74,7 @@ cat << EOF > ${HOME_DIR}/projects/${SCRIPT_NAME}.sh
 #!/usr/bin/env bash
 set -e
 
-CONTAINERS=\$(docker ps --format '{{.Names}}' | grep -E "^${PROJECT}_${CONTAINER}_[0-9]+")
+CONTAINERS=\$(docker ps --format '{{.Names}}' | grep -E "^${PROJECT}_${CONTAINER}.[0-9]+")
 for CONTAINER_NAME in \$CONTAINERS; do
     docker exec ${DOCKERARGS} \${CONTAINER_NAME} ${TMP_COMMAND}
 done
@@ -81,25 +106,25 @@ make_cmd() {
 parse_schedule() {
 	case $1 in
         "@yearly")
-            echo "0 0 0 1 1 *"
+            echo "0 0 1 1 *"
             ;;
         "@annually")
-            echo "0 0 0 1 1 *"
+            echo "0 0 1 1 *"
             ;;
         "@monthly")
-            echo "0 0 0 1 * *"
+            echo "0 0 1 * *"
             ;;
         "@weekly")
-            echo "0 0 0 * * 0"
+            echo "0 0 * * 0"
             ;;
         "@daily")
-            echo "0 0 0 * * *"
+            echo "0 0 * * *"
             ;;
         "@midnight")
-            echo "0 0 0 * * *"
+            echo "0 0 * * *"
             ;;
         "@hourly")
-            echo "0 0 * * * *"
+            echo "0 * * * *"
             ;;
         "@every")
             TIME=$2
@@ -119,7 +144,7 @@ parse_schedule() {
                 TOTAL=$(($TOTAL + ${D::-1} * 60 * 24))
             fi
 
-            echo "*/${TOTAL} * * * * *"
+            echo "*/${TOTAL} * * * *"
             ;;
         *)
             echo "${@}"
@@ -151,6 +176,7 @@ function build_crontab() {
         fi
 
         SCRIPT_NAME=$(jq -r .[$i].name ${CONFIG})
+        SCRIPT_NAME=$(slugify $SCRIPT_NAME)
         if [ "${SCRIPT_NAME}" == "null" ]; then
             SCRIPT_NAME=$(cat /proc/sys/kernel/random/uuid)
         fi
@@ -204,6 +230,8 @@ EOF
     done
 }
 
+ensure_docker_socket_accessible
+
 if [ "$1" = "crond" ]; then
     if [ -f ${CONFIG} ]; then
         build_crontab
@@ -213,4 +241,4 @@ if [ "$1" = "crond" ]; then
 fi
 
 echo "$@"
-exec "$@"
+exec "$@"

test_logging

@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
 set -e
 
+# This file is for testing the logging of docker output #8
+
 LOG_FILE=./jobs.log
 touch ${LOG_FILE}
 UUID="xxxxxxxxxxxxxxxxx"