Snck3rs/docker-crontab
Snck3rs/docker-crontab
1
0
Fork 0
mirror of https://github.com/willfarrell/docker-crontab.git synced 2025-04-04 14:05:11 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

Documented usage with docker-compose

Browse Source
This commit is contained in:
Sergey Shambir 2019-03-02 16:16:07 +03:00
parent 02a89f6dac
commit 5946f3545d
1 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -57,6 +57,7 @@ See [`config.sample.json`](https://github.com/willfarrell/docker-crontab/blob/ma
## How to use ## How to use
### Command Line ### Command Line
```bash ```bash
docker build -t crontab . docker build -t crontab .
docker run -d \ docker run -d \
@ -67,7 +68,19 @@ docker run -d \
crontab 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
```Dockerfile ```Dockerfile
FROM willfarrell/crontab FROM willfarrell/crontab
@ -76,6 +89,7 @@ COPY config.json ${HOME_DIR}/
``` ```
### Logrotate Dockerfile ### Logrotate Dockerfile
```Dockerfile ```Dockerfile
FROM willfarrell/crontab FROM willfarrell/crontab
@ -87,13 +101,13 @@ CMD ["crond", "-f"]
``` ```
### Logging - In Dev ### 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. 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` 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}` grok: `CRONTABLOG %{DATA:request_id} %{TIMESTAMP_ISO8601:timestamp} \[%{LOGLEVEL:severity}\] %{GREEDYDATA:message}`
## TODO ## TODO
- [ ] Have ability to auto regenerate crontab on file change (signal HUP?) - [ ] Have ability to auto regenerate crontab on file change (signal HUP?)
- [ ] Run commands on host machine (w/ --privileged?) - [ ] Run commands on host machine (w/ --privileged?)