Ce contenu n'est pas disponible dans la langue sélectionnée.

Building and deploying Data Grid clusters with Helm

Red Hat Data Grid 8.3

Create Data Grid clusters on OpenShift

Red Hat Customer Content Services

Legal Notice

Abstract

Build and deploy Data Grid clusters with Helm.

Red Hat Data Grid
Copier lien

Data Grid is a high-performance, distributed in-memory data store.

Schemaless data structure: Flexibility to store different objects as key-value pairs.
Grid-based data storage: Designed to distribute and replicate data across clusters.
Elastic scaling: Dynamically adjust the number of nodes to meet demand without service disruption.
Data interoperability: Store, retrieve, and query data in the grid from different endpoints.

Data Grid documentation
Copier lien

Documentation for Data Grid is available on the Red Hat customer portal.

Data Grid downloads
Copier lien

Access the Data Grid Software Downloads on the Red Hat customer portal.

Note

You must have a Red Hat account to access and download Data Grid software.

Making open source more inclusive
Copier lien

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. We are beginning with these four terms: master, slave, blacklist, and whitelist. Because of the enormity of this endeavor, these changes will be implemented gradually over several upcoming releases. For more details, see our CTO Chris Wright’s message.

Chapter 1. Deploying Data Grid clusters as Helm chart releases
Copier lien

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.

1.1. Installing the Data Grid chart through the OpenShift console
Copier lien

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

Log in to the OpenShift Web Console.
Select the Developer perspective.
Open the Add view and then select Helm Chart to browse the Red Hat developer catalog.
Locate and select the Data Grid chart.
Specify a name for the chart and select a version.
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.
  Tip
  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.
Select Install.

Verification

Select the Helm view in the Developer perspective.
Select the Helm release you created to view details, resources, and other information.

1.2. Installing the Data Grid chart on the command line
Copier lien

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

Install the helm client.
Add the OpenShift Helm Charts repository.
Have access to an OpenShift cluster.
Have an oc client.

Procedure

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

$ 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

Copy to Clipboard

Toggle word wrap

Install the Data Grid chart and specify your values file.

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

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

Copy to Clipboard

Toggle word wrap

Tip

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

--set deploy.replicas=3

--set deploy.replicas=3

Copy to Clipboard

Toggle word wrap

Verification

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

oc get pods -w

$ oc get pods -w

Copy to Clipboard

Toggle word wrap

1.3. Upgrading Data Grid Helm releases
Copier lien

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

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

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

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

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

Copy to Clipboard

Toggle word wrap

Verification

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

oc get pods -w

$ oc get pods -w

Copy to Clipboard

Toggle word wrap

1.4. Uninstalling Data Grid Helm releases
Copier lien

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

Note

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

List the installed Data Grid Helm releases.
```
helm list
```
```
$ helm list
```
Copy to Clipboard Toggle word wrap
Use the helm client to uninstall a release and remove the Data Grid cluster:
```
helm uninstall <helm_release_name>
```
```
$ helm uninstall <helm_release_name>
```
Copy to Clipboard Toggle word wrap

Use the oc client to remove the generated secret.

oc delete secret <helm_release_name>-generated-secret

$ oc delete secret <helm_release_name>-generated-secret

Copy to Clipboard

Toggle word wrap

1.5. Deployment configuration values
Copier lien

Deployment configuration values let you customize Data Grid clusters.

Tip

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

Expand

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.podLabels`	Adds labels to each Data Grid pod that you create.	No default value.
`deploy.svcLabels`	Adds labels to each service that you create.	No default value.
`deploy.resourceLabels`	Adds labels to all Data Grid resources including 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.

Chapter 2. Configuring Data Grid Servers
Copier lien

Apply custom Data Grid Server configuration to your deployments.

2.1. Customizing Data Grid Server configuration
Copier lien

Apply custom deploy.infinispan values to Data Grid clusters that configure the Cache Manager and underlying server mechanisms like security realms or Hot Rod and REST endpoints.

Important

You must always provide a complete Data Grid Server configuration when you modify deploy.infinispan values.

Note

Do not modify or remove the default "metrics" configuration if you want to use monitoring capabilities for your Data Grid cluster.

Procedure

Modify Data Grid Server configuration as required:

Specify configuration values for the Cache Manager with deploy.infinispan.cacheContainer fields.
For example, you can create caches at startup with any Data Grid configuration or add cache templates and use them to create caches on demand.
Configure security authorization to control user roles and permissions with the deploy.infinispan.cacheContainer.security.authorization field.
Select one of the default JGroups stacks or configure cluster transport with the deploy.infinispan.cacheContainer.transport fields.
Configure Data Grid Server endpoints with the deploy.infinispan.server.endpoints fields.
Configure Data Grid Server network interfaces and ports with the deploy.infinispan.server.interfaces and deploy.infinispan.server.socketBindings fields.
Configure Data Grid Server security mechanisms with the deploy.infinispan.server.security fields.
Note
The Data Grid chart does not currently support TLS/SSL security realms and encrypted client connections.

2.2. Data Grid Server configuration values
Copier lien

Data Grid Server configuration values let you customize the Cache Manager and modify server instances that run in OpenShift pods.

Data Grid Server configuration

deploy:
  infinispan:
    cacheContainer:
    # [USER] Add cache, template, and counter configuration.
    name: default
    # [USER] Specify `security: null` to disable security authorization.
    security:
      authorization: {}
    transport:
      cluster: ${infinispan.cluster.name:cluster}
      node-name: ${infinispan.node.name:}
      stack: kubernetes
    server:
      endpoints:
        # [USER] Hot Rod and REST endpoints.
        - securityRealm: default
          socketBinding: default
        # [METRICS] Metrics endpoint for cluster monitoring capabilities.
        - connectors:
            rest:
              restConnector:
                authentication:
                  mechanisms: BASIC
          securityRealm: metrics
          socketBinding: metrics
      interfaces:
      - inetAddress:
          value: ${infinispan.bind.address:127.0.0.1}
        name: public
      security:
        credentialStores:
        - clearTextCredential:
            clearText: secret
          name: credentials
          path: credentials.pfx
        securityRealms:
        # [USER] Security realm for the Hot Rod and REST endpoints.
        - name: default
          # [USER] Comment or remove this properties realm to disable authentication.
          propertiesRealm:
            groupProperties:
              path: groups.properties
            groupsAttribute: Roles
            userProperties:
              path: users.properties
          # [METRICS] Security realm for the metrics endpoint.
        - name: metrics
          propertiesRealm:
            groupProperties:
              path: metrics-groups.properties
              relativeTo: infinispan.server.config.path
            groupsAttribute: Roles
            userProperties:
              path: metrics-users.properties
              plainText: true
              relativeTo: infinispan.server.config.path
        socketBindings:
          defaultInterface: public
          portOffset: ${infinispan.socket.binding.port-offset:0}
          socketBinding:
            # [USER] Socket binding for the Hot Rod and REST endpoints.
          - name: default
            port: 11222
            # [METRICS] Socket binding for the metrics endpoint.
          - name: metrics
            port: 11223

deploy:
  infinispan:
    cacheContainer:
    # [USER] Add cache, template, and counter configuration.
    name: default
    # [USER] Specify `security: null` to disable security authorization.
    security:
      authorization: {}
    transport:
      cluster: ${infinispan.cluster.name:cluster}
      node-name: ${infinispan.node.name:}
      stack: kubernetes
    server:
      endpoints:
        # [USER] Hot Rod and REST endpoints.
        - securityRealm: default
          socketBinding: default
        # [METRICS] Metrics endpoint for cluster monitoring capabilities.
        - connectors:
            rest:
              restConnector:
                authentication:
                  mechanisms: BASIC
          securityRealm: metrics
          socketBinding: metrics
      interfaces:
      - inetAddress:
          value: ${infinispan.bind.address:127.0.0.1}
        name: public
      security:
        credentialStores:
        - clearTextCredential:
            clearText: secret
          name: credentials
          path: credentials.pfx
        securityRealms:
        # [USER] Security realm for the Hot Rod and REST endpoints.
        - name: default
          # [USER] Comment or remove this properties realm to disable authentication.
          propertiesRealm:
            groupProperties:
              path: groups.properties
            groupsAttribute: Roles
            userProperties:
              path: users.properties
          # [METRICS] Security realm for the metrics endpoint.
        - name: metrics
          propertiesRealm:
            groupProperties:
              path: metrics-groups.properties
              relativeTo: infinispan.server.config.path
            groupsAttribute: Roles
            userProperties:
              path: metrics-users.properties
              plainText: true
              relativeTo: infinispan.server.config.path
        socketBindings:
          defaultInterface: public
          portOffset: ${infinispan.socket.binding.port-offset:0}
          socketBinding:
            # [USER] Socket binding for the Hot Rod and REST endpoints.
          - name: default
            port: 11222
            # [METRICS] Socket binding for the metrics endpoint.
          - name: metrics
            port: 11223

Copy to Clipboard

Toggle word wrap

Data Grid cache configuration

deploy:
  infinispan:
    cacheContainer:
      distributedCache:
        name: "mycache"
        mode: "SYNC"
        owners: "2"
        segments: "256"
        capacityFactor: "1.0"
        statistics: "true"
        encoding:
          mediaType: "application/x-protostream"
        expiration:
          lifespan: "5000"
          maxIdle: "1000"
        memory:
          maxCount: "1000000"
          whenFull: "REMOVE"
        partitionHandling:
          whenSplit: "ALLOW_READ_WRITES"
          mergePolicy: "PREFERRED_NON_NULL"
    #Provide additional Cache Manager configuration.
  server:
    #Provide configuration for server instances.

deploy:
  infinispan:
    cacheContainer:
      distributedCache:
        name: "mycache"
        mode: "SYNC"
        owners: "2"
        segments: "256"
        capacityFactor: "1.0"
        statistics: "true"
        encoding:
          mediaType: "application/x-protostream"
        expiration:
          lifespan: "5000"
          maxIdle: "1000"
        memory:
          maxCount: "1000000"
          whenFull: "REMOVE"
        partitionHandling:
          whenSplit: "ALLOW_READ_WRITES"
          mergePolicy: "PREFERRED_NON_NULL"
    #Provide additional Cache Manager configuration.
  server:
    #Provide configuration for server instances.

Copy to Clipboard

Toggle word wrap

Cache template

deploy:
  infinispan:
    cacheContainer:
      distributedCacheConfiguration:
        name: "my-dist-template"
        mode: "SYNC"
        statistics: "true"
        encoding:
          mediaType: "application/x-protostream"
        expiration:
          lifespan: "5000"
          maxIdle: "1000"
        memory:
          maxCount: "1000000"
          whenFull: "REMOVE"
    #Provide additional Cache Manager configuration.
  server:
    #Provide configuration for server instances.

deploy:
  infinispan:
    cacheContainer:
      distributedCacheConfiguration:
        name: "my-dist-template"
        mode: "SYNC"
        statistics: "true"
        encoding:
          mediaType: "application/x-protostream"
        expiration:
          lifespan: "5000"
          maxIdle: "1000"
        memory:
          maxCount: "1000000"
          whenFull: "REMOVE"
    #Provide additional Cache Manager configuration.
  server:
    #Provide configuration for server instances.

Copy to Clipboard

Toggle word wrap

Cluster transport

deploy:
  infinispan:
    cacheContainer:
      transport:
        #Specifies the name of a default JGroups stack.
        stack: kubernetes
    #Provide additional Cache Manager configuration.
  server:
    #Provide configuration for server instances.

deploy:
  infinispan:
    cacheContainer:
      transport:
        #Specifies the name of a default JGroups stack.
        stack: kubernetes
    #Provide additional Cache Manager configuration.
  server:
    #Provide configuration for server instances.

Copy to Clipboard

Toggle word wrap

Chapter 3. Configuring authentication and authorization
Copier lien

Control access to Data Grid clusters by adding credentials and assigning roles with different permissions.

3.1. Default credentials
Copier lien

Data Grid adds default credentials in a <helm_release_name>-generated-secret secret.

Expand

Username	Description
`developer`	User that has the `admin` role with full access to Data Grid resources.
`monitor`	Internal user that has the `monitor` role with access to Data Grid metrics through port `11223`.

3.1.1. Retrieving credentials
Copier lien

Get Data Grid credentials from authentication secrets.

Prerequisites

Install the Data Grid Helm chart.
Have an oc client.

Procedure

Retrieve default credentials from the <helm_release_name>-generated-secret or custom credentials from another secret with the following command:

oc get secret <helm_release_name>-generated-secret \
-o jsonpath="{.data.identities-batch}" | base64 --decode

$ oc get secret <helm_release_name>-generated-secret \
-o jsonpath="{.data.identities-batch}" | base64 --decode

Copy to Clipboard

Toggle word wrap

3.2. Adding custom user credentials
Copier lien

Create Data Grid user credentials and assign roles that grant security authorization for cluster access.

Procedure

Create credentials by specifying a user create command in the deploy.security.batch field.

User with implicit authorization

deploy:
  security:
    batch: 'user create admin -p changeme'

deploy:
  security:
    batch: 'user create admin -p changeme'

Copy to Clipboard

Toggle word wrap

User with a specific role

deploy:
  security:
    batch: 'user create personone -p changeme -g deployer'

deploy:
  security:
    batch: 'user create personone -p changeme -g deployer'

Copy to Clipboard

Toggle word wrap

Install or upgrade your Data Grid Helm release.

3.2.1. User roles and permissions
Copier lien

Data Grid uses role-based access control to authorize users for access to cluster resources and data. For additional security, you should grant Data Grid users with appropriate roles when you add credentials.

Expand

Role	Permissions	Description
`admin`	ALL	Superuser with all permissions including control of the Cache Manager lifecycle.
`deployer`	ALL_READ, ALL_WRITE, LISTEN, EXEC, MONITOR, CREATE	Can create and delete Data Grid resources in addition to `application` permissions.
`application`	ALL_READ, ALL_WRITE, LISTEN, EXEC, MONITOR	Has read and write access to Data Grid resources in addition to `observer` permissions. Can also listen to events and execute server tasks and scripts.
`observer`	ALL_READ, MONITOR	Has read access to Data Grid resources in addition to `monitor` permissions.
`monitor`	MONITOR	Can view statistics for Data Grid clusters.

3.2.2. Adding multiple credentials with authentication secrets
Copier lien

Add multiple credentials to Data Grid clusters with authentication secrets.

Prerequisites

Have an oc client.

Procedure

Create an identities-batch file that contains the commands to add your credentials.

apiVersion: v1
kind: Secret
metadata:
  name: connect-secret
type: Opaque
stringData:
  # The "monitor" user authenticates with the Prometheus ServiceMonitor.
  username: monitor
  # The password for the "monitor" user.
  password: password
  # The key must be 'identities-batch'.
  # The content is "user create" commands for the Data Grid CLI.
  identities-batch: |-
    user create user1 -p changeme -g admin
    user create user2 -p changeme -g deployer
    user create monitor -p password --users-file metrics-users.properties --groups-file metrics-groups.properties

apiVersion: v1
kind: Secret
metadata:
  name: connect-secret
type: Opaque
stringData:
  # The "monitor" user authenticates with the Prometheus ServiceMonitor.
  username: monitor
  # The password for the "monitor" user.
  password: password
  # The key must be 'identities-batch'.
  # The content is "user create" commands for the Data Grid CLI.
  identities-batch: |-
    user create user1 -p changeme -g admin
    user create user2 -p changeme -g deployer
    user create monitor -p password --users-file metrics-users.properties --groups-file metrics-groups.properties

Copy to Clipboard

Toggle word wrap

Create an authentication secret from your identities-batch file.
```
oc apply -f identities-batch.yaml
```
```
$ oc apply -f identities-batch.yaml
```
Copy to Clipboard Toggle word wrap

Specify the authentication secret in the deploy.security.SecretName field.

deploy:
  security:
    authentication: true
    secretName: 'connect-secret'

deploy:
  security:
    authentication: true
    secretName: 'connect-secret'

Copy to Clipboard

Toggle word wrap

Install or upgrade your Data Grid Helm release.

3.3. Disabling authentication
Copier lien

Allow users to access Data Grid clusters and manipulate data without providing credentials.

Important

Do not disable authentication if endpoints are accessible from outside the OpenShift cluster. You should disable authentication for development environments only.

Procedure

Remove the propertiesRealm fields from the "default" security realm.
Install or upgrade your Data Grid Helm release.

3.4. Disabling security authorization
Copier lien

Allow Data Grid users to perform any operation regardless of their role.

Procedure

Set null as the value for the deploy.infinispan.cacheContainer.security field.
Tip
Use the --set deploy.infinispan.cacheContainer.security=null argument with the helm client.
Install or upgrade your Data Grid Helm release.

Chapter 4. Configuring network access
Copier lien

Configure network access for your Data Grid deployment and find out about internal network services.

4.1. Exposing Data Grid clusters on the network
Copier lien

Make Data Grid clusters available on the network so you can access Data Grid Console as well as REST and Hot Rod endpoints. By default, the Data Grid chart exposes deployments through a Route but you can configure it to expose clusters via Load Balancer or Node Port. You can also configure the Data Grid chart so that deployments are not exposed on the network and only available internally to the OpenShift cluster.

Procedure

Specify one of the following for the deploy.expose.type field:

Expand

Option	Description
`Route`	Exposes Data Grid through a route. This is the default value.
`LoadBalancer`	Exposes Data Grid through a load balancer service.
`NodePort`	Exposes Data Grid through a node port service.
`""` (empty value)	Disables exposing Data Grid on the network.

Optionally specify a hostname with the deploy.expose.host field if you expose Data Grid through a route.
Optionally specify a port with the deploy.expose.nodePort field if you expose Data Grid through a node port service.
Install or upgrade your Data Grid Helm release.

4.2. Retrieving network service details
Copier lien

Get network service details so you can connect to Data Grid clusters.

Prerequisites

Expose your Data Grid cluster on the network.
Have an oc client.

Procedure

Use one of the following commands to retrieve network service details:

If you expose Data Grid through a route:
```
oc get routes
```
```
$ oc get routes
```
Copy to Clipboard Toggle word wrap
If you expose Data Grid through a load balancer or node port service:
```
oc get services
```
```
$ oc get services
```
Copy to Clipboard Toggle word wrap

4.3. Network services
Copier lien

The Data Grid chart creates default network services for internal access.

Expand

Service	Port	Protocol	Description
`<helm_release_name>`	`11222`	TCP	Provides access to Data Grid Hot Rod and REST endpoints.
`<helm_release_name>`	`11223`	TCP	Provides access to Data Grid metrics.
`<helm_release_name>-ping`	`8888`	TCP	Allows Data Grid pods to discover each other and form clusters.

You can retrieve details about internal network services as follows:

oc get services

$ oc get services

NAME              TYPE        CLUSTER-IP       EXTERNAL-IP   PORT(S)
infinispan        ClusterIP   192.0.2.0        <none>        11222/TCP,11223/TCP
infinispan-ping   ClusterIP   None             <none>        8888/TCP

Copy to Clipboard

Toggle word wrap

Chapter 5. Connecting to Data Grid clusters
Copier lien

After you configure and deploy Data Grid clusters you can establish remote connections through the Data Grid Console, command line interface (CLI), Hot Rod client, or REST API.

5.1. Accessing Data Grid Console
Copier lien

Access the console to create caches, perform adminstrative operations, and monitor your Data Grid clusters.

Prerequisites

Expose your Data Grid cluster on the network.
Retrieve network service details.

Procedure

Access Data Grid Console from any browser at $SERVICE_HOSTNAME:$PORT.
Replace $SERVICE_HOSTNAME:$PORT with the hostname and port where Data Grid is available on the network.

5.2. Connecting with the command line interface (CLI)
Copier lien

Use the Data Grid CLI to connect to clusters and create caches, manipulate data, and perform administrative operations.

Prerequisites

Expose your Data Grid cluster on the network.
Retrieve network service details.
Download the native Data Grid CLI distribution from the Data Grid software downloads.
Extract the .zip archive for the native Data Grid CLI distribution to your host filesystem.

Procedure

Start the Data Grid CLI with the network service as the value for the -c argument, for example:
```
{native_cli} -c http://cluster-name-myroute.hostname.net/
```
```
$ {native_cli} -c http://cluster-name-myroute.hostname.net/
```
Copy to Clipboard Toggle word wrap
Enter your Data Grid credentials when prompted.
Perform CLI operations as required.
Tip
Press the tab key or use the --help argument to view available options and help text.
Use the quit command to exit the CLI.

5.3. Connecting Hot Rod clients running on OpenShift
Copier lien

Access remote caches with Hot Rod clients running on the same OpenShift cluster as your Data Grid cluster.

Prerequisites

Retrieve network service details.

Procedure

Specify the internal network service detail for your Data Grid cluster in the client configuration.
In the following configuration examples, $SERVICE_HOSTNAME:$PORT denotes the hostname and port that allows access to your Data Grid cluster.
Specify your credentials so the client can authenticate with Data Grid.
Configure client intelligence, if required.
Hot Rod clients running on OpenShift can use any client intelligence because they can access internal IP addresses for Data Grid pods.
The default intelligence, HASH_DISTRIBUTION_AWARE, is recommended because it allows clients to route requests to primary owners, which improves performance.

Programmatic configuration

import org.infinispan.client.hotrod.configuration.ConfigurationBuilder;
import org.infinispan.client.hotrod.configuration.SaslQop;
import org.infinispan.client.hotrod.impl.ConfigurationProperties;
...

ConfigurationBuilder builder = new ConfigurationBuilder();
      builder.addServer()
               .host("$SERVICE_HOSTNAME")
               .port(ConfigurationProperties.DEFAULT_HOTROD_PORT)
             .security().authentication()
               .username("username")
               .password("changeme")
               .realm("default")
               .saslQop(SaslQop.AUTH)
               .saslMechanism("SCRAM-SHA-512");

import org.infinispan.client.hotrod.configuration.ConfigurationBuilder;
import org.infinispan.client.hotrod.configuration.SaslQop;
import org.infinispan.client.hotrod.impl.ConfigurationProperties;
...

ConfigurationBuilder builder = new ConfigurationBuilder();
      builder.addServer()
               .host("$SERVICE_HOSTNAME")
               .port(ConfigurationProperties.DEFAULT_HOTROD_PORT)
             .security().authentication()
               .username("username")
               .password("changeme")
               .realm("default")
               .saslQop(SaslQop.AUTH)
               .saslMechanism("SCRAM-SHA-512");

Copy to Clipboard

Toggle word wrap

Hot Rod client properties

Connection
Authentication

# Connection
infinispan.client.hotrod.server_list=$SERVICE_HOSTNAME:$PORT

# Authentication
infinispan.client.hotrod.use_auth=true
infinispan.client.hotrod.auth_username=developer
infinispan.client.hotrod.auth_password=$PASSWORD
infinispan.client.hotrod.auth_server_name=$CLUSTER_NAME
infinispan.client.hotrod.sasl_properties.javax.security.sasl.qop=auth
infinispan.client.hotrod.sasl_mechanism=SCRAM-SHA-512

Copy to Clipboard

Toggle word wrap

5.4. Connecting Hot Rod clients running outside OpenShift
Copier lien

Access remote caches with Hot Rod clients running externally to the OpenShift cluster where you deploy your Data Grid cluster.

Prerequisites

Expose your Data Grid cluster on the network.
Retrieve network service details.

Procedure

Specify the internal network service detail for your Data Grid cluster in the client configuration.
In the following configuration examples, $SERVICE_HOSTNAME:$PORT denotes the hostname and port that allows access to your Data Grid cluster.
Specify your credentials so the client can authenticate with Data Grid.
Configure clients to use BASIC intelligence.

Programmatic configuration

import org.infinispan.client.hotrod.configuration.ClientIntelligence;
import org.infinispan.client.hotrod.configuration.ConfigurationBuilder;
import org.infinispan.client.hotrod.configuration.SaslQop;
...

ConfigurationBuilder builder = new ConfigurationBuilder();
      builder.addServer()
               .host("$SERVICE_HOSTNAME")
               .port("$PORT")
             .security().authentication()
               .username("username")
               .password("changeme")
               .realm("default")
               .saslQop(SaslQop.AUTH)
               .saslMechanism("SCRAM-SHA-512");
      builder.clientIntelligence(ClientIntelligence.BASIC);

import org.infinispan.client.hotrod.configuration.ClientIntelligence;
import org.infinispan.client.hotrod.configuration.ConfigurationBuilder;
import org.infinispan.client.hotrod.configuration.SaslQop;
...

ConfigurationBuilder builder = new ConfigurationBuilder();
      builder.addServer()
               .host("$SERVICE_HOSTNAME")
               .port("$PORT")
             .security().authentication()
               .username("username")
               .password("changeme")
               .realm("default")
               .saslQop(SaslQop.AUTH)
               .saslMechanism("SCRAM-SHA-512");
      builder.clientIntelligence(ClientIntelligence.BASIC);

Copy to Clipboard

Toggle word wrap

Hot Rod client properties

Connection
Client intelligence
Authentication

# Connection
infinispan.client.hotrod.server_list=$SERVICE_HOSTNAME:$PORT

# Client intelligence
infinispan.client.hotrod.client_intelligence=BASIC

# Authentication
infinispan.client.hotrod.use_auth=true
infinispan.client.hotrod.auth_username=developer
infinispan.client.hotrod.auth_password=$PASSWORD
infinispan.client.hotrod.auth_server_name=$CLUSTER_NAME
infinispan.client.hotrod.sasl_properties.javax.security.sasl.qop=auth
infinispan.client.hotrod.sasl_mechanism=SCRAM-SHA-512

Copy to Clipboard

Toggle word wrap

5.5. Accessing the REST API
Copier lien

Data Grid provides a RESTful interface that you can interact with using HTTP clients.

Prerequisites

Expose your Data Grid cluster on the network.
Retrieve network service details.

Procedure

Access the REST API with any HTTP client at $SERVICE_HOSTNAME:$PORT/rest/v2.
Replace $SERVICE_HOSTNAME:$PORT with the hostname and port where Data Grid is available on the network.

Legal Notice
Copier lien

The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.

Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.

Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.

Linux® is the registered trademark of Linus Torvalds in the United States and other countries.

Java® is a registered trademark of Oracle and/or its affiliates.

XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.

MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.

Node.js® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.

The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.

Ce contenu n'est pas disponible dans la langue sélectionnée.

Building and deploying Data Grid clusters with Helm

Create Data Grid clusters on OpenShift

Red Hat Data GridCopier lienLien copié sur presse-papiers!

Data Grid documentationCopier lienLien copié sur presse-papiers!

Data Grid downloadsCopier lienLien copié sur presse-papiers!

Making open source more inclusiveCopier lienLien copié sur presse-papiers!

Chapter 1. Deploying Data Grid clusters as Helm chart releasesCopier lienLien copié sur presse-papiers!

1.1. Installing the Data Grid chart through the OpenShift consoleCopier lienLien copié sur presse-papiers!

1.2. Installing the Data Grid chart on the command lineCopier lienLien copié sur presse-papiers!

1.3. Upgrading Data Grid Helm releasesCopier lienLien copié sur presse-papiers!

1.4. Uninstalling Data Grid Helm releasesCopier lienLien copié sur presse-papiers!

1.5. Deployment configuration valuesCopier lienLien copié sur presse-papiers!

Chapter 2. Configuring Data Grid ServersCopier lienLien copié sur presse-papiers!

2.1. Customizing Data Grid Server configurationCopier lienLien copié sur presse-papiers!

2.2. Data Grid Server configuration valuesCopier lienLien copié sur presse-papiers!

Chapter 3. Configuring authentication and authorizationCopier lienLien copié sur presse-papiers!

3.1. Default credentialsCopier lienLien copié sur presse-papiers!

3.1.1. Retrieving credentialsCopier lienLien copié sur presse-papiers!

3.2. Adding custom user credentialsCopier lienLien copié sur presse-papiers!

3.2.1. User roles and permissionsCopier lienLien copié sur presse-papiers!

3.2.2. Adding multiple credentials with authentication secretsCopier lienLien copié sur presse-papiers!

3.3. Disabling authenticationCopier lienLien copié sur presse-papiers!

3.4. Disabling security authorizationCopier lienLien copié sur presse-papiers!

Chapter 4. Configuring network accessCopier lienLien copié sur presse-papiers!

4.1. Exposing Data Grid clusters on the networkCopier lienLien copié sur presse-papiers!

4.2. Retrieving network service detailsCopier lienLien copié sur presse-papiers!

4.3. Network servicesCopier lienLien copié sur presse-papiers!

Chapter 5. Connecting to Data Grid clustersCopier lienLien copié sur presse-papiers!

5.1. Accessing Data Grid ConsoleCopier lienLien copié sur presse-papiers!

5.2. Connecting with the command line interface (CLI)Copier lienLien copié sur presse-papiers!

5.3. Connecting Hot Rod clients running on OpenShiftCopier lienLien copié sur presse-papiers!

Programmatic configuration

Hot Rod client properties

5.4. Connecting Hot Rod clients running outside OpenShiftCopier lienLien copié sur presse-papiers!

Programmatic configuration

Hot Rod client properties

5.5. Accessing the REST APICopier lienLien copié sur presse-papiers!

Legal NoticeCopier lienLien copié sur presse-papiers!

Apprendre

Essayez, achetez et vendez

Communautés

À propos de la documentation Red Hat

Rendre l’open source plus inclusif

À propos de Red Hat

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

Red Hat Data Grid
Copier lien

Data Grid documentation
Copier lien

Data Grid downloads
Copier lien

Making open source more inclusive
Copier lien

Chapter 1. Deploying Data Grid clusters as Helm chart releases
Copier lien

1.1. Installing the Data Grid chart through the OpenShift console
Copier lien

1.2. Installing the Data Grid chart on the command line
Copier lien

1.3. Upgrading Data Grid Helm releases
Copier lien

1.4. Uninstalling Data Grid Helm releases
Copier lien

1.5. Deployment configuration values
Copier lien

Chapter 2. Configuring Data Grid Servers
Copier lien

2.1. Customizing Data Grid Server configuration
Copier lien

2.2. Data Grid Server configuration values
Copier lien

Chapter 3. Configuring authentication and authorization
Copier lien

3.1. Default credentials
Copier lien

3.1.1. Retrieving credentials
Copier lien

3.2. Adding custom user credentials
Copier lien

3.2.1. User roles and permissions
Copier lien

3.2.2. Adding multiple credentials with authentication secrets
Copier lien

3.3. Disabling authentication
Copier lien

3.4. Disabling security authorization
Copier lien

Chapter 4. Configuring network access
Copier lien

4.1. Exposing Data Grid clusters on the network
Copier lien

4.2. Retrieving network service details
Copier lien

4.3. Network services
Copier lien

Chapter 5. Connecting to Data Grid clusters
Copier lien

5.1. Accessing Data Grid Console
Copier lien

5.2. Connecting with the command line interface (CLI)
Copier lien

5.3. Connecting Hot Rod clients running on OpenShift
Copier lien

5.4. Connecting Hot Rod clients running outside OpenShift
Copier lien

5.5. Accessing the REST API
Copier lien

Legal Notice
Copier lien