OpenEBS

https://openebs.io/docs
Admin
OpenEBS is a container-native storage solution that transforms Kubernetes worker node storage into...
Tokens:745,395
Snippets:9,586
Trust Score:8.8
Update:4 months ago
Show doc for...
Tokens:
Raw
### Example Helm Install Command for NFS Provisioner

Source: https://openebs.io/docs/3.0.x/concepts/rwm

An example of a complete Helm install command for the NFS server provisioner, demonstrating specific values for namespace, release name, storage class, size, and NFS StorageClass name.

```bash
helm install stable/nfs-server-provisioner --namespace=nfs-wp-provisioner --name=openebs-nfs-wordpress --set=persistence.enabled=true,persistence.storageClass=openebs-cstor-disk,persistence.size=5Gi,storageClass.name=wordpress-nfs-sc1,storageClass.provisionerName=openebs.io/nfs
```

--------------------------------

### Blockdevice Table Example

Source: https://openebs.io/docs/3.7.x/troubleshooting/ndm

Example output of `kubectl get bd -n openebs` showing block devices and their partitions, filesystems, and mountpoints.

```text
NAME   FSTYPE MOUNTPOINT   SIZE  

sda                        1.8T  
├─sda1                     500G  
├─sda2                     500G  
├─sda3                     500G  
└─sda4 ext4   /kubernetes  363G  
sdb                       55.9G  
├─sdb1 vfat   /boot/efi    512M  
└─sdb2 ext4   /           55.4G  
```

--------------------------------

### Example Blockdevice Output

Source: https://openebs.io/docs/3.0.x/troubleshooting/ndm

This is an example output from `kubectl get bd -n openebs` showing blockdevices and their partitions, some of which may be mounted.

```yaml
NAME   FSTYPE MOUNTPOINT   SIZE  

sda                        1.8T  

├─sda1                     500G  

├─sda2                     500G  

├─sda3                     500G  

└─sda4 ext4   /kubernetes  363G  

sdb                       55.9G  

├─sdb1 vfat   /boot/efi    512M  

└─sdb2 ext4   /           55.4G  
```

--------------------------------

### Install Velero with Cloud Storage Configuration

Source: https://openebs.io/docs/4.2.x/user-guides/local-storage-user-guide/local-pv-zfs/advanced-operations/zfs-backup-restore

Example command for installing Velero with generic cloud storage (like AWS S3) for backups.

```bash
velero install --provider aws --bucket <bucket_name> --secret-file <./aws-iam-creds> --plugins velero/velero-plugin-for-aws:v1.0.0-beta.1 --backup-location-config region=<bucket_region>,s3ForcePathStyle="true" --use-volume-snapshots=true --use-node-agent --uploader-type restic  
```

--------------------------------

### Apply Local Device PVC and Pod Manifests

Source: https://openebs.io/docs/3.8.x/user-guides/localpv-device

Apply the example PVC and pod manifests to create an OpenEBS Local PV Device volume and a pod that uses it. Ensure OpenEBS is already installed.

```bash
kubectl apply -f https://openebs.github.io/charts/examples/local-device/local-device-pvc.yaml  

kubectl apply -f https://openebs.github.io/charts/examples/local-device/local-device-pod.yaml  
```

--------------------------------

### Apply Local PV Hostpath PVC and Pod

Source: https://openebs.io/docs/3.0.x/user-guides/localpv-hostpath

Apply the example PVC and Pod configurations to create an OpenEBS Local PV Hostpath volume and a pod that uses it. Ensure OpenEBS is already installed.

```bash
kubectl apply -f https://openebs.github.io/charts/examples/local-hostpath/local-hostpath-pvc.yaml  

kubectl apply -f https://openebs.github.io/charts/examples/local-hostpath/local-hostpath-pod.yaml  
```

--------------------------------

### Verify Default Storage Classes

Source: https://openebs.io/docs/4.0.x/quickstart-guide/installation

This is an example of the expected output when listing StorageClasses after a successful OpenEBS installation. It shows the default StorageClasses provided by OpenEBS, including local and CSI-based options.

```text
NAME                       PROVISIONER               RECLAIMPOLICY   VOLUMEBINDINGMODE    ALLOWVOLUMEEXPANSION   
mayastor-etcd-localpv      openebs.io/local          Delete          WaitForFirstConsumer false  
mayastor-loki-localpv      openebs.io/local          Delete          WaitForFirstConsumer false  
openebs-hostpath           openebs.io/local          Delete          WaitForFirstConsumer false  
openebs-single-replica     io.openebs.csi-mayastor   Delete          Immediate            true  
```

--------------------------------

### Velero Installation Output

Source: https://openebs.io/docs/user-guides/data-migration/migration-using-velero/migration-for-replicated-db/replicateddb-restore

Observe the output of the Velero installation process, which includes resource creation and confirmation of successful installation.

```bash
CustomResourceDefinition/backuprepositories.velero.io: attempting to create resource  

CustomResourceDefinition/backuprepositories.velero.io: attempting to create resource client  

CustomResourceDefinition/backuprepositories.velero.io: created  

CustomResourceDefinition/backups.velero.io: attempting to create resource  

CustomResourceDefinition/backups.velero.io: attempting to create resource client  

CustomResourceDefinition/backups.velero.io: created  

CustomResourceDefinition/backupstoragelocations.velero.io: attempting to create resource  

CustomResourceDefinition/backupstoragelocations.velero.io: attempting to create resource client  

CustomResourceDefinition/backupstoragelocations.velero.io: created  

CustomResourceDefinition/deletebackuprequests.velero.io: attempting to create resource  

CustomResourceDefinition/deletebackuprequests.velero.io: attempting to create resource client  

CustomResourceDefinition/deletebackuprequests.velero.io: created  

CustomResourceDefinition/downloadrequests.velero.io: attempting to create resource  

CustomResourceDefinition/downloadrequests.velero.io: attempting to create resource client  

CustomResourceDefinition/downloadrequests.velero.io: created  

CustomResourceDefinition/podvolumebackups.velero.io: attempting to create resource  

CustomResourceDefinition/podvolumebackups.velero.io: attempting to create resource client  

CustomResourceDefinition/podvolumebackups.velero.io: created  

CustomResourceDefinition/podvolumerestores.velero.io: attempting to create resource  

CustomResourceDefinition/podvolumerestores.velero.io: attempting to create resource client  

CustomResourceDefinition/podvolumerestores.velero.io: created  

CustomResourceDefinition/restores.velero.io: attempting to create resource  

CustomResourceDefinition/restores.velero.io: attempting to create resource client  

CustomResourceDefinition/restores.velero.io: created  

CustomResourceDefinition/schedules.velero.io: attempting to create resource  

CustomResourceDefinition/schedules.velero.io: attempting to create resource client  

CustomResourceDefinition/schedules.velero.io: created  

CustomResourceDefinition/serverstatusrequests.velero.io: attempting to create resource  

CustomResourceDefinition/serverstatusrequests.velero.io: attempting to create resource client  

CustomResourceDefinition/serverstatusrequests.velero.io: created  

CustomResourceDefinition/volumesnapshotlocations.velero.io: attempting to create resource  

CustomResourceDefinition/volumesnapshotlocations.velero.io: attempting to create resource client  

CustomResourceDefinition/volumesnapshotlocations.velero.io: created  

Waiting for resources to be ready in cluster...  

Namespace/velero: attempting to create resource  

Namespace/velero: attempting to create resource client  

Namespace/velero: created  

ClusterRoleBinding/velero: attempting to create resource  

ClusterRoleBinding/velero: attempting to create resource client  

ClusterRoleBinding/velero: created  

ServiceAccount/velero: attempting to create resource  

ServiceAccount/velero: attempting to create resource client  

ServiceAccount/velero: created  

Secret/cloud-credentials: attempting to create resource  

Secret/cloud-credentials: attempting to create resource client  

Secret/cloud-credentials: created  

BackupStorageLocation/default: attempting to create resource  

BackupStorageLocation/default: attempting to create resource client  

BackupStorageLocation/default: created  

VolumeSnapshotLocation/default: attempting to create resource  

VolumeSnapshotLocation/default: attempting to create resource client  

VolumeSnapshotLocation/default: created  

Deployment/velero: attempting to create resource  

Deployment/velero: attempting to create resource client  

Deployment/velero: created  

DaemonSet/node-agent: attempting to create resource  

DaemonSet/node-agent: attempting to create resource client  

DaemonSet/node-agent: created  

Velero is installed! ⛵ Use 'kubectl logs deployment/velero -n velero' to view the status.  

thulasiraman_ilangovan@cloudshell:~$   
```

--------------------------------

### Create Database and Insert Sample Data

Source: https://openebs.io/docs/Solutioning/backup-and-restore/cloudnative-backup

SQL commands to create a new database named 'demo', define a table 'my_table', and populate it with 100 records.

```sql
CREATE DATABASE demo;
\c demo;

CREATE TABLE my_table (
  id SERIAL PRIMARY KEY,
  name VARCHAR(255),
  value INTEGER,
  created_at TIMESTAMP DEFAULT NOW()
);

INSERT INTO my_table (name, value)
SELECT
  'Record ' || generate_series(1, 100),
  (random() * 1000)::INTEGER;

SELECT COUNT(*) FROM my_table;
```

--------------------------------

### Example Output of OpenEBS StorageClasses

Source: https://openebs.io/docs/4.3.x/quickstart-guide/installation

This output displays the default StorageClasses created by OpenEBS during installation. Verify that these, or similar entries, are present to confirm a successful setup.

```text
NAME                       PROVISIONER               RECLAIMPOLICY   VOLUMEBINDINGMODE    ALLOWVOLUMEEXPANSION   

mayastor-etcd-localpv      openebs.io/local          Delete          WaitForFirstConsumer false  
mayastor-loki-localpv      openebs.io/local          Delete          WaitForFirstConsumer false  
openebs-hostpath           openebs.io/local          Delete          WaitForFirstConsumer false  
openebs-single-replica     io.openebs.csi-mayastor   Delete          Immediate            true  
```

--------------------------------

### Example Pod Status with ContainerCreating

Source: https://openebs.io/docs/3.10.x/troubleshooting/volume-provisioning

This output from `kubectl get pods` shows an application pod in the 'ContainerCreating' state while OpenEBS Jiva volume provisioners are running. This indicates an issue with the application pod's ability to start.

```text
NAME                                                             READY     STATUS              RESTARTS   AGE  

nginx-deployment-57849d9f57-12345                                0/1       ContainerCreating   0          2m  
pvc-adb79406-8e3e-11e8-a06a-001c42c2325f-ctrl-58dcdf997f-n4kd9   2/2       Running             0          8m  
pvc-adb79406-8e3e-11e8-a06a-001c42c2325f-rep-696b599894-gq4z6    1/1       Running             0          8m  
pvc-adb79406-8e3e-11e8-a06a-001c42c2325f-rep-696b599894-hwx52    1/1       Running             0          8m  
pvc-adb79406-8e3e-11e8-a06a-001c42c2325f-rep-696b599894-vs97n    1/1       Running             0          8m  

```

--------------------------------

### Example Kubernetes Context Configuration

Source: https://openebs.io/docs/3.0.x/user-guides/installation

An example of how to set a specific Kubernetes context, linking a cluster and user for administrative access.

```bash
kubectl config set-context admin-ctx --cluster=gke_strong-eon-153112_us-central1-a_rocket-test2 --user=cluster-admin
```

--------------------------------

### Helm Installation Error on Azure AKS

Source: https://openebs.io/docs/3.10.x/troubleshooting/install

This is an example of a Helm installation error on Azure AKS related to RBAC authorization. It indicates that the installer is attempting to grant extra privileges that are not allowed.

```bash
Error: release openebs failed: clusterroles.rbac.authorization.k8s.io "openebs" isforbidden: attempt to grant extra privileges:[PolicyRule{Resources:["nodes"], APIGroups:["*"],Verbs:["get"]} PolicyRule{Resources:["nodes"],APIGroups:["*"], Verbs:["list"]}PolicyRule{Resources:["nodes"], APIGroups:["*"],Verbs:["watch"]} PolicyRule{Resources:["nodes/proxy"],APIGroups:["*"], Verbs:["get"]}PolicyRule{Resources:["nodes/proxy"], APIGroups:["*"],Verbs:["list"]} PolicyRule{Resources:["nodes/proxy"],APIGroups:["*"], Verbs:["watch"]}PolicyRule{Resources:["namespaces"], APIGroups:["*"],Verbs:["*"]} PolicyRule{Resources:["services"],APIGroups:["*"], Verbs:["*"]."pods"],APIGroups:["*"], Verbs:["*"]."deployments"],APIGroups:["*"], Verbs:["*"]."events"],APIGroups:["*"], Verbs:["*"]."endpoints"],APIGroups:["*"], Verbs:["*"]."persistentvolumes"],APIGroups:["*"], Verbs:["*"]."persistentvolumeclaims"],APIGroups:["*"], Verbs:["*"]."storageclasses"],APIGroups:["storage.k8s.io"], Verbs:["*"]."storagepools"], APIGroups:["*"],Verbs:["get"]."storagepools"], APIGroups:["*"],Verbs:["list"] NonResourceURLs:["/metrics"],Verbs:["get"]}] user=&{system:serviceaccount:kube-system:tiller6f3172cc-4a08-11e8-9af5-0a58ac1f1729 [system:serviceaccounts system:serviceaccounts:kube-systemsystem:authenticated] map[]} ownerrules=[]ruleResolutionErrors=[clusterroles.rbac.authorization.k8s.io"cluster-admin" not found]
```

--------------------------------

### Example dmsetup Output

Source: https://openebs.io/docs/3.3.x/troubleshooting/volume-provisioning

This output shows LVM handlers present on devices. If your output is similar, you need to remove these handlers.

```text
Name             Maj Min Stat Open Targ Event  UUID

usr              254   0 L--r    1    1      0 CRYPT-VERITY-959135d6b3894b3b8125503de238d5c4-usr

centos-home      254   2 L--w    0    1      0 LVM-1kqWMeQWqH3qTsiHhYw3ygAzOvpfDL58dDmziWBI0panwOGRq2rp9PjpmE6qdf1V

centos-swap      254   1 L--w    0    1      0 LVM-1kqWMeQWqH3qTsiHhYw3ygAzOvpfDL58UIVFhLkzvE1mk7uCy2nePlktBHfTuTYF

centos-root      254   3 L--w    0    1      0 LVM-1kqWMeQWqH3qTsiHhYw3ygAzOvpfDL58WULaIYm0X7QmrwQaWYxz1hTwzWocAwYJ
```

--------------------------------

### GDB Session Start Example

Source: https://openebs.io/docs/4.1.x/troubleshootingre

This is an example of the initial output when opening a coredump in GDB. It shows GDB version information and the program that was terminated.

```text
GNU gdb (Ubuntu 9.2-0ubuntu1~20.04) 9.2  
Copyright (C) 2020 Free Software Foundation, Inc.  
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>  
This is free software: you are free to change and redistribute it.  
There is NO WARRANTY, to the extent permitted by law.  
Type "show copying" and "show warranty" for details.  
This GDB was configured as "x86_64-linux-gnu".  
Type "show configuration" for configuration details.  
For bug reporting instructions, please see:  
<http://www.gnu.org/software/gdb/bugs/>.  
Find the GDB manual and other documentation resources online at:  
    <http://www.gnu.org/software/gdb/documentation/>.  
  
For help, type "help".  
Type "apropos word" to search for commands related to "word"...  
[New LWP 13]  
[New LWP 17]  
[New LWP 14]  
[New LWP 16]  
[New LWP 18]  
Core was generated by `/bin/mayastor -l0 -nnats'.  
Program terminated with signal SIGABRT, Aborted.  
#0  0x00007ffdad99fb37 in clock_gettime ()  
[Current thread is 1 (LWP 13)]  
```

--------------------------------

### Example dmsetup Output

Source: https://openebs.io/docs/3.10.x/troubleshooting/volume-provisioning

This output indicates the presence of LVM handlers for 'centos-home', 'centos-swap', and 'centos-root'. These need to be removed.

```text
Name             Maj Min Stat Open Targ Event  UUID  

usr              254   0 L--r    1    1      0 CRYPT-VERITY-959135d6b3894b3b8125503de238d5c4-usr  

centos-home      254   2 L--w    0    1      0 LVM-1kqWMeQWqH3qTsiHhYw3ygAzOvpfDL58dDmziWBI0panwOGRq2rp9PjpmE6qdf1V  

centos-swap      254   1 L--w    0    1      0 LVM-1kqWMeQWqH3qTsiHhYw3ygAzOvpfDL58UIVFhLkzvE1mk7uCy2nePlktBHfTuTYF  

centos-root      254   3 L--w    0    1      0 LVM-1kqWMeQWqH3qTsiHhYw3ygAzOvpfDL58WULaIYm0X7QmrwQaWYxz1hTwzWocAwYJ  

```

--------------------------------

### Azure AKS RBAC Error Example

Source: https://openebs.io/docs/3.2.x/troubleshooting/install

This is an example of an error encountered on Azure AKS during OpenEBS Helm installation, indicating a potential RBAC misconfiguration.

```text
Error: release openebs failed: clusterroles.rbac.authorization.k8s.io "openebs" isforbidden: attempt to grant extra privileges:[PolicyRule{Resources:["nodes"], APIGroups:["*"],Verbs:["get"]} PolicyRule{Resources:["nodes"],APIGroups:["*"], Verbs:["list"]}PolicyRule{Resources:["nodes"], APIGroups:["*"],Verbs:["watch"]} PolicyRule{Resources:["nodes/proxy"],APIGroups:["*"], Verbs:["get"]}PolicyRule{Resources:["nodes/proxy"], APIGroups:["*"],Verbs:["list"]} PolicyRule{Resources:["nodes/proxy"],APIGroups:["*"], Verbs:["watch"]}PolicyRule{Resources:["namespaces"], APIGroups:["*"],Verbs:["*"]} PolicyRule{Resources:["services"],APIGroups:["*"], Verbs:["*"]} PolicyRule{Resources:["pods"],APIGroups:["*"], Verbs:["*"ПолисиRule{Resources:["deployments"], APIGroups:["*"],Verbs:["*"}PolicyRule{Resources:["events"], APIGroups:["*"],Verbs:["*"}PolicyRule{Resources:["endpoints"], APIGroups:["*"],Verbs:["*"}PolicyRule{Resources:["persistentvolumes"],APIGroups:["*"], Verbs:["*"}PolicyRule{Resources:["persistentvolumeclaims"],APIGroups:["*"], Verbs:["*"ПолисиRule{Resources:["storageclasses"], APIGroups:["storage.k8s.io"], Verbs:["*"}PolicyRule{Resources:["storagepools"], APIGroups:["*"],Verbs:["get"]} PolicyRule{Resources:["storagepools"], APIGroups:["*"],Verbs:["list"]}PolicyRule{NonResourceURLs:["/metrics"],Verbs:["get"]}] user=&{system:serviceaccount:kube-system:tiller6f3172cc-4a08-11e8-9af5-0a58ac1f1729 [system:serviceaccounts system:serviceaccounts:kube-systemsystem:authenticated] map[]} ownerrules=[]ruleResolutionErrors=[clusterroles.rbac.authorization.k8s.io"cluster-admin" not found]
```

--------------------------------

### Velero Credentials File Example

Source: https://openebs.io/docs/4.4.x/user-guides/local-storage-user-guide/local-pv-zfs/advanced-operations/zfs-backup-restore

Example of a credentials file for Velero, used to authenticate with object storage like MinIO.

```bash
cat /home/pawan/velero/credentials-minio  

[default]  

aws_access_key_id = minio  

aws_secret_access_key = minio123  


```

--------------------------------

### Access and Verify Sample Data

Source: https://openebs.io/docs/4.1.x/Solutioning/backup-and-restore/kastenbrfs

This sequence of commands demonstrates how to execute a command within a restored Pod to access its volume and verify sample data.

```bash
root@master-restore:~# kubectl exec -it test-cd9847c9c-s922r -n test -- bash
root@test-cd9847c9c-s922r:/# cd volume/ 
root@test-cd9847c9c-s922r:/volume# cat abc  
Mayastor Kasten backup and restore  
root@test-cd9847c9c-s922r:/volume# exit  
exit  
root@master-restore:~#
```

--------------------------------

### Helm Installation Error on AKS

Source: https://openebs.io/docs/3.4.x/troubleshooting/install

Example of a Helm installation error on AKS related to RBAC authorization, indicating a failure to grant necessary privileges.

```text
Error: release openebs failed: clusterroles.rbac.authorization.k8s.io "openebs" isforbidden: attempt to grant extra privileges:[PolicyRule{Resources:["nodes"], APIGroups:["*"],Verbs:["get"]} PolicyRule{Resources:["nodes"],APIGroups:["*"], Verbs:["list"]}PolicyRule{Resources:["nodes"], APIGroups:["*"],Verbs:["watch"]} PolicyRule{Resources:["nodes/proxy"],APIGroups:["*"], Verbs:["get"]}PolicyRule{Resources:["nodes/proxy"], APIGroups:["*"],Verbs:["list"]} PolicyRule{Resources:["nodes/proxy"],APIGroups:["*"], Verbs:["watch"]}PolicyRule{Resources:["namespaces"], APIGroups:["*"],Verbs:["*"]} PolicyRule{Resources:["services"],APIGroups:["*"], Verbs:["*"]} PolicyRule{Resources:["pods"],APIGroups:["*"], Verbs:["*"ПолисиRule{Resources:["deployments"], APIGroups:["*"],Verbs:["*"}PolicyRule{Resources:["events"],APIGroups:["*"], Verbs:["*"}PolicyRule{Resources:["endpoints"], APIGroups:["*"],Verbs:["*"}PolicyRule{Resources:["persistentvolumes"],APIGroups:["*"], Verbs:["*"}PolicyRule{Resources:["persistentvolumeclaims"],APIGroups:["*"], Verbs:["*"}PolicyRule{Resources:["storageclasses"],APIGroups:["storage.k8s.io"], Verbs:["*"}PolicyRule{Resources:["storagepools"], APIGroups:["*"],Verbs:["get"]} PolicyRule{Resources:["storagepools"], APIGroups:["*"],Verbs:["list"]}PolicyRule{NonResourceURLs:["/metrics"],Verbs:["get"]}] user=&{system:serviceaccount:kube-system:tiller6f3172cc-4a08-11e8-9af5-0a58ac1f1729 [system:serviceaccounts system:serviceaccounts:kube-systemsystem:authenticated] map[]} ownerrules=[]ruleResolutionErrors=[clusterroles.rbac.authorization.k8s.io"cluster-admin" not found]
```

--------------------------------

### AKS RBAC Error during OpenEBS Helm Install

Source: https://openebs.io/docs/3.3.x/troubleshooting/install

This is an example of an error message encountered when installing OpenEBS on AKS via Helm, indicating RBAC permission issues.

```text
Error: release openebs failed: clusterroles.rbac.authorization.k8s.io "openebs" isforbidden: attempt to grant extra privileges:[PolicyRule{Resources:["nodes"], APIGroups:["*"],Verbs:["get"]} PolicyRule{Resources:["nodes"],APIGroups:["*"], Verbs:["list"]}PolicyRule{Resources:["nodes"], APIGroups:["*"],Verbs:["watch"]} PolicyRule{Resources:["nodes/proxy"],APIGroups:["*"], Verbs:["get"]}PolicyRule{Resources:["nodes/proxy"],APIGroups:["*"], Verbs:["list"]} PolicyRule{Resources:["nodes/proxy"],APIGroups:["*"], Verbs:["watch"]}PolicyRule{Resources:["namespaces"], APIGroups:["*"],Verbs:["*"]} PolicyRule{Resources:["services"],APIGroups:["*"], Verbs:["*"].}PolicyRule{Resources:["pods"],APIGroups:["*"], Verbs:["*"]}.}PolicyRule{Resources:["deployments"], APIGroups:["*"],Verbs:["*"].}PolicyRule{Resources:["events"],APIGroups:["*"], Verbs:["*"].}PolicyRule{Resources:["endpoints"], APIGroups:["*"],Verbs:["*"].} PolicyRule{Resources:["persistentvolumes"],APIGroups:["*"], Verbs:["*"].} PolicyRule{Resources:["persistentvolumeclaims"],APIGroups:["*"], Verbs:["*"].}PolicyRule{Resources:["storageclasses"], APIGroups:["storage.k8s.io"], Verbs:["*"].}PolicyRule{Resources:["storagepools"], APIGroups:["*"],Verbs:["get"]}. PolicyRule{Resources:["storagepools"], APIGroups:["*"],Verbs:["list"]}. PolicyRule{NonResourceURLs:["/metrics"],Verbs:["get"]}] user=&{system:serviceaccount:kube-system:tiller6f3172cc-4a08-11e8-9af5-0a58ac1f1729 [system:serviceaccounts system:serviceaccounts:kube-systemsystem:authenticated] map[]} ownerrules=[]ruleResolutionErrors=[clusterroles.rbac.authorization.k8s.io"cluster-admin" not found]  
```

--------------------------------

### Velero Credentials File Example

Source: https://openebs.io/docs/4.0.x/user-guides/local-storage-user-guide/local-pv-zfs/advanced-operations/zfs-backup-restore

Example of a credentials file for Velero, specifying AWS access key ID and secret access key for MinIO.

```bash
$ cat /home/pawan/velero/credentials-minio

[default]

aws_access_key_id = minio

aws_secret_access_key = minio123


```

--------------------------------

### Helm Installation Error on AKS

Source: https://openebs.io/docs/3.1.x/troubleshooting/install

This is an example of a Helm installation error on AKS related to RBAC authorization. It indicates that the tiller user is attempting to grant extra privileges that are not allowed.

```text
Error: release openebs failed: clusterroles.rbac.authorization.k8s.io "openebs" isforbidden: attempt to grant extra privileges:[PolicyRule{Resources:["nodes"], APIGroups:["*"],Verbs:["get"]} PolicyRule{Resources:["nodes"],APIGroups:["*"], Verbs:["list"]}PolicyRule{Resources:["nodes"], APIGroups:["*"],Verbs:["watch"]} PolicyRule{Resources:["nodes/proxy"],APIGroups:["*"], Verbs:["get"]}PolicyRule{Resources:["nodes/proxy"], APIGroups:["*"],Verbs:["list"]} PolicyRule{Resources:["nodes/proxy"],APIGroups:["*"], Verbs:["watch"]}PolicyRule{Resources:["namespaces"], APIGroups:["*"],Verbs:["*"]} PolicyRule{Resources:["services"],APIGroups:["*"], Verbs:["*"]."pods"],APIGroups:["*"], Verbs:["*"]."deployments"],APIGroups:["*"], Verbs:["*"]."events"],APIGroups:["*"], Verbs:["*"]."endpoints"],APIGroups:["*"], Verbs:["*"]."persistentvolumes"],APIGroups:["*"], Verbs:["*"]."persistentvolumeclaims"],APIGroups:["*"], Verbs:["*"]."storageclasses"],APIGroups:["storage.k8s.io"], Verbs:["*"]."storagepools"], APIGroups:["*"],Verbs:["get"] PolicyRule{Resources:["storagepools"], APIGroups:["*"],Verbs:["list"]}PolicyRule{NonResourceURLs:["/metrics"],Verbs:["get"]}] user=&{system:serviceaccount:kube-system:tiller6f3172cc-4a08-11e8-9af5-0a58ac1f1729 [system:serviceaccounts system:serviceaccounts:kube-systemsystem:authenticated] map[]} ownerrules=[]ruleResolutionErrors=[clusterroles.rbac.authorization.k8s.io"cluster-admin" not found]
```

--------------------------------

### Example Upgrade Status Output

Source: https://openebs.io/docs/4.1.x/user-guides/replicated-storage-user-guide/replicated-pv-mayastor/additional-information/upgrade-re

This is an example of the output you might see when checking the upgrade status using `kubectl mayastor get upgrade-status`. It indicates the versions involved and the success of the upgrade.

```text
Upgrade From: 2.0.0
Upgrade To: 2.6.1
Upgrade Status: Successfully upgraded Mayastor
```

--------------------------------

### Example Velero Backup Creation

Source: https://openebs.io/docs/3.0.x/user-guides/jiva-guide

An example of creating a Velero backup named 'hostpathbkp2' with specific selectors.

```bash
velero backup create hostpathbkp2 --selector '!openebs.io/controller,!openebs.io/replica'
```

--------------------------------

### Helm Installation Error on Azure AKS

Source: https://openebs.io/docs/3.9.x/troubleshooting/install

This is an example of a Helm installation error on Azure AKS, indicating a forbidden attempt to grant extra privileges due to RBAC misconfiguration. The error details the specific policy rules that were denied.

```text
Error: release openebs failed: clusterroles.rbac.authorization.k8s.io "openebs" isforbidden: attempt to grant extra privileges:[PolicyRule{Resources:["nodes"], APIGroups:["*"],Verbs:["get"]} PolicyRule{Resources:["nodes"],APIGroups:["*"], Verbs:["list"]}PolicyRule{Resources:["nodes"], APIGroups:["*"],Verbs:["watch"]} PolicyRule{Resources:["nodes/proxy"],APIGroups:["*"], Verbs:["get"]}PolicyRule{Resources:["nodes/proxy"], APIGroups:["*"],Verbs:["list"]} PolicyRule{Resources:["nodes/proxy"],APIGroups:["*"], Verbs:["watch"]}PolicyRule{Resources:["namespaces"], APIGroups:["*"],Verbs:["*"]} PolicyRule{Resources:["services"],APIGroups:["*"], Verbs:["*"]} PolicyRule{Resources:["pods"],APIGroups:["*"], Verbs:["*"ПолисиRule{Resources:["deployments"], APIGroups:["*"],Verbs:["*"}PolicyRule{Resources:["events"],APIGroups:["*"], Verbs:["*"}PolicyRule{Resources:["endpoints"], APIGroups:["*"],Verbs:["*"}PolicyRule{Resources:["persistentvolumes"],APIGroups:["*"], Verbs:["*"}PolicyRule{Resources:["persistentvolumeclaims"], APIGroups:["*"],Verbs:["*"ПолисиRule{Resources:["storageclasses"],APIGroups:["storage.k8s.io"], Verbs:["*"}PolicyRule{Resources:["storagepools"], APIGroups:["*"],Verbs:["get"]} PolicyRule{Resources:["storagepools"], APIGroups:["*"],Verbs:["list"]}PolicyRule{NonResourceURLs:["/metrics"],Verbs:["get"]}] user=&{system:serviceaccount:kube-system:tiller6f3172cc-4a08-11e8-9af5-0a58ac1f1729 [system:serviceaccounts system:serviceaccounts:kube-systemsystem:authenticated] map[]} ownerrules=[]ruleResolutionErrors=[clusterroles.rbac.authorization.k8s.io"cluster-admin" not found]
```

--------------------------------

### View Supportability Tool Help

Source: https://openebs.io/docs/4.3.x/user-guides/supportability

Execute this command to see all available options and sub-commands for the `kubectl openebs dump` command.

```bash
kubectl openebs dump --help
```

--------------------------------

### Example of Accessing Kubelet Container Shell on AKS

Source: https://openebs.io/docs/3.0.x/user-guides/prerequisites

An example demonstrating how to execute commands within the kubelet container shell using a specific container ID.

```bash
sudo docker exec -it 3aab0f9a48e2 bash
```

--------------------------------

### Clone Crunchy Data Postgres Operator Examples

Source: https://openebs.io/docs/4.2.x/Solutioning/backup-and-restore/cloning-crunchy-data

Clones the official CrunchyData postgres-operator-examples repository to access operator installation manifests.

```bash
git clone https://github.com/CrunchyData/postgres-operator-examples.git
cd postgres-operator-examples
```

--------------------------------

### Deploy OpenEBS Operator

Source: https://openebs.io/docs/3.0.x/faqs/general

Use this command to deploy the OpenEBS operator in a Kubernetes environment. This is the first step to get started with OpenEBS.

```bash
kubectl apply -f https://openebs.github.io/charts/openebs-operator.yaml
```

--------------------------------

### Example: Create Base ZFS Snapshot

Source: https://openebs.io/docs/3.0.x/additional-info/kb

An example of creating a base ZFS snapshot for a cStor volume's Persistent Volume (PV). Replace placeholders with your actual pool, PV, and snapshot names.

```bash
root@cstor-sparse-pool-sb1v-77658f4c85-jcgwc:/# zfs snapshot cstor-231fca0f-c6a1-11e9-be30-42010a800094/pvc-5c52d001-c6a1-11e9-be30-42010a800094@snap_data1
```

--------------------------------

### Local PV ZFS Sample Output

Source: https://openebs.io/docs/4.3.x/user-guides/kubectl-openebs

Presents an example output for the localpv-zfs command, illustrating its structure and options. This helps in understanding the available operations for ZFS volumes.

```text
Usage: kubectl-openebs localpv-zfs [OPTIONS] <COMMAND>  
  
Commands:  
  get   Gets localpv-zfs resources  
  help  Print this message or the help of the given subcommand(s)  
  
Options:  
  -o, --output <OUTPUT>          The Output, viz yaml, json [default: none]  
  -n, --namespace <NAMESPACE>    Namespace where openebs is installed. If unset, defaults to the default namespace in the current context  
  -k, --kubeconfig <KUBECONFIG>  Path to kubeconfig file  
  -h, --help                     Print help  
     
```

--------------------------------

### iSCSI Client Setup Error

Source: https://openebs.io/docs/3.2.x/troubleshooting/install

This error indicates that the iSCSI client service may not be enabled or running on your nodes. Ensure 'iscsid.service' is enabled and started.

```text
MountVolume.WaitForAttach failed for volume "pvc-ea5b871b-32d3-11e9-9bf5-0a8e969eb15a" : open /sys/class/iscsi_host: no such file or directory -
```

--------------------------------

### Set Namespace to 'storage' in Current Context

Source: https://openebs.io/docs/4.3.x/user-guides/kubectl-openebs

An example of setting the default namespace to 'storage' for the current kubectl context. This is useful if OpenEBS is installed in a specific namespace.

```bash
kubectl config set-context --namespace=storage --current
```

--------------------------------

### View Configuration Files

Source: https://openebs.io/docs/3.1.x/troubleshooting

Examine these configuration files to understand the settings for reboot management and transactional updates.

```bash
cat /etc/rebootmgr.conf  

cat /usr/lib/systemd/system/transactional-update.timer  

cat /usr/etc/transactional-update.conf  
```

--------------------------------

### Example Invalid CVR Status

Source: https://openebs.io/docs/3.5.x/troubleshooting/cstor

This is a sample output from 'kubectl get cvr' showing a CVR in an 'Invalid' state. This indicates a problem with the associated cStor pool.

```bash
NAME                                                         USED   ALLOCATED   STATUS    AGE  
pvc-738f76c0-b553-11e9-858e-54e1ad4a9dd4-cstor-sparse-p8yp   6K     6K          Invalid   6m
```
Tokens:
Raw