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

Spell check in PR #24

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@
# Ensure that the 'codespell-autofix.sh' script has executable permissions.
# chmod +x .github/Spell-check-autofix/codespell-autofix.sh
spell-fix:
./.github/spell-check-autofix/codespell-autofix.sh
./.github/spell-check-autofix/codespell-autofix.sh
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ deployment.apps/proxy-server restarted

Redis is used to store application data regarding [tenants, quota, and volume ownership](../../design#quota--volume-ownership). This data is stored on the system under `/var/lib/rancher/k3s/storage/<redis-primary-pv-claim-volume-name>/appendonly.aof`.

`appendonly.aof` can be copied and used to restore this appliation data in Authorization deployments. See the example.
`appendonly.aof` can be copied and used to restore this application data in Authorization deployments. See the example.

### Steps to execute in the existing Authorization deployment

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Given a setup where Kubernetes, a storage system, and the CSM for Authorization

1. Apply the secret containing the tenant token data into the driver namespace. It's assumed that the Kubernetes administrator has the token secret manifest, generated by your storage administrator via [Generate a Token](../proxy-server/#generate-a-token), saved in `/tmp/token.yaml`.

#It is assumed that array type powerflex has the namepace "vxflexos".
#It is assumed that array type powerflex has the namespace "vxflexos".
```console
kubectl apply -f /tmp/token.yaml -n vxflexos
```
Expand Down Expand Up @@ -172,6 +172,6 @@ Given a setup where Kubernetes, a storage system, and the CSM for Authorization
Alternatively, you can use the minimal sample files provided
[here](https://github.com/dell/csm-operator/tree/main/samples/minimal-samples) and install the module using default values

6. Install the Dell CSI PowerFlex driver following the appropriate documenation for your installation method.
6. Install the Dell CSI PowerFlex driver following the appropriate documentation for your installation method.

7. (Optional) Install [dellctl](../../../../support/cli/#installation-instructions) to perform Kubernetes administrator commands for additional capabilities (e.g., list volumes). Please refer to the [dellctl documentation page](../../../../support/cli) for the installation steps and command list.
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,6 @@ Create the karavi-authorization-config secret using this command:
Alternatively, you can use the minimal sample files provided
[here](https://github.com/dell/csm-operator/tree/main/samples/minimal-samples) and install the module using default values

5. Install the Dell CSI PowerMax driver following the appropriate documenation for your installation method.
5. Install the Dell CSI PowerMax driver following the appropriate documentation for your installation method.

6. (Optional) Install [dellctl](../../../../support/cli/#installation-instructions) to perform Kubernetes administrator commands for additional capabilities (e.g., list volumes). Please refer to the [dellctl documentation page](../../../../support/cli) for the installation steps and command list.
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,6 @@ kubectl -n isilon create secret generic karavi-authorization-config --from-file=
Alternatively, you can use the minimal sample files provided
[here](https://github.com/dell/csm-operator/tree/main/samples/minimal-samples) and install the module using default values

6. Install the Dell CSI PowerScale driver following the appropriate documenation for your installation method.
6. Install the Dell CSI PowerScale driver following the appropriate documentation for your installation method.

7. (Optional) Install [dellctl](../../../../support/cli/#installation-instructions) to perform Kubernetes administrator commands for additional capabilities (e.g., list volumes). Please refer to the [dellctl documentation page](../../../../support/cli) for the installation steps and command list.
2 changes: 1 addition & 1 deletion content/docs/authorization/v1.x/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Description: >
This response occurs when running 'make rpm' without the proper permissions or correct pathing of the Authorization repository.

```
Error response from daemon: failed to create shim task: OCI runtime create failed: runc create failed: unable to start container process: error during container init: error mounting "/root/karavi-authorization/bin/deploy" to rootfs at "/home/builder/rpm/deploy": mount /root/karavi-authorization/bin/deploy:/home/builder/rpm/deploy (via /proc/self/fd/6), flags: 0x5000: not a directory: unknown: Are you trying to mount a directory onto a file (or vice-versa)? Check if the specified host path exists and is the expected type.ERRO[0001] error waiting for container: context canceled
Error response from daemon: failed to create shim task: OCI runtime create failed: runc create failed: unable to start container process: error during container init: error mounting "/root/karavi-authorization/bin/deploy" to rootfs at "/home/builder/rpm/deploy": mount /root/karavi-authorization/bin/deploy:/home/builder/rpm/deploy (via /proc/self/fd/6), flags: 0x5000: not a directory: unknown: Are you trying to mount a directory onto a file (or vice-versa)? Check if the specified host path exists and is the expected type.ERROR[0001] error waiting for container: context canceled
```

__Resolution__
Expand Down
6 changes: 3 additions & 3 deletions content/docs/authorization/v2.x/configuration/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ A `storage` entity in CSM Authorization consists of the storage type (`powerflex

| Parameter | Description | Required | Default |
| ------------------------- | ------------------------------------------------------------------------------------ | -------- | ------- |
| type | The type of the stoage array. | Yes | - |
| type | The type of the storage array. | Yes | - |
| endpoint | HTTPS REST API endpoint of the backend storage array. | Yes | - |
| systemID | System ID of the backend storage array. | Yes | - |
| vault.identifier | The identifier of the Vault to be used that was configured in the Authorization CR. | Yes | - |
Expand Down Expand Up @@ -97,7 +97,7 @@ A `role` consists of a name, the storage array to use, and the quota limit for t
| name | The name of the role that will be used to bind with the tenant. | Yes | - |
| quota | The amount of allocated space for the specified role. | Yes | - |
| systemID | System ID of the backend storage array. | Yes | - |
| systemType | The type of the stoage array. | Yes | - |
| systemType | The type of the storage array. | Yes | - |
| pool | The storage pool name. | Yes | - |

For example, to create a role named `role1` using the PowerFlex storage created above with a quota limit of 128iB in storage pool `myStoragePool`:
Expand Down Expand Up @@ -129,7 +129,7 @@ A `tenant` is a Kubernetes cluster that a role will be bound to. Edit these para

| Parameter | Description | Required | Default |
| ------------ | ------------------------------------------------------------------------------------------------------------------------------ | -------- | ------- |
| roles | A comma seperate list of roles that the tenant can be associated with. | Yes | - |
| roles | A comma separate list of roles that the tenant can be associated with. | Yes | - |
| approveSdc | ApproveSdc is used to enable an SDC to access the MDM while the SDC is in restricted access mode. | Yes | false |
| revoke | Revoke is a boolean to indicate whether tenant is revoked. Set to `true` to revoke the tenant but keep it in CSM Auth. | Yes | false |
| volumePrefix | The prefix that all volumes and snapshots will contain to show association with the tenant. It should not exceed 3 characters. | Yes | - |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -207,4 +207,4 @@ Given a setup where Kubernetes, a storage system, and the CSM for Authorization
skipCertificateValidation: true
```

7. Install the Dell CSI PowerMax driver following the appropriate documenation for your installation method.
7. Install the Dell CSI PowerMax driver following the appropriate documentation for your installation method.
Original file line number Diff line number Diff line change
Expand Up @@ -179,4 +179,4 @@ Given a setup where Kubernetes, a storage system, and the CSM for Authorization
skipCertificateValidation: true
```

6. Install the Dell CSI PowerScale driver following the appropriate documenation for your installation method.
6. Install the Dell CSI PowerScale driver following the appropriate documentation for your installation method.
2 changes: 1 addition & 1 deletion content/docs/cosidriver/troubleshooting/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ For logs use:
kubectl logs <driver pod> -n dell-cosi
```

Additionaly check kubernetes resources:
Additionally check kubernetes resources:

```bash
kubectl get bucketclaim -n dell-cosi
Expand Down
2 changes: 1 addition & 1 deletion content/docs/csidriver/features/powerflex.md
Original file line number Diff line number Diff line change
Expand Up @@ -570,7 +570,7 @@ When creating ephemeral volumes, it is important to specify the following within

## Consuming Existing Volumes with Static Provisioning

To use existing volumes from PowerFlex array as Peristent volumes in your Kubernetes environment, perform these steps:
To use existing volumes from PowerFlex array as Persistent volumes in your Kubernetes environment, perform these steps:
1. Log into one of the MDMs of the PowerFlex cluster.
2. Execute these commands to retrieve the `systemID` and `volumeID`.
1. ```bash
Expand Down
4 changes: 2 additions & 2 deletions content/docs/csidriver/features/powerstore.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ To enable this feature you need to set `connection.enableCHAP` to `true` when in

The driver uses the generated chapsecret to configure the iSCSI node database on each node with iSCSI access.

When creating a new host on powerstore array driver will populate host chap credentials with generated values. When re-using already existing hosts driver must override existing CHAP credentials with newly generated ones.
When creating a new host on powerstore array driver will populate host chap credentials with generated values. When reusing already existing hosts driver must override existing CHAP credentials with newly generated ones.

## Volume Expansion

Expand Down Expand Up @@ -711,7 +711,7 @@ CSI Driver for Dell Powerstore 2.3.0 and above supports creating volume groups a

## Configurable Volume Attributes (Optional)

The CSI PowerStore driver version 2.3.0 and above supports Configurable volume atttributes.
The CSI PowerStore driver version 2.3.0 and above supports Configurable volume attributes.

PowerStore array provides a set of optional volume creation attributes. These attributes can be configured for the volume (block and NFS) at the time of creation through PowerStore CSI driver.
These attributes can be specified as labels in PVC yaml file. The following is a sample manifest for creating volume with some of the configurable volume attributes.
Expand Down
2 changes: 1 addition & 1 deletion content/docs/csidriver/release/powerflex.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ description: Release notes for PowerFlex CSI driver
| sdc:3.6.0.6 is causing issues while installing the csi-powerflex driver on ubuntu,RHEL8.3 | Workaround: <br /> Change the powerflexSdc to sdc:3.6 in values.yaml https://github.com/dell/csi-powerflex/blob/72b27acee7553006cc09df97f85405f58478d2e4/helm/csi-vxflexos/values.yaml#L13 <br /> |
| sdc:3.6.1 is causing issues while installing the csi-powerflex driver on ubuntu. | Workaround: <br /> Change the powerflexSdc to sdc:3.6 in values.yaml https://github.com/dell/csi-powerflex/blob/72b27acee7553006cc09df97f85405f58478d2e4/helm/csi-vxflexos/values.yaml#L13 <br /> |
A CSI ephemeral pod may not get created in OpenShift 4.13 and fail with the error `"error when creating pod: the pod uses an inline volume provided by CSIDriver csi-vxflexos.dellemc.com, and the namespace has a pod security enforcement level that is lower than privileged."` | This issue occurs because OpenShift 4.13 introduced the CSI Volume Admission plugin to restrict the use of a CSI driver capable of provisioning CSI ephemeral volumes during pod admission. Therefore, an additional label `security.openshift.io/csi-ephemeral-volume-profile` in [csidriver.yaml](https://github.com/dell/helm-charts/blob/csi-vxflexos-2.10.0/charts/csi-vxflexos/templates/csidriver.yaml) file with the required security profile value should be provided. Follow [OpenShift 4.13 documentation for CSI Ephemeral Volumes](https://docs.openshift.com/container-platform/4.13/storage/container_storage_interface/ephemeral-storage-csi-inline.html) for more information. |
| If the volume limit is exhausted and there are pending pods and PVCs due to `exceed max volume count`, the pending PVCs will be bound to PVs and the pending pods will be scheduled to nodes when the driver pods are restarted. | It is advised not to have any pending pods or PVCs once the volume limit per node is exhausted on a CSI Driver. There is an open issue reported with kubenetes at https://github.com/kubernetes/kubernetes/issues/95911 with the same behavior. |
| If the volume limit is exhausted and there are pending pods and PVCs due to `exceed max volume count`, the pending PVCs will be bound to PVs and the pending pods will be scheduled to nodes when the driver pods are restarted. | It is advised not to have any pending pods or PVCs once the volume limit per node is exhausted on a CSI Driver. There is an open issue reported with kubernetes at https://github.com/kubernetes/kubernetes/issues/95911 with the same behavior. |
| Resource quotas may not work properly with the CSI PowerFlex driver. PowerFlex is only able to assign storage in 8Gi chunks, so if a create volume call is made with a size not divisible by 8Gi, CSI-PowerFlex will round up to the next 8Gi boundary when it provisions storage -- however, the resource quota will not record this size but rather the original size in the create request. This means that, for example, if a 10Gi resource quota is set, and a user provisions 10 1Gi PVCs, 80Gi of storage will actually be allocated, which is well over the amount specified in the resource quota. | For now, users should only provision volumes in 8Gi-divisible chunks if they want to use resource quotas. |


Expand Down
2 changes: 1 addition & 1 deletion content/docs/csidriver/release/powerscale.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ description: Release notes for PowerScale CSI driver
| fsGroupPolicy may not work as expected without root privileges for NFS only<br/>https://github.com/kubernetes/examples/issues/260 | To get the desired behavior set "RootClientEnabled" = "true" in the storage class parameter |
| Driver logs shows "VendorVersion=2.3.0+dirty" | Update the driver to csi-powerscale 2.4.0 |
| PowerScale 9.5.0, Driver installation fails with session based auth, "HTTP/1.1 401 Unauthorized" | Fix is available in PowerScale >= 9.5.0.4 |
| If the volume limit is exhausted and there are pending pods and PVCs due to `exceed max volume count`, the pending PVCs will be bound to PVs and the pending pods will be scheduled to nodes when the driver pods are restarted. | It is advised not to have any pending pods or PVCs once the volume limit per node is exhausted on a CSI Driver. There is an open issue reported with kubenetes at https://github.com/kubernetes/kubernetes/issues/95911 with the same behavior. |
| If the volume limit is exhausted and there are pending pods and PVCs due to `exceed max volume count`, the pending PVCs will be bound to PVs and the pending pods will be scheduled to nodes when the driver pods are restarted. | It is advised not to have any pending pods or PVCs once the volume limit per node is exhausted on a CSI Driver. There is an open issue reported with kubernetes at https://github.com/kubernetes/kubernetes/issues/95911 with the same behavior. |

### Note

Expand Down
Loading
Loading