From 3ebca1dc1e6ee4acc20a70df9c5f1d3f75a03bef Mon Sep 17 00:00:00 2001 From: Martin Honermeyer <7229+djmaze@users.noreply.github.com> Date: Mon, 27 Feb 2023 00:04:25 +0100 Subject: [PATCH] Move example configs to their own folder --- README.md | 6 ++++-- .../docker-compose.apprise.yml | 1 - .../docker-compose.swarm-cronjob.yml | 1 - 3 files changed, 4 insertions(+), 4 deletions(-) rename docker-compose.apprise.yml => examples/docker-compose.apprise.yml (97%) rename docker-compose.swarm-cronjob.yml => examples/docker-compose.swarm-cronjob.yml (98%) diff --git a/README.md b/README.md index bc30e28..0b98b73 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,8 @@ That's a bad precondition for maintaining a project. So if there is anyone who i constraints: - node.role == manager +See the example [docker-compose.yml](docker-compose.yml) and some more compose configs in the [examples](examples) folder. + ## Configuration Shepherd will try to update your services every 5 minutes by default. You can adjust this value using the `SLEEP_TIME` variable. @@ -89,7 +91,7 @@ You can enable connection to insecure private registry by setting the `WITH_INSE You can force image deployment whatever the architecture by setting the `WITH_NO_RESOLVE_IMAGE` variable. -You can enable notifications on service update with apprise, using the [apprise microservice](https://github.com/djmaze/apprise-microservice) and the `APPRISE_SIDECAR_URL` variable. See the file [docker-compose.apprise.yml](docker-compose.apprise.yml) for an example. +You can enable notifications on service update with apprise, using the [apprise microservice](https://github.com/djmaze/apprise-microservice) and the `APPRISE_SIDECAR_URL` variable. See the file [docker-compose.apprise.yml](examples/docker-compose.apprise.yml) for an example. You can enable old image autocleaning on service update by setting the `IMAGE_AUTOCLEAN_LIMIT` variable. @@ -124,7 +126,7 @@ When running shepherd as described with a `SLEEP_TIME`, the de facto running tim 1. Create a *swarm-cronjob* service [as described in its documentation](https://crazymax.dev/swarm-cronjob/install/docker/#usage). 2. Set `RUN_ONCE_AND_EXIT` to `true`, `replicas` to `0` and `restart_policy` to `condition: none`. Add docker labels for the schedule. -See [docker-compose.swarm-cronjob.yml](docker-compose.swarm-cronjob.yml) for a full stack example which includes both shepherd as well as swarm-cronjob. +See [docker-compose.swarm-cronjob.yml](examples/docker-compose.swarm-cronjob.yml) for a full stack example which includes both shepherd as well as swarm-cronjob. ## How does it work? diff --git a/docker-compose.apprise.yml b/examples/docker-compose.apprise.yml similarity index 97% rename from docker-compose.apprise.yml rename to examples/docker-compose.apprise.yml index 75df9d6..c7d8ea9 100644 --- a/docker-compose.apprise.yml +++ b/examples/docker-compose.apprise.yml @@ -2,7 +2,6 @@ version: "3" services: app: - build: . image: mazzolino/shepherd environment: APPRISE_SIDECAR_URL: notify:5000 diff --git a/docker-compose.swarm-cronjob.yml b/examples/docker-compose.swarm-cronjob.yml similarity index 98% rename from docker-compose.swarm-cronjob.yml rename to examples/docker-compose.swarm-cronjob.yml index d05ac92..d97a4ec 100644 --- a/docker-compose.swarm-cronjob.yml +++ b/examples/docker-compose.swarm-cronjob.yml @@ -2,7 +2,6 @@ version: "3" services: app: - build: . image: mazzolino/shepherd environment: TZ: 'US/Eastern'