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 * `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 ""
  16   * `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. May refer to an upstream by its name (https://upstream\_name/path)
  19     * `upstream` if the url reference an upstream a dict with the configuration, optional
  20       * `conf` the configuration as expected by kong for an upstream creation
  21         * `name` mandatory name for the upstream
  22         * `healthchecks` optional healthchecks configuration as expected by kong api
  23       * `targets` an array of dict defining a target for kong
  24         * `target` the host:port to reach the target (mandatory)
  25         * `weight` the weight of the target (optional)
  26     * `plugins` An array of plugins to activate with their name and config in a dict
  27       * `name`
  28       * `config`
  29     * `routes` An array of routes to create for this service.
  30       * `hosts`
  31       * `paths`
  32       * `protocols`
  33       * `methods`
  34
  35 Dependencies
  36 ------------
  37
  38
  39
  40 Example Playbook
  41 ----------------
  42
  43     - hosts: localhost
  44       roles:
  45          - { role: kong-app, kong_servers: [ kong_app_admin_url: http://localhost:8001,
  46              services: [ name:example,
  47              url: http://example.com,
  48              plugins: [],
  49              routes: [ { hosts: [my.kong.example], paths: [/] } ]]]
  50            }
  51
  52 License
  53 -------
  54
  55 TBD
  56
  57 Author Information
  58 ------------------
  59
  60 FretLink Team