Skip to content
This repository has been archived by the owner on Mar 3, 2022. It is now read-only.

Commit

Permalink
chore(release): update references to 2.11 (#952)
Browse files Browse the repository at this point in the history 
* chore(release): update references to 2.11
* feat(cstor): update cstor guide with install steps
* update 2.11 enhancements
* update bugfixes from 2.11
* update install instructions

Signed-off-by: kmova <[email protected]>
  • Loading branch information
@kmova
kmova committed Jul 18, 2021
1 parent bbf9be7 commit d6b03ef
Show file tree
Hide file tree
Showing 9 changed files with 334 additions and 209 deletions.
12 changes: 6 additions & 6 deletions docs/d-cStorguide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1259,11 +1259,11 @@ Below table lists the storage policies supported by cStor. These policies should
| cStor Storage Policy | Mandatory | Default | Purpose |
| ------------------------------------------------------------ | --------- | --------------------------------------- | ------------------------------------------------------------ |
| [ReplicaCount](#Replica-Count-Policy) | No | 3 | Defines the number of cStor volume replicas |
| [VolumeControllerImage](#Volume-Controller-Image-Policy) | | openebs/cstor-volume-mgmt:2.10.0 | Dedicated side car for command management like taking snapshots etc. Can be used to apply a specific issue or feature for the workload |
| [VolumeTargetImage](#Volume-Target-Image-Policy) | | openebs/cstor-istgt:2.10.0 | iSCSI protocol stack dedicated to the workload. Can be used to apply a specific issue or feature for the workload |
| [VolumeControllerImage](#Volume-Controller-Image-Policy) | | openebs/cstor-volume-mgmt:2.11.0 | Dedicated side car for command management like taking snapshots etc. Can be used to apply a specific issue or feature for the workload |
| [VolumeTargetImage](#Volume-Target-Image-Policy) | | openebs/cstor-istgt:2.11.0 | iSCSI protocol stack dedicated to the workload. Can be used to apply a specific issue or feature for the workload |
| [StoragePoolClaim](#Storage-Pool-Claim-Policy) | Yes | N/A (a valid pool must be provided) | The cStorPool on which the volume replicas should be provisioned |
| [VolumeMonitor](#Volume-Monitor-Policy) | | ON | When ON, a volume exporter sidecar is launched to export Prometheus metrics. |
| [VolumeMonitorImage](#Volume-Monitoring-Image-Policy) | | openebs/m-exporter:2.10.0 | Used when VolumeMonitor is ON. A dedicated metrics exporter to the workload. Can be used to apply a specific issue or feature for the workload |
| [VolumeMonitorImage](#Volume-Monitoring-Image-Policy) | | openebs/m-exporter:2.11.0 | Used when VolumeMonitor is ON. A dedicated metrics exporter to the workload. Can be used to apply a specific issue or feature for the workload |
| [FSType](#Volume-File-System-Type-Policy) | | ext4 | Specifies the filesystem that the volume should be formatted with. Other values are `xfs` |
| [TargetNodeSelector](#Target-NodeSelector-Policy) | | Decided by Kubernetes scheduler | Specify the label in `key: value` format to notify Kubernetes scheduler to schedule cStor target pod on the nodes that match label |
| [TargetResourceLimits](#Target-ResourceLimits-Policy) | | Decided by Kubernetes scheduler | CPU and Memory limits to cStor target pod |
Expand Down Expand Up @@ -1327,7 +1327,7 @@ metadata:
annotations:
cas.openebs.io/config: |
- name: VolumeControllerImage
value: openebs/cstor-volume-mgmt:2.10.0
value: openebs/cstor-volume-mgmt:2.11.0
- name: StoragePoolClaim
value: "cstor-disk-pool"
openebs.io/cas-type: cstor
Expand All @@ -1346,7 +1346,7 @@ metadata:
annotations:
cas.openebs.io/config: |
- name: VolumeTargetImage
value:openebs/cstor-istgt:2.10.0
value:openebs/cstor-istgt:2.11.0
- name: StoragePoolClaim
value: "cstor-disk-pool"
openebs.io/cas-type: cstor
Expand Down Expand Up @@ -1384,7 +1384,7 @@ metadata:
annotations:
cas.openebs.io/config: |
- name: VolumeMonitorImage
value: openebs/m-exporter:2.10.0
value: openebs/m-exporter:2.11.0
- name: StoragePoolClaim
value: "cstor-sparse-pool"
openebs.io/cas-type: cstor
Expand Down
97 changes: 47 additions & 50 deletions docs/installation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,55 +6,48 @@ sidebar_label: Installation
------

<br>
This guide will help you to customize and install OpenEBS. If this is your first time installing OpenEBS, make sure that your Kubernetes nodes are meet the [required prerequisites](/docs/next/prerequisites.html).
This guide will help you to customize and install OpenEBS.

## Prerequisites

If this is your first time installing OpenEBS, make sure that your Kubernetes nodes meet the [required prerequisites](/docs/next/prerequisites.html). At a high level OpenEBS requires:

## Verify that you have the admin context

For installation of OpenEBS, cluster-admin user context is a must. OpenEBS installs service accounts and custom resource definitions that are only allowed for cluster administrators.

Use the `kubectl auth can-i` commands to verify that you have the cluster-admin context. You can use the following commands to verify if you have access:

```
kubectl auth can-i 'create' 'namespace' -A
kubectl auth can-i 'create' 'crd' -A
kubectl auth can-i 'create' 'sa' -A
kubectl auth can-i 'create' 'clusterrole' -A
```

If you do not have admin permissions to your cluster, please check with your Kubernetes cluster administrator to help with installing OpenEBS or if you are the owner of the cluster, check out the <a href="/docs/next/installation.html#set-cluster-admin-user-context" target="_blank"> steps to create a new admin context </a> and use it for installing OpenEBS.
- Verify that you have the admin context. If you do not have admin permissions to your cluster, please check with your Kubernetes cluster administrator to help with installing OpenEBS or if you are the owner of the cluster, check out the <a href="/docs/next/installation.html#set-cluster-admin-user-context" target="_blank"> steps to create a new admin context </a> and use it for installing OpenEBS.
- You have Kubernetes 1.18 version or higher.
- Each storage engine may have few additional requirements like having:
- iSCSI initiator utils installed for Jiva and cStor volumes
- Depending on the managed Kubernetes platform like Rancher or MicroK8s - set up the right bind mounts
- Decide which of the devices on the nodes should be used by OpenEBS or if you need to create LVM Volume Groups or ZFS Pools
- Join [OpenEBS community on Kubernetes slack](docs/next/support.html).


## Installation through helm

Verify helm is installed and helm repo is updated. See <a href="https://helm.sh/docs/intro/install/#from-script" target="_blank">helm docs</a> for setting up helm v3. Installed helm version can be obtained by using the following command:

```
helm version
```
Example output:

<div class="co">
version.BuildInfo{Version:"v3.6.0", GitCommit:"7f2df6467771a75f5646b7f12afb408590ed1755", GitTreeState:"clean", GoVersion:"go1.16.3"}
</div>
Verify helm is installed and helm repo is updated. You need helm 3.2 or more.

Setup helm repository
```
helm repo add openebs https://openebs.github.io/charts
helm repo update
```

OpenEBS provides several options that you can customize during install like specifying the directory where hostpath volume data is stored, specifying the nodes on which OpenEBS components should be deployed, and so forth. The default OpenEBS helm chart will only install Local PV hostpath and Jiva data engines.
OpenEBS provides several options that you can customize during install like:
- specifying the directory where hostpath volume data is stored or
- specifying the nodes on which OpenEBS components should be deployed, and so forth.

Please refer to <a href="https://github.com/openebs/charts/tree/master/charts/openebs" target="_blank">OpenEBS helm chart documentation</a> for full list of customizable options and using cStor and other flavors of OpenEBS data engines by setting the correct helm values.
The default OpenEBS helm chart will only install Local PV hostpath and Jiva data engines. Please refer to <a href="https://github.com/openebs/charts/tree/master/charts/openebs" target="_blank">OpenEBS helm chart documentation</a> for full list of customizable options and using cStor and other flavors of OpenEBS data engines by setting the correct helm values.

Install OpenEBS helm chart with default values.

```
helm install openebs --namespace openebs openebs/openebs --create-namespace
```
The above commands will install OpenEBS in `openebs` namespace and chart name as `openebs`
The above commands will install OpenEBS Jiva and Local PV components in `openebs` namespace and chart name as `openebs`. To install and enable other engines you can modified the above command as follows:

- cStor
```
helm install openebs --namespace openebs openebs/openebs --create-namespace --set cstor.enabled=true
```

To view the chart
```
Expand All @@ -68,16 +61,25 @@ As a next step [verify](#verifying-openebs-installation) your installation and d

OpenEBS provides a list of YAMLs that will allow you to easily customize and run OpenEBS in your Kubernetes cluster. For custom installation, <a href="https://openebs.github.io/charts/openebs-operator.yaml" target="_blank">download</a> the **openebs-operator** YAML file, update the configurations and use the customized YAML for installation in the below `kubectl` command.

To continue with **default installation mode**, use the following command to install OpenEBS. OpenEBS is installed in `openebs` namespace.
To continue with default installation mode, use the following command to install OpenEBS. OpenEBS is installed in `openebs` namespace.

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

The above command installs Jiva and Local PV components. You have to run additional YAMLs to enable other engines as follows:
- cStor (`https://openebs.github.io/charts/cstor-operator.yaml`)
- Local PV ZFS ( `kubectl apply -f https://openebs.github.io/charts/zfs-operator.yaml` )
- Local PV LVM ( `kubectl apply -f https://openebs.github.io/charts/lvm-operator.yaml` )
The above command installs Jiva and Local PV components. To install and enable other engines you will need to run additional command like:
- cStor
```
kubectl apply -f https://openebs.github.io/charts/cstor-operator.yaml
```
- Local PV ZFS
```
kubectl apply -f https://openebs.github.io/charts/zfs-operator.yaml
```
- Local PV LVM
```
kubectl apply -f https://openebs.github.io/charts/lvm-operator.yaml
```


## Verifying OpenEBS installation
Expand Down Expand Up @@ -127,30 +129,14 @@ openebs-device openebs.io/local
openebs-hostpath openebs.io/local 64s
openebs-jiva-default openebs.io/provisioner-iscsi 64s
openebs-snapshot-promoter volumesnapshot.external-storage.k8s.io/snapshot-promoter 64s
standard (default) kubernetes.io/gce-pd 6m41s
</div>



**Verify Jiva default pool - default**


```
kubectl get sp
```

Following is an example output.

<div class="co">NAME AGE
default 2m
</div>


## Post-Installation considerations

<br>

For a testing your OpenEBS installation, you can use the below default storage classes
For testing your OpenEBS installation, you can use the below default storage classes

- `openebs-jiva-default` for provisioning Jiva Volume (this uses `default` pool which means the data replicas are created in the /var/openebs/ directory of the Jiva replica pod)

Expand All @@ -166,6 +152,17 @@ You can follow through the below user guides for each of the engines to use stor

### Set cluster-admin user context

For installation of OpenEBS, cluster-admin user context is a must. OpenEBS installs service accounts and custom resource definitions that are only allowed for cluster administrators.

Use the `kubectl auth can-i` commands to verify that you have the cluster-admin context. You can use the following commands to verify if you have access:

```
kubectl auth can-i 'create' 'namespace' -A
kubectl auth can-i 'create' 'crd' -A
kubectl auth can-i 'create' 'sa' -A
kubectl auth can-i 'create' 'clusterrole' -A
```

If there is no cluster-admin user context already present, create one and use it. Use the following command to create the new context.

```
Expand Down
12 changes: 6 additions & 6 deletions docs/jivaguide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -577,11 +577,11 @@ Below table lists the storage policies supported by Jiva. These policies can be
| JIVA STORAGE POLICY | MANDATORY | DEFAULT | PURPOSE |
| ------------------------------------------------------------ | --------- | --------------------------------- | ------------------------------------------------------------ |
| [ReplicaCount](#Replica-Count-Policy) | No | 3 | Defines the number of Jiva volume replicas |
| [Replica Image](#Replica-Image-Policy) | | openebs/m-apiserver:2.10.0 | To use particular Jiva replica image |
| [ControllerImage](#Controller-Image-Policy) | | openebs/jiva:2.10.0 | To use particular Jiva Controller Image |
| [Replica Image](#Replica-Image-Policy) | | openebs/m-apiserver:2.11.0 | To use particular Jiva replica image |
| [ControllerImage](#Controller-Image-Policy) | | openebs/jiva:2.11.0 | To use particular Jiva Controller Image |
| [StoragePool](#Storage-Pool-Policy) | Yes | default | A storage pool provides a persistent path for an OpenEBS volume. It can be a directory on host OS or externally mounted disk. |
| [VolumeMonitor](#Volume-Monitor-Policy) | | ON | When ON, a volume exporter sidecar is launched to export Prometheus metrics. |
| [VolumeMonitorImage](#Volume-Monitoring-Image-Policy) | | openebs/m-exporter:2.10.0 | Used when VolumeMonitor is ON. A dedicated metrics exporter to the workload. Can be used to apply a specific issue or feature for the workload |
| [VolumeMonitorImage](#Volume-Monitoring-Image-Policy) | | openebs/m-exporter:2.11.0 | Used when VolumeMonitor is ON. A dedicated metrics exporter to the workload. Can be used to apply a specific issue or feature for the workload |
| [Volume FSType](#Volume-File-System-Type-Policy) | | ext4 | Specifies the filesystem that the volume should be formatted with. Other values are `xfs` |
| [Volume Space Reclaim](#Volume-Space-Reclaim-Policy) | | false | It will specify whether data need to be retained post PVC deletion. |
| [TargetNodeSelector](#Targe-NodeSelector-Policy) | | Decided by Kubernetes scheduler | Specify the label in `key: value` format to notify Kubernetes scheduler to schedule Jiva target pod on the nodes that match label. |
Expand Down Expand Up @@ -627,7 +627,7 @@ metadata:
openebs.io/cas-type: jiva
cas.openebs.io/config: |
- name: ReplicaImage
value: openebs/m-apiserver:2.10.0
value: openebs/m-apiserver:2.11.0
provisioner: openebs.io/provisioner-iscsi
```

Expand All @@ -644,7 +644,7 @@ metadata:
openebs.io/cas-type: jiva
cas.openebs.io/config: |
- name: ControllerImage
value: openebs/jiva:2.10.0
value: openebs/jiva:2.11.0
provisioner: openebs.io/provisioner-iscsi
```

Expand Down Expand Up @@ -733,7 +733,7 @@ metadata:
openebs.io/cas-type: jiva
cas.openebs.io/config: |
- name: VolumeMonitorImage
value: openebs/m-exporter:2.10.0
value: openebs/m-exporter:2.11.0
provisioner: openebs.io/provisioner-iscsi
```

Expand Down
Loading

0 comments on commit d6b03ef

Please sign in to comment.