Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added docs for SCT feature Unity XT #752

Merged
merged 4 commits into from
Aug 16, 2023
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/docs/csidriver/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ The CSI Drivers by Dell implement an interface between [CSI](https://kubernetes-
| Topology | yes | yes | yes | yes | yes |
| Multi-array | yes | yes | yes | yes | yes |
| Volume Health Monitoring | yes | yes | yes | yes | yes |
| Storage Capacity Tracking | yes | no | no | yes | yes |
| Storage Capacity Tracking | yes | no | yes | yes | yes |
{{</table>}}
### Supported Storage Platforms
{{<table "table table-striped table-bordered table-sm">}}
Expand Down
10 changes: 10 additions & 0 deletions content/docs/csidriver/features/unity.md
Original file line number Diff line number Diff line change
Expand Up @@ -492,6 +492,16 @@ This feature:
```
By default this is disabled in CSI Driver for Unity XT. You will have to set the `healthMonitor.enable` flag for controller, node or for both in `values.yaml` to get the volume stats and volume condition.

## Storage Capacity Tracking
CSI for Unity XT driver version 2.8.0 and above supports Storage Capacity Tracking.

This feature helps the scheduler to make more informed choices about where to schedule pods which depends on unbound volumes with late binding (aka "wait for first consumer"). Pods will be scheduled on a node (satisfying the topology constraints) only if the requested capacity is available on the storage array.
If such a node is not available, the pods stay in Pending state. This means pods are not scheduled.

Without storage capacity tracking, pods get scheduled on a node satisfying the topology constraints. If the required capacity is not available, volume attachment to the pods fails, and pods remain in ContainerCreating state. Storage capacity tracking eliminates unnecessary scheduling of pods when there is insufficient capacity.

The attribute `storageCapacity.enabled` in `values.yaml` can be used to enable/disable the feature during driver installation using helm. This is by default set to true. To configure how often driver checks for changed capacity set `storageCapacity.pollInterval` attribute. In case of driver installed via operator, this interval can be configured in the sample file provided [here.](https://github.com/dell/csm-operator/blob/main/samples/storage_csm_unity_v280.yaml) by editing the `--capacity-poll-interval` argument present in the provisioner sidecar.

## Dynamic Logging Configuration

### Helm based installation
Expand Down
2 changes: 2 additions & 0 deletions content/docs/csidriver/installation/helm/unity.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,8 @@ Procedure
| podmon.image| pod man image name | false | - |
| tenantName | Tenant name added while adding host entry to the array | No | |
| fsGroupPolicy | Defines which FS Group policy mode to be used, Supported modes `None, File and ReadWriteOnceWithFSType` | No | "ReadWriteOnceWithFSType" |
| storageCapacity.enabled | Enable/Disable storage capacity tracking | No | true |
| storageCapacity.pollInterval | Configure how often the driver checks for changed capacity | No | 5m |
| **controller** | Allows configuration of the controller-specific parameters.| - | - |
| controllerCount | Defines the number of csi-unity controller pods to deploy to the Kubernetes release| Yes | 2 |
| volumeNamePrefix | Defines a string prefix for the names of PersistentVolumes created | Yes | "k8s" |
Expand Down
2 changes: 1 addition & 1 deletion content/docs/csidriver/installation/operator/unity.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ spec:
args: ["--snapshot-name-prefix=csiunitysnap"]
# Enable/Disable health monitor of CSI volumes from node plugin. Provides details of volume usage.
# - name: external-health-monitor
# args: ["--monitor-interval=60s"]
# args: ["--monitor-interval=60s"]

controller:
envs:
Expand Down
8 changes: 2 additions & 6 deletions content/docs/csidriver/release/unity.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,11 @@ title: Unity XT
description: Release notes for Unity XT CSI driver
---

## Release Notes - CSI Unity XT v2.7.0
## Release Notes - CSI Unity XT v2.8.0

### New Features/Changes

- [Migrated image registry from k8s.gcr.io to registry.k8s.io](https://github.com/dell/csm/issues/744)
- [Added support for OpenShift 4.12](https://github.com/dell/csm/issues/571)
- [Added support for Kubernetes 1.27](https://github.com/dell/csm/issues/761)
- [Added support for K3s on Debian OS](https://github.com/dell/csm/issues/798)
- [Added support for Unisphere 5.3.0 array](https://github.com/dell/csm/issues/842)
- [Added support for Storage Capacity Tracking for Unity XT](https://github.com/dell/csm/issues/876)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add this under release notes for csm-operator as well

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

### Fixed Issues

Expand Down
2 changes: 2 additions & 0 deletions content/docs/deployment/csmoperator/drivers/unity.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@ kubectl get csm --all-namespaces
| replicas | Controls the number of controller pods you deploy. If the number of controller pods is greater than the number of available nodes, the excess pods will be in pending state until new nodes are available for scheduling. Default is 2 which allows for Controller high availability. | Yes | 2 |
| namespace | Specifies namespace where the driver will be installed | Yes | "unity" |
| fsGroupPolicy | Defines which FS Group policy mode to be used. Supported modes `None, File and ReadWriteOnceWithFSType` | No |"ReadWriteOnceWithFSType"|
| storageCapacity.enabled | Enable/Disable storage capacity tracking | No | true |
| storageCapacity.pollInterval | Configure how often the driver checks for changed capacity | No | 5m |
| ***Common parameters for node and controller*** |
| X_CSI_UNITY_ALLOW_MULTI_POD_ACCESS | To enable sharing of volumes across multiple pods within the same node in RWO access mode | No | false |
| X_CSI_UNITY_SYNC_NODEINFO_INTERVAL | Time interval to add node info to array. Default 15 minutes. Minimum value should be 1 | No | 15 |
Expand Down
12 changes: 1 addition & 11 deletions content/docs/deployment/csmoperator/release/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,9 @@ Description: >
## Release Notes - Container Storage Modules Operator v1.2.0

### New Features/Changes
- [Added support for CSI Unity XT Driver](https://github.com/dell/csm/issues/756)
- [Added support for PowerMax Driver](https://github.com/dell/csm/issues/769)
- [Added Replication Support for PowerFlex driver](https://github.com/dell/csm/issues/821)
- [CSM Operator: Support install of Resiliency module](https://github.com/dell/csm/issues/739)
- [Migrated image registry from k8s.gcr.io to registry.k8s.io](https://github.com/dell/csm/issues/744)
- [Added support for OpenShift 4.12](https://github.com/dell/csm/issues/571)
- [Added support for Kubernetes 1.27](https://github.com/dell/csm/issues/761)

- [Added support for Storage Capacity Tracking feature for Unity XT via csm operator](https://github.com/dell/csm/issues/876)

### Fixed Issues
- [CSM object goes into failed state when deployments are getting scaled down/up](https://github.com/dell/csm/issues/816)
- [Install issues of the Replication module have been fixed](https://github.com/dell/csm/issues/788)


### Known Issues
There are no known issues in this release.