Configuration Reference

Version:2.1.0

Discovery Client Config Properties

🔗
Table 1. Configuration Properties for EurekaConfiguration$EurekaRegistrationConfiguration
Property Type Description

eureka.client.registration.secure-port

int

eureka.client.registration.port

int

eureka.client.registration.instance-id

java.lang.String

eureka.client.registration.asg-name

java.lang.String

eureka.client.registration.home-page-url

java.lang.String

eureka.client.registration.lease-info

LeaseInfo

eureka.client.registration.country-id

int

eureka.client.registration.status-page-url

java.lang.String

eureka.client.registration.health-check-url

java.lang.String

eureka.client.registration.secure-health-check-url

java.lang.String

eureka.client.registration.data-center-info

DataCenterInfo

eureka.client.registration.status

InstanceInfo$Status

eureka.client.registration.app-group-name

java.lang.String

eureka.client.registration.ip-addr

java.lang.String

eureka.client.registration.vip-address

java.lang.String

eureka.client.registration.secure-vip-address

java.lang.String

eureka.client.registration.metadata

java.util.Map

eureka.client.registration.lease-info.registration-timestamp

long

eureka.client.registration.lease-info.renewal-timestamp

long

eureka.client.registration.lease-info.eviction-timestamp

long

eureka.client.registration.lease-info.service-up-timestamp

long

eureka.client.registration.lease-info.duration-in-secs

int

eureka.client.registration.lease-info.renewal-interval-in-secs

int

eureka.client.registration.prefer-ip-address

boolean

eureka.client.registration.timeout

java.time.Duration

eureka.client.registration.fail-fast

boolean

eureka.client.registration.deregister

boolean

eureka.client.registration.enabled

boolean

eureka.client.registration.retry-count

int

eureka.client.registration.retry-delay

java.time.Duration

eureka.client.registration.health-path

java.lang.String

🔗
Table 2. Configuration Properties for VaultClientConfiguration$VaultClientConnectionPoolConfiguration
Property Type Description

vault.client.pool.enabled

boolean

vault.client.pool.max-connections

int

vault.client.pool.max-pending-acquires

int

vault.client.pool.acquire-timeout

java.time.Duration

🔗
Table 3. Configuration Properties for OracleCloudVaultClientConfiguration$OracleCloudVaultClientDiscoveryConfiguration
Property Type Description

oraclecloud.vault.config.enabled

boolean

oraclecloud.vault.config.path

java.lang.String

oraclecloud.vault.config.format

ConfigDiscoveryConfiguration$Format

🔗
Table 4. Configuration Properties for ConsulConfiguration$ConsulRegistrationConfiguration
Property Type Description

consul.client.registration.tags

java.util.List

The tags for registering the service

consul.client.registration.meta

java.util.Map

The metadata for registering the service

consul.client.registration.ip-addr

java.lang.String

consul.client.registration.prefer-ip-address

boolean

consul.client.registration.timeout

java.time.Duration

consul.client.registration.fail-fast

boolean

consul.client.registration.deregister

boolean

consul.client.registration.enabled

boolean

consul.client.registration.retry-count

int

consul.client.registration.retry-delay

java.time.Duration

consul.client.registration.health-path

java.lang.String

🔗
Table 5. Configuration Properties for VaultClientConfiguration
Property Type Description

vault.client.uri

java.lang.String

Set the Vault Server Uri. Default value ("http://locahost:8200").

vault.client.token

java.lang.String

Set the Vault authentication token.

vault.client.kv-version

VaultClientConfiguration$VaultKvVersion

Set the version of the Vault Secret engine. V1 or V2. Default value (V2).

vault.client.secret-engine-name

java.lang.String

Set the name of the Vault Secret engine name. Default value ("secret").

vault.client.fail-fast

boolean

If set to true an exception will be thrown if configuration is not found for the application or any of its environments. Default value (false).

vault.client.http-version

HttpVersion

vault.client.log-level

LogLevel

vault.client.event-loop-group

java.lang.String

vault.client.ssl-configuration

SslConfiguration

vault.client.exception-on-error-status

boolean

vault.client.logger-name

java.lang.String

vault.client.follow-redirects

boolean

vault.client.default-charset

java.nio.charset.Charset

vault.client.channel-options

java.util.Map

vault.client.shutdown-timeout

java.time.Duration

vault.client.read-timeout

java.time.Duration

vault.client.read-idle-timeout

java.time.Duration

vault.client.connect-timeout

java.time.Duration

vault.client.connect-ttl

java.time.Duration

vault.client.num-of-threads

java.lang.Integer

vault.client.thread-factory

java.lang.Class

vault.client.max-content-length

int

vault.client.proxy-type

java.net.Proxy$Type

vault.client.proxy-address

java.net.SocketAddress

vault.client.proxy-username

java.lang.String

vault.client.proxy-password

java.lang.String

vault.client.proxy-selector

java.net.ProxySelector

🔗
Table 6. Configuration Properties for ConsulConfiguration$ConsulConnectionPoolConfiguration
Property Type Description

consul.client.pool.enabled

boolean

consul.client.pool.max-connections

int

consul.client.pool.max-pending-acquires

int

consul.client.pool.acquire-timeout

java.time.Duration

🔗
Table 7. Configuration Properties for ConsulConfiguration$ConsulDiscoveryConfiguration
Property Type Description

consul.client.discovery.tags

java.util.Map

The tags to use for querying

consul.client.discovery.schemes

java.util.Map

The service ID to protocol scheme

consul.client.discovery.datacenters

java.util.Map

The data centers to query

consul.client.discovery.passing

boolean

Whether services that are not passing health checks should be returned

consul.client.discovery.enabled

boolean

🔗
Table 8. Configuration Properties for OracleCloudVaultClientConfiguration$OracleCloudVault
Property Type Description

oraclecloud.vault.vaults[*].ocid

java.lang.String

Sets the OCID of the vault that contains secrets that will be retrieved, decoded and set as config vars.

oraclecloud.vault.vaults[*].compartment-ocid

java.lang.String

Sets the compartment OCID where the vault resides.

🔗
Table 9. Configuration Properties for EurekaConfiguration$EurekaDiscoveryConfiguration
Property Type Description

eureka.client.discovery.use-secure-port

boolean

Sets whether the secure port is used for communication.

eureka.client.discovery.enabled

boolean

🔗
Table 10. Configuration Properties for ConsulConfiguration
Property Type Description

consul.client.asl-token

java.lang.String

The asl token

consul.client.health-check

boolean

Sets whether the Consul server should be considered for health checks. @see io.micronaut.discovery.consul.health.ConsulHealthIndicator

consul.client.http-version

HttpVersion

consul.client.log-level

LogLevel

consul.client.event-loop-group

java.lang.String

consul.client.ssl-configuration

SslConfiguration

consul.client.exception-on-error-status

boolean

consul.client.logger-name

java.lang.String

consul.client.follow-redirects

boolean

consul.client.default-charset

java.nio.charset.Charset

consul.client.channel-options

java.util.Map

consul.client.shutdown-timeout

java.time.Duration

consul.client.read-timeout

java.time.Duration

consul.client.read-idle-timeout

java.time.Duration

consul.client.connect-timeout

java.time.Duration

consul.client.connect-ttl

java.time.Duration

consul.client.num-of-threads

java.lang.Integer

consul.client.thread-factory

java.lang.Class

consul.client.max-content-length

int

consul.client.proxy-type

java.net.Proxy$Type

consul.client.proxy-address

java.net.SocketAddress

consul.client.proxy-username

java.lang.String

consul.client.proxy-password

java.lang.String

consul.client.proxy-selector

java.net.ProxySelector

consul.client.should-use-dns

boolean

Whether DNS should be used to resolve the discovery servers.

consul.client.context-path

java.lang.String

Sets the context path.

consul.client.default-zone

java.util.List

Sets the Discovery servers to use for the default zone.

consul.client.zones

java.util.Map

Configures Discovery servers in other zones.

consul.client.secure

boolean

Set if the discovery server is exposed over HTTPS

consul.client.host

java.lang.String

The Discovery server host name

consul.client.port

int

The port for the Discovery server

🔗
Table 11. Configuration Properties for SpringCloudClientConfiguration$SpringConfigDiscoveryConfiguration
Property Type Description

spring.cloud.config.config.enabled

boolean

spring.cloud.config.config.path

java.lang.String

spring.cloud.config.config.format

ConfigDiscoveryConfiguration$Format

🔗
Table 12. Configuration Properties for EurekaConfiguration$EurekaConnectionPoolConfiguration
Property Type Description

eureka.client.pool.enabled

boolean

eureka.client.pool.max-connections

int

eureka.client.pool.max-pending-acquires

int

eureka.client.pool.acquire-timeout

java.time.Duration

🔗
Table 13. Configuration Properties for ConsulConfiguration$ConsulRegistrationConfiguration$CheckConfiguration
Property Type Description

consul.client.registration.check.method

HttpMethod

The HTTP method to be used for an HTTP check.

consul.client.registration.check.interval

java.time.Duration

Default value (15).

consul.client.registration.check.headers

java.util.Map

Headers for the HTTP checks

consul.client.registration.check.deregister-critical-service-after

java.time.Duration

Specifies that checks associated with a service should deregister after this time

consul.client.registration.check.notes

java.lang.String

Arbitrary information for humans

consul.client.registration.check.id

java.lang.String

The unique ID for this check on the node

consul.client.registration.check.tls-skip-verify

java.lang.Boolean

Specifies if the certificate for an HTTPS check should not be verified.

consul.client.registration.check.enabled

boolean

Default value (true).

consul.client.registration.check.http

boolean

Default value (false).

🔗
Table 14. Configuration Properties for SpringCloudClientConfiguration$SpringCloudConnectionPoolConfiguration
Property Type Description

spring.cloud.config.pool.enabled

boolean

spring.cloud.config.pool.max-connections

int

spring.cloud.config.pool.max-pending-acquires

int

spring.cloud.config.pool.acquire-timeout

java.time.Duration

🔗
Table 15. Configuration Properties for SpringCloudClientConfiguration
Property Type Description

spring.cloud.config.uri

java.lang.String

Set the Spring Cloud config server uri. Default value ("http://localhost:8888").

spring.cloud.config.label

java.lang.String

Set the Spring Cloud config server label.

spring.cloud.config.fail-fast

boolean

If set to true an exception will be thrown if configuration is not found. Default value (false).

spring.cloud.config.http-version

HttpVersion

spring.cloud.config.log-level

LogLevel

spring.cloud.config.event-loop-group

java.lang.String

spring.cloud.config.ssl-configuration

SslConfiguration

spring.cloud.config.exception-on-error-status

boolean

spring.cloud.config.logger-name

java.lang.String

spring.cloud.config.follow-redirects

boolean

spring.cloud.config.default-charset

java.nio.charset.Charset

spring.cloud.config.channel-options

java.util.Map

spring.cloud.config.shutdown-timeout

java.time.Duration

spring.cloud.config.read-timeout

java.time.Duration

spring.cloud.config.read-idle-timeout

java.time.Duration

spring.cloud.config.connect-timeout

java.time.Duration

spring.cloud.config.connect-ttl

java.time.Duration

spring.cloud.config.num-of-threads

java.lang.Integer

spring.cloud.config.thread-factory

java.lang.Class

spring.cloud.config.max-content-length

int

spring.cloud.config.proxy-type

java.net.Proxy$Type

spring.cloud.config.proxy-address

java.net.SocketAddress

spring.cloud.config.proxy-username

java.lang.String

spring.cloud.config.proxy-password

java.lang.String

spring.cloud.config.proxy-selector

java.net.ProxySelector

🔗
Table 16. Configuration Properties for VaultClientConfiguration$VaultClientDiscoveryConfiguration
Property Type Description

vault.client.config.enabled

boolean

vault.client.config.path

java.lang.String

vault.client.config.format

ConfigDiscoveryConfiguration$Format

🔗
Table 17. Configuration Properties for ConsulConfiguration$ConsulConfigDiscoveryConfiguration
Property Type Description

consul.client.config.datacenter

java.lang.String

The datacenter

consul.client.config.enabled

boolean

consul.client.config.path

java.lang.String

consul.client.config.format

ConfigDiscoveryConfiguration$Format

🔗
Table 18. Configuration Properties for OracleCloudVaultClientConfiguration
Property Type Description

oraclecloud.vault.vaults

java.util.List

A list of OracleCloudVaultClientConfiguration$OracleCloudVault objects that contain secrets that will be retrieved, decoded and set into your application as config variables.

oraclecloud.vault.use-instance-principal

boolean

Whether or not the configuration client should use Instance Principal Authentication to interact with the SDK. If this value is false, you must include a path to an OCI Config file to use Config File based auth.

oraclecloud.vault.path-to-config

java.lang.String

If you are not using Instance Principal auth then you must pass the path to a valid OCI config file. Default value "~/.oci/config".

oraclecloud.vault.profile

java.lang.String

Which profile in the config file should be used? Default value "DEFAULT".

oraclecloud.vault.region

java.lang.String

The OCI region Ex: 'US-PHOENIX-1'.

🔗
Table 19. Configuration Properties for EurekaConfiguration
Property Type Description

eureka.client.http-version

HttpVersion

eureka.client.log-level

LogLevel

eureka.client.event-loop-group

java.lang.String

eureka.client.ssl-configuration

SslConfiguration

eureka.client.exception-on-error-status

boolean

eureka.client.logger-name

java.lang.String

eureka.client.follow-redirects

boolean

eureka.client.default-charset

java.nio.charset.Charset

eureka.client.channel-options

java.util.Map

eureka.client.shutdown-timeout

java.time.Duration

eureka.client.read-timeout

java.time.Duration

eureka.client.read-idle-timeout

java.time.Duration

eureka.client.connect-timeout

java.time.Duration

eureka.client.connect-ttl

java.time.Duration

eureka.client.num-of-threads

java.lang.Integer

eureka.client.thread-factory

java.lang.Class

eureka.client.max-content-length

int

eureka.client.proxy-type

java.net.Proxy$Type

eureka.client.proxy-address

java.net.SocketAddress

eureka.client.proxy-username

java.lang.String

eureka.client.proxy-password

java.lang.String

eureka.client.proxy-selector

java.net.ProxySelector

eureka.client.should-use-dns

boolean

Whether DNS should be used to resolve the discovery servers.

eureka.client.context-path

java.lang.String

Sets the context path.

eureka.client.default-zone

java.util.List

Sets the Discovery servers to use for the default zone.

eureka.client.zones

java.util.Map

Configures Discovery servers in other zones.

eureka.client.secure

boolean

Set if the discovery server is exposed over HTTPS

eureka.client.host

java.lang.String

The Discovery server host name

eureka.client.port

int

The port for the Discovery server