Skip to main content

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"
  }
}

Release files for consul-service-discovery 0.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for consul-service-discovery 0.1.2
File Size Uploaded
consul-service-discovery-0.1.2.tar.gz 2.5 kB Details

Release files / consul-service-discovery-0.1.2.tar.gz

Download URL consul-service-discovery-0.1.2.tar.gz
Size 2.5 kB
Tags Source
SHA-256 checksum
How to use checksums
9e9aafe10cc1abe6a175caa9ec59c05c86b5785646f1f41134db8797ad6bf007
BLAKE2b-256 checksum
How to use checksums
30035fc488559013fe50f70490d30db4a03b94eacfbdf9bf4bdf92338e7cd135
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.1.2 This release

1 release file

0.1.1

1 release file

0.1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page