diff options
| author | Gaëtan Duchaussois <gaetan.duchaussois@fretlink.com> | 2018-05-16 15:29:57 +0200 |
|---|---|---|
| committer | Gaëtan Duchaussois <gaetan.duchaussois@fretlink.com> | 2018-05-17 15:38:05 +0200 |
| commit | e39a878d84f3b3ec5265d332e5e06ee0edd55418 (patch) | |
| tree | a4e74004829038caa97ff4c7b0c23eaa79d01cb4 /README.md | |
| parent | f9fca1285e7a0e996a5b2db7b807ad7aff63f0d2 (diff) | |
| download | ansible-kong-app-e39a878d84f3b3ec5265d332e5e06ee0edd55418.tar.gz ansible-kong-app-e39a878d84f3b3ec5265d332e5e06ee0edd55418.tar.zst ansible-kong-app-e39a878d84f3b3ec5265d332e5e06ee0edd55418.zip | |
add more info on README
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 12 |
1 files changed, 7 insertions, 5 deletions
| @@ -15,12 +15,14 @@ Role Variables | |||
| 15 | * `kong_app_admin_apikey` the apikey to use kong admin api. Default to "" | 15 | * `kong_app_admin_apikey` the apikey to use kong admin api. Default to "" |
| 16 | * `services` an array of services to setup (default to []) | 16 | * `services` an array of services to setup (default to []) |
| 17 | * `name` the name of the service to create for this app, mandatory | 17 | * `name` the name of the service to create for this app, mandatory |
| 18 | * `url` the url of the backend of the app, mandatory | 18 | * `url` the url of the backend of the app, mandatory. May refer to an upstream by its name (https://upstream\_name/path) |
| 19 | * `upstream` if the url reference an upstream a dict with the configuration | 19 | * `upstream` if the url reference an upstream a dict with the configuration, optional |
| 20 | * `conf` the configuration as expected by kong for an upstream creataion | 20 | * `conf` the configuration as expected by kong for an upstream creation |
| 21 | * `name` mandatory name for the upstream | ||
| 22 | * `healthchecks` optional healthchecks configuration as expected by kong api | ||
| 21 | * `targets` an array of dict defining a target for kong | 23 | * `targets` an array of dict defining a target for kong |
| 22 | * `target` the host:port to reach the target | 24 | * `target` the host:port to reach the target (mandatory) |
| 23 | * `weight` the weight of the target | 25 | * `weight` the weight of the target (optional) |
| 24 | * `plugins` An array of plugins to activate with their name and config in a dict | 26 | * `plugins` An array of plugins to activate with their name and config in a dict |
| 25 | * `name` | 27 | * `name` |
| 26 | * `config` | 28 | * `config` |