模型托管>> consul-ansible-module>> 返回
项目作者： mtchavez

项目描述 ：
Ansible Module for Consul HTTP API
高级语言： Python
项目地址: git://github.com/mtchavez/consul-ansible-module.git
创建时间： 2015-04-01T23:33:01Z
项目社区：https://github.com/mtchavez/consul-ansible-module
开源协议：MIT License
下载


Consul HTTP API Ansible Module

Latest Version
Build Status

An Ansible module to interact with consul’s API from your playbooks and roles.

API Endpoints

ACL

Usage

  1. - name: Create ACL with defaults
  2.   consul_acl:
  3.     action: create
  4.     token: "master-token"
  6. - name: Update ACL
  7.   consul_acl:
  8.     action: update
  9.     acl_id: "existing-acl-id"
  10.     name: "updated-acl-name"
  11.     token: "master-token"
  13. - name: List ACL
  14.   consul_acl:
  15.     action: list
  16.     token: "master-token"
  18. - name: Get ACL replication
  19.   consul_acl:
  20.     action: replication
  21.     token: "master-token"
  23. - name: Get ACL info
  24.   consul_acl:
  25.     action: info
  26.     acl_id: "asdf-1234-asdf-1234"
  27.     token: "master-token"
  29. - name: Destroy ACL
  30.   consul_acl:
  31.     action: destroy
  32.     acl_id: "asdf-1234-asdf-1234"
  33.     token: "master-token"
  35. - name: Clone ACL
  36.   consul_acl:
  37.     action: clone
  38.     acl_id: "asdf-1234-asdf-1234"
  39.     token: "master-token"

Documentation

  1. ---
  2. module: consul_acl
  3. version_added: "1.9"
  4. author: Chavez
  5. short_description: Interact with Consul ACL API
  6. description:
  7.    - Use Consul ACL API in your playbooks and roles
  8. options:
  9.   acl_type:
  10.     description:
  11.       - Type of ACL
  12.     required: false
  13.   action:
  14.     description:
  15.       - One of [create]
  16.     required: true
  17.   dc:
  18.     desription:
  19.       - The datacenter to use
  20.     required: false
  21.     default: dc1
  22.   host:
  23.     description:
  24.       - Consul host
  25.     required: true
  26.     default: 127.0.0.1
  27.   name:
  28.     description:
  29.       - Name of event to fire
  30.     required: false
  31.   port:
  32.     description:
  33.       - Consul API port
  34.     required: true
  35.   rules:
  36.     description:
  37.       - ACL rules to set or update
  38.     required: false
  39.   token:
  40.     description:
  41.       - ACL token to use with requests
  42.     required: false
  43.   version:
  44.     description:
  45.       - Consul API version
  46.     required: true
  47.     default: v1

Events

Usage

Examples

  1. - name: Event new
  2.   consul_event:
  3.     action: fire
  4.     name: deploy
  5.   register: new_event
  7. - name: Event new
  8.   consul_event:
  9.     action: list
  10.   register: all_events

Documentation

  1. ---
  2. module: consul_events
  3. version_added: "1.9"
  4. author: Chavez
  5. short_description: Interact with Consul Event API
  6. description:
  7.    - Use Consul Event API in your playbooks and roles
  8. options:
  9.   action:
  10.     description:
  11.       - One of [leader, peers]
  12.     required: true
  13.   dc:
  14.     desription:
  15.       - The datacenter to use
  16.     required: false
  17.     default: dc1
  18.   host:
  19.     description:
  20.       - Consul host
  21.     required: true
  22.     default: 127.0.0.1
  23.   name:
  24.     description:
  25.       - Name of event to fire
  26.     required: false
  27.   node:
  28.     description:
  29.       - Node query filter for event fire
  30.     required: false
  31.   port:
  32.     description:
  33.       - Consul API port
  34.     required: true
  35.   service:

Key/Value

Usage

Examples

  1. - name: PUT a value for a key
  2.   consul_kv:
  3.     action: put
  4.     key: foo
  5.     value: bar
  7. - name: PUT value with flag
  8.   consul_kv:
  9.     action: put
  10.     key: bar/baz/bizzle
  11.     value: shizzle
  12.     flags: 23
  14. - name: GET key for PUT with check and set
  15.   consul_kv:
  16.     action: get
  17.     key: bar/baz/bizzle
  18.   register: bizzle
  20. - name: PUT check and set
  21.   consul_kv:
  22.     action: put
  23.     key: bar/baz/bizzle
  24.     value: "no shizzle"
  25.     cas: "{{ item.ModifyIndex|int }}"
  26.   with_items: bizzle.value
  28. - name: PUT with session
  29.   consul_kv:
  30.     action: put
  31.     key: razzle/acquired
  32.     value: true
  33.     acquire: "some-valid-session"
  35. - name: PUT with session release
  36.   consul_kv:
  37.     action: put
  38.     key: razzle/acquired
  39.     value: true
  40.     release: "some-valid-session"
  42. - name: GET a value for a key
  43.   consul_kv:
  44.     action: get
  45.     key: foo/bar/baz
  47. - name: GET keys for prefix
  48.   consul_kv:
  49.     action: get
  50.     key: bar
  51.     keys: true
  52.   register: bar_keys
  54. - name: GET keys up to separator
  55.   consul_kv:
  56.     action: get
  57.     key: bar/
  58.     keys: true
  59.     separator: "/"
  60.   register: separator_keys
  62. - name: DELETE a key
  63.   consul_kv:
  64.     action: delete
  65.     key: foo/tmp
  67. - name: DELETE a directory recursively
  68.   consul_kv:
  69.     action: delete
  70.     key: foo/bar
  71.     recurse: true

Documentation

  1. module: consul_kv
  2. version_added: "1.9"
  3. author: Chavez
  4. short_description: Interact with Consul K/V API
  5. description:
  6.    - Use Consul K/V API in your playbooks and roles
  7. options:
  8.   acquire:
  9.     - description:
  10.       - Session to use for PUT requests
  11.     required: false
  13.     description:
  14.       - HTTP verb [GET, PUT, DELETE]
  15.     required: true
  16.   dc:
  17.     desription:
  18.       - The datacenter to use
  19.     required: false
  20.     default: dc1
  21.   cas:
  22.     description:
  23.       - Check and set parameter
  24.     require: false
  25.   flags:
  26.     description:
  27.       - Opaque flag to set as metadata for a key
  28.     require: false
  29.   host:
  30.     description:
  31.       - Consul host
  32.     required: true
  33.     default: 127.0.0.1
  34.   key:
  35.     description:
  36.       - Key to interact with in K/V store
  37.     required: true
  38.   keys:
  39.     description:
  40.       - Return keys on a GET request for a given path
  41.     required: false
  42.     default: False
  43.   port:
  44.     description:
  45.       - Consul API port
  46.     required: true
  47.     default: 8500
  48.   recurse:
  49.     description:
  50.       - Recurse flag for DELETE or GET actions
  51.     required: false
  52.     default: False
  53.   release:
  54.     - description:
  55.       - Session to release for PUT requests
  56.     required: false
  57.   separator:
  58.     description:
  59.       - Separator to use when listing keys for a GET
  60.     required: false
  61.   value:
  62.     description:
  63.       - Value to set when adding or updating a key
  64.     required: false
  65.   version:
  66.     description:
  67.       - Consul API version
  68.     required: true
  69.     default: v1

Session

Usage

Examples

  1. - name: Session create
  2.   consul_session:
  3.     action: create
  4.     ttl: 15s
  5.   register: session
  7. - name: Get session info
  8.   consul_session:
  9.     action: info
  10.     session: "{{ session.value.ID }}"
  11.   register: session_info
  13. - name: Session create with all params
  14.   consul_session:
  15.     action: create
  16.     lock_delay: 25s
  17.     node: "{{ item.Node }}"
  18.     behavior: delete
  19.     checks: ""
  20.     ttl: 25s
  21.   register: session_params
  22.   with_items: "{{ session_info.value }}"
  24. - name: Get session params info
  25.   consul_session:
  26.     action: info
  27.     session: "{{ item.value.ID }}"
  28.   register: session_params_info
  29.   with_items: "{{ session_params.results }}"
  31. - name: Get session renew
  32.   consul_session:
  33.     action: renew
  34.     session: "{{ session.value.ID }}"
  35.   register: session_renew
  37. - name: List sessions
  38.   consul_session:
  39.     action: list
  40.   register: all_sessions
  42. - name: All sessions for a node
  43.   consul_session:
  44.     action: node
  45.     node: "{{ item.Node }}"
  46.   register: node_sessions
  47.   with_items: "{{ session_info.value }}"
  49. - name: Destroy session
  50.   consul_session:
  51.     action: destroy
  52.     session: "{{ item }}"
  53.   with_items:
  54.     - "{{ session.value.ID }}"
  55.     - "{{ session_params.results[0].value.ID }}"

Documentation

  1. module: consul_session
  2. version_added: "1.9"
  3. author: Chavez
  4. short_description: Interact with Consul Sessions API
  5. description:
  6.    - Use Consul Sessions API in your playbooks and roles
  7. options:
  8.   action:
  9.     description:
  10.       - API session action [create, destroy, info, node, list, renew]
  11.     required: true
  12.   behavior:
  13.     description:
  14.       - Controls when the session is invalidated [release, delete]
  15.     require: false
  16.   checks:
  17.     description:
  18.       - List of associated health checks comma separated "foo,bar,baz"
  19.     required: false
  20.   dc:
  21.     desription:
  22.       - The datacenter to use
  23.     required: false
  24.     default: dc1
  25.   host:
  26.     description:
  27.       - Consul host
  28.     required: true
  29.     default: 127.0.0.1
  30.   lock_delay:
  31.     description:
  32.       - Time to delay the lock of the session
  33.     require: false
  34.   node:
  35.     description:
  36.       - Node name to set on create
  37.     required: false
  38.   port:
  39.     description:
  40.       - Consul API port
  41.     required: true
  42.   session:
  43.     description:
  44.       - Consul session to interact with
  45.     require: false
  46.   ttl:
  47.     description:
  48.       - Session TTL
  49.     required: false
  50.   version:
  51.     description:
  52.       - Consul API version
  53.     required: true
  54.     default: v1

Status

Usage

Examples

  1. - name: Get leader
  2.   consul_status:
  3.     action: leader
  4.   register: leader
  6. - name: Get peers
  7.   consul_status:
  8.     action: peers
  9.   register: peers

Documentation

  1. module: consul_status
  2. version_added: "1.9"
  3. author: Chavez
  4. short_description: Interact with Consul Status API
  5. description:
  6.    - Use Consul Status API in your playbooks and roles
  7. options:
  8.   action:
  9.     description:
  10.       - One of [leader, peers]
  11.     required: true
  12.   dc:
  13.     desription:
  14.       - The datacenter to use
  15.     required: false
  16.     default: dc1
  17.   host:
  18.     description:
  19.       - Consul host
  20.     required: true
  21.     default: 127.0.0.1
  22.   port:
  23.     description:
  24.       - Consul API port
  25.     required: true
  26.   version:
  27.     description:
  28.       - Consul API version
  29.     required: true
  30.     default: v1
  32. # informational: requirements for nodes
  33. requirements: [ ]

Testing

You will need to be running a consul server locally to run the test playbook.

Run consul with

  • DC1: consul agent --server --bootstrap-expect=1 --data-dir=ci/consul/dc1/ --log-level=debug --config-file=ci/consul/dc1/config.json
  • DC2: consul agent --server --bootstrap-expect=1 --config-file=ci/consul/dc2/config.json --data-dir=ci/consul/dc2 --log-level=debug

Then you can run the test playbook with ansible-playbook -i ./hosts test-consul.yml

TODO

  • ACL API
    • /v1/acl/create
    • /v1/acl/update
    • /v1/acl/destroy/<id>
    • /v1/acl/info/<id>
    • /v1/acl/clone/<id>
    • /v1/acl/list
    • /v1/acl/replication
  • Agent API
    • /v1/agent/checks
    • /v1/agent/services
    • /v1/agent/members
    • /v1/agent/self
    • /v1/agent/maintenance
    • /v1/agent/join/<address>
    • /v1/agent/force-leave/<node>
    • /v1/agent/check/register
    • /v1/agent/check/deregister/<checkID>
    • /v1/agent/check/pass/<checkID>
    • /v1/agent/check/warn/<checkID>
    • /v1/agent/check/fail/<checkID>
    • /v1/agent/check/update/<checkID>
    • /v1/agent/service/register
    • /v1/agent/service/deregister/<serviceID>
    • /v1/agent/service/maintenance/<serviceID>
  • Catalog API
    • /v1/catalog/register
    • /v1/catalog/deregister
    • /v1/catalog/datacenters
    • /v1/catalog/nodes
    • /v1/catalog/services
    • /v1/catalog/service/<service>
    • /v1/catalog/node/<node>
  • Coordinate API
    • /v1/coordinate/datacenters
    • /v1/coordinate/nodes
  • Events API
    • fire
    • list
  • Health Checks API
    • /v1/health/node/<node>
    • /v1/health/checks/<service>
    • /v1/health/service/<service>
    • /v1/health/state/<state>
  • Key/Value API
    • GET
    • PUT
    • DELETE
    • Session acquire PUT
    • Session release PUT
  • Prepared Queries API
    • /v1/query
    • /v1/query/<query
    • /v1/query/<query or name>/execute
    • /v1/query/<query or name>/explain
  • Session API
    • create
    • destroy
    • info
    • node
    • list
    • renew
  • Status API
    • leader
    • peers