{"id":13820194,"url":"https://github.com/openebs/openebsctl","last_synced_at":"2025-08-21T22:31:37.776Z","repository":{"id":41876820,"uuid":"274539236","full_name":"openebs/openebsctl","owner":"openebs","description":"`openebsctl` is a kubectl plugin to manage OpenEBS storage components.","archived":false,"fork":false,"pushed_at":"2024-11-08T05:18:57.000Z","size":68265,"stargazers_count":29,"open_issues_count":11,"forks_count":21,"subscribers_count":15,"default_branch":"develop","last_synced_at":"2024-11-24T20:42:01.608Z","etag":null,"topics":["cli-tool","hacktoberfest","kubectl","kubectl-plugin","kubernetes","openebs"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openebs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":"GOVERNANCE.md","roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-06-24T00:43:34.000Z","updated_at":"2024-11-10T12:21:44.000Z","dependencies_parsed_at":"2024-01-13T16:22:32.301Z","dependency_job_id":"b7bdbfc0-3bb7-4ad8-99fc-98e003addc0d","html_url":"https://github.com/openebs/openebsctl","commit_stats":null,"previous_names":["vaniisgh/mayactl"],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openebs%2Fopenebsctl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openebs%2Fopenebsctl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openebs%2Fopenebsctl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openebs%2Fopenebsctl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openebs","download_url":"https://codeload.github.com/openebs/openebsctl/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230537062,"owners_count":18241515,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli-tool","hacktoberfest","kubectl","kubectl-plugin","kubernetes","openebs"],"created_at":"2024-08-04T08:00:59.335Z","updated_at":"2025-08-21T22:31:37.765Z","avatar_url":"https://github.com/openebs.png","language":"Go","funding_links":[],"categories":["kubernetes"],"sub_categories":[],"readme":"\u003cimg width=\"300\" align=\"right\" alt=\"OpenEBS Logo\" src=\"https://raw.githubusercontent.com/cncf/artwork/master/projects/openebs/stacked/color/openebs-stacked-color.png\" xmlns=\"http://www.w3.org/1999/html\"\u003e\n\n# OpenEBSCTL\n\n[![Slack](https://img.shields.io/badge/chat-slack-ff1493.svg?style=flat-square)](https://kubernetes.slack.com/messages/openebs)\n[![Community Meetings](https://img.shields.io/badge/Community-Meetings-blue)](https://github.com/openebs/community/blob/HEAD/README.md#community)\n[![Go Report Card](https://goreportcard.com/badge/github.com/openebs/openebsctl?)](https://goreportcard.com/report/github.com/openebs/openebsctl)\n[![FOSSA Status](https://app.fossa.com/api/projects/custom%2B162%2Fgithub.com%2Fopenebs%2Fopenebsctl.svg?type=shield\u0026issueType=license)](https://app.fossa.com/projects/custom%2B162%2Fgithub.com%2Fopenebs%2Fopenebsctl?ref=badge_shield\u0026issueType=license)\n\n\nOpenEBSCTL is a kubectl plugin to manage OpenEBS storage components.\n\n\n## Project Status\n\n**Alpha**. Under active development and seeking [contributions from the community](#contributing).\nThe CLI currently supports managing `LocalPV-LVM`, `LocalPV-ZFS` and `LocalPV-HostPath` Engines.\n\n## Table of Contents\n* [Installation](#installation)\n* [Build](#build)\n* [Code Walkthrough](#code-walkthrough)\n* [Usage](#usage)\n* [Contributing](#contributing)\n\n## Installation\n\nOpenEBSCTL is available on Linux, macOS and Windows platforms.\n\n* (**Recommended**) The latest binary can be installed via `krew`\n  ```bash\n  $ kubectl krew install openebs\n  ...\n  ...\n  $ kubectl krew list\n  PLUGIN    VERSION\n  openebs    v0.2.0\n  ...\n  ...\n  # to update the openebs plugin\n  $ kubectl krew upgrade openebs\n  ...\n  ...\n  ```\n\n* Binaries for Linux, Mac and Windows are available as tarballs and zip in the [release](https://github.com/openebs/openebsctl/releases) page.\n* Or, if you don't want to setup krew, you run the following to get latest version :-\n   ```shell\n   wget https://raw.githubusercontent.com/openebs/openebsctl/develop/scripts/install-latest.sh -O - | bash\n   ```\n\n## Build\n\n- Clone this repo to your system. `git clone https://github.com/openebs/openebsctl`\n- `cd openebsctl`\n- Run `make openebsctl`\n\n## Usage\n\n* ```bash\n  $ kubectl openebs\n  kubectl openebs is a a kubectl plugin for interacting with OpenEBS storage components such as storage(zfspools, volumegroups), volumes, pvcs.\n  Find out more about OpenEBS on https://openebs.io/\n  \n  Usage:\n  openebs [command]\n  \n  Available Commands:\n  cluster-info Show component version, status and running components for each installed engine\n  completion   Outputs shell completion code for the specified shell (bash or zsh)\n  describe     Provide detailed information about an OpenEBS resource\n  get          Provides fetching operations related to a Volume/Storage\n  help         Help about any command\n  version      Shows openebs kubectl plugin's version\n  \n  Flags:\n  -h, --help                help for openebs\n  -c, --kubeconfig string   path to config file\n  -v, --version             version for openebs\n  \n  Use \"openebs [command] --help\" for more information about a command.\n  ```\n\n* To know more about various engine specific commands check these:-\n  * [LocalPV-LVM](docs/localpv-lvm/README.md)\n  * [LocalPV-ZFS](docs/localpv-zfs/README.md)\n  \n## Contributing\n\nOpenEBS welcomes your feedback and contributions in any form possible.\n\n- [Join OpenEBS community on Kubernetes Slack](https://kubernetes.slack.com)\n    - Already signed up? Head to our discussions at [#openebs](https://kubernetes.slack.com/messages/openebs/)\n- Want to raise an issue or help with fixes and features?\n    - See [open issues](https://github.com/openebs/openebs/issues)\n    - See [contributing guide](./CONTRIBUTING.md)\n    - See [Project Roadmap](https://github.com/openebs/openebsctl/projects/1)\n    - Checkout our existing [adopters](https://github.com/openebs/openebs/tree/master/adopters) and their [feedbacks](https://github.com/openebs/openebs/issues/2719).\n    - Want to join our contributor community meetings, [check this out](https://hackmd.io/mfG78r7MS86oMx8oyaV8Iw?view).\n- Join our OpenEBS CNCF Mailing lists\n    - For OpenEBS project updates, subscribe to [OpenEBS Announcements](https://lists.cncf.io/g/cncf-openebs-announcements)\n    - For interacting with other OpenEBS users, subscribe to [OpenEBS Users](https://lists.cncf.io/g/cncf-openebs-users)\n\n\nFor more details checkout [CONTRIBUTING.md](./CONTRIBUTING.md).\n\n\n\n## License Compliance\n[![FOSSA Status](https://app.fossa.com/api/projects/custom%2B162%2Fgithub.com%2Fopenebs%2Fopenebsctl.svg?type=large\u0026issueType=license)](https://app.fossa.com/projects/custom%2B162%2Fgithub.com%2Fopenebs%2Fopenebsctl?ref=badge_large\u0026issueType=license)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenebs%2Fopenebsctl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenebs%2Fopenebsctl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenebs%2Fopenebsctl/lists"}