Archives/pyentrypoint
2
0
Fork 0
mirror of https://github.com/cmehay/pyentrypoint synced 2024-10-30 15:21:11 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #13 from cmehay/readme

Browse Source 
Update readme
This commit is contained in:
Christophe Mehay 2016-12-08 09:55:03 +01:00 committed by GitHub
commit 72e44abe8c
3 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -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:

3
docs/config.rst
View File

@ -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.

4
docs/templates.rst
View File

@ -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