aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 15 insertions, 14 deletions
diff --git a/README.md b/README.md
index 5cf5f18..074e830 100644
--- a/README.md
+++ b/README.md
@@ -13,16 +13,17 @@ Role Variables
13 13
14* `kong_app_admin_url` the kong admin url (mandatory). 14* `kong_app_admin_url` the kong admin url (mandatory).
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* `kong_app_service_name` the nameof the service to create for this app, mandatory 16* `kong_services` an array of services to setup (default to [])
17* `kong_app_service_url` the url of the backend of the app, mandatory 17 * `name` the name of the service to create for this app, mandatory
18* `kong_app_plugins` An array of plugins to activate with their name and config in a dict 18 * `url` the url of the backend of the app, mandatory
19 * `name` 19 * `plugins` An array of plugins to activate with their name and config in a dict
20 * `config` 20 * `name`
21* `kong_app_routes` An array of routes to create for this app. 21 * `config`
22 * `hosts` 22 * `routes` An array of routes to create for this service.
23 * `paths` 23 * `hosts`
24 * `protocols` 24 * `paths`
25 * `methods` 25 * `protocols`
26 * `methods`
26 27
27Dependencies 28Dependencies
28------------ 29------------
@@ -35,10 +36,10 @@ Example Playbook
35 - hosts: localhost 36 - hosts: localhost
36 roles: 37 roles:
37 - { role: kong-app, kong_app_admin_url: http://localhost:8001, 38 - { role: kong-app, kong_app_admin_url: http://localhost:8001,
38 kong_app_service_name: example, 39 kong_app_services: [ name:example,
39 kong_app_service_url: http://example.com, 40 url: http://example.com,
40 kong_app_plugins: [], 41 plugins: [],
41 kong_app_routes: [ { hosts: [my.kong.example], paths: [/] } ] 42 routes: [ { hosts: [my.kong.example], paths: [/] } ]]
42 } 43 }
43 44
44License 45License