Module: Kongkit::Client::Cluster

Included in:

Kongkit::Client

Defined in:

lib/kongkit/client/cluster.rb

Instance Method Summary

• #cluster_status ⇒ Kongkit::Client::Resource

  Retrieve cluster status.

• #remove_node(name) ⇒ Boolean

  Forcibly remove a node.

Instance Method Details

#cluster_status ⇒ Kongkit::Client::Resource

Retrieve cluster status

Retrieve the cluster status, returning information for each node in the cluster.

Returns:

• (Kongkit::Client::Resource) —

  Cluster status

See Also:

• https://getkong.org/docs/0.8.x/admin-api/#retrieve-cluster-status

# File 'lib/kongkit/client/cluster.rb', line 10

def cluster_status
  get('/cluster')
end

#remove_node(name) ⇒ Boolean

Forcibly remove a node

Forcibly remove a node from the cluster.

Parameters:

• name (String) —

  Name of the node

Returns:

• (Boolean) —

  ‘true` if successfully removed

See Also:

• https://getkong.org/docs/0.8.x/admin-api/#forcibly-remove-a-node

# File 'lib/kongkit/client/cluster.rb', line 21

def remove_node(name)
  delete('/cluster', query: { name: name })
end