Crate consul_api

Source

Structs§

ACLLink
AccessLogsConfig
AccessLogsConfig contains the associated default settings for all Envoy instances within the datacenter or partition
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
AgentTTLCheckRequestQuery
AgentTTLCheckUpdateRequestBody
AgentTTLCheckUpdateRequestQuery
AgentWeights
AgentWeights represent optional weights for a service
Base64Payload
CatalogDeregisterEntityQuery
CatalogGatewayServicesQuery
CatalogListNodesForServiceQuery
CatalogListServicesQuery
CatalogNodeServicesQuery
CatalogRegisterEntityQuery
CheckDefinition
CheckDefinition is used to JSON decode the Check definitions
CheckServiceNode
CheckServiceNode is used to provide the node, its service definition, as well as a HealthCheck that is associated.
CheckType
CheckType is used to create either the CheckMonitor or the CheckTTL. The following types are supported: Script, HTTP, TCP, Docker, TTL, GRPC, Alias, H2PING. Script, HTTP, Docker, TCP, GRPC, and H2PING all require Interval. Only one of the types may to be provided: TTL or Script/Interval or HTTP/Interval or TCP/Interval or Docker/Interval or GRPC/Interval or AliasService or H2PING/Interval. Since types like CheckHTTP and CheckGRPC derive from CheckType, there are helper conversion methods that do the reverse conversion. ie. checkHTTP.CheckType()
Client
The Consul API client.
ClientBuilder
Config
ConnectAuthorizeRequest
ConnectAuthorizeRequest is the structure of a request to authorize a connection.
ConnectAuthorizeRequestQuery
ConnectAuthorizeRequestReply
ConnectProxyConfig
ConnectProxyConfig describes the configuration needed for any proxy managed or unmanaged. It describes a single logical service’s listener and optionally upstreams and sidecar-related config for a single instance. To describe a centralized proxy that routed traffic for multiple services, a different one of these would be needed for each, sharing the same LogicalProxyID.
DeregisterCheckRequestQuery
DeregisterRequest
DeregisterRequest is used for the Catalog.Deregister endpoint to deregister a service, check, or node (only one should be provided). If ServiceID or CheckID are not provided, the entire node is deregistered. If a ServiceID is provided, any associated Checks with that service are also deregistered.
DeregisterServiceRequestQuery
EnableMaintenanceModeRequestQuery
EnvoyExtension
EnvoyExtension has configuration for an extension that patches Envoy resources.
EventFireQuery
EventListQuery
ExposeConfig
ExposeConfig describes HTTP paths to expose through Envoy outside of Connect. Users can expose individual paths and/or all HTTP/GRPC paths for checks.
ExposePath
FilterRequestQuery
GatewayService
GatewayService is used to associate gateways with their linked services.
HealthCheck
HealthCheck is used to represent a single check
HealthCheckDefinition
HealthListNodesQuery
HealthListServiceInstancesQuery
HealthListServicesQuery
HealthListStateQuery
KVCreateOrUpdateKeyQuery
KVDeleteKeyQuery
KVReadKeyQuery
LocalServiceHealthByIDRequestQuery
LocalServiceHealthByNameRequestQuery
Locality
Locality identifies where a given entity is running.
MeshGatewayConfig
MeshGatewayConfig controls how Mesh Gateways are configured and used This is a struct to allow for future additions without having more free-hanging configuration items all over the place
NamespaceACLConfig
NamespaceACLConfig is the Namespace specific ACL configuration container
Node
Used to return information about a node
NodeService
NodeService is a service provided by a node
NodeServices
NodeServices represents services provided by Node. Services is a map of service IDs to services.
PeeringServiceMeta
PeeringServiceMeta is read-only information provided from an exported peer.
QueryOptions
QueryOptions are used to parameterize a query
RegisterRequest
RegisterRequest is used for the Catalog.Register endpoint to register a node as providing a service. If no service is provided, the node is registered.
RegisterServiceRequestQuery
ServiceAddress
Type to hold a address and port of a service
ServiceConfigurationRequestQuery
ServiceConnect
ServiceConnect are the shared Connect settings between all service definitions from the agent to the state store.
ServiceDefinition
ServiceDefinition is used to JSON decode the Service definitions. For documentation on specific fields see NodeService which is better documented.
ServiceName
ServiceNode
ServiceNode represents a node that is part of a service. ID, Address, TaggedAddresses, and NodeMeta are node-related fields that are always empty in the state store and are filled in on the way out by parseServiceNodes(). This is also why PartialClone() skips them, because we know they are blank already so it would be a waste of time to copy them. This is somewhat complicated when the address is really a unix domain socket; technically that will override the address field, but in practice the two use cases should not overlap.
StatusQuery
TransparentProxyConfig
Upstream
Upstream represents a single upstream dependency for a service or proxy. It describes the mechanism used to discover instances to communicate with (the Target) as well as any potential client configuration that may be useful such as load balancer options, timeouts etc.
UserEvent
UserEventParam is used to parameterize a user event
Weights
Weights represent the weight used by DNS for a given status
WriteRequest

Enums§

GatewayServiceKind
Health
LogSinkType
MeshGatewayMode

Type Aliases§

AgentServiceChecks
CheckTypes
HealthChecks
Upstreams