Package com.hazelcast.kubernetes
Class KubernetesProperties
java.lang.Object
com.hazelcast.kubernetes.KubernetesProperties
public final class KubernetesProperties extends Object
Configuration class of the Hazelcast Discovery Plugin for Kubernetes.
For possible configuration properties please refer to the public constants of this class.
-
Field Summary
Fields Modifier and Type Field Description static PropertyDefinition
KUBERNETES_API_RETIRES
Configuration key:kubernetes-api-retries
static PropertyDefinition
KUBERNETES_API_TOKEN
Configuration key:api-token
static PropertyDefinition
KUBERNETES_CA_CERTIFICATE
Configuration key:ca-certificate
CA Authority certificate from Kubernetes Master, defaults to reading the certificate from the auto-injected file at:/var/run/secrets/kubernetes.io/serviceaccount/ca.crt
static PropertyDefinition
KUBERNETES_MASTER_URL
Configuration key:kubernetes-master
static String
KUBERNETES_SYSTEM_PREFIX
Configuration System Environment Prefix:hazelcast.kubernetes.
static PropertyDefinition
NAMESPACE
Configuration key:namespace
static PropertyDefinition
POD_LABEL_NAME
Configuration key:pod-label-name
static PropertyDefinition
POD_LABEL_VALUE
Configuration key:pod-label-value
static PropertyDefinition
RESOLVE_NOT_READY_ADDRESSES
Configuration key:resolve-not-ready-addresses
static PropertyDefinition
SERVICE_DNS
Configuration key:service-dns
static PropertyDefinition
SERVICE_DNS_TIMEOUT
Configuration key:service-dns-timeout
static PropertyDefinition
SERVICE_LABEL_NAME
Configuration key:service-label-name
static PropertyDefinition
SERVICE_LABEL_VALUE
Configuration key:service-label-value
static PropertyDefinition
SERVICE_NAME
Configuration key:service-name
static PropertyDefinition
SERVICE_PORT
Configuration key:service-port
static PropertyDefinition
USE_NODE_NAME_AS_EXTERNAL_ADDRESS
Configuration key:use-node-name-as-external-address
-
Method Summary
-
Field Details
-
KUBERNETES_SYSTEM_PREFIX
Configuration System Environment Prefix:
Defines the prefix for system environment variables and JVM command line parameters.hazelcast.kubernetes.
Defining or overriding properties as JVM parameters or using the system environment, those properties need to be prefixed to prevent collision on property names.
Example:SERVICE_DNS
will be:-Dhazelcast.kubernetes.service-dns=value
For kubernetes and openshift there is a special rule where the environment variables are provided in C-identifier style, therefore the prefix is converted to uppercase and dots and dashed will be replaced with underscores:HAZELCAST_KUBERNETES_SERVICE_DNS=value
- See Also:
- Constant Field Values
-
SERVICE_DNS
Configuration key:
Defines the DNS service lookup domain. This is defined as something similar toservice-dns
my-svc.my-namespace.svc.cluster.local
.
For more information please refer to the official documentation of the Kubernetes DNS addon, here. -
SERVICE_DNS_TIMEOUT
Configuration key:
Defines the DNS service lookup timeout in seconds. Defaults to: 5 secs.service-dns-timeout
-
SERVICE_NAME
Configuration key:
Defines the service name of the POD to lookup through the Service Discovery REST API of Kubernetes.service-name
-
SERVICE_LABEL_NAME
Configuration key:
Defines the service label to lookup through the Service Discovery REST API of Kubernetes.service-label-name
-
SERVICE_LABEL_VALUE
Configuration key:
Defines the service label value to lookup through the Service Discovery REST API of Kubernetes.service-label-value
-
NAMESPACE
Configuration key:
Defines the namespace of the application POD through the Service Discovery REST API of Kubernetes.namespace
-
POD_LABEL_NAME
Configuration key:
Defines the pod label to lookup through the Service Discovery REST API of Kubernetes.pod-label-name
-
POD_LABEL_VALUE
Configuration key:
Defines the pod label value to lookup through the Service Discovery REST API of Kubernetes.pod-label-value
-
RESOLVE_NOT_READY_ADDRESSES
Configuration key:
Defines if not ready addresses should be evaluated to be discovered on startup.resolve-not-ready-addresses
-
USE_NODE_NAME_AS_EXTERNAL_ADDRESS
Configuration key:
Defines if the node name should be used as external address, instead of looking up the external IP using theuse-node-name-as-external-address
/nodes
resource. Default is false. -
KUBERNETES_API_RETIRES
Configuration key:
Defines the number of retries to Kubernetes API. Defaults to: 3.kubernetes-api-retries
-
KUBERNETES_MASTER_URL
Configuration key:
Defines an alternative address for the kubernetes master. Defaults to:kubernetes-master
https://kubernetes.default.svc
-
KUBERNETES_API_TOKEN
Configuration key:
Defines an oauth token for the kubernetes client to access the kubernetes REST API. Defaults to reading the token from the auto-injected file at:api-token
/var/run/secrets/kubernetes.io/serviceaccount/token
-
KUBERNETES_CA_CERTIFICATE
Configuration key:ca-certificate
CA Authority certificate from Kubernetes Master, defaults to reading the certificate from the auto-injected file at:/var/run/secrets/kubernetes.io/serviceaccount/ca.crt
-
SERVICE_PORT
Configuration key:
If specified with a value greater than 0, its value defines the endpoint port of the service (overriding the default).service-port
-