From e39a878d84f3b3ec5265d332e5e06ee0edd55418 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Ga=C3=ABtan=20Duchaussois?= Date: Wed, 16 May 2018 15:29:57 +0200 Subject: [PATCH] add more info on README --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 5853226..8db9391 100644 --- a/README.md +++ b/README.md @@ -15,12 +15,14 @@ Role Variables * `kong_app_admin_apikey` the apikey to use kong admin api. Default to "" * `services` an array of services to setup (default to []) * `name` the name of the service to create for this app, mandatory - * `url` the url of the backend of the app, mandatory - * `upstream` if the url reference an upstream a dict with the configuration - * `conf` the configuration as expected by kong for an upstream creataion + * `url` the url of the backend of the app, mandatory. May refer to an upstream by its name (https://upstream\_name/path) + * `upstream` if the url reference an upstream a dict with the configuration, optional + * `conf` the configuration as expected by kong for an upstream creation + * `name` mandatory name for the upstream + * `healthchecks` optional healthchecks configuration as expected by kong api * `targets` an array of dict defining a target for kong - * `target` the host:port to reach the target - * `weight` the weight of the target + * `target` the host:port to reach the target (mandatory) + * `weight` the weight of the target (optional) * `plugins` An array of plugins to activate with their name and config in a dict * `name` * `config` -- 2.41.0