retry in case of failed patch

[github/fretlink/ansible-kong-app.git] / README.md

diff --git a/README.md b/README.md
index e9a2a29610225e3127a94cb93bbeb12f77250046..8db9391ee1bc4e176be41a4ea6a29c8b3417d8f7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -13,9 +13,16 @@ Role Variables
 * `kong_servers`: an array of kong\_server to configure with followin configuration:
   * `kong_app_admin_url` the kong admin url (mandatory).
   * `kong_app_admin_apikey` the apikey to use kong admin api. Default to ""
-  * `kong_services` an array of services to setup (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
+    * `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 (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`
@@ -35,11 +42,11 @@ Example Playbook
 
     - hosts: localhost
       roles:
-         - { role: kong-app, kong_app_admin_url: http://localhost:8001,
-             kong_app_services: [ name:example,
+         - { role: kong-app, kong_servers: [ kong_app_admin_url: http://localhost:8001,
+             services: [ name:example,
              url: http://example.com,
              plugins: [],
-             routes: [ { hosts: [my.kong.example], paths: [/] } ]]
+             routes: [ { hosts: [my.kong.example], paths: [/] } ]]]
            }
 
 License