From e15f4f8372beeaaa172a28328bb46ea536822e6b Mon Sep 17 00:00:00 2001 From: Ariel Kass Date: Mon, 23 Dec 2024 11:28:34 +0200 Subject: [PATCH] 1.12.1 documentation updates --- docs/SUMMARY.md | 3 ++- docs/book_files/csi_block_storage_kc_rn.md | 2 +- docs/book_files/csi_block_storage_kc_whatsnew.md | 4 ++-- .../content/configuration/configuring_hostdefiner.md | 2 +- .../install_compatibility_requirements.md | 2 +- docs/content/installation/install_detached.md | 4 ++-- docs/content/installation/install_driver_github.md | 4 ++-- .../installation/install_hostdefiner_github.md | 2 +- docs/content/release_notes/changelog_1.12.1.md | 10 ++++++++++ .../release_notes/compatibility_requirements.md | 2 +- docs/content/release_notes/known_issues.md | 6 +++--- .../content/release_notes/supported_orchestration.md | 3 +++ docs/content/release_notes/supported_storage.md | 2 +- docs/content/release_notes/whats_new.md | 12 ++++++------ 14 files changed, 36 insertions(+), 22 deletions(-) create mode 100644 docs/content/release_notes/changelog_1.12.1.md diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 33a94e373..970de9b28 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -3,12 +3,13 @@ * [Overview](content/overview.md) * [What's new](book_files/csi_block_storage_kc_whatsnew.md) * [Release notes](book_files/csi_block_storage_kc_rn.md) - * [What's new in 1.12.0](content/release_notes/whats_new.md) + * [What's new in 1.12.1](content/release_notes/whats_new.md) * [Compatibility and requirements](content/release_notes/compatibility_requirements.md) * [Supported storage systems](content/release_notes/supported_storage.md) * [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.12.1 (January 2025)](content/release_notes/changelog_1.12.1.md) * [1.12.0 (December 2024)](content/release_notes/changelog_1.12.0.md) * [1.11.4 (September 2024)](content/release_notes/changelog_1.11.4.md) * [1.11.3 (May 2024)](content/release_notes/changelog_1.11.3.md) diff --git a/docs/book_files/csi_block_storage_kc_rn.md b/docs/book_files/csi_block_storage_kc_rn.md index 1d2b4bdf5..b4cb64ced 100644 --- a/docs/book_files/csi_block_storage_kc_rn.md +++ b/docs/book_files/csi_block_storage_kc_rn.md @@ -1,4 +1,4 @@ # Release notes -The following release information is available for version 1.12.0 of the IBM® block storage CSI driver. +The following release information is available for version 1.12.1 of the IBM® block storage CSI driver. diff --git a/docs/book_files/csi_block_storage_kc_whatsnew.md b/docs/book_files/csi_block_storage_kc_whatsnew.md index 37f3c601e..e93a1f519 100644 --- a/docs/book_files/csi_block_storage_kc_whatsnew.md +++ b/docs/book_files/csi_block_storage_kc_whatsnew.md @@ -1,8 +1,8 @@ # What's new -This topic lists the dates and nature of updates to the published information of IBM® block storage CSI driver 1.12.0. +This topic lists the dates and nature of updates to the published information of IBM® block storage CSI driver 1.12.1. | Date | Nature of updates to the published information | |-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| December 2024 | The version information was added to IBM Documentation.
For more information about this version, see the [What's new in 1.12.0](../content/release_notes/whats_new.md) section in the release notes. | +| January 2025 | The version information was added to IBM Documentation.
For more information about this version, see the [What's new in 1.12.1](../content/release_notes/whats_new.md) section in the release notes. | diff --git a/docs/content/configuration/configuring_hostdefiner.md b/docs/content/configuration/configuring_hostdefiner.md index 1153e9a60..8073162e4 100644 --- a/docs/content/configuration/configuring_hostdefiner.md +++ b/docs/content/configuration/configuring_hostdefiner.md @@ -12,4 +12,4 @@ For more information about using the host definer, see [Using dynamic host defin |`dynamicNodeLabeling`|Defines whether the nodes that run the CSI node pod are dynamically labeled or if the user must create the `hostdefiner.block.csi.ibm.com/manage-node=true` label on each relevant node. This label tells the host definer which nodes to manage their host definition on the storage side.
Input values are `true` or `false`.
The default value is `false`, where the user must manually create this label on every node to be managed by the host definer for dynamic host definition on the storage.| |`portSet`|FlashSystem specific field - Specifies the portset for new port definitions (ports already defined on the FlashSystem are not modified).| -For an example HostDefiner yaml file, see [csi_v1_hostdefiner_cr.yaml](https://raw.githubusercontent.com/IBM/ibm-block-csi-operator/v1.12.0/config/samples/csi_v1_hostdefiner_cr.yaml). +For an example HostDefiner yaml file, see [csi_v1_hostdefiner_cr.yaml](https://raw.githubusercontent.com/IBM/ibm-block-csi-operator/v1.12.1/config/samples/csi_v1_hostdefiner_cr.yaml). diff --git a/docs/content/installation/install_compatibility_requirements.md b/docs/content/installation/install_compatibility_requirements.md index 37f3264f2..336181e66 100644 --- a/docs/content/installation/install_compatibility_requirements.md +++ b/docs/content/installation/install_compatibility_requirements.md @@ -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/v1.12.0/deploy/99-ibm-attach.yaml > 99-ibm-attach.yaml + curl https://raw.githubusercontent.com/IBM/ibm-block-csi-operator/v1.12.1/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. diff --git a/docs/content/installation/install_detached.md b/docs/content/installation/install_detached.md index e098ab4ea..93577022c 100644 --- a/docs/content/installation/install_detached.md +++ b/docs/content/installation/install_detached.md @@ -122,11 +122,11 @@ Once the private registry is set up, the CatalogSource is configured and the IBM 1. Download the driver installation yaml ``` -curl https://raw.githubusercontent.com/IBM/ibm-block-csi-operator/v1.12.0/config/samples/csi.ibm.com_v1_ibmblockcsi_cr.yaml > csi.ibm.com_v1_ibmblockcsi_cr.yaml +curl https://raw.githubusercontent.com/IBM/ibm-block-csi-operator/v1.12.1/config/samples/csi.ibm.com_v1_ibmblockcsi_cr.yaml > csi.ibm.com_v1_ibmblockcsi_cr.yaml ``` 2. Update the driver installation yaml, setting all image paths and tags to match your private registry images 3. Optionally, download the HostDefiner driver installation yaml and update it, setting all iamge paths and tags to match your private registry images ``` - curl https://raw.githubusercontent.com/IBM/ibm-block-csi-operator/v1.12.0/config/samples/csi_v1_hostdefiner_cr.yaml > csi_v1_hostdefiner_cr.yaml + curl https://raw.githubusercontent.com/IBM/ibm-block-csi-operator/v1.12.1/config/samples/csi_v1_hostdefiner_cr.yaml > csi_v1_hostdefiner_cr.yaml ``` diff --git a/docs/content/installation/install_driver_github.md b/docs/content/installation/install_driver_github.md index 949f2b829..b4ebbe32e 100644 --- a/docs/content/installation/install_driver_github.md +++ b/docs/content/installation/install_driver_github.md @@ -14,7 +14,7 @@ Use the following steps to install the operator and driver, with [GitHub](https: 1. Download the manifest from GitHub. ``` - curl https://raw.githubusercontent.com/IBM/ibm-block-csi-operator/v1.12.0/deploy/installer/generated/ibm-block-csi-operator.yaml > ibm-block-csi-operator.yaml + curl https://raw.githubusercontent.com/IBM/ibm-block-csi-operator/v1.12.1/deploy/installer/generated/ibm-block-csi-operator.yaml > ibm-block-csi-operator.yaml ``` 2. (Optional) Update the image fields in the `ibm-block-csi-operator.yaml`. @@ -40,7 +40,7 @@ Use the following steps to install the operator and driver, with [GitHub](https: 1. Download the manifest from GitHub. ``` - curl https://raw.githubusercontent.com/IBM/ibm-block-csi-operator/v1.12.0/config/samples/csi.ibm.com_v1_ibmblockcsi_cr.yaml > csi.ibm.com_v1_ibmblockcsi_cr.yaml + curl https://raw.githubusercontent.com/IBM/ibm-block-csi-operator/v1.12.1/config/samples/csi.ibm.com_v1_ibmblockcsi_cr.yaml > csi.ibm.com_v1_ibmblockcsi_cr.yaml ``` 2. (Optional) Update the image repository field, tag field, or both in the `csi.ibm.com_v1_ibmblockcsi_cr.yaml`. diff --git a/docs/content/installation/install_hostdefiner_github.md b/docs/content/installation/install_hostdefiner_github.md index fd9f99dd0..99a9fe650 100644 --- a/docs/content/installation/install_hostdefiner_github.md +++ b/docs/content/installation/install_hostdefiner_github.md @@ -6,7 +6,7 @@ Use the following steps to install the HostDefiner custom resource, with [GitHub 1. Download the custom resource manifest from [GitHub](https://github.com/IBM/ibm-block-csi-operator). - curl https://raw.githubusercontent.com/IBM/ibm-block-csi-operator/v1.12.0/config/samples/csi_v1_hostdefiner_cr.yaml > csi_v1_hostdefiner_cr.yaml + curl https://raw.githubusercontent.com/IBM/ibm-block-csi-operator/v1.12.1/config/samples/csi_v1_hostdefiner_cr.yaml > csi_v1_hostdefiner_cr.yaml 2. Install the `csi_v1_hostdefiner_cr.yaml`. diff --git a/docs/content/release_notes/changelog_1.12.1.md b/docs/content/release_notes/changelog_1.12.1.md new file mode 100644 index 000000000..b63899b6c --- /dev/null +++ b/docs/content/release_notes/changelog_1.12.1.md @@ -0,0 +1,10 @@ +# 1.12.1 (January 2025) + +IBM® Block Storage CSI driver 1.12.1 added new support and enhancements. +- Extended support to RedHat OpenShift® 4.18 and 4.19 +- Extended support to Kubernetes 1.32 + +**Note:** + +- As of this document's publication date, IBM DS8000® family is not supported for this release. +- As of this document's publication date, IBM Power® and zLinux® architectures are not supported for this release. diff --git a/docs/content/release_notes/compatibility_requirements.md b/docs/content/release_notes/compatibility_requirements.md index 1bcaf0dc9..df2c1ea83 100644 --- a/docs/content/release_notes/compatibility_requirements.md +++ b/docs/content/release_notes/compatibility_requirements.md @@ -1,3 +1,3 @@ # Compatibility and requirements -This section specifies the compatibility and requirements of version 1.12.0 of IBM® block storage CSI driver. +This section specifies the compatibility and requirements of version 1.12.1 of IBM® block storage CSI driver. diff --git a/docs/content/release_notes/known_issues.md b/docs/content/release_notes/known_issues.md index ca35dfbfd..9111bb884 100644 --- a/docs/content/release_notes/known_issues.md +++ b/docs/content/release_notes/known_issues.md @@ -1,6 +1,6 @@ # Known issues -This section details the known issues in IBM® block storage CSI driver 1.12.0, along with possible solutions or workarounds (if available). +This section details the known issues in IBM® block storage CSI driver 1.12.1, along with possible solutions or workarounds (if available). The following severity levels apply to known issues: @@ -12,8 +12,8 @@ The following severity levels apply to known issues: **Important:** -- **The issues listed below apply to IBM block storage CSI driver 1.12.0**. As long as a newer version has not yet been released, a newer release notes edition for IBM block storage CSI driver 1.12.0 might be issued to provide a more updated list of known issues and workarounds. -- When a newer version is released for general availability, the release notes of this version will no longer be updated. Accordingly, check the release notes of the newer version to learn whether any newly discovered issues affect IBM block storage CSI driver 1.12.0 or whether the newer version resolves any of the issues listed below. +- **The issues listed below apply to IBM block storage CSI driver 1.12.1**. As long as a newer version has not yet been released, a newer release notes edition for IBM block storage CSI driver 1.12.1 might be issued to provide a more updated list of known issues and workarounds. +- When a newer version is released for general availability, the release notes of this version will no longer be updated. Accordingly, check the release notes of the newer version to learn whether any newly discovered issues affect IBM block storage CSI driver 1.12.1 or whether the newer version resolves any of the issues listed below. |Ticket ID|Severity|Description| |---------|--------|-----------| diff --git a/docs/content/release_notes/supported_orchestration.md b/docs/content/release_notes/supported_orchestration.md index ee8345e51..9591e3f4e 100644 --- a/docs/content/release_notes/supported_orchestration.md +++ b/docs/content/release_notes/supported_orchestration.md @@ -7,10 +7,13 @@ The following table details orchestration platforms suitable for deployment of t |Kubernetes| 1.29 |x86| |Kubernetes| 1.30 |x86| |Kubernetes| 1.31 |x86| +|Kubernetes| 1.32 |x86| |Red Hat OpenShift| 4.14 |x86| |Red Hat OpenShift| 4.15 |x86| |Red Hat OpenShift| 4.16 |x86| |Red Hat OpenShift| 4.17 |x86| +|Red Hat OpenShift| 4.18 |x86| +|Red Hat OpenShift| 4.19 |x86| **Note:** - 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). diff --git a/docs/content/release_notes/supported_storage.md b/docs/content/release_notes/supported_storage.md index 3a28e6055..a91bfc438 100644 --- a/docs/content/release_notes/supported_storage.md +++ b/docs/content/release_notes/supported_storage.md @@ -1,6 +1,6 @@ # Supported storage systems -IBM® block storage CSI driver 1.12.0 supports different IBM storage systems as listed in the following table. +IBM® block storage CSI driver 1.12.1 supports different IBM storage systems as listed in the following table. |Storage system|Microcode version| |--------------|-----------------| diff --git a/docs/content/release_notes/whats_new.md b/docs/content/release_notes/whats_new.md index aad01fa34..e47b06b93 100644 --- a/docs/content/release_notes/whats_new.md +++ b/docs/content/release_notes/whats_new.md @@ -1,12 +1,12 @@ -# What's new in 1.12.0 +# What's new in 1.12.1 -IBM® block storage CSI driver 1.12.0 is a major release that adds support for: +IBM® block storage CSI driver 1.12.1 is a minor release that adds support for: -- PVC ReadWriteMany (RWX) access mode -- New FlashSystem-specific configuration option for host definer to set the portset for new ports created by host definer +- RedHat OpenShift® 4.18 and 4.19 +- Kubernetes 1.32 -**General availability date:** December 2024 +**General availability date:** January 2025 ## Miscellaneous resolved issues -For information about the resolved issues in version 1.12.0, see [1.12.0 (December 2024)](changelog_1.12.0.md). +For information about the resolved issues in version 1.12.1, see [1.12.1 (January 2025)](changelog_1.12.1.md).