Skip to main content

Python client for Consul Service Discovery API

Project description

Consul Service Discovery API

This module provides a simple way to work with the Consul Service Discovery API from python.

Examples

Usage examples:

import consul
service = consul.Client()
service.register(id='flexlm1', name='flexlm',
            address='10.112.0.211', port=28518,
            tags=('flexlm1', light', 'v1'),
            check={'id': 'flexlm', 'name': 'flexlm on port 28518',
                   'tcp': '10.112.0.211:28518',
                   'Interval': '30s', 'timeout': '2s'})
service.deregister(id='flexlm1')
service.list()
service.info(name='flexlm')

The registration/deregistration is done using the consul agent API:

http://localhost:8500
PUT /v1/agent/service/register
DELETE /v1/agent/service/deregister/<serviceId>

To query the information the catalog API is used:

http://localhost:8500
GET /v1/catalog/services
GET /v1/catalog/service/bigdata
GET /v1/catalog/nodes
GET /v1/catalog/node/c13-9

The payload for the registration request has the following format:

{
  "ID": "flexlm1",
  "Name": "flexlm",
  "Tags": ["flexlm1", light", "v1"],
  "Address": "10.112.0.211",
  "Port": 28518,
  "Check": {
    "id": "flexlm",
    "name": "flexlm on port 28518",
    "tcp": "10.112.0.211:28518",
    "Interval": "30s",
    "timeout": "2s"
  }
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

consul-service-discovery-0.1.2.tar.gz (2.5 kB view details)

Uploaded Source

File details

Details for the file consul-service-discovery-0.1.2.tar.gz.

File metadata

File hashes

Hashes for consul-service-discovery-0.1.2.tar.gz
Algorithm Hash digest
SHA256 9e9aafe10cc1abe6a175caa9ec59c05c86b5785646f1f41134db8797ad6bf007
MD5 c1ea54e29ae44925b9404dd87ee667f0
BLAKE2b-256 30035fc488559013fe50f70490d30db4a03b94eacfbdf9bf4bdf92338e7cd135

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page