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

Docsy dependency latest version update #1205

Merged
merged 9 commits into from
Jul 31, 2024
Merged
Show file tree
Hide file tree
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: 8 additions & 0 deletions .cspell.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# cSpell:ignore textlintrc
# For settings, see
# https://www.streetsidesoftware.com/vscode-spell-checker/docs/configuration/
version: '0.2'
caseSensitive: true
words:
Copy link
Collaborator

Choose a reason for hiding this comment

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

We can remove this file @WilsonRadadia20

- Docsy
- Goldydocs
6 changes: 3 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
node_modules/
public/
/public
resources/
node_modules/
.hugo_build.lock
coverage/
reports/
reports/
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
lts/*
15 changes: 15 additions & 0 deletions config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# THIS IS A TEST CONFIG ONLY!
# FOR THE CONFIGURATION OF YOUR SITE USE hugo.yaml.
#
# As of Docsy 0.7.0, Hugo 0.110.0 or later must be used.
#
# The sole purpose of this config file is to detect Hugo-module builds that use
# an older version of Hugo.
#
# DO NOT add any config parameters to this file. You can safely delete this file
# if your project is using the required Hugo version.

module:
hugoVersion:
extended: true
min: 0.110.0
Copy link
Collaborator

Choose a reason for hiding this comment

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

We can remove this file @WilsonRadadia20

4 changes: 2 additions & 2 deletions content/_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@

{{< blocks/cover title="Welcome to Dell Technologies Container Storage Modules documentation!" image_anchor="top" height="max" color="primary" >}}
<div class="mx-auto">
<a class="btn btn-lg btn-primary mr-3 mb-4" href="{{< relref "/docs" >}}">
Learn More <i class="fas fa-arrow-alt-circle-right ml-2"></i>
<a class="btn btn-lg btn-primary me-3 mb-4" href="/csm-docs/docs/">
Learn More <i class="fas fa-arrow-alt-circle-right ms-2"></i>
</a>
</div>
{{< /blocks/cover >}}
151 changes: 55 additions & 96 deletions content/docs/support/cert-csi/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,22 +57,17 @@ mv ./cert-csi-linux-amd64 ~/.local/bin/cert-csi

### Pull The Container Image

{{< tabs name="pulling-cert-csi-image" >}}
{{% tab name="Docker" %}}

```bash
{{< tabpane name="pulling-cert-csi-image" lang="bash">}}
{{<tab header="Docker" >}}
docker pull dellemc/cert-csi:v1.4.1
```

{{% /tab %}}
{{% tab name="Podman" %}}
{{</tab >}}
{{<tab header="Podman" >}}

```bash
podman pull dellemc/cert-csi:v1.4.1
```

{{% /tab %}}
{{< /tabs >}}
{{</tab >}}
{{< /tabpane >}}

### Building Locally
#### Prerequisites
Expand All @@ -88,24 +83,20 @@ git clone -b "v1.4.1" https://github.com/dell/cert-csi.git && cd cert-csi

2. Build cert-csi

{{< tabs name="build-cert-csi" >}}
{{% tab name="Executable" %}}
{{< tabpane name="build-cert-csi" lang="bash">}}
{{<tab header="Executable" >}}

```bash
make build # the cert-csi executable will be in the working directory
chmod +x ./cert-csi # if building on *nix machine
```

{{% /tab %}}
{{% tab name="Container Image" %}}
{{</tab >}}
{{<tab header="Container Image" >}}

```bash
# uses podman if available, otherwise uses docker. The resulting image is tagged cert-csi:latest
make docker
```

{{% /tab %}}
{{< /tabs >}}
{{</tab >}}
{{< /tabpane >}}

### Optional

Expand All @@ -117,24 +108,18 @@ make install-ms

## Running Cert-CSI

{{< tabs name="running-cert-csi" >}}
{{% tab name="Executable" %}}
```bash
{{< tabpane name="running-cert-csi" lang="bash">}}
{{<tab header="Executable" >}}
cert-csi --help
```
{{% /tab %}}
{{% tab name="Docker" %}}
```bash
{{</tab >}}
{{<tab header="Docker" >}}
docker run --rm -it -v ~/.kube/config:/root/.kube/config dellemc/cert-csi:v1.4.1 --help
```
{{% /tab %}}
{{% tab name="Podman" %}}
```bash
{{</tab >}}
{{<tab header="Podman" >}}
podman run --rm -it -v ~/.kube/config:/root/.kube/config dellemc/cert-csi:v1.4.1 --help
```

{{% /tab %}}
{{< /tabs >}}
{{</tab >}}
{{< /tabpane >}}

> The following sections showing how to execute the various test suites use the executable for brevity. For executions requiring special behavior, such as mounting file arguments into the container image, it will be noted for the relevant command.

Expand Down Expand Up @@ -181,10 +166,9 @@ storageClasses:

Driver specific examples:

{{< tabs name="cerity-config-examples" >}}
{{% tab name="CSI PowerFlex" %}}
{{< tabpane name="cerity-config-examples" lang="yaml">}}
{{<tab header="CSI PowerFlex" >}}

```yaml
storageClasses:
- name: vxflexos
minSize: 8Gi
Expand Down Expand Up @@ -220,12 +204,11 @@ storageClasses:
capacityTracking:
driverNamespace: powerstore
pollInterval: 2m
```

{{% /tab %}}
{{% tab name="CSI PowerScale" %}}

```yaml
{{</tab >}}
{{<tab header="CSI PowerScale" >}}

storageClasses:
- name: isilon
minSize: 8Gi
Expand All @@ -244,12 +227,10 @@ storageClasses:
IsiPath: "/ifs/data/sample"
IsiVolumePathPermissions: "0777"
AzServiceIP: "192.168.2.1"
```

{{% /tab %}}
{{% tab name="CSI PowerMax" %}}
{{</tab >}}
{{<tab header="CSI PowerMax" >}}

```yaml
storageClasses:
- name: powermax-iscsi
minSize: 5Gi
Expand All @@ -271,12 +252,10 @@ storageClasses:
capacityTracking:
driverNamespace: powerstore
pollInterval: 2m
```

{{% /tab %}}
{{% tab name="CSI PowerStore" %}}
{{</tab >}}
{{<tab header="CSI PowerStore" >}}

```yaml
storageClasses:
- name: powerstore
minSize: 5Gi
Expand Down Expand Up @@ -311,12 +290,10 @@ storageClasses:
capacityTracking:
driverNamespace: powerstore
pollInterval: 2m
```

{{% /tab %}}
{{% tab name="CSI Unity" %}}
{{</tab >}}
{{<tab header="CSI Unity" >}}

```yaml
storageClasses:
- name: unity-iscsi
minSize: 3Gi
Expand Down Expand Up @@ -354,10 +331,9 @@ storageClasses:
capacityTracking:
driverNamespace: unity
pollInterval: 2m
```

{{% /tab %}}
{{< /tabs >}}
{{</tab >}}
{{< /tabpane >}}

#### Launching Test Run
1. Executes the [VolumeIO](#volume-io) suite.
Expand Down Expand Up @@ -394,19 +370,14 @@ Run `cert-csi certify -h` for more options.

If you are using the container image, the `cert-config` file must be mounted into the container. Assuming your `cert-config` file is `/home/user/example-certify-config.yaml`, here are examples of how to exeucte this suite with the container image.

{{< tabs name="running-container-certify" >}}
{{% tab name="Docker" %}}
```bash
{{< tabpane name="running-container-certify" lang="bash">}}
{{<tab header="Docker" >}}
docker run --rm -it -v ~/.kube/config:/root/.kube/config -v /home/user/example-certify-config.yaml:/example-certify-config.yaml dellemc/cert-csi:v1.4.1 certify --cert-config /example-certify-config.yaml --vsc <volume-snapshot-class>
```
{{% /tab %}}
{{% tab name="Podman" %}}
```bash
{{</tab >}}
{{<tab header="Podman" >}}
podman run --rm -it -v ~/.kube/config:/root/.kube/config -v /home/user/example-certify-config.yaml:/example-certify-config.yaml dellemc/cert-csi:v1.4.1 certify --cert-config /example-certify-config.yaml --vsc <volume-snapshot-class>
```

{{% /tab %}}
{{< /tabs >}}
{{</tab >}}
{{< /tabpane >}}

## Running Individual Test Suites

Expand Down Expand Up @@ -592,57 +563,46 @@ Run `cert-csi test ephemeral-volume -h` for more options.

If you are using the container image, the `attr` file must be mounted into the container. Assuming your `attr` file is `/home/user/ephemeral-config.properties`, here are examples of how to exeucte this suite with the container image.

{{< tabs name="running-container-ephemeral-volume" >}}
{{% tab name="Docker" %}}
```bash
{{< tabpane name="running-container-ephemeral-volume" lang="bash">}}
{{<tab header="Docker" >}}
docker run --rm -it -v ~/.kube/config:/root/.kube/config -v /home/user/ephemeral-config.properties:/ephemeral-config.properties dellemc/cert-csi:v1.4.1 test ephemeral-volume --driver <driver-name> --attr /ephemeral-config.properties
```
{{% /tab %}}
{{% tab name="Podman" %}}
```bash
{{</tab >}}
{{<tab header="Podman" >}}
podman run --rm -it -v ~/.kube/config:/root/.kube/config -v /home/user/ephemeral-config.properties:/ephemeral-config.properties dellemc/cert-csi:v1.4.1 test ephemeral-volume --driver <driver-name> --attr /ephemeral-config.properties
```

{{% /tab %}}
{{< /tabs >}}
{{</tab >}}
{{< /tabpane >}}

Sample ephemeral-config.properties (key/value pair)
{{< tabs name="volume-attributes-examples" >}}
{{% tab name="CSI PowerFlex" %}}
{{< tabpane name="volume-attributes-examples" lang="yaml">}}
{{<tab header="CSI PowerFlex" >}}

```yaml
volumeName: "my-ephemeral-vol"
size: "10Gi"
storagepool: "sample"
systemID: "sample"
```

{{% /tab %}}
{{% tab name="CSI PowerScale" %}}
{{</tab >}}
{{<tab header="CSI PowerScale" >}}

```yaml
size: "10Gi"
ClusterName: "sample"
AccessZone: "sample"
IsiPath: "/ifs/data/sample"
IsiVolumePathPermissions: "0777"
AzServiceIP: "192.168.2.1"
```

{{% /tab %}}
{{% tab name="CSI PowerStore" %}}
{{</tab >}}
{{<tab header="CSI PowerStore" >}}

```yaml
size: "10Gi"
arrayID: "sample"
nasName: "sample"
nfsAcls: "0777"
```

{{% /tab %}}
{{% tab name="CSI Unity" %}}
{{</tab >}}
{{<tab header="CSI Unity" >}}

```yaml
size: "10Gi"
arrayID: "sample"
protocol: iSCSI
Expand All @@ -651,10 +611,9 @@ Sample ephemeral-config.properties (key/value pair)
tieringPolicy: "1"
storagePool: pool_2
nasName: "sample"
```

{{% /tab %}}
{{< /tabs >}}
{{</tab >}}
{{< /tabpane >}}

#### Storage Capacity Tracking
1. Creates namespace `functional-test` where resources will be created.
Expand Down
Loading