aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
-rw-r--r--README.md52
1 files changed, 52 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5cf5f18
--- /dev/null
+++ b/README.md
@@ -0,0 +1,52 @@
1kong-app
2=========
3
4This role aims at creating on a remote kong the service, routes and plugins needed by an app
5
6Requirements
7------------
8
9None at the moment
10
11Role Variables
12--------------
13
14* `kong_app_admin_url` the kong admin url (mandatory).
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
17* `kong_app_service_url` the url of the backend of the app, mandatory
18* `kong_app_plugins` An array of plugins to activate with their name and config in a dict
19 * `name`
20 * `config`
21* `kong_app_routes` An array of routes to create for this app.
22 * `hosts`
23 * `paths`
24 * `protocols`
25 * `methods`
26
27Dependencies
28------------
29
30
31
32Example Playbook
33----------------
34
35 - hosts: localhost
36 roles:
37 - { role: kong-app, kong_app_admin_url: http://localhost:8001,
38 kong_app_service_name: example,
39 kong_app_service_url: http://example.com,
40 kong_app_plugins: [],
41 kong_app_routes: [ { hosts: [my.kong.example], paths: [/] } ]
42 }
43
44License
45-------
46
47TBD
48
49Author Information
50------------------
51
52FretLink Team