Skip to content

Commit b964b30

Browse files
committed
docs: kubectl openebs plugin
Signed-off-by: Bala Harish <[email protected]>
1 parent 164e1fb commit b964b30

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

docs/main/user-guides/kubectl-openebs.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,24 @@ description: A comprehensive guide to the kubectl-openebs plugin, enabling unifi
1212

1313
## Overview
1414

15-
The Kubectl OpenEBS Plugin is an OSS plugin that allows you to interact with all OpenEBS storages through a unified interface. This is especially beneficial if you have installed a cluster using the OpenEBS umbrella chart. The supported storages include:
15+
The Kubectl OpenEBS Plugin is an OSS plugin that allows you to interact with all OpenEBS storages through a unified interface. This unified plugin is especially beneficial if you have installed a cluster using the OpenEBS umbrella chart. The supported storages include:
1616

1717
- Local PV HostPath
1818
- Local PV LVM
1919
- Local PV ZFS
2020
- Replicated PV Mayastor
2121

22-
This plugin integrates the current `kubectl-mayastor` codebase for Replicated PV Mayastor specific commands while introducing newly developed functionality for other storages, inspired by the existing `kubectl-openebs` plugin.
22+
This plugin integrates the current `kubectl-mayastor` functionality for Replicated PV Mayastor specific commands while introducing newly developed functionality for other storages, inspired by the existing `kubectl-openebs` plugin. The previous `kubectl-openebs` supported only Local PV storages whereas now it extends its capabilities to include Replicated PV Mayastor commands. Also, the plugin supports multiple output formats, such as YAML and JSON.
2323

24-
The previous `kubectl-openebs` supported only Local PV storages whereas now it extends its capabilities to include Replicated PV Mayastor commands. Also, the plugin supports multiple output formats, such as YAML and JSON.
24+
By using this plugin, you can gain a simplified and consistent interface to manage multiple storages, with improved output formats, flexible namespace configurations, and robust command options tailored to meet diverse storage needs.
2525

26-
## Namespace Assumption
26+
## Features
27+
28+
### Unified Plugin for All Storages
29+
30+
The plugin consolidates functionality for all OpenEBS storages under a single interface. You can manage Local PV Hostpath, Local PV LVM, Local PV ZFS, and Replicated PV Mayastor resources without switching between multiple tools or plugins.
31+
32+
### Namespace Assumption
2733

2834
The `kubectl-mayastor` plugin previously assumed the namespace to be `mayastor` if unspecified. Now, if the namespace is not explicitly defined, the plugin reads it from the kubeconfig context's namespace (It is set to `default` by default).
2935

@@ -45,6 +51,8 @@ kubectl config set-context --namespace=storage --current
4551

4652
## Command Overview
4753

54+
This section provides a detailed breakdown of the primary `kubectl-openebs` commands. This plugin serves as the central CLI for managing OpenEBS storage resources.
55+
4856
**Command**
4957

5058
```
@@ -75,7 +83,7 @@ Options:
7583

7684
### Local PV HostPath
7785

78-
Local PV Hostpath supports volume management commands.
86+
The Local PV Hostpath command supports resource retrieval for Hostpath storage volumes.
7987

8088
**Command**
8189

@@ -96,7 +104,7 @@ pvc-4b07a2a9-b7e9-4173-a094-14ab2ca7eb62 node-3 Ready 4.00 GiB
96104

97105
### Local PV LVM
98106

99-
Local PV LVM supports resource retrieval commands.
107+
The Local PV LVM command supports operations like retrieving information about volumes, volume groups, and node-specific resources.
100108

101109
**Command**
102110

@@ -117,7 +125,7 @@ pvc-c7688f88-a379-4e22-985c-02d1908e5c9a node-1 Ready 4.00 GiB
117125

118126
### Local PV ZFS
119127

120-
Local PV ZFS supports commands for managing volumes and pools.
128+
The Local PV ZFS command provides options for managing ZFS volumes and pools.
121129

122130
**Command**
123131

@@ -138,7 +146,7 @@ pvc-4b07a2a9-b7e9-4173-a094-14ab2ca7eb62 node-2 Ready 4.00 GiB
138146

139147
### Replicated PV Mayastor
140148

141-
Replicated PV Mayastor commands support operations like resource management, scaling, and upgrading.
149+
The Replicated PV Mayastor command enables you to perform advanced operations on Replicated PV Mayastor resources, such as scaling, resource management, and upgrades.
142150

143151
**Command**
144152

0 commit comments

Comments
 (0)