Skip to content

Commit

Permalink
Update manifests and Readme in tests (#274)
Browse files Browse the repository at this point in the history
  • Loading branch information
@rensyct
rensyct authored Jun 7, 2023
1 parent f57a784 commit e2719ef
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 46 deletions.
2 changes: 1 addition & 1 deletion bundle.Dockerfile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,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.10
LABEL com.redhat.openshift.versions=v4.11-v4.12
LABEL com.redhat.delivery.backport=false
LABEL com.redhat.delivery.operator.bundle=true

Expand Down
43 changes: 21 additions & 22 deletions bundle/manifests/dell-csm-operator.clusterserviceversion.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1486,28 +1486,27 @@ spec:
version: v1
description: "Dell Container Storage Modules (CSM) Operator is a Kubernetes Operator
which can be \nused to install and manage Dell’s CSI drivers and CSM modules.
\nBy using Dell CSM Operator, enterprises can quickly and easily
deploy the \nCSM modules for CSI drivers making it
easy for DevOps \nteams to build and optimize their Kubernetes workloads using
enterprise grade storage \nwhile consistently aligning with the desired outcomes
of the organization.\nThis operator is available as both community and
certified operator for Openshift \nand as a community operator for
upstream Kubernetes.\nOperator can be deployed via OperatorHub.io.
using Operator Lifecycle Manager (OLM)\n\n### About Dell CSM\n\nDell CSM brings
powerful enterprise storage features and functionality to Kubernetes for \neasier
adoption of cloud native workloads, improved productivity and scalable operations.
\n\nCSM delivers software modules for storage management that provide developers
access to \nbuild automation for enhanced IT needs and other critical enterprise
storage features. \n\nCurrently, the following modules are available as part of
Dell CSM. \n*\tObservability - Delivers a high-level view of the storage capacity
\n and performance usage via Grafana dashboards to the Kubernetes users\n*\tReplication
- Enables array replication capabilities for Kubernetes users\n*\tAuthorization
- Provides both storage and Kubernetes administrators the ability \n to apply
RBAC for Dell EMC CSI Drivers\n*\tResiliency - Designed to make Kubernetes applications
more resilient to \n node failures\n\nThese modules are available for various
storage platforms in the Dell portfolio, \nsuch as Dell PowerStore, Dell PowerMax,
Dell PowerFlex, Dell PowerScale, and Dell Unity XT.\n\nFor more information, visit
[Dell’s Container Storage Module web page](https://www.dell.com/en-us/dt/solutions/kubernetes-containers/kubernetes-storage.htm)\n\nAdditional
\nBy using Dell CSM Operator, enterprises can quickly and easily deploy the \nCSM
modules for CSI drivers making it easy for DevOps \nteams to build and optimize
their Kubernetes workloads using enterprise grade storage \nwhile consistently
aligning with the desired outcomes of the organization.\nThis operator is available
as both community and certified operator for Openshift \nand as a community operator
for upstream Kubernetes.\nOperator can be deployed via OperatorHub.io. using Operator
Lifecycle Manager (OLM)\n\n### About Dell CSM\n\nDell CSM brings powerful enterprise
storage features and functionality to Kubernetes for \neasier adoption of cloud
native workloads, improved productivity and scalable operations. \n\nCSM delivers
software modules for storage management that provide developers access to \nbuild
automation for enhanced IT needs and other critical enterprise storage features.
\n\nCurrently, the following modules are available as part of Dell CSM. \n*\tObservability
- Delivers a high-level view of the storage capacity \n and performance usage
via Grafana dashboards to the Kubernetes users\n*\tReplication - Enables array
replication capabilities for Kubernetes users\n*\tAuthorization - Provides both
storage and Kubernetes administrators the ability \n to apply RBAC for Dell EMC
CSI Drivers\n*\tResiliency - Designed to make Kubernetes applications more resilient
to \n node failures\n\nThese modules are available for various storage platforms
in the Dell portfolio, \nsuch as Dell PowerStore, Dell PowerMax, Dell PowerFlex,
Dell PowerScale, and Dell Unity XT.\n\nFor more information, visit [Dell’s Container
Storage Module web page](https://www.dell.com/en-us/dt/solutions/kubernetes-containers/kubernetes-storage.htm)\n\nAdditional
Materials\n*\t[CSM Operator GitHub Page](https://dell.github.io/csm-docs/docs/deployment/csmoperator/)\n*\t[CSM
Introduction Video](https://www.youtube.com/watch?v=NtNSKdF9Iyo)\n*\t[CSM Solution
Brief](https://www.delltechnologies.com/asset/en-us/products/storage/briefs-summaries/csm-solution-brief.pdf)\n*\t[CSI
Expand Down
43 changes: 21 additions & 22 deletions config/manifests/bases/dell-csm-operator.clusterserviceversion.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -422,28 +422,27 @@ spec:
version: v1
description: "Dell Container Storage Modules (CSM) Operator is a Kubernetes Operator
which can be \nused to install and manage Dell’s CSI drivers and CSM modules.
\nBy using Dell CSM Operator, enterprises can quickly and easily
deploy the \nCSM modules for CSI drivers making it
easy for DevOps \nteams to build and optimize their Kubernetes workloads using
enterprise grade storage \nwhile consistently aligning with the desired outcomes
of the organization.\nThis operator is available as both community and
certified operator for Openshift \nand as a community operator for
upstream Kubernetes.\nOperator can be deployed via OperatorHub.io.
using Operator Lifecycle Manager (OLM)\n\n### About Dell CSM\n\nDell CSM brings
powerful enterprise storage features and functionality to Kubernetes for \neasier
adoption of cloud native workloads, improved productivity and scalable operations.
\n\nCSM delivers software modules for storage management that provide developers
access to \nbuild automation for enhanced IT needs and other critical enterprise
storage features. \n\nCurrently, the following modules are available as part of
Dell CSM. \n*\tObservability - Delivers a high-level view of the storage capacity
\n and performance usage via Grafana dashboards to the Kubernetes users\n*\tReplication
- Enables array replication capabilities for Kubernetes users\n*\tAuthorization
- Provides both storage and Kubernetes administrators the ability \n to apply
RBAC for Dell EMC CSI Drivers\n*\tResiliency - Designed to make Kubernetes applications
more resilient to \n node failures\n\nThese modules are available for various
storage platforms in the Dell portfolio, \nsuch as Dell PowerStore, Dell PowerMax,
Dell PowerFlex, Dell PowerScale, and Dell Unity XT.\n\nFor more information, visit
[Dell’s Container Storage Module web page](https://www.dell.com/en-us/dt/solutions/kubernetes-containers/kubernetes-storage.htm)\n\nAdditional
\nBy using Dell CSM Operator, enterprises can quickly and easily deploy the \nCSM
modules for CSI drivers making it easy for DevOps \nteams to build and optimize
their Kubernetes workloads using enterprise grade storage \nwhile consistently
aligning with the desired outcomes of the organization.\nThis operator is available
as both community and certified operator for Openshift \nand as a community operator
for upstream Kubernetes.\nOperator can be deployed via OperatorHub.io. using Operator
Lifecycle Manager (OLM)\n\n### About Dell CSM\n\nDell CSM brings powerful enterprise
storage features and functionality to Kubernetes for \neasier adoption of cloud
native workloads, improved productivity and scalable operations. \n\nCSM delivers
software modules for storage management that provide developers access to \nbuild
automation for enhanced IT needs and other critical enterprise storage features.
\n\nCurrently, the following modules are available as part of Dell CSM. \n*\tObservability
- Delivers a high-level view of the storage capacity \n and performance usage
via Grafana dashboards to the Kubernetes users\n*\tReplication - Enables array
replication capabilities for Kubernetes users\n*\tAuthorization - Provides both
storage and Kubernetes administrators the ability \n to apply RBAC for Dell EMC
CSI Drivers\n*\tResiliency - Designed to make Kubernetes applications more resilient
to \n node failures\n\nThese modules are available for various storage platforms
in the Dell portfolio, \nsuch as Dell PowerStore, Dell PowerMax, Dell PowerFlex,
Dell PowerScale, and Dell Unity XT.\n\nFor more information, visit [Dell’s Container
Storage Module web page](https://www.dell.com/en-us/dt/solutions/kubernetes-containers/kubernetes-storage.htm)\n\nAdditional
Materials\n*\t[CSM Operator GitHub Page](https://dell.github.io/csm-docs/docs/deployment/csmoperator/)\n*\t[CSM
Introduction Video](https://www.youtube.com/watch?v=NtNSKdF9Iyo)\n*\t[CSM Solution
Brief](https://www.delltechnologies.com/asset/en-us/products/storage/briefs-summaries/csm-solution-brief.pdf)\n*\t[CSI
Expand Down
2 changes: 1 addition & 1 deletion tests/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ Most steps to cover common use cases already have their respective backend imple

1. `Fully recycled old step`: If the desired steps has already been covered in another test scenario, just copy line for line. You don't need any code change
2. `partially recycled old step`: In this case, a very similar test has already been cover. This means there's already an entrypoint in `steps`. You should review the `StepRunnerInit` function at [step_runner.go](https://github.com/dell/csm-operator/blob/main/tests/e2e/steps/steps_runner.go) and trace the implementation function that matches your step. For example the step `"Validate [world] module is installed"`. The line that matches this in `StepRunnerInit` is `runner.addStep(`^Validate \[([^"]*)\] module is installed$`, step.validateModuleInstalled)`. The implementation to trace is `step.validateModuleInstalled`. We will review the implementation function in [steps_def.go](https://github.com/dell/csm-operator/blob/main/tests/e2e/steps/steps_def.go) to decide whether or not we need to do anything. Make the code changes if needed.
3. `new step`: New step can be simple such as `"Validate Today is Tuesday"` or a templated such as `["Validate it is [raining]"](https://jira.cec.lab.emc.com/browse/KRV-3130)`. The workflow to support these two cases is the same and only varies in the signature of the implementation function. The workflow include:
3. `new step`: New step can be simple such as `"Validate Today is Tuesday"` or a templated such as `["Validate it is [raining]"](https://example.com)`. The workflow to support these two cases is the same and only varies in the signature of the implementation function. The workflow include:
1. Implement steps in [steps_def.go](https://github.com/dell/csm-operator/blob/main/tests/e2e/steps/steps_def.go). Define a function to implement your step. Note that the steps are stateless! If you want to define a function to test a happy path, your function should return nil if no error occurs and error otherwise. However, if you want to test an error path, your function should return nil if you get error and error otherwise. The constraints of all functions in step_def.go is as follows:
- must return `error` or `nil`
- must take at least one argument. The first one MUST be type `Resource`(even though it may not be used). If your step has any group(a groups is anything in your step enclosed by `[]`), the remaining arguments should be the groups in the order they appear on the steps(from left to right). For example, the two new functions above will can be implemented as shown below:
Expand Down

0 comments on commit e2719ef

Please sign in to comment.