Pro plan from £5 per endpoint per month · see pricing
Secronyx
AvailableLinuxWindowsmacOS

Consul

See whether the cluster has a leader and how many servers it can lose, each server's raft health, which members are failed and which health checks are critical, with a read-only ACL token.

What it answers

Questions an on-call engineer asks, which an AI client can answer with this plugin.

  • Does the Consul cluster have a leader, and how many servers can fail before it loses quorum?
  • Which server is the raft leader, and is any server unhealthy or behind on the raft log?
  • Which members does this agent see as failed or gone?
  • Which health checks are critical, on which node and service, and why?

What it returns

Each of the plugin's read-only tools, described in words.

  • Consul cluster leadership in one row - the leader's server ID, whether autopilot sees the cluster as healthy, how many server failures it can tolerate and the voting servers
  • Consul gossip members seen by this agent with their name, address, status (1 alive, 2 leaving, 3 left, 4 failed), role (consul for servers, node for clients), datacenter and version
  • Consul health checks in the critical state with their node, check ID and name, service, check type and the normalised output of the last run
  • Each Consul server in autopilot - name, address, raft status (leader, voter, non-voter), whether it is healthy, last contact with the leader, last raft term and index, and version

At a glance

Plugin
consul 1.0.0
Publisher
levantar
Platforms
Linux, Windows, macOS

Tested on

  • Consul 1.19.2 and 2.1.0 on Linux (Ubuntu 24.04, Docker), test lab
  • Consul 1.19.2 on macOS (official release), test lab
  • Consul 1.19.2 on Windows Server 2022 (official release), test lab

How it logs in

Without an explicit choice, install tries the methods that need no secret first, in this order.

  • A bearer token
  • A client certificate
  • No login (a local endpoint)

The least-privilege login

The setup file in the pack. secronyx plugin setup consul prints it; an administrator applies it by hand.

# The least-privilege ACL policy for the consul plugin: read the raft and # autopilot state (operator), the members and every node's checks (node), # and every service's checks (service). Nothing here can write. # # With a management token in CONSUL_HTTP_TOKEN, on any server: # # consul acl policy create -name secronyx-consul-read -rules @grants.hcl # consul acl token create -policy-name secronyx-consul-read \ # -description "secronyx consul plugin" # # and install with the SecretID it prints: # # secronyx plugin install ./consul-1.0.0.scxp --auth token --password-stdin # # Give the token this policy directly, not through a role: the privilege # check cannot see a role's policies. operator = "read" node_prefix "" { policy = "read" } service_prefix "" { policy = "read" }

See it run

Recording coming. Install, setup and status runs for this plugin are recorded on the shared test lab, and appear here once they have run.

Read-only, in layers

Every request is a GET or HEAD to the endpoint the operator configured, on a path fixed in the signed pack. Redirects are not followed, and requests known to change state are refused.

These controls narrow what the plugin can do; none of them is a guarantee on its own. An administrator can still accept a more powerful login on purpose (audited and shown in status), root or Administrator on the host can replace the agent, and the plugin can read whatever its login can see.