Skip to content

Commit

Permalink
Prepare CSM-Operator for 1.6.0 release (#604)
Browse files Browse the repository at this point in the history
* update csm-operator version

* update driver sample files and fix linting errors

* upgrade modules

* update sidecars

* update config version

* update sidecars and ocp version
  • Loading branch information
ChristianAtDell committed Oct 15, 2024
1 parent 367b1f0 commit d3b7540
Show file tree
Hide file tree
Showing 197 changed files with 4,956 additions and 3,874 deletions.
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ LABEL vendor="Dell Inc." \
name="dell-csm-operator" \
summary="Operator for installing Dell CSI Drivers and Dell CSM Modules" \
description="Common Operator for installing various Dell CSI Drivers and Dell CSM Modules" \
version="1.5.1" \
version="1.6.0" \
license="Dell CSM Operator Apache License"

# copy the licenses folder
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ OPM = $(shell which opm)
endif
endif

# A comma-separated list of bundle images (e.g. make catalog-build BUNDLE_IMGS=example.com/operator-bundle:v0.1.0,example.com/operator-bundle:v1.5.1).
# A comma-separated list of bundle images (e.g. make catalog-build BUNDLE_IMGS=example.com/operator-bundle:v0.1.0,example.com/operator-bundle:v1.6.0).
# These images MUST exist in a registry and be pull-able.
BUNDLE_IMGS ?= $(BUNDLE_IMG)

Expand Down
25 changes: 19 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ You may obtain a copy of the License at
-->

# Dell Technologies Container Storage Modules (CSM) Operator

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](https://github.com/dell/csm/blob/main/docs/CODE_OF_CONDUCT.md)
[![License](https://img.shields.io/github/license/dell/csm-operator)](LICENSE)
[![Docker Pulls](https://img.shields.io/docker/pulls/dellemc/dell-csm-operator)](https://hub.docker.com/r/dellemc/dell-csm-operator)
Expand All @@ -27,14 +28,15 @@ Dell Technologies Container Storage Modules (CSM) Operator is an open-source Kub
* [List of Adopters](./docs/ADOPTERS.md)
* [Support](./docs/SUPPORT.md)
* [Security](./docs/SECURITY.md)
* [Dell Container Storage Modules Operator](#dell-csm-operator)
* [Dell Container Storage Modules Operator](#dell-container-storage-modules-operator)
* [Support](#support)
* [Supported Platforms](#supported-platforms)
* [Installation](#installation)
* [Install CSI Drivers and CSM Modules](#install-csi-drivers-and-csm-modules)
* [Uninstall CSI Drivers and CSM Modules](#uninstall-csi-drivers-and-csm-modules)

# Dell Container Storage Modules Operator

Dell Container Storage Modules Operator is a Kubernetes native application which helps in installing and managing CSI Drivers and CSM Modules provided by Dell Technologies for its various storage platforms.
Dell Container Storage Modules Operator uses Kubernetes CRDs (Custom Resource Definitions) to define a manifest that describes the deployment specifications for each driver to be deployed.

Expand All @@ -51,18 +53,21 @@ Currently, the Dell Container Storage Modules Operator can be used to deploy the
**NOTE**: You can refer to additional information about the Dell Container Storage Modules Operator on the new documentation website [here](https://dell.github.io/csm-docs/docs/deployment/csmoperator/)

## Support

The Dell Container Storage Modules Operator image is available on Dockerhub and is officially supported by Dell Technologies.
For any CSM Operator and driver issues, questions or feedback, join the [Dell Technologies Container community](https://www.dell.com/community/Containers/bd-p/Containers) or the [Slack channel for Dell Container Storage Modules](https://dellemccsm.slack.com/).

## Supported Platforms

Dell Container Storage Modules Operator has been tested and qualified with

* Upstream Kubernetes cluster v1.27, v1.28, v1.29
* OpenShift Clusters 4.13, 4.14, 4.15 with RHEL 8.x & RHCOS worker nodes
* Upstream Kubernetes cluster v1.28, v1.29, v1.30
* OpenShift Clusters 4.14, 4.15 with RHEL 8.x & RHCOS worker nodes

## Installation

## Install Operator (both OLM and Non OLM) in dev mode

1. Clone the repo: `git clone https://github.com/dell/csm-operator.git`
2. Navigate one level inside the cloned repo: `cd csm-operator`
3. Execute `make install` to install the CRDs
Expand All @@ -74,12 +79,15 @@ NOTE: Closing the session where operator is running will stop the operator.
## Install Operator using scripts

### Operator install on a cluster without OLM

For Non OLM based install of Operator please refer the steps given here at [https://dell.github.io/csm-docs/docs/deployment/csmoperator/#operator-installation-on-a-cluster-without-olm](https://dell.github.io/csm-docs/docs/deployment/csmoperator/#operator-installation-on-a-cluster-without-olm)

To uninstall the Operator, execute `bash scripts/uninstall.sh`

### Operator install on a cluster with OLM

NOTE: Index image or Catalog image should be used for OLM based install of Operator. This mode of install is used only for internal testing purposes as the bundle and index/catalog images are not posted in Dockerhub.

1. Clone the repo: `git clone https://github.com/dell/csm-operator.git`
2. Navigate one level inside the cloned repo: `cd csm-operator`
3. Update the image specified in `deploy/olm/operator_community.yaml` to the required image.
Expand All @@ -88,31 +96,36 @@ To uninstall the Operator, execute `bash scripts/uninstall.sh`
To uninstall the Operator, execute `bash scripts/uninstall_olm.sh`

### Operator install using offline bundle on a cluster without OLM
For Non OLM based install of Operator using offline bundle please refer the steps given here at [https://dell.github.io/csm-docs/docs/deployment/csmoperator/#offline-bundle-installation-on-a-cluster-without-olm](https://dell.github.io/csm-docs/docs/deployment/csmoperator/#offline-bundle-installation-on-a-cluster-without-olm)

For Non OLM based install of Operator using offline bundle please refer the steps given here at [https://dell.github.io/csm-docs/docs/deployment/csmoperator/#offline-bundle-installation-on-a-cluster-without-olm](https://dell.github.io/csm-docs/docs/deployment/csmoperator/#offline-bundle-installation-on-a-cluster-without-olm)

## Install CSI Drivers and CSM Modules

To install CSI drivers and CSM modules using the operator please refer here at [https://dell.github.io/csm-docs/docs/deployment/csmoperator/](https://dell.github.io/csm-docs/docs/deployment/csmoperator/)

## Uninstall CSI Drivers and CSM Modules

To uninstall CSI drivers and CSM modules installed using the operator please refer here at [https://dell.github.io/csm-docs/docs/deployment/csmoperator/](https://dell.github.io/csm-docs/docs/deployment/csmoperator/).

## Install Apex Connectivity Client

1. Ensure that CSM Operator is installed and the operator pods are up and running.
2. Edit the images to point to the correct location in `connectivity_client_v100.yaml` sample file located at `csm-operator\samples` folder.
3. To deploy Apex Connectivity Client, execute `kubectl create -f samples\connectivity_client_v100.yaml`.
4. Ensure that the Apex Connectivity Client pods are up and running.

## Update Apex Connectivity Client

1. Ensure that CSM Operator is installed and the operator pods are up and running.
2. Edit the required images to point to the correct location in `connectivity_client_v100.yaml` sample file located at `csm-operator\samples` folder.
3. To update Apex Connectivity Client, execute `kubectl apply -f samples\connectivity_client_v100.yaml`.
4. Ensure that the Apex Connectivity Client pods are up and running.

## Uninstall Apex Connectivity Client

1. Ensure that CSM Operator is installed and the operator pods are up and running.
3. To uninstall Apex Connectivity Client, execute `kubectl delete -f samples\connectivity_client_v100.yaml`
4. Ensure that the Apex Connectivity Client pods are deleted.
2. To uninstall Apex Connectivity Client, execute `kubectl delete -f samples\connectivity_client_v100.yaml`
3. Ensure that the Apex Connectivity Client pods are deleted.

## Versioning

Expand Down
2 changes: 1 addition & 1 deletion bundle.Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ LABEL operators.operatorframework.io.metrics.project_layout=go.kubebuilder.io/v3
# Labels for testing.
LABEL operators.operatorframework.io.test.mediatype.v1=scorecard+v1
LABEL operators.operatorframework.io.test.config.v1=tests/scorecard/
LABEL com.redhat.openshift.versions=v4.13-v4.15
LABEL com.redhat.openshift.versions=v4.14-v4.15
LABEL com.redhat.delivery.backport=false
LABEL com.redhat.delivery.operator.bundle=true

Expand Down
Loading

0 comments on commit d3b7540

Please sign in to comment.