Skip to content

Commit

Permalink
1.12.1 documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
kasserater committed Dec 23, 2024
1 parent 8181971 commit e15f4f8
Show file tree
Hide file tree
Showing 14 changed files with 36 additions and 22 deletions.
3 changes: 2 additions & 1 deletion docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion docs/book_files/csi_block_storage_kc_rn.md
Original file line number Diff line number Diff line change
@@ -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.

4 changes: 2 additions & 2 deletions docs/book_files/csi_block_storage_kc_whatsnew.md
Original file line number Diff line number Diff line change
@@ -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.<br>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.<br>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. |

2 changes: 1 addition & 1 deletion docs/content/configuration/configuring_hostdefiner.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.<br>Input values are `true` or `false`.<br>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).
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/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.
Expand Down
4 changes: 2 additions & 2 deletions docs/content/installation/install_detached.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

4 changes: 2 additions & 2 deletions docs/content/installation/install_driver_github.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand All @@ -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`.
Expand Down
2 changes: 1 addition & 1 deletion docs/content/installation/install_hostdefiner_github.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down
10 changes: 10 additions & 0 deletions docs/content/release_notes/changelog_1.12.1.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion docs/content/release_notes/compatibility_requirements.md
Original file line number Diff line number Diff line change
@@ -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.
6 changes: 3 additions & 3 deletions docs/content/release_notes/known_issues.md
Original file line number Diff line number Diff line change
@@ -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:

Expand All @@ -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|
|---------|--------|-----------|
Expand Down
3 changes: 3 additions & 0 deletions docs/content/release_notes/supported_orchestration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
2 changes: 1 addition & 1 deletion docs/content/release_notes/supported_storage.md
Original file line number Diff line number Diff line change
@@ -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|
|--------------|-----------------|
Expand Down
12 changes: 6 additions & 6 deletions docs/content/release_notes/whats_new.md
Original file line number Diff line number Diff line change
@@ -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).

0 comments on commit e15f4f8

Please sign in to comment.