Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/openebs/openebsctl

`openebsctl` is a kubectl plugin to manage OpenEBS storage components.
https://github.com/openebs/openebsctl

cli-tool hacktoberfest kubectl kubectl-plugin kubernetes openebs

Last synced: 5 days ago
JSON representation

`openebsctl` is a kubectl plugin to manage OpenEBS storage components.

Host: GitHub
URL: https://github.com/openebs/openebsctl
Owner: openebs
License: apache-2.0
Created: 2020-06-24T00:43:34.000Z (over 4 years ago)
Default Branch: develop
Last Pushed: 2024-11-08T05:18:57.000Z (6 days ago)
Last Synced: 2024-11-08T06:23:21.177Z (6 days ago)
Topics: cli-tool, hacktoberfest, kubectl, kubectl-plugin, kubernetes, openebs
Language: Go
Homepage:
Size: 65.1 MB
Stars: 28
Watchers: 15
Forks: 21
Open Issues: 11
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Governance: GOVERNANCE.md

Awesome Lists containing this project

README

        

# OpenEBSCTL

[![Slack](https://img.shields.io/badge/chat-slack-ff1493.svg?style=flat-square)](https://kubernetes.slack.com/messages/openebs)

[![Community Meetings](https://img.shields.io/badge/Community-Meetings-blue)](https://us05web.zoom.us/j/87535654586?pwd=CigbXigJPn38USc6Vuzt7qSVFoO79X.1)

[![Go Report Card](https://goreportcard.com/badge/github.com/openebs/openebsctl?)](https://goreportcard.com/report/github.com/openebs/openebsctl)

[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/4852/badge)](https://www.bestpractices.dev/projects/4852)

[![FOSSA Status](https://app.fossa.com/api/projects/custom%2B162%2Fgithub.com%2Fopenebs%2Fopenebsctl.svg?type=shield&issueType=license)](https://app.fossa.com/projects/custom%2B162%2Fgithub.com%2Fopenebs%2Fopenebsctl?ref=badge_shield&issueType=license)

OpenEBSCTL is a kubectl plugin to manage OpenEBS storage components.

## Project Status

**Alpha**. Under active development and seeking [contributions from the community](#contributing).

The CLI currently supports managing `LocalPV-LVM`, `LocalPV-ZFS` and `LocalPV-HostPath` Engines.

## Table of Contents

* [Installation](#installation)

* [Build](#build)

* [Code Walkthrough](#code-walkthrough)

* [Usage](#usage)

* [Contributing](#contributing)

## Installation

OpenEBSCTL is available on Linux, macOS and Windows platforms.

* (**Recommended**) The latest binary can be installed via `krew`

  ```bash

  $ 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](https://github.com/openebs/openebsctl/releases) page.

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

   ```shell

   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

* ```bash

  $ 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](docs/localpv-lvm/README.md)

  * [LocalPV-ZFS](docs/localpv-zfs/README.md)

  

## Contributing

OpenEBS welcomes your feedback and contributions in any form possible.

- [Join OpenEBS community on Kubernetes Slack](https://kubernetes.slack.com)

    - Already signed up? Head to our discussions at [#openebs](https://kubernetes.slack.com/messages/openebs/)

- Want to raise an issue or help with fixes and features?

    - See [open issues](https://github.com/openebs/openebs/issues)

    - See [contributing guide](./CONTRIBUTING.md)

    - See [Project Roadmap](https://github.com/openebs/openebsctl/projects/1)

    - Checkout our existing [adopters](https://github.com/openebs/openebs/tree/master/adopters) and their [feedbacks](https://github.com/openebs/openebs/issues/2719).

    - Want to join our contributor community meetings, [check this out](https://hackmd.io/mfG78r7MS86oMx8oyaV8Iw?view).

- Join our OpenEBS CNCF Mailing lists

    - For OpenEBS project updates, subscribe to [OpenEBS Announcements](https://lists.cncf.io/g/cncf-openebs-announcements)

    - For interacting with other OpenEBS users, subscribe to [OpenEBS Users](https://lists.cncf.io/g/cncf-openebs-users)

For more details checkout [CONTRIBUTING.md](./CONTRIBUTING.md).

## License Compliance

[![FOSSA Status](https://app.fossa.com/api/projects/custom%2B162%2Fgithub.com%2Fopenebs%2Fopenebsctl.svg?type=large&issueType=license)](https://app.fossa.com/projects/custom%2B162%2Fgithub.com%2Fopenebs%2Fopenebsctl?ref=badge_large&issueType=license)