Module consul_rs::agent [−][src]
Structs
| ACL_MODE_DISABLED | ACL_MODE_DISABLED indicates that ACLs are disabled for this agent |
| ACL_MODE_ENABLED | ACL_MODE_ENABLED indicates that ACLs are enabled and operating in new ACL mode (v1.4.0+ ACLs) |
| ACL_MODE_LEGACY | ACL_MODE_LEGACY indicates that ACLs are enabled and operating in legacy mode. |
| ACL_MODE_UNKNOWN | ACL_MODE_UNKNOWN is used to indicate that the AgentMember.Tags didn’t advertise an ACL mode at all. This is the case for Consul versions before v1.4.0 and should be treated similarly to ACLModeLegacy. |
| AGENT | |
| ALL_SEGMENTS | ALL_SEGMENTS is used to select for all segments in MembersOpts. |
| Agent | Agent can be used to query the Agent endpoints |
| AgentCheck | AgentCheck represents a check known to the api |
| AgentMember | AgentMember represents a cluster member known to the agent |
| AgentService | AgentService represents a service known to the agent |
| AgentServiceCheck | AgentServiceCheck is used to define a node or service level check |
| AgentServiceChecksInfo | AgentServiceChecksInfo returns information about a Service and its checks |
| AgentServiceConnect | AgentServiceConnect represents the Connect configuration of a service. |
| AgentServiceConnectProxyConfig | AgentServiceConnectProxyConfig is the proxy configuration in a connect-proxy ServiceDefinition or response. |
| AgentServiceRegistration | AgentServiceRegistration is used to register a new service |
| AgentWeights | AgentWeights represent optional weights for a service |
| ConnectProxyConfig | ConnectProxyConfig is the response structure for agent-local proxy configuration. |
| Filter | Filter |
| GaugeValue | GaugeValue stores one value that is updated as time goes on, such as the amount of memory allocated. |
| MembersOpts | MembersOpts is used for querying member information. |
| MetricsInfo | Metrics info is used to store different types of metric values from the agent. |
| PointValue | PointValue holds a series of points for a metric. |
| SERVICE_KIND_CONNECT_PROXY | SERVICE_KIND_CONNECT_PROXY is a proxy for the Connect feature. This service proxies another service within Consul and speaks the connect protocol. |
| SERVICE_KIND_MESH_GATEWAY | SERVICE_KIND_MESH_GATEWAY is a Mesh Gateway for the Connect feature. This service will proxy connections based off the SNI header set by other connect proxies |
| SERVICE_KIND_TERMINATING_GATEWAY | SERVICE_KIND_TERMINATING_GATEWAY is a Terminating Gateway for the Connect feature. This service will proxy connections to services outside the mesh. |
| SERVICE_KIND_TYPICAL | SERVICE_KIND_TYPICAL is a typical, classic Consul service. This is represented by the absence of a value. This was chosen for ease of backwards compatibility: existing services in the catalog would default to the typical service. |
| SampledValue | SampledValue stores info about a metric that is incremented over time, such as the number of requests to an HTTP endpoint. |
| ServiceRegisterOpts | ServiceRegisterOpts is used to pass extra options to the service register. |
| UPSTREAM_DEST_TYPE_PREPARED_QUERY | UpstreamDestTypePreparedQuery discovers instances via prepared query execution. |
| UPSTREAM_DEST_TYPE_SERVICE | UpstreamDestTypeService discovers instances via healthy service lookup. |
| Upstream | Upstream is the response structure for a proxy upstream configuration. |
Constants
| MEMBER_TAG_KEY_ACL_MODE | MEMBER_TAG_KEY_ACL_MODE is the key used to indicate what ACL mode the agent is operating in. The values of this key will be one of the MemberACLMode constants with the key not being present indicating ACLModeUnknown. |
| MEMBER_TAG_KEY_BOOTSTRAP | MemberTagKeyBootstrap is the key name of the tag used to indicate whether this agent was started with the “bootstrap” configuration enabled |
| MEMBER_TAG_KEY_BOOTSTRAP_EXPECT | MEMBER_TAG_KEY_BOOTSTRAP_EXPECT is the key name of the tag used to indicate whether this agent was started with the “bootstrap_expect” configuration set to a non-zero value. The value of this key will be the string for of that configuration value. |
| MEMBER_TAG_KEY_READ_REPLICA | MEMBER_TAG_KEY_READ_REPLICA is the key used to indicate that the member is a read replica server (will remain a Raft non-voter). Read Replicas are a Consul Enterprise feature. |
| MEMBER_TAG_KEY_ROLE | MEMBER_TAG_KEY_ROLE is the key used to indicate that the member is a server or not. |
| MEMBER_TAG_KEY_SEGMENT | MEMBER_TAG_KEY_SEGMENT is the key name of the tag used to indicate which network segment this member is in. Network Segments are a Consul Enterprise feature. |
| MEMBER_TAG_KEY_USE_TLS | MEMBER_TAG_KEY_USE_TLS is the key name of the tag used to indicate whther this agent was configured to use TLS. |
| MEMBER_TAG_VALUE_BOOTSTRAP | MEMBER_TAG_VALUE_BOOTSTRAP is the value of the MemberTagKeyBootstrap key when the agent was started with the “bootstrap” configuration enabled. |
| MEMBER_TAG_VALUE_READ_REPLICA | MEMBER_TAG_VALUE_READ_REPLICA is the value of the MemberTagKeyReadReplica key when the member is in fact a read-replica. Any other value indicates that it is not. Read Replicas are a Consul Enterprise feature. |
| MEMBER_TAG_VALUE_ROLE_SERVER | MEMBER_TAG_VALUE_ROLE_SERVER is the value of the MemberTagKeyRole used to indicate that the member represents a Consul server. |
| MEMBER_TAG_VALUE_USE_TLS | MEMBER_TAG_VALUE_USE_TLS is the value of the MemberTagKeyUseTLS when the agent was configured to use TLS. Any other value indicates that it was not setup in that manner. |
Type Definitions
| MemberACLMode |