Skip to content

Doc improvements #50

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.

Sign up for GitHub

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

Merged
jtherin merged 2 commits into from
Mar 3, 2023
Merged

Doc improvements #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
54a9562
Improving copy
tgenaitay Mar 3, 2023
8c73db3
Update README.md
tgenaitay Mar 3, 2023
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: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The [Scaleway Block Volume](https://www.scaleway.com/en/block-storage/) Container Storage Interface (CSI) driver is an implementation of the [CSI interface](https://github.com/container-storage-interface/spec/blob/master/spec.md) to provide a way to manage Scaleway Block Volumes through a container orchestration system, like Kubernetes.

**WARNING**: this project is under active development and should be considered alpha.
**WARNING**: ⚠️ This project is under active development and should be considered alpha.

### CSI Specification Compability Matrix

Expand Down Expand Up @@ -35,7 +35,7 @@ spec:

#### At-Rest Encryption

Support for volume encryption. [see in exemples](https://github.com/scaleway/scaleway-csi/tree/master/examples/kubernetes#encrypting-volumes)
Support for volume encryption with Cryptsetup/LUKS. [See more details in examples](https://github.com/scaleway/scaleway-csi/tree/master/examples/kubernetes#encrypting-volumes)

#### Volume Snapshots

Expand All @@ -47,7 +47,7 @@ The Scaleway CSI driver implements the [`NodeGetVolumeStats`](https://github.com

## Kubernetes

This section is Kubernetes specific. Note that Scaleway CSI driver may work for older Kubernetes version than those announced.
This section is Kubernetes specific. Note that Scaleway CSI driver may work for older Kubernetes versions than those announced.
The CSI driver allows to use [Persistent Volumes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) in Kubernetes.

### Kubernetes Version Compability Matrix
Expand All @@ -73,7 +73,7 @@ These steps will cover how to install the Scaleway CSI driver in your Kubernetes

#### Deployment

1. Configure the Scalewy secrets.
1. Configure the Scaleway secrets.

Edit the [secret file](./deploy/kubernetes/scaleway-secret.yaml) in order to set your own secrets.
Once replaced, you can create the secret:
Expand Down
8 changes: 4 additions & 4 deletions examples/kubernetes/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Kubernetes examples

You can found in this directory some examples about how to use the Scaleway CSI driver inside Kubernetes.
You can find in this directory some examples about how to use the Scaleway CSI driver inside Kubernetes.

It will cover [Persistent Volumes/Persistent Volume Claim (PV/PVC)](https://kubernetes.io/docs/concepts/storage/persistent-volumes/), [Storage Class](https://kubernetes.io/docs/concepts/storage/storage-classes/) and [Volume Snapshots](https://kubernetes.io/docs/concepts/storage/volume-snapshots/)
It will cover [Persistent Volumes/Persistent Volume Claim (PV/PVC)](https://kubernetes.io/docs/concepts/storage/persistent-volumes/), [Storage Class](https://kubernetes.io/docs/concepts/storage/storage-classes/) and [Volume Snapshots](https://kubernetes.io/docs/concepts/storage/volume-snapshots/).

If a [StorageClass](https://kubernetes.io/docs/concepts/storage/storage-classes/) is not provided in the examples, the `scw-bssd` storage class will be used.

Expand Down Expand Up @@ -182,7 +182,7 @@ parameters:

### Choose the type of Scaleway Block Volume

When the new type of Scaleway Block Volume will be available, let's say it's called `b_ssd+`, you will need to add the `type` parameter to the storage class:
When a new type of Scaleway Block Volume will be available, let's say it's called `b_ssd+`, you will need to add the `type` parameter to the storage class:
```yaml
kind: StorageClass
apiVersion: storage.k8s.io/v1
Expand Down Expand Up @@ -221,7 +221,7 @@ This plugin supports at rest encryption of the volumes with Cryptsetup/LUKS.
### Storage Class parameters

In order to have an encrypted volume, `encrypted: true` needs to be added to the StorageClass parameters.
You will also need an passphrase to encrypt/decrypt the volume, which is take from the secrets passed to the `NodeStageVolume` method.
You will also need a passphrase to encrypt/decrypt the volume, which is taken from the secrets passed to the `NodeStageVolume` method.

The [external-provisioner](https://github.com/kubernetes-csi/external-provisioner) can be used to [pass down the wanted secret to the CSI plugin](https://kubernetes-csi.github.io/docs/secrets-and-credentials-storage-class.html) (v1.0.1+).

Expand Down