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

CSM Operator document changes for CSM 1.9.1 patch release #958

Merged
merged 9 commits into from
Jan 25, 2024
Merged
Changes from 6 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
8 changes: 4 additions & 4 deletions content/docs/deployment/csmoperator/_index.md
Original file line number Diff line number Diff line change
@@ -64,7 +64,7 @@ The installation process involves the creation of a `Subscription` object either
1. Install volume snapshot CRDs. For detailed snapshot setup procedure, [click here](../../snapshots/#volume-snapshot-feature).
2. Clone and checkout the required csm-operator version using
```bash
git clone -b v1.4.0 https://github.com/dell/csm-operator.git
git clone -b v1.4.1 https://github.com/dell/csm-operator.git
```
3. `cd csm-operator`
4. _(Optional)_ If using a local Docker image, edit the `deploy/operator.yaml` file and set the image name for the CSM Operator Deployment.
@@ -136,7 +136,7 @@ This needs to be performed on a Linux system with access to the Internet as a gi
To build an offline bundle, the following steps are needed:
1. Clone and checkout the required csm-operator version using
```bash
git clone -b v1.4.0 https://github.com/dell/csm-operator.git
git clone -b v1.4.1 https://github.com/dell/csm-operator.git
```
2. `cd csm-operator`
3. Run the `csm-offline-bundle.sh` script which will be found in the `scripts` directory with an argument of `-c` in order to create an offline bundle
@@ -175,7 +175,7 @@ Here is the output of a request to build an offline bundle for the Dell CSM Oper
dellemc/dell-csi-replicator:v1.7.0
dellemc/dell-replication-controller:v1.7.0
dellemc/sdc:4.5
docker.io/dellemc/dell-csm-operator:v1.4.0
docker.io/dellemc/dell-csm-operator:v1.4.1
gcr.io/kubebuilder/kube-rbac-proxy:v0.8.0
nginxinc/nginx-unprivileged:1.20
otel/opentelemetry-collector:0.42.0
@@ -342,7 +342,7 @@ The `Update approval` (**`InstallPlan`** in OLM terms) strategy plays a role whi
#### Using Installation Script
1. Clone and checkout the required csm-operator version using
```bash
git clone -b v1.4.0 https://github.com/dell/csm-operator.git
git clone -b v1.4.1 https://github.com/dell/csm-operator.git
```
2. `cd csm-operator`
3. Execute `bash scripts/install.sh --upgrade` . This command will install the latest version of the operator.
39 changes: 37 additions & 2 deletions content/docs/deployment/csmoperator/release/_index.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@ Description: >
Release notes for Dell Container Storage Modules Operator
---

## Release Notes - Container Storage Modules Operator v1.4.0
## Release Notes - Container Storage Modules Operator v1.4.1



@@ -31,4 +31,39 @@ Description: >
- [#990 - [BUG]: X_CSI_AUTH_TYPE cannot be set in CSM Operator](https://github.com/dell/csm/issues/990)

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

| Issue | Workaround |
|-------|------------|
| It appears that the images of sideCars are currently missing in the sample YAMLs in the offline bundle. As a consequence, the csm-operator is pulling them from registry.k8s.io. | We recommend manually updating the images of sideCars in the sample YAML file, for example, `storage_csm_powerflex_v290.yaml`, before proceeding with the driver installation. Here is an example snippet for the sideCars section in the YAML file:

```yaml
sideCars:
# 'k8s' represents a string prepended to each volume created by the CSI driver
- name: provisioner
image: <localregistry>/csi-provisioner:v3.6.2
args: ["--volume-name-prefix=k8s"]
- name: attacher
image: <localregistry>/csi-attacher:v4.4.2
- name: registrar
image: <localregistry>/csi-node-driver-registrar:v2.9.1
- name: resizer
image: <localregistry>/csi-resizer:v1.9.2
- name: snapshotter
image: <localregistry>/csi-snapshotter:v6.3.2

# sdc-monitor is disabled by default, due to high CPU usage
- name: sdc-monitor
enabled: false
image: <localregistry>/sdc:4.5
envs:
- name: HOST_PID
value: "1"
- name: MDM
value: "10.xx.xx.xx,10.xx.xx.xx" # Do not add mdm value here if it is present in secret

# health monitor is disabled by default, refer to driver documentation before enabling it
# Also set the env variable controller.envs.X_CSI_HEALTH_MONITOR_ENABLED to "true".
- name: csi-external-health-monitor-controller
enabled: false
image: <localregistry>/csi-external-health-monitor-controller:v0.10.0
args: ["--monitor-interval=60s"]