README.md

   1 kong-app
   2 =========
   3
   4 This role aims at creating on a remote kong the service, routes and plugins needed by an app
   5
   6 Requirements
   7 ------------
   8
   9 None at the moment
  10
  11 Role 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_services` an array of services to setup (default to [])
  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`
  27
  28 Dependencies
  29 ------------
  30
  31
  32
  33 Example Playbook
  34 ----------------
  35
  36     - hosts: localhost
  37       roles:
  38          - { role: kong-app, kong_app_admin_url: http://localhost:8001,
  39              kong_app_services: [ name:example,
  40              url: http://example.com,
  41              plugins: [],
  42              routes: [ { hosts: [my.kong.example], paths: [/] } ]]
  43            }
  44
  45 License
  46 -------
  47
  48 TBD
  49
  50 Author Information
  51 ------------------
  52
  53 FretLink Team