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

Update cert-csi version #1343

Merged
merged 1 commit into from
Oct 30, 2024
Merged
Changes from all 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
30 changes: 13 additions & 17 deletions content/docs/support/cert-csi/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Any orchestrator platform, operating system or version that is not mentioned in

You may qualify your environment for Dell CSI Drivers by executing the [Run All Test Suites](#run-all-test-suites) workflow.

Please submit your test results for our review [here](https://github.com/dell/csm/issues/new?assignees=&labels=type%2Fqualification&projects=&template=community_qualification.yml&title=%5BQualification%5D%3A+). If the results are a success, the orchestrator platform and version will be published under Community Qualified Configurations.
Please submit your test results for our review [here](https://github.com/dell/csm/issues/new?assignees=&labels=type%2Fqualification&projects=&template=community_qualification.yml&title=%5BQualification%5D%3A+). If the results are a success, the orchestrator platform and version will be published under Community Qualified Configurations.

## Installation

Expand All @@ -28,11 +28,7 @@ There are three methods of installing `cert-csi`.
### Download Release (Linux)
> NOTE: Please ensure you delete any previously downloaded Cert-CSI binaries, as each release uses the same name (`cert-csi-linux-amd64`). After installing the latest version, run the `cert-csi -v` command to verify the installed version.

1. Download the latest release of the cert-csi zip file.

```bash
wget https://github.com/dell/cert-csi/releases/download/v1.5.0/cert-csi-linux-amd64
```
1. Download `cert-csi` from [here](https://github.com/dell/cert-csi/releases/latest/download/cert-csi-linux-amd64)

2. Set the execute permission before running it.

Expand Down Expand Up @@ -78,7 +74,7 @@ mv ./cert-csi-linux-amd64 ~/.local/bin/cert-csi
1. Clone the repository

```bash
git clone -b "v1.5.0" https://github.com/dell/cert-csi.git && cd cert-csi
git clone -b "v1.6.0" https://github.com/dell/cert-csi.git && cd cert-csi
```

2. Build cert-csi
Expand Down Expand Up @@ -132,11 +128,11 @@ make install-ms

## Run All Test Suites

You can use cert-csi to launch a test run against multiple storage classes to check if the driver adheres to advertised capabilities.
You can use cert-csi to launch a test run against multiple storage classes to check if the driver adheres to advertised capabilities.

#### Preparing Config

To run the test suites you need to provide `.yaml` config with storage classes and their capabilities. You can use `example-certify-config.yaml` as an example.
To run the test suites you need to provide `.yaml` config with storage classes and their capabilities. You can use `example-certify-config.yaml` as an example.

Template:
```yaml
Expand All @@ -161,7 +157,7 @@ storageClasses:
attr2: # volume attr for EphemeralVolumeSuite
capacityTracking:
driverNamespace: # namepsace where driver is installed
pollInterval: # duration to poll capacity (e.g., 2m)
pollInterval: # duration to poll capacity (e.g., 2m)
```

Driver specific examples:
Expand Down Expand Up @@ -425,7 +421,7 @@ Run `cert-csi test scaling -h` for more options.
11. Verifies the checksum of the data.

```bash
cert-csi test snap --sc <storage class> --vsc <volume snapshot class>
cert-csi test snap --sc <storage class> --vsc <volume snapshot class>
```

Run `cert-csi test snap -h` for more options.
Expand Down Expand Up @@ -474,7 +470,7 @@ Run `cert-csi test multi-attach-vol -h` for more options.
10. Verifies the replication group name on ersistent Volume Claims.

```bash
cert-csi test replication --sc <storage class> --vsc <snapshot class>
cert-csi test replication --sc <storage class> --vsc <snapshot class>
```

Run `cert-csi test replication -h` for more options.
Expand Down Expand Up @@ -517,7 +513,7 @@ Run `cert-csi test expansion -h` for more options.
2. Creates Persistent Volume Claim.
3. If the specified storage class binding mode is not `WaitForFirstConsumer`, waits for Persistent Volume Claim to be bound to Persistent Volumes.
4. Creates Pod to consume the Persistent Volume Claim.
5. Writes data to the volume.
5. Writes data to the volume.
5. Creates a Volume Snapshot from the Persistent Volume Claim.
6. Waits for the Volume Snapshot to be Ready.
7. Create a Persistent Volume Claim with raw block volume mode from the Volume Snapshot.
Expand Down Expand Up @@ -657,7 +653,7 @@ To use this feature, run cert-csi with the option `--image-config /path/to/confi
## Kubernetes End-To-End Tests
All Kubernetes end to end tests require that you provide the driver config based on the storage class you want to test and the version of the kubernetes you want to test against. These are the mandatory parameters that you can provide in command like..
```bash
--driver-config <path of driver config file> and --version "v1.25.0"
--driver-config <path of driver config file> and --version "v1.25.0"
```

### Running kubernetes end-to-end tests
Expand Down Expand Up @@ -687,7 +683,7 @@ cert-csi k8s-e2e --config <kube config> --driver-config <path to driver config>
./cert-csi k8s-e2e --config "/root/.kube/config" --driver-config "/root/e2e_config/config-iscsi.yaml" --focus "External.Storage.*" --timeout "2h" --version "v1.25.0" --focus-file "capacity.go"
```

### Interacting with DB
### Interacting with DB

#### Generating report from runs without running tests

Expand Down Expand Up @@ -726,7 +722,7 @@ Options:
To generate report from multiple databases, run the command:
```bash
cert-csi report --tr <db-path>:<test-run-name> --tr ... --tabular --xml
Supported report types:
Supported report types:
--xml
--tabular
```
Expand Down Expand Up @@ -755,7 +751,7 @@ Commands:

To run tests with driver resource usage metrics enabled, run the command:
```bash
cert-csi test <test suite> --sc <storage class> <...> --ns <driver namespace>
cert-csi test <test suite> --sc <storage class> <...> --ns <driver namespace>
```

#### Running custom hooks from program
Expand Down
Loading