consul-clojure, a Consul client for Clojure

Consul is an awesome service discovery and configuration provider.

Goals

Provide a useful library for building Consul aware Clojure applications.

Getting Started

First, you'll need to setup a local consul agent. See setup instructions. It's much easier to see what's happening by using the consul-web-ui.

This is the LaunchAgent configuration I use for OSX after installing consul and consul-web-ui.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
  <dict>
    <key>KeepAlive</key>
    <true/>
    <key>Label</key>
    <string>hashicorp.consul.server</string>
    <key>ProgramArguments</key>
    <array>
      <string>/usr/local/bin/consul</string>
      <string>agent</string>
      <string>-server</string>
      <string>-bootstrap-expect</string>
      <string>1</string>
      <string>-data-dir</string>
      <string>/usr/local/var/consul</string>
      <string>-config-dir</string>
      <string>/usr/local/etc/consul.d</string>
      <string>-ui-dir</string>
      <string>/opt/homebrew-cask/Caskroom/consul-web-ui/0.5.2/dist</string>
    </array>
    <key>RunAtLoad</key>
    <true/>
    <key>UserName</key>
    <string>bpoweski</string>
    <key>WorkingDirectory</key>
    <string>/usr/local/var</string>
    <key>StandardErrorPath</key>
    <string>/usr/local/var/log/consul.log</string>
    <key>StandardOutPath</key>
    <string>/usr/local/var/log/consul.log</string>
  </dict>
</plist>

Key/Value store

When using the Key/Value store endpoints directly, one has to contend with a variety of different response formats depending upon the parameters passed. Rather than continue with this approach, different functions are used instead.

Getting a key:

(require '[consul.core :as consul])

(consul/kv-get :local "my-key")
=> ["my-key" nil]

But what about the consul index information?

(meta (consul/kv-get :local "my-key"))
=> {:x-consul-lastcontact "0", :known-leader true, :modify-index 352}

Setting a value:

(consul/kv-put :local "my-key" "a")
=> true

Want a list of keys?

(consul/kv-keys :local "my")
=> #{"my-key"}

Don't want a key?

(consul/kv-del :local "my-key)
=> true

Let's remove more than one:

(consul/kv-put :local "key-1" "a")
=> true
(consul/kv-put :local "key-2" nil)
=> true
(consul/kv-keys :local "key")
=> #{"key-1" "key-2"}

(consul/kv-del :local "key" :recurse? true)
=> true
(consul/kv-keys :local "key")
=> #{}

Agent

Catalog

Health Checks

Access Control Lists

User Events

Status

License

Copyright © 2015 Benjamin Poweski

Distributed under the Eclipse Public License either version 1.0 or (at your option) any later version.