DataCore Puls8 Kubectl Plugin

Explore this Page

• Overview
• Using the DataCore Puls8 Kubectl Plugin
• Command Usage
• License Management
• Backup and Restore
• Benefits of DataCore Puls8 Kubectl Plugin

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 available for Linux and can be manually installed by downloading the binary from the official release page. Download the latest version of the Puls8 plugin from the following location:

DataCore Puls8 Kubectl Plugin Releases on GitHub

After downloading, move the binary to a directory listed in your system’s $PATH.

To verify that the plugin has been installed correctly, run:

kubectl puls8 -V

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:

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:

Usage: kubectl-puls8 [OPTIONS] <COMMAND>

Available Commands

'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:

-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

• DataCore Puls8 License Activation
• Backup and Restore