Deploying Data Grid clusters as Helm chart releases

Guide
  • Red Hat Data Grid 8.3
  • Updated 01 March 2022
  • Published 02 December 2021

Topics included in this guide

Deploying Data Grid clusters as Helm chart releases

Guide
Red Hat Data Grid 8.3
  • Updated 01 March 2022
  • Published 02 December 2021

Build, configure, and deploy Data Grid clusters with Helm. Data Grid provides a Helm chart that packages resources for running Data Grid clusters on OpenShift.

Install the Data Grid chart to create a Helm release, which instantiates a Data Grid cluster in your OpenShift project.

Installing the Data Grid chart through the OpenShift console

Use the OpenShift Web Console to install the Data Grid chart from the Red Hat developer catalog. Installing the chart creates a Helm release that deploys a Data Grid cluster.

Prerequisites

  • Have access to OpenShift.

Procedure

  1. Log in to the OpenShift Web Console.

  2. Select the Developer perspective.

  3. Open the Add view and then select Helm Chart to browse the Red Hat developer catalog.

  4. Locate and select the Data Grid chart.

  5. Specify a name for the chart and select a version.

  6. Define values in the following sections of the Data Grid chart:

    • Images configures the container images to use when creating pods for your Data Grid cluster.

    • Deploy configures your Data Grid cluster.

      To find descriptions for each value, select the YAML view option and access the schema. Edit the yaml configuration to customize your Data Grid chart.

  7. Select Install.

Verification

  1. Select the Helm view in the Developer perspective.

  2. Select the Helm release you created to view details, resources, and other information.

Installing the Data Grid chart on the command line

Use the command line to install the Data Grid chart on OpenShift and instantiate a Data Grid cluster. Installing the chart creates a Helm release that deploys a Data Grid cluster.

Prerequisites
Procedure

  1. Create a values file that configures your Data Grid cluster.

    For example, the following values file creates a cluster with two nodes:

    $ cat > infinispan-values.yaml<<EOF
#Build configuration
images:
  server: registry.redhat.io/datagrid/datagrid-8-rhel8:latest
  initContainer: registry.access.redhat.com/ubi8-micro
#Deployment configuration
deploy:
  #Add a user with full security authorization.
  security:
    batch: "user create admin -p changeme"
  #Create a cluster with two pods.
  replicas: 2
EOF

  2. Install the Data Grid chart and specify your values file.

    $ helm install infinispan openshift-helm-charts/redhat-data-grid --values infinispan-values.yaml

Use the --set flag to override configuration values for the deployment. For example, to create a cluster with three nodes:

--set deploy.replicas=3
Verification

Watch the pods to ensure all nodes in the Data Grid cluster are created successfully.

$ oc get pods -w

Upgrading Data Grid Helm releases

Modify your Data Grid cluster configuration at runtime by upgrading Helm releases.

Prerequisites

  • Deploy the Data Grid chart.

  • Have a helm client.

  • Have an oc client.

Procedure

  1. Modify the values file for your Data Grid deployment as appropriate.

  2. Use the helm client to apply your changes, for example:

    $ helm upgrade infinispan openshift-helm-charts/redhat-data-grid --values infinispan-values.yaml
Verification

Watch the pods rebuild to ensure all changes are applied to your Data Grid cluster successfully.

$ oc get pods -w

Uninstalling Data Grid Helm releases

Uninstall a release of the Data Grid chart to remove pods and other deployment artifacts.

This procedure shows you how to uninstall a Data Grid deployment on the command line but you can use the OpenShift Web Console instead. Refer to the OpenShift documentation for specific instructions.

Prerequisites

  • Deploy the Data Grid chart.

  • Have a helm client.

  • Have an oc client.

Procedure

  1. List the installed Data Grid Helm releases.

    $ helm list

  2. Use the helm client to uninstall a release and remove the Data Grid cluster:

    $ helm uninstall <helm_release_name>

  3. Use the oc client to remove the generated secret.

    $ oc delete secret <helm_release_name>-generated-secret

Deployment configuration values

Deployment configuration values let you customize Data Grid clusters.

You can also find field and value descriptions in the Data Grid chart README.

Field Description Default value

deploy.replicas

Specifies the number of nodes in your Data Grid cluster, with a pod created for each node.

1

deploy.container.extraJvmOpts

Passes JVM options to Data Grid Server.

No default value.

deploy.container.storage.ephemeral

Defines whether storage is ephemeral or permanent.

The default value is false, which means data is permanent. Set the value to true to use ephemeral storage, which means all data is deleted when clusters shut down or restart.

deploy.container.storage.size

Defines how much storage is allocated to each Data Grid pod.

1Gi

deploy.container.storage.storageClassName

Specifies the name of a StorageClass object to use for the persistent volume claim (PVC).

No default value. By default, the persistent volume claim uses the storage class that has the storageclass.kubernetes.io/is-default-class annotation set to true. If you include this field, you must specify an existing storage class as the value.

deploy.container.resources.limits.cpu

Defines the CPU limit, in CPU units, for each Data Grid pod.

500m

deploy.container.resources.limits.memory

Defines the maximum amount of memory, in bytes, for each Data Grid pod.

512Mi

deploy.container.resources.requests.cpu

Specifies the maximum CPU requests, in CPU units, for each Data Grid pod.

500m

deploy.container.resources.requests.memory

Specifies the maximum memory requests, in bytes, for each Data Grid pod.

512Mi

deploy.security.secretName

Specifies the name of a secret that creates credentials and configures security authorization.

No default value. If you create a custom security secret then deploy.security.batch does not take effect.

deploy.security.batch

Provides a batch file for the Data Grid command line interface (CLI) to create credentials and configure security authorization at startup.

No default value.

deploy.expose.type

Specifies the service that exposes Hot Rod and REST endpoints on the network and provides access to your Data Grid cluster, including the Data Grid Console.

Route Valid options are: "" (empty value), Route, LoadBalancer, and NodePort. Set an empty value ("") if you do not want to expose Data Grid on the network.

deploy.expose.nodePort

Specifies a network port for node port services within the default range of 30000 to 32767.

0 If you do not specify a port, the platform selects an available one.

deploy.expose.host

Optionally specifies the hostname where the Route is exposed.

No default value.

deploy.expose.annotations

Adds annotations to the service that exposes Data Grid on the network.

No default value.

deploy.logging.categories

Configures Data Grid cluster log categories and levels.

No default value.

deploy.resourceLabels

Adds labels to Data Grid resources such as pods and services.

No default value.

deploy.makeDataDirWritable

Allows write access to the data directory for each Data Grid Server node.

false If you set the value to true, Data Grid creates an initContainer that runs chmod -R on the /opt/infinispan/server/data directory to change permissions.

deploy.nameOverride

Specifies a name for all Data Grid cluster resources.

Helm Chart release name.

deploy.infinispan

Data Grid Server configuration.

Data Grid provides default server configuration. For more information about configuring server instances, see Data Grid Server configuration values.
Legal Notices for Trademarks