Chapter 2. Installing the native Data Grid CLI as a client plugin

Data Grid provides a command line interface (CLI) compiled to a native executable that you can install as a plugin for oc clients. You can then use your oc client to:

  • Create Data Grid Operator subscriptions and remove Data Grid Operator installations.
  • Set up Data Grid clusters and configure services.
  • Work with Data Grid resources via remote shells.

2.1. Installing the native Data Grid CLI plugin

Install the native Data Grid Command Line Interface (CLI) as a plugin for oc clients.

Prerequisites

Procedure

  1. Extract the .zip archive for the native Data Grid CLI distribution.

  2. Copy the native executable, or create a hard link, to a file named "kubectl-infinispan", for example: 

    cp redhat-datagrid-cli kubectl-infinispan
  3. Add kubectl-infinispan to your PATH.

  4. Verify that the CLI is installed. 

    oc plugin list

The following compatible plugins are available:
/path/to/kubectl-infinispan

  5. Use the infinispan --help command to view available commands. 

    oc infinispan --help

Additional resources

2.2. kubectl-infinispan command reference

This topic provides some details about the kubectl-infinispan plugin for clients.

Tip

Use the --help argument to view the complete list of available options and descriptions for each command.

For example, oc infinispan create cluster --help prints all command options for creating Data Grid clusters.

Command

Description

oc infinispan install

Creates Data Grid Operator subscriptions and installs into the global namespace by default.

oc infinispan create cluster

Creates Data Grid clusters.

oc infinispan get clusters

Displays running Data Grid clusters.

oc infinispan shell

Starts an interactive remote shell session on a Data Grid cluster.

oc infinispan delete cluster

Removes Data Grid clusters.

oc infinispan uninstall

Removes Data Grid Operator installations and all managed resources.