]> git.immae.eu Git - github/fretlink/ansible-kong-app.git/blame - README.md
fix README
[github/fretlink/ansible-kong-app.git] / README.md
CommitLineData
530dddec
GD
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--------------
507bb99c
GD
13* `kong_servers`: an array of kong\_server to configure with followin configuration:
14 * `kong_app_admin_url` the kong admin url (mandatory).
15 * `kong_app_admin_apikey` the apikey to use kong admin api. Default to ""
0d2ed34f 16 * `services` an array of services to setup (default to [])
507bb99c
GD
17 * `name` the name of the service to create for this app, mandatory
18 * `url` the url of the backend of the app, mandatory
19 * `plugins` An array of plugins to activate with their name and config in a dict
20 * `name`
21 * `config`
22 * `routes` An array of routes to create for this service.
23 * `hosts`
24 * `paths`
25 * `protocols`
26 * `methods`
530dddec
GD
27
28Dependencies
29------------
30
31
32
33Example Playbook
34----------------
35
36 - hosts: localhost
37 roles:
0d2ed34f
GD
38 - { role: kong-app, kong_servers: [ kong_app_admin_url: http://localhost:8001,
39 services: [ name:example,
767c0e53
GD
40 url: http://example.com,
41 plugins: [],
0d2ed34f 42 routes: [ { hosts: [my.kong.example], paths: [/] } ]]]
530dddec
GD
43 }
44
45License
46-------
47
48TBD
49
50Author Information
51------------------
52
53FretLink Team