From cfc37ba3f1c17154a344d5929daee3f472c97571 Mon Sep 17 00:00:00 2001 From: Shizun Ge Date: Wed, 27 Nov 2024 17:02:30 -0800 Subject: [PATCH] [docs] add a note about label on services. remove unnecessary comments from examples. --- README.md | 2 ++ examples/cronjob/docker-compose.yml | 2 -- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7049251..4990fd0 100644 --- a/README.md +++ b/README.md @@ -117,6 +117,8 @@ Labels can be added to services to modify the behavior of *Gantry* for particula | `gantry.update.options=` | Override [`GANTRY_UPDATE_OPTIONS`](#to-add-options-to-services-update). | | `gantry.update.timeout_seconds=` | Override [`GANTRY_UPDATE_TIMEOUT_SECONDS`](#to-add-options-to-services-update). | +> NOTE: You must apply the labels to the services not the containers. If you are using docker compose files to setup your services, you need to add the label to the [deploy](https://docs.docker.com/reference/compose-file/deploy/#labels) section. + ## FAQ [Authentication](docs/authentication.md) diff --git a/examples/cronjob/docker-compose.yml b/examples/cronjob/docker-compose.yml index b3ac1a0..89ccb76 100644 --- a/examples/cronjob/docker-compose.yml +++ b/examples/cronjob/docker-compose.yml @@ -7,8 +7,6 @@ services: - /var/run/docker.sock:/var/run/docker.sock environment: - "GANTRY_NODE_NAME={{.Node.Hostname}}" - # The gantry service is able to find the name of itself service. Use GANTRY_SERVICES_SELF when you want to set a different value. - # - "GANTRY_SERVICES_SELF=${STACK}_gantry" - "GANTRY_SLEEP_SECONDS=0" deploy: replicas: 0