# Functions
Decode is used to decode a MsgPack encoded object.
Encode is used to encode a MsgPack object with type prefix.
No description provided by the author
SatisfiesMetaFilters returns true if the metadata map contains the given filters.
ValidateMeta validates a set of key/value pairs from the agent config.
No description provided by the author
# Constants
ACLBootstrapInit is used to perform a scan for existing tokens which will decide whether bootstrapping is allowed for a cluster.
ACLBootstrapNow is used to perform a one-time ACL bootstrap operation on a cluster to get the first management token.
FSM snapshots only.
ACLDelete deletes a token.
ACLForceSet is deprecated, but left for backwards compatibility.
These are serialized between Consul servers and stored in Consul snapshots, so entries must only ever be added.
ACLSet creates or updates a token.
ACLTypeClient tokens have rules applied.
ACLTypeManagement tokens have an always allow policy, so they can make other tokens and can access all resources.
These are serialized between Consul servers and stored in Consul snapshots, so entries must only ever be added.
These are serialized between Consul servers and stored in Consul snapshots, so entries must only ever be added.
These are used to manage the "consul" service that's attached to every Consul server node in the catalog.
These are used to manage the "consul" service that's attached to every Consul server node in the catalog.
These are serialized between Consul servers and stored in Consul snapshots, so entries must only ever be added.
These are serialized between Consul servers and stored in Consul snapshots, so entries must only ever be added.
IgnoreUnknownTypeFlag is set along with a MessageType to indicate that the message type can be safely ignored if it is not recognized.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
These are serialized between Consul servers and stored in Consul snapshots, so entries must only ever be added.
MaxLockDelay provides a maximum LockDelay value for a session.
MetaSegmentKey is the node metadata key used to store the node's network segment.
NodeMaint is the special key set by a node in maintenance mode.
No description provided by the author
No description provided by the author
These are serialized between Consul servers and stored in Consul snapshots, so entries must only ever be added.
No description provided by the author
QueryTemplateTypeNamePrefixMatch uses the Name field of the query as a prefix to select the template.
These are serialized between Consul servers and stored in Consul snapshots, so entries must only ever be added.
These are used to manage the built-in "serfHealth" check that's attached to every node in the catalog.
These are used to manage the built-in "serfHealth" check that's attached to every node in the catalog.
These are used to manage the built-in "serfHealth" check that's attached to every node in the catalog.
These are used to manage the built-in "serfHealth" check that's attached to every node in the catalog.
ServiceMaintPrefix is the prefix for a service in maintenance mode.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
These are serialized between Consul servers and stored in Consul snapshots, so entries must only ever be added.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
These are serialized between Consul servers and stored in Consul snapshots, so entries must only ever be added.
These are serialized between Consul servers and stored in Consul snapshots, so entries must only ever be added.
# Variables
ACLBootstrapNotAllowedErr is returned once we know that a bootstrap can no longer be done since the cluster was bootstrapped, or a management token was created manually.
ACLBootstrapNotInitializedErr is returned when a bootstrap is attempted but we haven't yet initialized ACL bootstrap.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
ACL is used to represent a token and its rules.
ACLBootstrap keeps track of whether bootstrapping ACLs is allowed for a cluster.
ACLPolicy is a policy that can be associated with a token.
ACLPolicyRequest is used to request an ACL by ID, conditionally filtering on an ID.
ACLReplicationStatus provides information about the health of the ACL replication system.
ACLRequest is used to create, update or delete an ACL.
ACLSpecificRequest is used to request an ACL by ID.
AutopilotConfig holds the Autopilot configuration for a cluster.
AutopilotSetConfigRequest is used by the Operator endpoint to update the current Autopilot configuration of the cluster.
CheckDefinition is used to JSON decode the Check definitions.
CheckServiceNode is used to provide the node, its service definition, as well as a HealthCheck that is associated.
ChecksInStateRequest is used to query for nodes in a state.
CheckType is used to create either the CheckMonitor or the CheckTTL.
Coordinate stores a node name with its associated network coordinate.
CoordinateUpdateRequest is used to update the network coordinate of a given node.
DatacenterMap is used to represent a list of nodes with their raw coordinates, associated with a datacenter.
DCSpecificRequest is used to query about a specific DC.
DeregisterRequest is used for the Catalog.Deregister endpoint to deregister a node as providing a service.
DirEntry is used to represent a directory entry.
EventFireRequest is used to ask a server to fire a Serf event.
EventFireResponse is used to respond to a fire request.
HealthCheck represents a single check on a given node.
IndexedACLs has tokens along with the Raft metadata about them.
No description provided by the author
IndexedCoordinate is used to represent a single node's coordinate from the state store.
IndexedCoordinates is used to represent a list of nodes and their corresponding raw coordinates.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
KeyListRequest is used to list keys.
KeyRequest is used to request a key, or key prefix.
KeyringRequest encapsulates a request to modify an encryption keyring.
KeyringResponse is a unified key response and can be used for install, remove, use, as well as listing key queries.
KeyringResponses holds multiple responses to keyring queries.
KVSRequest is used to operate on the Key-Value store.
Used to return information about a node.
NodeInfo is used to dump all associated information about a node.
NodeService is a service provided by a node.
No description provided by the author
NodeSpecificRequest is used to request the information about a single node.
OperatorHealthReply is a representation of the overall health of the cluster.
PreparedQuery defines a complete prepared query, and is the structure we maintain in the state store.
PreparedQueryExecuteRemoteRequest is used when running a local query in a remote datacenter.
PreparedQueryExecuteRequest is used to execute a prepared query.
PreparedQueryExecuteResponse has the results of executing a query.
PreparedQueryExplainResponse has the results when explaining a query/.
QueryRequest is used to create or change prepared queries.
PreparedQuerySpecificRequest is used to get information about a prepared query.
QueryDatacenterOptions sets options about how we fail over if there are no healthy nodes in the local datacenter.
QueryDNSOptions controls settings when query results are served over DNS.
QueryMeta allows a query response to include potentially useful metadata about a query.
QueryOptions is used to specify various flags for read queries.
QuerySource is used to pass along information about the source node in queries so that we can adjust the response based on its network coordinates.
QueryTemplateOptions controls settings if this query is a template.
RaftConfigrationResponse is returned when querying for the current Raft configuration.
RaftIndex is used to track the index used while creating or modifying a given struct type.
RaftRemovePeerRequest is used by the Operator endpoint to apply a Raft operation on a specific Raft peer by address in the form of "IP:port".
RaftServer has information about a server in the Raft configuration.
RegisterRequest is used for the Catalog.Register endpoint to register a node as providing a service.
ServerHealth is the health (from the leader's point of view) of a server.
ServerStats holds miscellaneous Raft metrics for a server.
ServiceDefinition is used to JSON decode the Service definitions.
ServiceNode represents a node that is part of a service.
ServiceQuery is used to query for a set of healthy nodes offering a specific service.
ServiceSpecificRequest is used to query about a specific service.
Session is used to represent an open session in the KV store.
SessionRequest is used to operate on sessions.
SessionSpecificRequest is used to request a session by ID.
SnapshotRequest is used as a header for a snapshot RPC request.
SnapshotResponse is used header for a snapshot RPC response.
TombstoneRequest is used to trigger a reaping of the tombstones.
TxnError is used to return information about an error for a specific operation.
TxnKVOp is used to define a single operation on the KVS inside a transaction.
TxnOp is used to define a single operation inside a transaction.
TxnReadRequest is used as a fast path for read-only transactions that don't modify the state store.
TxnReadResponse is the structure returned by a TxnReadRequest.
TxnRequest is used to apply multiple operations to the state store in a single transaction.
TxnResponse is the structure returned by a TxnRequest.
TxnResult is used to define the result of a given operation inside a transaction.
No description provided by the author
# Interfaces
CompoundResponse is an interface for gathering multiple responses.
RPCInfo is used to describe common information about query.
# Type aliases
ACLOp is used in RPCs to encode ACL operations.
ACLRequests is a list of ACL change requests.
ACLs is a slice of ACLs.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
HealthChecks is a collection of HealthCheck structs.
No description provided by the author
No description provided by the author
NodeDump is used to dump all the nodes with all their associated data.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Used to return information about a provided services.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SnapshotReplyFn gets a peek at the reply before the snapshot streams, which is useful for setting headers.
No description provided by the author
TxnErrors is a list of TxnError entries.
TxnOps is a list of operations within a transaction.
TxnResults is a list of TxnResult entries.