package
0.9.2
Repository: https://github.com/as/consul.git
Documentation: pkg.go.dev

# Packages

The snapshot endpoint is a special non-RPC endpoint that supports streaming for taking and restoring snapshots for disaster recovery.
Package agent provides a logical endpoint for Consul agents in the network.
No description provided by the author
No description provided by the author
Package servers provides a Manager interface for Manager managed metadata.Server objects.
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

ACLDisabled handles if ACL datacenter is not configured.
Asset loads and returns the asset for the given name.
AssetDir returns the file names below a certain directory embedded in the file by go-bindata.
AssetInfo loads and returns the asset info for the given name.
AssetNames returns the names of the assets.
Bool is used to initialize bool pointers in struct literals.
DecodeCheckDefinition is used to decode a check definition.
DecodeConfig reads the configuration from the given reader in JSON format and decodes it into a proper Config structure.
DecodeServiceDefinition is used to decode a service definition.
DefaultConfig is used to return a sane default configuration.
DevConfig is used to return a set of configuration to use for dev mode.
Duration is used to initialize time.Duration pointers in struct literals.
ExecScript returns a command to execute a script.
No description provided by the author
FixupConfigDurations is used to handle parsing the duration fields in the Autopilot config struct.
FixupLockDelay is used to handle parsing the JSON body to session/create and properly parsing out the lock delay duration value.
MergeConfig merges two configurations together to make a single new configuration.
MustAsset is like Asset but panics when Asset would return an error.
No description provided by the author
NewBlacklist returns a blacklist for the given list of prefixes.
No description provided by the author
No description provided by the author
No description provided by the author
NewLocalState creates a is used to initialize the local state.
NewTestAgent returns a started agent with the given name and configuration.
ParseHost verifies that the given host strings is valid.
ParseMetaPair parses a key/value pair of the form key:value.
ParseRelayFactor validates and converts the given relay factor to uint8.
ReadConfigPaths reads the paths in the given order to load configurations.
RestoreAsset restores an asset under the given directory.
RestoreAssets restores an asset under the given directory recursively.
TenPorts returns the first port number of a block of ten random ports.
TestACLConfig returns a default configuration for testing an agent with ACLs.
TestConfig returns a unique default configuration for testing an agent.
Uint64 is used to initialize uint64 pointers in struct literals.
No description provided by the author

# Constants

4KB.
No description provided by the author
MinInterval is the minimal interval between two checks.
No description provided by the author
No description provided by the author
UserAgent is the value of the User-Agent header for HTTP health checks.
4KB.

# Variables

No description provided by the author
TempDir defines the base dir for temporary directories.

# Structs

AddressConfig is used to provide address overrides for specific services.
No description provided by the author
The agent is the long running process that is run on every machine.
Autopilot is used to configure helpful features for operating Consul servers.
Blacklist implements an HTTP endpoint blacklist based on a list of endpoint prefixes which should be blocked.
CheckDocker is used to periodically invoke a script to determine the health of an application running inside a Docker Container.
CheckHTTP is used to periodically make an HTTP request to determine the health of a given check.
CheckMonitor is used to periodically invoke a script to determine the health of a given check.
CheckTCP is used to periodically make an TCP/UDP connection to determine the health of a given check.
CheckTTL is used to apply a TTL to check status, and enables clients to set the status of a check but upon the TTL expiring, the check status is automatically set to critical.
Config is the configuration that can be set for an Agent.
CriticalCheck is used to return the duration a check has been critical along with its associated health check.
DNSConfig is used to fine tune the DNS sub-system.
DNSServer is used to wrap an Agent and expose various service discovery endpoints using a DNS interface.
DockerClient is a simplified client for the Docker Engine API to execute the health checks and avoid significant dependencies.
HTTPConfig is used to fine tune the Http sub-system.
HTTPServer provides an HTTP api for an agent.
NotifyGroup is used to allow a simple notification mechanism.
Performance is used to tune the performance of Consul's subsystems.
Ports is used to simplify the configuration by providing default ports, and allowing the addresses to only be specified once.
No description provided by the author
RetryJoinAzure is used to configure discovery of instances via AzureRM API.
RetryJoinEC2 is used to configure discovery of instances via Amazon's EC2 api.
RetryJoinGCE is used to configure discovery of instances via Google Compute Engine's API.
No description provided by the author
ServiceSummary is used to summarize a service.
Telemetry is the telemetry configuration for the server.
TestAgent encapsulates an Agent with a default configuration and startup procedure suitable for testing.
UnixSocketConfig stores information about various unix sockets which Consul creates and uses for communication.
UnixSocketPermissions contains information about a unix socket, and implements the FilePermissions interface.
UserEventParam is used to parameterize a user event.

# Interfaces

CheckNotifier interface is used by the CheckMonitor to notify when a check has a status update.
FilePermissions is an interface which allows a struct to set ownership and permissions easily on a file it describes.