Skip to content

Commit bfcef14

Browse files
authored
Document driver installation with Helm chart (#59)
1 parent 9809753 commit bfcef14

File tree

1 file changed

+34
-23
lines changed

1 file changed

+34
-23
lines changed

README.md

Lines changed: 34 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -64,40 +64,51 @@ Some examples are available [here](./examples/kubernetes).
6464

6565
### Installation
6666

67-
These steps will cover how to install the Scaleway CSI driver in your Kubernetes cluster.
67+
These steps will cover how to install the Scaleway CSI driver in your Kubernetes cluster, using Helm.
68+
69+
> **Warning**
70+
> Please note that the manifest files provided in `deploy/kubernetes` are deprecated and
71+
> no longer maintained.
6872
6973
#### Requirements
7074

71-
* A Kubernetes cluster running on Scaleway instances (v1.17+)
75+
* A Kubernetes cluster running on Scaleway instances (v1.20+)
7276
* Scaleway Project or Organization ID, Access and Secret key
77+
* Helm v3
7378

7479
#### Deployment
7580

76-
1. Configure the Scaleway secrets.
81+
1. Add the Scaleway Helm repository.
7782

78-
Edit the [secret file](./deploy/kubernetes/scaleway-secret.yaml) in order to set your own secrets.
79-
Once replaced, you can create the secret:
80-
```bash
81-
$ kubectl apply -f ./deploy/kubernetes/scaleway-secret.yaml
82-
```
83+
```bash
84+
helm repo add scaleway https://helm.scw.cloud/
85+
helm repo update
86+
```
8387

84-
2. Deploy the Scaleway CSI driver and the needed sidecars.
88+
2. Deploy the latest release of the `scaleway-csi` Helm chart.
8589

86-
It's recommended to deploy the latest tagged version, but you can also deploy the master version. Here we will deploy the latest version `0.1.4`.
87-
```bash
88-
$ kubectl create -f ./deploy/kubernetes/scaleway-csi-v0.1.4.yaml
89-
```
90+
```bash
91+
helm upgrade --install scaleway-csi --namespace kube-system scaleway/scaleway-csi \
92+
--set controller.scaleway.env.SCW_DEFAULT_ZONE=fr-par-1 \
93+
--set controller.scaleway.env.SCW_DEFAULT_PROJECT_ID=11111111-1111-1111-1111-111111111111 \
94+
--set controller.scaleway.env.SCW_ACCESS_KEY=ABCDEFGHIJKLMNOPQRST \
95+
--set controller.scaleway.env.SCW_SECRET_KEY=11111111-1111-1111-1111-111111111111
96+
```
9097

91-
You can now verify that the driver is running:
92-
```bash
93-
$ kubectl get pods -n kube-system
94-
[...]
95-
scaleway-csi-controller-76897b577d-b4dgw 5/5 Running 0 3m
96-
scaleway-csi-node-hvkfw 3/3 Running 0 3m
97-
scaleway-csi-node-jmrz2 3/3 Running 0 3m
98-
[...]
99-
```
100-
and you should see the scaleway-csi-controller and the scaleway-csi-node pods.
98+
Review the [configuration values](https://github.com/scaleway/helm-charts/blob/master/charts/scaleway-csi/values.yaml) for the Helm chart.
99+
100+
3. You can now verify that the driver is running:
101+
102+
```bash
103+
$ kubectl get pods -n kube-system
104+
[...]
105+
scaleway-csi-controller-76897b577d-b4dgw 8/8 Running 0 3m
106+
scaleway-csi-node-hvkfw 3/3 Running 0 3m
107+
scaleway-csi-node-jmrz2 3/3 Running 0 3m
108+
[...]
109+
```
110+
111+
You should see the scaleway-csi-controller and the scaleway-csi-node pods.
101112

102113
## Development
103114

0 commit comments

Comments
 (0)