README.md

OpenEBSCTL

OpenEBSCTL is a kubectl plugin to manage OpenEBS storage components.

Project Status

Alpha. Under active development and seeking contributions from the community. The CLI currently supports managing LocalPV-LVM, LocalPV-ZFS and LocalPV-HostPath Engines.

Table of Contents

• Installation
• Build
• Code Walkthrough
• Usage
• Contributing

Installation

OpenEBSCTL is available on Linux, macOS and Windows platforms.

• (Recommended) The latest binary can be installed via krew

  $ kubectl krew install openebs
  ...
  ...
  $ kubectl krew list
  PLUGIN    VERSION
  openebs    v0.2.0
  ...
  ...
  # to update the openebs plugin
  $ kubectl krew upgrade openebs
  ...
  ...

• Binaries for Linux, Mac and Windows are available as tarballs and zip in the release page.

• Or, if you don't want to setup krew, you run the following to get latest version :-

  wget https://raw.githubusercontent.com/openebs/openebsctl/develop/scripts/install-latest.sh -O - | bash

Build

• Clone this repo to your system. git clone https://github.com/openebs/openebsctl
• cd openebsctl
• Run make openebsctl

Usage

• $ kubectl openebs
  kubectl openebs is a a kubectl plugin for interacting with OpenEBS storage components such as storage(zfspools, volumegroups), volumes, pvcs.
  Find out more about OpenEBS on https://openebs.io/
  
  Usage:
  openebs [command]
  
  Available Commands:
  cluster-info Show component version, status and running components for each installed engine
  completion   Outputs shell completion code for the specified shell (bash or zsh)
  describe     Provide detailed information about an OpenEBS resource
  get          Provides fetching operations related to a Volume/Storage
  help         Help about any command
  version      Shows openebs kubectl plugin's version
  
  Flags:
  -h, --help                help for openebs
  -c, --kubeconfig string   path to config file
  -v, --version             version for openebs
  
  Use "openebs [command] --help" for more information about a command.

• To know more about various engine specific commands check these:-

  • LocalPV-LVM
  • LocalPV-ZFS

Contributing

OpenEBS welcomes your feedback and contributions in any form possible.

• Join OpenEBS community on Kubernetes Slack
  • Already signed up? Head to our discussions at #openebs
• Want to raise an issue or help with fixes and features?
  • See open issues
  • See contributing guide
  • See Project Roadmap
  • Checkout our existing adopters and their feedbacks.
  • Want to join our contributor community meetings, check this out.
• Join our OpenEBS CNCF Mailing lists
  • For OpenEBS project updates, subscribe to OpenEBS Announcements
  • For interacting with other OpenEBS users, subscribe to OpenEBS Users

For more details checkout CONTRIBUTING.md.

License Compliance