Skip to content

Latest commit

 

History

History
113 lines (83 loc) · 4.12 KB

examples.md

File metadata and controls

113 lines (83 loc) · 4.12 KB
Raw

Creating a client

# create a default client
c = Consul.client()

# create a client by specifying host and port
c = Consul.client(host: "127.0.0.1", port: 8500)

# create a client by setting all parameters
c = Consul.client(host: "127.0.0.1", port: 8500, scheme: "https", token: "my-secret-consul-token", consistency: "default")

KV Store

# create a kv
c.kv.create_key("animal/ape", "gorilla")

# get a kv value
c.kv.get_key("animal/ape")

# get kv recursively
c.kv.get_key("animal", recurse: true)

# get kv keys recursively
c.kv.get_key("animal", recurse: true, keys: true)

# delete a kv pair
c.kv.delete_key("animal/ape")

# catch exception
begin
  c.kv.get_key("animal/ape")
rescue ex : Consul::Error::NotFound
  puts "got: #{ex}"
rescue ex : Exception
  raise "this was unexpected: #{ex}"
end

Agent

# register a service on the local agent
service = Consul::Service.new()
service.name = "service-example"
service.tags = ["master"]
service.address = "10.42.10.11"
service.port = 9922
service.check = {"HTTP" => "http://localhost:9922", "Interval" => "10s"}

c.agent.register_service(service)

# get services that are registered on the local agent
c.agent.get_services()
{"service-example" => #<Consul::Types::Agent::Service:0x7fd03885f980 @id="service-example", @service="service-example", @tags=["master"], @port=9922, @address="10.42.10.11">

# get service configuration for a specified service by name
c.agent.get_service_conf("service-example")
# <Consul::Types::Agent::ServiceConf:0x7f167f191a50 @kind=nil, @id="service-example", @service="service-example", @tags=["master"], @meta={}, @address="10.42.10.11", @port=9922, @enable_tag_override=false, @content_hash="631ec0c28596219c">

# deregister a service by service id
c.agent.deregister_service("service-example")

# register a check on the local agent
check = Consul::Check.new()
check.name = "check-kibana"
check.http = "http://localhost:9200"
check.interval = "10s"

c.agent.register_check(check)

# get all checks registred on the local agent
c.agent.get_checks()
# {"check kibana" => #<Consul::Types::Agent::Check:0x7f4ebcdb7000 @node="vagrant", @check_id="check kibana", @name="check-kibana", @status="critical", @output="">, "service:service-example" => #<Consul::Types::Agent::Check:0x7f4ebcdbef00 @node="vagrant", @check_id="service:service-example", @name="Service 'service-example' check", @status="critical", @output="Get www.google.com: unsupported protocol scheme \"\"">}

# get checks and query with filter
c.agent.get_checks(filter: "Name == \"check kibana\"")
# {"check kibana" => #<Consul::Types::Agent::Check:0x7fb3a7f9d700 @node="vagrant", @check_id="check kibana", @name="check kibana", @status="critical", @output="Get http://localhost:9200: dial tcp [::1]:9200: connect: connection refused">}

# deregister a check
c.agent.deregister_check(check_id: "check-kibana")

Catalog

# get datacenters
c.catalog.get_datacenters()
# Array(String) eg ["dc1"]

# get all nodes in the given datacenter
c.catalog.get_nodes()
# [#<Consul::Types::Catalog::Node:0x7fedaf659d80 @id="3912fc6d-2033-ab35-1e7b-dcf8bf92340b", @node="50332f402c14", @address="127.0.0.1", @datacenter="dc1", @tagged_addresses={"lan" => "127.0.0.1", "wan" => "127.0.0.1"}, @meta={"consul-network-segment" => ""}>]

# get all services registered by the given datacenter
c.catalog.get_services()
# {"consul" => [], "service-example" => ["master"]]}

# get all nodes and port for a given service
services = c.catalog.get_nodes_for_service(service: "service-example")
# [#<Consul::Types::Catalog::NodeService:0x7fc638f369a0 @id="3912fc6d-2033-ab35-1e7b-dcf8bf92340b", @node="50332f402c14", @address="127.0.0.1", @datacenter="dc1", @tagged_addresses={"lan" => "127.0.0.1", "wan" => "127.0.0.1"}, @node_meta={"consul-network-segment" => ""}, @service_id="service-example", @service_name="service-example", @service_tags=["master"], @service_address="10.42.10.11", @service_meta={}, @service_port=9922>]

Health

# get all nodes and port for a given service with a passing health check
c.health.get_nodes_for_service(service: "service-example", filter: "Checks.Status == passing")