com.github.qzagarese.dockerunit.discovery.consul.annotation

Annotation Type EnableConsul

@Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface EnableConsul

Allows Consul to probe each replica of your service. This enables basic discovery by telling Consul about your service by means of registrator. If you are creating an HTTP/HTTPS service, you should expose a health-check endpoint and use WebHealthCheck

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
EnableConsul.CheckStatus	checkInitialStatus The initial status for the Consul check associated to this service.
int	exposedPort The port that is exposed by the container (not the one it is mapped to on the host network interface) Default is 80
int	initialDelay The amount of time to wait before Consul performs the first health check.
int	pollingInterval The length of the interval (in seconds) Consul will wait before re-checking the service state.

Element Detail

exposedPort

public abstract int exposedPort

The port that is exposed by the container (not the one it is mapped to on the host network interface) Default is 80

Returns:

the port number

Default:

80

pollingInterval

public abstract int pollingInterval

The length of the interval (in seconds) Consul will wait before re-checking the service state. Default is 1 second.

Returns:

the interval in seconds

Default:

1

initialDelay

public abstract int initialDelay

The amount of time to wait before Consul performs the first health check. Default is 0.

Returns:

the delay in seconds

Default:

0

checkInitialStatus

public abstract EnableConsul.CheckStatus checkInitialStatus

The initial status for the Consul check associated to this service. Default is PASSING.

Returns:

the status of the check

Default:

com.github.qzagarese.dockerunit.discovery.consul.annotation.EnableConsul.CheckStatus.PASSING