Hazelcast IMDG is the most widely used in-memory data grid with hundreds of thousands of installed clusters around the world. It offers caching solutions ensuring that data is in the right place when it’s needed for optimal performance.
$ helm install stable/hazelcast
This chart bootstraps a Hazelcast deployment on a Kubernetes cluster using the Helm package manager.
- Kubernetes 1.9+
To install the chart with the release name my-release
:
$ helm install --name my-release stable/hazelcast
The command deploys Hazelcast on the Kubernetes cluster in the default configuration. The configuration section lists the parameters that can be configured during installation.
Tip: List all releases using
helm list
To uninstall/delete the my-release
deployment:
$ helm delete my-release
The command removes all the Kubernetes components associated with the chart and deletes the release.
The following table lists the configurable parameters of the Hazelcast chart and their default values.
Parameter | Description | Default |
---|---|---|
image.repository |
Hazelcast Image name | hazelcast/hazelcast-kubernetes |
image.tag |
Hazelcast Image tag | {VERSION} |
image.pullPolicy |
Image pull policy | IfNotPresent |
image.pullSecrets |
Specify docker-registry secret names as an array | nil |
cluster.memberCount |
Number of Hazelcast members | 2 |
hazelcast.rest |
Enable REST endpoints for Hazelcast member | true |
hazelcast.javaOpts |
Additional JAVA_OPTS properties for Hazelcast member | nil |
hazelcast.configurationFiles |
Hazelcast configuration files | {DEFAULT_HAZELCAST_XML} |
nodeSelector |
Hazelcast Node labels for pod assignment | nil |
gracefulShutdown.enabled |
Turn on and off Graceful Shutdown | true |
gracefulShutdown.maxWaitSeconds |
Maximum time to wait for the Hazelcast POD to shut down | 600 |
livenessProbe.enabled |
Turn on and off liveness probe | true |
livenessProbe.initialDelaySeconds |
Delay before liveness probe is initiated | 30 |
livenessProbe.periodSeconds |
How often to perform the probe | 10 |
livenessProbe.timeoutSeconds |
When the probe times out | 5 |
livenessProbe.successThreshold |
Minimum consecutive successes for the probe to be considered successful after having failed | 1 |
livenessProbe.failureThreshold |
Minimum consecutive failures for the probe to be considered failed after having succeeded. | 3 |
readinessProbe.enabled |
Turn on and off readiness probe | true |
readinessProbe.initialDelaySeconds |
Delay before readiness probe is initiated | 30 |
readinessProbe.periodSeconds |
How often to perform the probe | 10 |
readinessProbe.timeoutSeconds |
When the probe times out | 1 |
readinessProbe.successThreshold |
Minimum consecutive successes for the probe to be considered successful after having failed | 1 |
readinessProbe.failureThreshold |
Minimum consecutive failures for the probe to be considered failed after having succeeded. | 3 |
resources |
CPU/Memory resource requests/limits | nil |
service.type |
Kubernetes service type ('ClusterIP', 'LoadBalancer', or 'NodePort') | ClusterIP |
service.port |
Kubernetes service port | 5701 |
rbac.create |
Enable installing RBAC Role authorization | true |
serviceAccount.create |
Enable installing Service Account | true |
serviceAccount.name |
Name of Service Account, if not set, the name is generated using the fullname template | nil |
Specify each parameter using the --set key=value[,key=value]
argument to helm install
. For example,
$ helm install --name my-release \
--set cluster.memberCount=3,hazelcast.rest=false \
stable/hazelcast
The above command sets number of Hazelcast members to 3 and disables REST endpoints.
Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,
$ helm install --name my-release -f values.yaml stable/hazelcast
Tip: You can use the default values.yaml
Custom Hazelcast configuration can be specified inside values.yaml
, as the hazelcast.configurationFiles.hazelcast.xml
property.
hazelcast:
configurationFiles:
hazelcast.xml: |-
<?xml version="1.0" encoding="UTF-8"?>
<hazelcast xsi:schemaLocation="http://www.hazelcast.com/schema/config hazelcast-config-3.10.xsd"
xmlns="http://www.hazelcast.com/schema/config"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<properties>
<property name="hazelcast.discovery.enabled">true</property>
</properties>
<network>
<join>
<multicast enabled="false"/>
<tcp-ip enabled="false" />
<discovery-strategies>
<discovery-strategy enabled="true" class="com.hazelcast.kubernetes.HazelcastKubernetesDiscoveryStrategy">
</discovery-strategy>
</discovery-strategies>
</join>
</network>
<!-- Custom Configuration Placeholder -->
</hazelcast>