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

Commit

Permalink
Push 2.7 changes (#920)
Browse files Browse the repository at this point in the history
* fix(jiva): update with correct link to jiva in overview.md (#919)
* chore(release): update references to 2.7

Signed-off-by: kmova <[email protected]>
Co-authored-by: Knut Ole Sjøli <[email protected]>
  • Loading branch information
kmova and knutole authored Mar 16, 2021
1 parent a8828c2 commit f683c38
Show file tree
Hide file tree
Showing 10 changed files with 117 additions and 52 deletions.
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ after_success:
docker login -u "$DOCKER_USER" -p "$DOCKER_PASS" && docker build -t $REPO:$TRAVIS_BRANCH-$COMMIT . && docker push $REPO;
fi

- if [ "$TRAVIS_BRANCH" = "0.6" -a "$TRAVIS_PULL_REQUEST" = "false" ]; then export REPO=mayadataio/newstaging-openebs-docs;
- if [ "$TRAVIS_BRANCH" = "x.y.z" -a "$TRAVIS_PULL_REQUEST" = "false" ]; then export REPO=mayadataio/openebsdocsversion;
docker login -u "$DOCKER_USER" -p "$DOCKER_PASS" && docker build -t $REPO:$TRAVIS_BRANCH-$COMMIT . && docker push $REPO;
fi

Expand Down
4 changes: 2 additions & 2 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -598,7 +598,7 @@ Find `apiServer`, `provisioner`, `snapshotOperator`, `admission-server` and `ndm
```
provisioner:
image: "openebs/openebs-k8s-provisioner"
imageTag: "2.6.0"
imageTag: "2.7.0"
replicas: 1
nodeSelector: {}
tolerations: []
Expand All @@ -616,7 +616,7 @@ In the `values.yaml`, find`ndm` section to update `excludeVendors:` and `exclude
```
ndm:
image: "openebs/node-disk-manager"
imageTag: "1.2.0"
imageTag: "1.3.0"
sparse:
path: "/var/openebs/sparse"
size: "10737418240"
Expand Down
12 changes: 6 additions & 6 deletions docs/jivaguide.md
Original file line number Diff line number Diff line change
Expand Up @@ -573,11 +573,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.6.0 | To use particular Jiva replica image |
| [ControllerImage](#Controller-Image-Policy) | | openebs/jiva:2.6.0 | To use particular Jiva Controller Image |
| [Replica Image](#Replica-Image-Policy) | | openebs/m-apiserver:2.7.0 | To use particular Jiva replica image |
| [ControllerImage](#Controller-Image-Policy) | | openebs/jiva:2.7.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.6.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.7.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 @@ -623,7 +623,7 @@ metadata:
openebs.io/cas-type: jiva
cas.openebs.io/config: |
- name: ReplicaImage
value: openebs/m-apiserver:2.6.0
value: openebs/m-apiserver:2.7.0
provisioner: openebs.io/provisioner-iscsi
```

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

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

Expand Down
2 changes: 1 addition & 1 deletion docs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Installing OpenEBS in your cluster is as simple as a few `kubectl` or `helm` com
### Replicated Volumes

- [cStor](https://github.com/openebs/cstor-operators/blob/master/docs/quick.md)
- [Jiva](/docs/next/installation.html)
- [Jiva](/docs/next/jivaguide.html)
- [Mayastor](https://mayastor.gitbook.io/introduction/)


Expand Down
21 changes: 21 additions & 0 deletions docs/releases-1x.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,27 @@ sidebar_label: Releases 1.x

<br>

## 1.5.0 - Dec 15 2019

**Change summary:**
- Support BlockVolumeMode for OpenEBS Local PV backed by devices
- Support ZFS as a filesystem type for OpenEBS ZFS Local PV.
- Support for Block Device Replacement via the cStor YAML file (using new schema)
- Support resizing and remounting of Volumes when using cStor CSI Driver
- Support for generating of ARM builds for cStor Data Engine.
- Introduce block device hierarchy to NDM. 4 fields `Parent` ,`Partitions`, `Holders` and `Slaves` are used in defining the hierarchy tree of a device. Also, all the dependent devices of the discovered block device will be logged during the initial udev scan to get the disk level hierarchy of each node in the cluster.
- Add support for applications to provision a "zfs" filesystem directly in the ZFS POOL storage which will get the optimal performance.
- Enhanced the cStor pools to handle auto scale down scenarios to avoid shutting down the node where cStor pool is running. This is achieved by adding cluster-autoscaler.kubernetes.io/safe-to-evict": "false" to the annotation of each cStor pool pod.
- Fixes an issue with liveness probe on `cstor-pool` container by adding a timeout setting for command execution. Setting the timeout value as 120 sec will kill the process if command exceeds more than 120 seconds.
- Fixes an issue in cStor CSI volume unit size conversion while transitioning from PVC to CVC storage capacity the way kubernetes handles, by converting to Gi.
- Fixes a bug where OpenEBS Local PV with hostpaths in OpenShift 4.1 environments was failing.
- Fixes a vulnerability issue with default helper pod image by using the latest tag for helper pods so new version of OpenEBS will automatically get updated with new images. |

**Additional details:**
- [Release Notes](https://github.com/openebs/openebs/releases/tag/1.5.0)
- [Upgrade Steps](/v150/docs/next/upgrade.html)


## 1.4.0 - Nov 15 2019

**Change summary:**
Expand Down
85 changes: 64 additions & 21 deletions docs/releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,67 @@ sidebar_label: Releases

------

## 2.7.0 - Mar 16 2021

<br><font size="4">Latest Release</font><br/> (Recommended)<br/>

OpenEBS v2.7 is a maintenance release geared towards preparing for better structuring of the code and improving on the E2e frameworks. This release also includes some key user-requested bug fixes and enhancements.

The latest release versions of each of the engine are as follows:
- [Mayastor](https://mayastor.gitbook.io/introduction/) 0.8.1
- [cStor](https://github.com/openebs/cstor-operators) 2.7.0
- [Jiva](https://docs.openebs.io/docs/next/jivaguide.html) 2.7.0
- [Local PV host path](https://docs.openebs.io/docs/next/uglocalpv-hostpath.html) 2.7.0
- [Local PV device](https://docs.openebs.io/docs/next/uglocalpv-device.html) 2.7.0
- [Local PV ZFS](https://github.com/openebs/zfs-localpv) 1.5.0
- [Local PV LVM](https://github.com/openebs/lvm-localpv) 0.3.0
- [Local PV Rawfile](https://github.com/openebs/rawfile-localpv) 0.4.4
- [Dynamic NFS Volume](https://github.com/openebs/dynamic-nfs-provisioner) 0.2.0

Here are some of the key highlights in this release.

### Key Improvements

- [Mayastor] Several bug fixes to the Mayastor volumes and preparing to support ANA. See [Mayastor release notes](https://github.com/openebs/Mayastor/releases/tag/v0.8.1).
- [Jiva] Hardening the Jiva CSI driver (introduced for alpha testing) with automated E2e tests and fixing some of the issues found in the e2e tests. The driver is available for alpha testing. For instructions on how to set up and use the Jiva CSI driver, please see. https://github.com/openebs/jiva-operator.
- [LVM Local PV](https://github.com/openebs/lvm-localpv) is enhanced with additional features and some key bug fixes like:
* Support for creating CSIStorageCapacity objects to allow dynamic provisioning based on available capacity.
* Enhance the provisioning workflow to handle capacity exhaustion on LVM group and allow the volume to be re-scheduled to another node.
* Automated E2e tests for provisioning and resize features.
- [ZFS Local PV](https://github.com/openebs/zfs-localpv) added support for performing backup/restore on encrypted ZFS pools.


### Key Bug Fixes
- Fixed an issue with Mayastor where an error in creating a nexus could cause a hang.
- Fixed an issue with cStor that was causing a crash in arm64 due to invalid uzfs zc_nvlist_dst_size handling.
- Fixed an issue where NDM would not automatically de-activate a removed disk when GPTBasedUUID was enabled.
- Fixes an issue where Rawfile Local PV volume deletion would not delete the provisioned PV folders.
- Fixes an issue which caused resize on btrs filesystems on top of Rawfile Local PV was failing.
- Several fixes to docs were also included in this release.


### Backward Incompatibilities

- Kubernetes 1.17 or higher release is recommended as this release contains the following updates that will not be compatible with older Kubernetes releases.
* The CSI components have been upgraded to:
* k8s.gcr.io/sig-storage/csi-attacher:v3.1.0
* k8s.gcr.io/sig-storage/csi-node-driver-registrar:v2.1.0
* k8s.gcr.io/sig-storage/csi-provisioner:v2.1.0
* k8s.gcr.io/sig-storage/csi-provisioner:v2.1.1 (for Mayastor CSI volumes)
* k8s.gcr.io/sig-storage/csi-resizer:v1.1.0
* k8s.gcr.io/sig-storage/csi-snapshotter:v4.0.0
* k8s.gcr.io/sig-storage/snapshot-controller:v4.0.0
* k8s.gcr.io/sig-storage/csi-snapshotter:v3.0.3 (for cStor CSI volumes)
* k8s.gcr.io/sig-storage/snapshot-controller:v3.0.3 (for cStor CSI volumes)
- If you are upgrading from a version of cStor operators older than 2.6 to this version, you will need to manually delete the cStor CSI driver object prior to upgrading. `kubectl delete csidriver cstor.csi.openebs.io`. For complete details on how to upgrade your cStor operators, see https://github.com/openebs/upgrade/blob/master/docs/upgrade.md#cspc-pools.
- The CRD API version has been updated for the cStor custom resources to v1. If you are upgrading via the helm chart, you might have to make sure that the new CRDs are updated. https://github.com/openebs/cstor-operators/tree/master/deploy/helm/charts/crds
- The e2e pipelines include upgrade testing only from 1.6 and higher releases to 2.7. If you are running on release older than 1.6, OpenEBS recommends you upgrade to the latest version as soon as possible.

**Additional details:**
- [Release Notes](https://github.com/openebs/openebs/releases/tag/v2.6.0)
- [Upgrade Steps](/docs/next/upgrade.html)


## 2.6.0 - Feb 15 2021

<br><font size="4">Latest Release</font><br/> (Recommended)<br/>
Expand Down Expand Up @@ -645,26 +706,6 @@ Here are some of the key highlights in this release.
- [Upgrade Steps](/v160/docs/next/upgrade.html)


## 1.5.0 - Dec 15 2019

**Change summary:**
- Support BlockVolumeMode for OpenEBS Local PV backed by devices
- Support ZFS as a filesystem type for OpenEBS ZFS Local PV.
- Support for Block Device Replacement via the cStor YAML file (using new schema)
- Support resizing and remounting of Volumes when using cStor CSI Driver
- Support for generating of ARM builds for cStor Data Engine.
- Introduce block device hierarchy to NDM. 4 fields `Parent` ,`Partitions`, `Holders` and `Slaves` are used in defining the hierarchy tree of a device. Also, all the dependent devices of the discovered block device will be logged during the initial udev scan to get the disk level hierarchy of each node in the cluster.
- Add support for applications to provision a "zfs" filesystem directly in the ZFS POOL storage which will get the optimal performance.
- Enhanced the cStor pools to handle auto scale down scenarios to avoid shutting down the node where cStor pool is running. This is achieved by adding cluster-autoscaler.kubernetes.io/safe-to-evict": "false" to the annotation of each cStor pool pod.
- Fixes an issue with liveness probe on `cstor-pool` container by adding a timeout setting for command execution. Setting the timeout value as 120 sec will kill the process if command exceeds more than 120 seconds.
- Fixes an issue in cStor CSI volume unit size conversion while transitioning from PVC to CVC storage capacity the way kubernetes handles, by converting to Gi.
- Fixes a bug where OpenEBS Local PV with hostpaths in OpenShift 4.1 environments was failing.
- Fixes a vulnerability issue with default helper pod image by using the latest tag for helper pods so new version of OpenEBS will automatically get updated with new images. |

**Additional details:**
- [Release Notes](https://github.com/openebs/openebs/releases/tag/1.5.0)
- [Upgrade Steps](/v150/docs/next/upgrade.html)



<br>
Expand All @@ -673,7 +714,9 @@ Here are some of the key highlights in this release.

### [OpenEBS Upgrade](/docs/next/upgrade.html)

### [OpenEBS 0.x Releases](/docs/next/releases-0x.html)
### [Deprecated OpenEBS 1.x Releases](/docs/next/releases-0x.html)

### [Deprecated OpenEBS 0.x Releases](/docs/next/releases-0x.html)

### [OpenEBS FAQ](/docs/next/faq.html)

Expand Down
12 changes: 6 additions & 6 deletions docs/ugcstor.md
Original file line number Diff line number Diff line change
Expand Up @@ -1124,11 +1124,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.6.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.6.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.7.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.7.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.6.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.7.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 @@ -1192,7 +1192,7 @@ metadata:
annotations:
cas.openebs.io/config: |
- name: VolumeControllerImage
value: openebs/cstor-volume-mgmt:2.6.0
value: openebs/cstor-volume-mgmt:2.7.0
- name: StoragePoolClaim
value: "cstor-disk-pool"
openebs.io/cas-type: cstor
Expand All @@ -1211,7 +1211,7 @@ metadata:
annotations:
cas.openebs.io/config: |
- name: VolumeTargetImage
value:openebs/cstor-istgt:2.6.0
value:openebs/cstor-istgt:2.7.0
- name: StoragePoolClaim
value: "cstor-disk-pool"
openebs.io/cas-type: cstor
Expand Down Expand Up @@ -1249,7 +1249,7 @@ metadata:
annotations:
cas.openebs.io/config: |
- name: VolumeMonitorImage
value: openebs/m-exporter:2.6.0
value: openebs/m-exporter:2.7.0
- name: StoragePoolClaim
value: "cstor-sparse-pool"
openebs.io/cas-type: cstor
Expand Down
Loading

0 comments on commit f683c38

Please sign in to comment.