DataCore Puls8 Kubectl Plugin

Explore this Page

Overview

The DataCore Puls8 Kubectl Plugin provides a unified command-line interface that simplifies the management of OpenEBS storages and DataCore Puls8 specific operations in Kubernetes environments. Designed for users who have deployed their clusters using the DataCore Puls8 Helm chart, the plugin enables seamless interaction with various components Replicated PV Mayastor, Local PV Hostpath, Local PV LVM, and Local PV ZFS as well as DataCore Puls8 specific functionalities such as backup and restore (via Velero) and license management.

This plugin builds upon the existing kubectl openebs command set and streamlines operations by consolidating them under a single, user-friendly interface: kubectl puls8. It enhances operational efficiency by allowing you to manage all key storage and enterprise licensing tasks from a centralized CLI.

Installing the DataCore Puls8 Kubectl Plugin

The DataCore Puls8 kubectl plugin is distributed as a compressed tarball (.tar.gz) for Linux platforms. This plugin is available exclusively through the private DataCore Downloads Portal.

Access to the DataCore Downloads Portal requires valid credentials. Contact your DataCore representative to obtain download access.

Download Instructions

Download the plugin tarball appropriate for your operating system and CPU architecture. For example:

  • kubectl-puls8-x86_64-apple-darwin.tar.gz - For MacOS on Intel
  • kubectl-puls8-aarch64-apple-darwin.tar.gz - For MacOS on ARM
  • kubectl-puls8-aarch64-linux-musl.tar.gz - For Linux on ARM
  • kubectl-puls8-x86_64-linux-musl.tar.gz - For Linux on x86_x64
  • kubectl-puls8-x86_64-windows-gnu.tar.gz - For Windows on x86_64

Ensure you select the correct version to avoid compatibility issues during execution.

Installation Steps

  1. Extract the downloaded tarball:
    Copy
    Extract Plugin Tarball
    tar -xvzf kubectl-puls8-x86_64-linux-musl.tar.gz -C
  2. Move the extracted binary to a directory included in your system’s $PATH. For example: sudo mv kubectl-puls8 /usr/local/bin/.
  3. Verify the installation by running:
    Copy
    Verify the Installation
    kubectl puls8 -V
    Copy
    Sample Output
    Kubectl Plugin (kubectl-puls8) revision <> (v4.3.0+0)

Using the DataCore Puls8 Kubectl Plugin

Run the following command to access the DataCore Puls8 CLI help menu and explore available subcommands:

Copy
Display Help Menu and Available DataCore Puls8 Plugin Commands
kubectl puls8 --help

Command Usage

The DataCore Puls8 Kubectl Plugin extends the kubectl command-line tool with a set of subcommands that simplify managing OpenEBS storages and DataCore Puls8 specific features. The general syntax for using the plugin is shown below, followed by a list of supported commands:

Copy
General Syntax for Executing DataCore Puls8 Plugin Commands
Usage: kubectl-puls8 [OPTIONS] <COMMAND>

Available Commands

Copy
List of Commands Supported by the DataCore Puls8 Plugin
'mayastor'          Mayastor operations
'localpv-lvm'       LocalPV LVM operations
'localpv-zfs'       LocalPV ZFS operations
'localpv-hostpath'  LocalPV Hostpath operations
'velero'            Velero backup and recovery operations
'license'           License related operations
'help'              Print this message or the help of the given subcommand(s)

Options

The plugin supports the following options to customize command execution:

Copy
Command Line Options Supported by the DataCore Puls8 Plugin
-n, --namespace <NAMESPACE>           
    Namespace where Puls8 is installed. Defaults to the current context's namespace.

-k, --kube-config-path <KUBE_CONFIG_PATH>   
    Specify a custom kubeconfig file path.

    --agent-uri <AGENT_URI>           
    Override the default license agent endpoint URI.

-h, --help                            
    Display help information.

-V, --version                         
    Display the plugin version.

License Management

The license subcommand allows you to manage enterprise licensing in DataCore Puls8 environments, including activation and configuration. Refer to the DataCore Puls8 License Activation Documentation for more information.

Backup and Restore

The velero subcommand enables you to perform backup and restore operations in DataCore Puls8 managed environments using Velero. Refer to the Backup and Restore Documentation for more information.

Benefits of DataCore Puls8 Kubectl Plugin

  • Centralized Management: Manage all OpenEBS storages and DataCore Puls8 specific components through a single plugin.
  • Streamlined CLI Experience: Simplifies operations by internally invoking kubectl openebs commands.
  • Flexible Configuration: Customize execution with namespace targeting, kubeconfig paths, and license agent overrides.

Learn More