Skip to content

Commit

Permalink
updating documentation in preparation of 1.11.2 release
Browse files Browse the repository at this point in the history
  • Loading branch information
kasserater committed Apr 15, 2024
1 parent 407708a commit fd818c2
Show file tree
Hide file tree
Showing 11 changed files with 27 additions and 26 deletions.
2 changes: 1 addition & 1 deletion docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
* [Supported operating systems](content/release_notes/supported_os.md)
* [Supported orchestration platforms](content/release_notes/supported_orchestration.md)
* [Change log](content/release_notes/change_log.md)
* [1.11.2 (March 2024)](content/release_notes/changelog_1.11.2.md)
* [1.11.2 (May 2024)](content/release_notes/changelog_1.11.2.md)
* [1.11.1 (May 2023)](content/release_notes/changelog_1.11.1.md)
* [1.11.0 (January 2023)](content/release_notes/changelog_1.11.0.md)
* [1.10.0 (July 2022)](content/release_notes/changelog_1.10.0.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/book_files/csi_block_storage_kc_whatsnew.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ This topic lists the dates and nature of updates to the published information of

| Date | Nature of updates to the published information |
|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 31 March 2024 | The version information was added to IBM Documentation.<br>For more information about this version, see the [What's new in 1.11.2](../content/release_notes/whats_new.md) section in the release notes. |
| 01 May 2024 | The version information was added to IBM Documentation.<br>For more information about this version, see the [What's new in 1.11.2](../content/release_notes/whats_new.md) section in the release notes. |

2 changes: 1 addition & 1 deletion docs/content/configuration/creating_volumereplication.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,4 @@ When replicating a volume, be sure to follow all of the replication configuratio
- **Secondary** Indicates that the source volume is the secondary volume.
- **Unknown** Indicates that the driver does not recognize the replication state.
**Note:** For information about changing the replication state, see the [Usage](https://github.com/csi-addons/volume-replication-operator/tree/v0.2.0#usage) section of the Volume Replication Operator for csi-addons.
**Note:** For information about changing the replication state, see the [Usage](https://github.com/csiblock/volume-replication-operator/tree/v0.1.0#usage) section of the Volume Replication Operator for csi-addons.
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ VolumeReplicationClass needs to be present before a VolumeReplication can be cre
- **Secondary** Indicates that the source volume is the secondary volume.
- **Unknown** Indicates that the driver does not recognize the replication state.
**Note:** For information about changing the replication state, see the [Usage](https://github.com/csi-addons/volume-replication-operator/tree/v0.2.0#usage) section of the Volume Replication Operator for csi-addons.
**Note:** For information about changing the replication state, see the [Usage](https://github.com/csiblock/volume-replication-operator/tree/v0.1.0#usage) section of the Volume Replication Operator for csi-addons.
14 changes: 7 additions & 7 deletions docs/content/installation/install_compatibility_requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Complete these steps to prepare your environment for installing the CSI (Contain
Download and save the following YAML file:

```
curl https://raw.githubusercontent.com/IBM/ibm-block-csi-operator/master/deploy/99-ibm-attach.yaml > 99-ibm-attach.yaml
curl https://raw.githubusercontent.com/IBM/ibm-block-csi-operator/v1.11.2/deploy/99-ibm-attach.yaml > 99-ibm-attach.yaml
```

This file can be used for both Fibre Channel and iSCSI configurations. To support iSCSI, uncomment the last two lines in the file.
Expand All @@ -50,7 +50,7 @@ Complete these steps to prepare your environment for installing the CSI (Contain
2. Configure your storage system host attachment, per worker node.
**Note:** IBM® block storage CSI driver 1.11.0 introduces dynamic host definition. For more information and installation instructions, see [Installing the host definer](install_hostdefiner.md). If this feature is not installed, the nodes are not dynamically defined on the storage system and they must be defined manually.
**Note:** IBM® block storage CSI driver 1.11.0 introduced dynamic host definition. For more information and installation instructions, see [Installing the host definer](install_hostdefiner.md). If this feature is not installed, the nodes are not dynamically defined on the storage system and they must be defined manually.
Be sure to configure your storage system host attachment according to your storage system instructions.
Expand Down Expand Up @@ -85,13 +85,13 @@ Complete these steps to prepare your environment for installing the CSI (Contain
1. To enable support on your Kubernetes cluster, install the following replication CRDs once per cluster.
```
curl -O https://raw.githubusercontent.com/IBM/csi-volume-group-operator/v0.9.0/config/crd/bases/csi.ibm.com_volumegroupclasses.yaml
curl -O https://raw.githubusercontent.com/IBM/csi-volume-group-operator/v0.9.1/config/crd/bases/csi.ibm.com_volumegroupclasses.yaml
kubectl apply -f csi.ibm.com_volumegroupclasses.yaml
curl -O https://raw.githubusercontent.com/IBM/csi-volume-group-operator/v0.9.0/config/crd/bases/csi.ibm.com_volumegroupcontents.yaml
curl -O https://raw.githubusercontent.com/IBM/csi-volume-group-operator/v0.9.1/config/crd/bases/csi.ibm.com_volumegroupcontents.yaml
kubectl apply -f csi.ibm.com_volumegroupcontents.yaml
curl -O https://raw.githubusercontent.com/IBM/csi-volume-group-operator/v0.9.0/config/crd/bases/csi.ibm.com_volumegroups.yaml
curl -O https://raw.githubusercontent.com/IBM/csi-volume-group-operator/v0.9.1/config/crd/bases/csi.ibm.com_volumegroups.yaml
kubectl apply -f csi.ibm.com_volumegroups.yaml
```
Expand All @@ -102,10 +102,10 @@ Complete these steps to prepare your environment for installing the CSI (Contain
1. To enable support on your Kubernetes cluster, install the following volume group CRDs once per cluster.
```
curl -O https://raw.githubusercontent.com/csi-addons/volume-replication-operator/v0.3.0/config/crd/bases/replication.storage.openshift.io_volumereplicationclasses.yaml
curl -O https://raw.githubusercontent.com/csiblock/volume-replication-operator/v0.1.0/config/crd/bases/replication.storage.openshift.io_volumereplicationclasses.yaml
kubectl apply -f ./replication.storage.openshift.io_volumereplicationclasses.yaml
curl -O https://raw.githubusercontent.com/csi-addons/volume-replication-operator/v0.3.0/config/crd/bases/replication.storage.openshift.io_volumereplications.yaml
curl -O https://raw.githubusercontent.com/csiblock/volume-replication-operator/v0.1.0/config/crd/bases/replication.storage.openshift.io_volumereplications.yaml
kubectl apply -f ./replication.storage.openshift.io_volumereplications.yaml
```
Expand Down
2 changes: 1 addition & 1 deletion docs/content/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ By leveraging CSI (Container Storage Interface) drivers for IBM storage systems,
IBM storage orchestration for containers includes the following driver types for storage provisioning:

- The IBM block storage CSI driver, for block storage (documented here).
- The IBM Spectrum® Scale CSI driver, for file storage. For specific Spectrum Scale and Spectrum Scale CSI driver product information, see [IBM Spectrum Scale documentation](https://www.ibm.com/docs/en/spectrum-scale/).
- The IBM Storage® Scale CSI driver, for file storage. For specific Storage Scale and Storage Scale CSI driver product information, see [IBM Storage Scale documentation](https://www.ibm.com/docs/en/storage-scale/).

For details about volume provisioning with Kubernetes, refer to [Persistent volumes on Kubernetes](https://kubernetes.io/docs/concepts/storage/volumes/).

Expand Down
6 changes: 4 additions & 2 deletions docs/content/release_notes/changelog_1.11.2.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# 1.11.2 (December 2023)
# 1.11.2 (May 2024)

IBM® block storage CSI driver 1.11.2 added new support and enhancements.
- Additional orchestration platform support for Red Hat OpenShift 4.14 and Kubernetes 1.28
- Additional orchestration platform support for Red Hat OpenShift 4.14 and 4.15, as well as Kubernetes 1.28 and 1.29
- New RHEL 9.x support for x86 architecture
- Remove support for RHEL 7.x (reached end of life)
11 changes: 5 additions & 6 deletions docs/content/release_notes/supported_orchestration.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,17 @@ The following table details orchestration platforms suitable for deployment of t

|Orchestration platform| Version |Architecture|
|----------------------|---------|------------|
|Kubernetes| 1.24 |x86|
|Kubernetes| 1.25 |x86|
|Kubernetes| 1.26 |x86|
|Kubernetes| 1.27 |x86|
|Red Hat OpenShift| 4.10 |x86, IBM Z, IBM Power Systems<sup>1</sup>|
|Red Hat OpenShift| 4.11 |x86, IBM Z, IBM Power Systems<sup>1</sup>|
|Kubernetes| 1.28 |x86|
|Kubernetes| 1.29 |x86|
|Red Hat OpenShift| 4.12 |x86, IBM Z, IBM Power Systems<sup>1</sup>|
|Red Hat OpenShift| 4.13 |x86, IBM Z, IBM Power Systems<sup>1</sup>|
|Red Hat OpenShift| 4.14 |x86, IBM Z, IBM Power Systems<sup>1</sup>|
|Red Hat OpenShift| 4.15 |x86, IBM Z, IBM Power Systems<sup>1</sup>|

<sup>1</sup>IBM Power Systems architecture is only supported on Spectrum Virtualize and DS8000 family storage systems.

**Note:**
- As of this document's publication date, IBM Cloud® Satellite only supports RHEL 7 on x86 architecture for Red Hat OpenShift. For the latest support information, see [cloud.ibm.com/docs/satellite](https://cloud.ibm.com/docs/satellite).
- As of this document's publication date, IBM Cloud® Satellite only supports RHEL 8 on x86 architecture for Red Hat OpenShift. For the latest support information, see [Satellite host system requirements](https://cloud.ibm.com/docs/satellite?topic=satellite-host-reqs).
- For the latest orchestration platform support information, see the [Lifecycle and support matrix](https://www.ibm.com/docs/en/stg-block-csi-driver?topic=SSRQ8T/landing/csi_lifecycle_support_matrix.html).

4 changes: 2 additions & 2 deletions docs/content/release_notes/supported_os.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ The following table lists operating systems required for deployment of the IBM®

| Operating system |Architecture|
|---------------------------------------------------|------------|
| Red Hat® Enterprise Linux® (RHEL) 7.x |x86, IBM Z®|
| Red Hat® Enterprise Linux® (RHEL) 8.x |x86|
| Red Hat Enterprise Linux CoreOS (RHCOS) 4.10-4.13 |x86, IBM Z, IBM Power Systems™<sup>1</sup>|
| Red Hat® Enterprise Linux® (RHEL) 9.x |x86|
| Red Hat Enterprise Linux CoreOS (RHCOS) 4.12-4.15 |x86, IBM Z, IBM Power Systems™<sup>1</sup>|
| Ubuntu 20.04.4 LTS<sup>2</sup> | x86_64|

<sup>1</sup>IBM Power Systems architecture is only supported on Spectrum Virtualize and DS8000 family storage systems.<br/>
Expand Down
4 changes: 2 additions & 2 deletions docs/content/release_notes/supported_storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ IBM® block storage CSI driver 1.11.2 supports different IBM storage systems as

|Storage system|Microcode version|
|--------------|-----------------|
|Spectrum Virtualize™ family including Spectrum Virtualize as software only, Spectrum Virtualize for Public Cloud, SAN Volume Controller (SVC), and FlashSystem® family members built with Spectrum® Virtualize (including FlashSystem 5xxx, 7xxx, 9xxx)|7.8.x, 8.2.x, 8.3.x, 8.4.x, 8.5.x|
|Spectrum Virtualize™ family including Spectrum Virtualize as software only, Spectrum Virtualize for Public Cloud, SAN Volume Controller (SVC), and FlashSystem® family members built with Spectrum® Virtualize (including FlashSystem 5xxx, 7xxx, 9xxx)|8.4.x, 8.5.x, 8.6.x|
|DS8000® family|8.x and higher with same API interface|

**Note:**

- For the latest microcode storage support information, see the [Lifecycle and support matrix](https://www.ibm.com/docs/en/stg-block-csi-driver?topic=SSRQ8T/landing/csi_lifecycle_support_matrix.html).
- The Spectrum Virtualize family and SAN Volume Controller storage systems run the Spectrum Virtualize software. In addition, the Spectrum Virtualize package is available as a deployable solution that can be run on any compatible hardware.
- Spectrum Virtualize family (including Storwize, FlashSystem, and SAN Volume Controller) microcode versions 8.4.x and 8.5.x include both LTS and Non-LTS releases. For more information, see [IBM Spectrum Virtualize FAQ for Continuous Development (CD) Release Model for software releases](https://www.ibm.com/support/pages/node/6409554).
- Spectrum Virtualize family (including Storwize, FlashSystem, and SAN Volume Controller) microcode versions 8.4.x, 8.5.x and 8.6.x include both LTS and Non-LTS releases. For more information, see [IBM Spectrum Virtualize FAQ for Continuous Development (CD) Release Model for software releases](https://www.ibm.com/support/pages/node/6409554).


4 changes: 2 additions & 2 deletions docs/content/release_notes/whats_new.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

IBM® block storage CSI driver 1.11.2 introduces the enhancements that are detailed in the following section.

**General availability date:** 31 December 2023
**General availability date:** 1 May 2024

## Supported orchestration platforms for deployment

This version adds support for orchestration platforms Kubernetes 1.28 and Red Hat® OpenShift® 4.14, suitable for deployment of the CSI (Container Storage Interface) driver.

## Miscellaneous resolved issues

For information about the resolved issue in version 1.11.2, see [1.11.2 (December 2023)](changelog_1.11.2.md).
For information about the resolved issues in version 1.11.2, see [1.11.2 (May 2024)](changelog_1.11.2.md).

0 comments on commit fd818c2

Please sign in to comment.