From c7ee42fdaed4dfc97617ac4d057f7136bec0d1fd Mon Sep 17 00:00:00 2001 From: Christophe Mehay Date: Thu, 8 Dec 2016 09:43:05 +0100 Subject: [PATCH] Update readme --- README.md | 10 +++++++++- docs/config.rst | 3 +++ docs/templates.rst | 4 ++++ 3 files changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cce76af..bc17f74 100644 --- a/README.md +++ b/README.md @@ -111,6 +111,7 @@ secret_env: # Links are handled here # Port, name, protocol or env variable can be used to identify the links # Raise an error if the link could not be identified +# This is not supported when using docker network or docker-compose v2. links: 'ssh': port: 22 @@ -159,7 +160,9 @@ quiet: false ### Config templates -You can generate configuration for your service with jinga2 template. +You can generate configuration for your service with jinja2 template. + +**`links` and `containers` are not supported with docker network and docker-compose v2.** Here is an example for an hypothetical ssh config file: @@ -216,6 +219,8 @@ You have 4 available objects in your templates. #### links +**Not supported with docker network and docker-compose v2** + `Links` handles `Link` objects. You can identify links using wildcard patterns in the configuration file. `link` is related to one physical link (one ip and one port). @@ -235,6 +240,9 @@ You have 4 available objects in your templates. - tuple of related container names #### containers + +**Not supported with docker network and docker-compose v2** + `containers` handles a tuple of `container` object. `container` handles the following attributes: diff --git a/docs/config.rst b/docs/config.rst index 9d28131..8bbff33 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -46,6 +46,7 @@ This is an example of ``entrypoint-config.yml`` file. # Links are handled here # Port, name, protocol or env variable can be used to identify the links # Raise an error if the link could not be identified + # This not supported when using docker network or docker-compose v2. links: 'ssh': port: 22 @@ -175,6 +176,8 @@ running command to keep them secret. links ^^^^^ +**Not supported when using docker network or docker-compose v2.** + Links are handled here. Port, name, protocol or environment variables can be used to identify the links. diff --git a/docs/templates.rst b/docs/templates.rst index 8794eb3..62722cb 100644 --- a/docs/templates.rst +++ b/docs/templates.rst @@ -64,6 +64,8 @@ object. links ^^^^^ +**Not supported when using docker network or docker-compose v2.** + ``Links`` handles ``Link`` objects. You can identify links using wildcard patterns in the configuration file. @@ -78,6 +80,8 @@ container names containers ^^^^^^^^^^ +**Not supported when using docker network or docker-compose v2.** + ``containers`` handles a tuple of ``container`` object. ``container`` handles the following attributes: - ``ip`` - container ip