make docs more clear about how to work with the current api
This commit is contained in:
parent
521e295349
commit
a0c3d6a421
3 changed files with 19 additions and 23 deletions
17
docs/toml.md
17
docs/toml.md
|
@ -1583,25 +1583,24 @@ ExposedByDefault = false
|
|||
|
||||
# Endpoint to use when connecting to Rancher
|
||||
#
|
||||
# Optional
|
||||
# Endpoint = "http://rancherserver.example.com"
|
||||
# Required
|
||||
# Endpoint = "http://rancherserver.example.com/v1"
|
||||
|
||||
# AccessKey to use when connecting to Rancher
|
||||
#
|
||||
# Optional
|
||||
# AccessKey = "XXXXXXXXX"
|
||||
# Required
|
||||
# AccessKey = "XXXXXXXXXXXXXXXXXXXX"
|
||||
|
||||
# SecretKey to use when connecting to Rancher
|
||||
#
|
||||
# Optional
|
||||
# SecretKey = "XXXXXXXXXXX"
|
||||
# Required
|
||||
# SecretKey = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
|
||||
|
||||
```
|
||||
|
||||
If you're deploying traefik as a service within rancher, you can alternatively set these labels on the service to let it only fetch data of its current environment. The settings `endpoint`, `accesskey` and `secretkey` can be omitted then.
|
||||
As traefik needs access to the rancher API, you need to set the `endpoint`, `accesskey` and `secretkey` parameters.
|
||||
|
||||
- `io.rancher.container.create_agent=true`
|
||||
- `io.rancher.container.agent.role=environment`
|
||||
To enable traefik to fetch information about the Environment it's deployed in only, you need to create an `Environment API Key`. This can be found within the API Key advanced options.
|
||||
|
||||
Labels can be used on task containers to override default behaviour:
|
||||
|
||||
|
|
|
@ -1,9 +1,6 @@
|
|||
traefik:
|
||||
image: traefik
|
||||
command: --web --rancher --rancher.domain=rancher.localhost --logLevel=DEBUG
|
||||
labels:
|
||||
io.rancher.container.agent.role: environment
|
||||
io.rancher.container.create_agent: 'true'
|
||||
command: --web --rancher --rancher.domain=rancher.localhost --rancher.endpoint=http://example.com --rancher.accesskey=XXXXXXX --rancher.secretkey=YYYYYY --logLevel=DEBUG
|
||||
ports:
|
||||
- "80:80"
|
||||
- "443:443"
|
||||
|
|
|
@ -1031,18 +1031,18 @@
|
|||
|
||||
# Endpoint to use when connecting to Rancher
|
||||
#
|
||||
# Optional
|
||||
# Endpoint = "http://rancherserver.example.com"
|
||||
# Required
|
||||
# Endpoint = "http://rancherserver.example.com/v1"
|
||||
|
||||
# AccessKey to use when connecting to Rancher
|
||||
#
|
||||
# Optional
|
||||
# AccessKey = "XXXXXXXXX"
|
||||
# Required
|
||||
# AccessKey = "XXXXXXXXXXXXXXXXXXXX"
|
||||
|
||||
# SecretKey to use when connecting to Rancher
|
||||
#
|
||||
# Optional
|
||||
# SecretKey = "XXXXXXXXXXX"
|
||||
# Required
|
||||
# SecretKey = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
|
||||
|
||||
|
||||
################################################################
|
||||
|
|
Loading…
Reference in a new issue