Python library for Rancher Metadata API

This is a simple Python library that allows to interact with the Rancher Metadata REST API.

Pull requests to add additional API features (as documented at http://docs.rancher.com/rancher/metadata-service/) are very welcome. I only implemented what I needed.

Install

To install it simply issue the following command:

pip install rancher-metadata

Usage

from rancher_metadata import MetadataAPI
api = MetadataAPI(api_url = "http://rancher-metadata/2015-12-19")

print("Container create index: %d" % api.get_container_create_index())
print("Container service index: %d" % api.get_container_service_index())
print("Container ip: %s" % api.get_container_ip())
print("Container name: %s" % api.get_container_name())
print("Container service name: %s" % api.get_container_service_name())
print("Container hostname: %s" % api.get_container_hostname())

for name, container in api.wait_service_containers():
  print("Container %s is up (ip: %s, create index: %d, service index: %d)" % (name, container['primary_ip'], container['create_index'], container['service_index']))

metadata = api.get_service_metadata()
print(metadata)

print("Service scale size: %d" % api.get_service_scale_size())

Look up all containers:

for container in api.get_containers():
  print(container)

Look up all services:

for service in api.get_services():
  print(service)

Look up all stacks:

for stack in api.get_stacks():
  print(stack)

Look up all hosts:

for host in api.get_hosts():
  print(host)

Look up current container:

print(api.get_container())

Look up a container by name:

print(api.get_container("my_container"))

Look up a container's IP by name:

print("A container IP: %s" % api.get_container_ip("container_name"))

Look up current service:

print(api.get_service())

Look up a specific service running in the current stack:

print(api.get_service(service_name = 'my_service'))

Look up a specific service running in another stack:

print(api.get_service(service_name = 'my_service', stack_name = 'my_stack'))

Look up the current service containers

for name, container in api.get_service_containers().iteritems():
  print("Container %s (ip: %s, create index: %d, service index: %d)" % (name, container['primary_ip'], container['create_index'], container['service_index]))

Look up a specific service's containers running in the current stack:

for name, container in api.get_service_containers(service_name = 'my_service').iteritems():
  print("Container %s (ip: %s, create index: %d, service index: %d)" % (name, container['primary_ip'], container['create_index'], container['service_index']))

Look up a specific service's containers running in an another stack:

for name, container in api.get_service_containers(service_name = 'my_service', stack_name = 'my_stack').iteritems():
  print("Container %s (ip: %s, create index: %d, service index: %d)" % (name, container['primary_ip'], container['create_index'], container['service_index']))

Look up current stack:

print(api.get_stack())

Look up a specific stack by name:

print(api.get_stack("my_stack"))

Look up services running in current stack:

for service in api.get_stack_services():
  print(service)

Look up services running in another stack:

for service in api.get_stack_services("my_stack"):
  print(service)

Look up current host:

print(api.get_host())

Look up a specific host by name:

print(api.get_host("my_host"))

Returns true if the container is running in Rancher-managed network:

if api.is_network_managed():
  print("I am running in the managed network")
else:
  print("I am running in host-based networking")

Contact

Matteo Cerutti - matteo.cerutti@hotmail.co.uk