Skip to content

Commit 78b4b19

Browse files
sergelogvinovsergelogvinov
committed
fix: documentation
Update role creation command in documentation for consistency Signed-off-by: Serge Logvinov <serge.logvinov@sinextra.dev>
1 parent af7a276 commit 78b4b19

7 files changed

Lines changed: 79 additions & 27 deletions

File tree

‎charts/proxmox-csi-plugin/Chart.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ maintainers:
1818
url: https://github.com/sergelogvinov
1919
#
2020
# Versions are expected to follow Semantic Versioning (https://semver.org/)
21-
version: 0.4.0
21+
version: 0.4.1
2222
# This is the version number of the application being deployed. This version number should be
2323
# incremented each time you make changes to the application. Versions are not expected to
2424
# follow Semantic Versioning. They should reflect the version the application is using.

‎charts/proxmox-csi-plugin/README.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# proxmox-csi-plugin
22

3-
![Version: 0.3.18](https://img.shields.io/badge/Version-0.3.18-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.15.1](https://img.shields.io/badge/AppVersion-v0.15.1-informational?style=flat-square)
3+
![Version: 0.4.1](https://img.shields.io/badge/Version-0.4.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.15.1](https://img.shields.io/badge/AppVersion-v0.15.1-informational?style=flat-square)
44

55
Container Storage Interface plugin for Proxmox
66

@@ -33,7 +33,7 @@ Supported storage types:
3333
# Create role CSI
3434
pveum role add CSI -privs "VM.Audit VM.Config.Disk Datastore.Allocate Datastore.AllocateSpace Datastore.Audit"
3535
# Or if you need to use Replication feature (zfs replication)
36-
pveum role add CSI -privs "VM.Audit VM.Allocate VM.Clone VM.Config.CPU VM.Config.Disk VM.Config.HWType VM.Config.Memory VM.Config.Options VM.Migrate VM.Monitor VM.PowerMgmt Datastore.Allocate Datastore.AllocateSpace Datastore.Audit"
36+
pveum role add CSI -privs "VM.Audit VM.Allocate VM.Clone VM.Config.CPU VM.Config.Disk VM.Config.HWType VM.Config.Memory VM.Config.Options VM.Migrate VM.PowerMgmt Datastore.Allocate Datastore.AllocateSpace Datastore.Audit"
3737

3838
# Create user and grant permissions
3939
pveum user add kubernetes-csi@pve
@@ -128,6 +128,10 @@ helm upgrade -i --namespace=csi-proxmox -f proxmox-csi.yaml \
128128
| controller.resizer.image | object | `{"pullPolicy":"IfNotPresent","repository":"registry.k8s.io/sig-storage/csi-resizer","tag":"v1.14.0"}` | CSI Resizer. refs: https://github.com/kubernetes-csi/external-resizer |
129129
| controller.resizer.args | list | `[]` | Resizer arguments. example: --feature-gates=VolumeAttributesClass=true |
130130
| controller.resizer.resources | object | `{"requests":{"cpu":"10m","memory":"16Mi"}}` | Resizer resource requests and limits. ref: https://kubernetes.io/docs/user-guide/compute-resources/ |
131+
| controller.snapshotter.enabled | bool | `false` | |
132+
| controller.snapshotter.image | object | `{"pullPolicy":"IfNotPresent","repository":"registry.k8s.io/sig-storage/csi-snapshotter","tag":"v8.3.0"}` | CSI Snapshotter. refs: https://github.com/kubernetes-csi/external-snapshotter |
133+
| controller.snapshotter.args | list | `[]` | Snapshotter arguments. example: --feature-gates=CSIVolumeGroupSnapshot=true |
134+
| controller.snapshotter.resources | object | `{"requests":{"cpu":"10m","memory":"16Mi"}}` | Snapshotter resource requests and limits. ref: https://kubernetes.io/docs/user-guide/compute-resources/ |
131135
| node.plugin.image | object | `{"pullPolicy":"IfNotPresent","repository":"ghcr.io/sergelogvinov/proxmox-csi-node","tag":""}` | Node CSI Driver. |
132136
| node.plugin.resources | object | `{}` | Node CSI Driver resource requests and limits. ref: https://kubernetes.io/docs/user-guide/compute-resources/ |
133137
| node.driverRegistrar.image | object | `{"pullPolicy":"IfNotPresent","repository":"registry.k8s.io/sig-storage/csi-node-driver-registrar","tag":"v2.15.0"}` | Node CSI driver registrar. ref: https://github.com/kubernetes-csi/node-driver-registrar |

‎charts/proxmox-csi-plugin/README.md.gotmpl‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Supported storage types:
3131
# Create role CSI
3232
pveum role add CSI -privs "VM.Audit VM.Config.Disk Datastore.Allocate Datastore.AllocateSpace Datastore.Audit"
3333
# Or if you need to use Replication feature (zfs replication)
34-
pveum role add CSI -privs "VM.Audit VM.Allocate VM.Clone VM.Config.CPU VM.Config.Disk VM.Config.HWType VM.Config.Memory VM.Config.Options VM.Migrate VM.Monitor VM.PowerMgmt Datastore.Allocate Datastore.AllocateSpace Datastore.Audit"
34+
pveum role add CSI -privs "VM.Audit VM.Allocate VM.Clone VM.Config.CPU VM.Config.Disk VM.Config.HWType VM.Config.Memory VM.Config.Options VM.Migrate VM.PowerMgmt Datastore.Allocate Datastore.AllocateSpace Datastore.Audit"
3535
3636
# Create user and grant permissions
3737
pveum user add kubernetes-csi@pve

‎docs/deploy/proxmox-csi-plugin-release.yml‎

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ metadata:
1616
name: proxmox-csi-plugin-controller
1717
namespace: csi-proxmox
1818
labels:
19-
helm.sh/chart: proxmox-csi-plugin-0.3.18
19+
helm.sh/chart: proxmox-csi-plugin-0.4.1
2020
app.kubernetes.io/name: proxmox-csi-plugin
2121
app.kubernetes.io/instance: proxmox-csi-plugin
2222
app.kubernetes.io/version: "v0.15.1"
@@ -29,7 +29,7 @@ metadata:
2929
name: proxmox-csi-plugin-node
3030
namespace: csi-proxmox
3131
labels:
32-
helm.sh/chart: proxmox-csi-plugin-0.3.18
32+
helm.sh/chart: proxmox-csi-plugin-0.4.1
3333
app.kubernetes.io/name: proxmox-csi-plugin
3434
app.kubernetes.io/instance: proxmox-csi-plugin
3535
app.kubernetes.io/version: "v0.15.1"
@@ -42,7 +42,7 @@ metadata:
4242
name: proxmox-csi-plugin-controller
4343
namespace: csi-proxmox
4444
labels:
45-
helm.sh/chart: proxmox-csi-plugin-0.3.18
45+
helm.sh/chart: proxmox-csi-plugin-0.4.1
4646
app.kubernetes.io/name: proxmox-csi-plugin
4747
app.kubernetes.io/instance: proxmox-csi-plugin
4848
app.kubernetes.io/version: "v0.15.1"
@@ -80,6 +80,10 @@ rules:
8080
- apiGroups: ["storage.k8s.io"]
8181
resources: ["volumeattachments/status"]
8282
verbs: ["patch"]
83+
84+
- apiGroups: ["snapshot.storage.k8s.io"]
85+
resources: ["volumesnapshots"]
86+
verbs: ["get", "list"]
8387
---
8488
# Source: proxmox-csi-plugin/templates/node-clusterrole.yaml
8589
apiVersion: rbac.authorization.k8s.io/v1
@@ -88,7 +92,7 @@ metadata:
8892
name: proxmox-csi-plugin-node
8993
namespace: csi-proxmox
9094
labels:
91-
helm.sh/chart: proxmox-csi-plugin-0.3.18
95+
helm.sh/chart: proxmox-csi-plugin-0.4.1
9296
app.kubernetes.io/name: proxmox-csi-plugin
9397
app.kubernetes.io/instance: proxmox-csi-plugin
9498
app.kubernetes.io/version: "v0.15.1"
@@ -106,6 +110,12 @@ apiVersion: rbac.authorization.k8s.io/v1
106110
kind: ClusterRoleBinding
107111
metadata:
108112
name: proxmox-csi-plugin-controller
113+
labels:
114+
helm.sh/chart: proxmox-csi-plugin-0.4.1
115+
app.kubernetes.io/name: proxmox-csi-plugin
116+
app.kubernetes.io/instance: proxmox-csi-plugin
117+
app.kubernetes.io/version: "v0.15.1"
118+
app.kubernetes.io/managed-by: Helm
109119
roleRef:
110120
apiGroup: rbac.authorization.k8s.io
111121
kind: ClusterRole
@@ -136,7 +146,7 @@ metadata:
136146
name: proxmox-csi-plugin-controller
137147
namespace: csi-proxmox
138148
labels:
139-
helm.sh/chart: proxmox-csi-plugin-0.3.18
149+
helm.sh/chart: proxmox-csi-plugin-0.4.1
140150
app.kubernetes.io/name: proxmox-csi-plugin
141151
app.kubernetes.io/instance: proxmox-csi-plugin
142152
app.kubernetes.io/version: "v0.15.1"
@@ -162,6 +172,12 @@ kind: RoleBinding
162172
metadata:
163173
name: proxmox-csi-plugin-controller
164174
namespace: csi-proxmox
175+
labels:
176+
helm.sh/chart: proxmox-csi-plugin-0.4.1
177+
app.kubernetes.io/name: proxmox-csi-plugin
178+
app.kubernetes.io/instance: proxmox-csi-plugin
179+
app.kubernetes.io/version: "v0.15.1"
180+
app.kubernetes.io/managed-by: Helm
165181
roleRef:
166182
apiGroup: rbac.authorization.k8s.io
167183
kind: Role
@@ -178,7 +194,7 @@ metadata:
178194
name: proxmox-csi-plugin-node
179195
namespace: csi-proxmox
180196
labels:
181-
helm.sh/chart: proxmox-csi-plugin-0.3.18
197+
helm.sh/chart: proxmox-csi-plugin-0.4.1
182198
app.kubernetes.io/name: proxmox-csi-plugin
183199
app.kubernetes.io/instance: proxmox-csi-plugin
184200
app.kubernetes.io/version: "v0.15.1"
@@ -321,7 +337,7 @@ metadata:
321337
name: proxmox-csi-plugin-controller
322338
namespace: csi-proxmox
323339
labels:
324-
helm.sh/chart: proxmox-csi-plugin-0.3.18
340+
helm.sh/chart: proxmox-csi-plugin-0.4.1
325341
app.kubernetes.io/name: proxmox-csi-plugin
326342
app.kubernetes.io/instance: proxmox-csi-plugin
327343
app.kubernetes.io/version: "v0.15.1"

‎docs/deploy/proxmox-csi-plugin-talos.yml‎

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ metadata:
1616
name: proxmox-csi-plugin-controller
1717
namespace: csi-proxmox
1818
labels:
19-
helm.sh/chart: proxmox-csi-plugin-0.3.18
19+
helm.sh/chart: proxmox-csi-plugin-0.4.1
2020
app.kubernetes.io/name: proxmox-csi-plugin
2121
app.kubernetes.io/instance: proxmox-csi-plugin
2222
app.kubernetes.io/version: "v0.15.1"
@@ -29,7 +29,7 @@ metadata:
2929
name: proxmox-csi-plugin-node
3030
namespace: csi-proxmox
3131
labels:
32-
helm.sh/chart: proxmox-csi-plugin-0.3.18
32+
helm.sh/chart: proxmox-csi-plugin-0.4.1
3333
app.kubernetes.io/name: proxmox-csi-plugin
3434
app.kubernetes.io/instance: proxmox-csi-plugin
3535
app.kubernetes.io/version: "v0.15.1"
@@ -68,7 +68,7 @@ metadata:
6868
name: proxmox-csi-plugin-controller
6969
namespace: csi-proxmox
7070
labels:
71-
helm.sh/chart: proxmox-csi-plugin-0.3.18
71+
helm.sh/chart: proxmox-csi-plugin-0.4.1
7272
app.kubernetes.io/name: proxmox-csi-plugin
7373
app.kubernetes.io/instance: proxmox-csi-plugin
7474
app.kubernetes.io/version: "v0.15.1"
@@ -106,6 +106,10 @@ rules:
106106
- apiGroups: ["storage.k8s.io"]
107107
resources: ["volumeattachments/status"]
108108
verbs: ["patch"]
109+
110+
- apiGroups: ["snapshot.storage.k8s.io"]
111+
resources: ["volumesnapshots"]
112+
verbs: ["get", "list"]
109113
---
110114
# Source: proxmox-csi-plugin/templates/node-clusterrole.yaml
111115
apiVersion: rbac.authorization.k8s.io/v1
@@ -114,7 +118,7 @@ metadata:
114118
name: proxmox-csi-plugin-node
115119
namespace: csi-proxmox
116120
labels:
117-
helm.sh/chart: proxmox-csi-plugin-0.3.18
121+
helm.sh/chart: proxmox-csi-plugin-0.4.1
118122
app.kubernetes.io/name: proxmox-csi-plugin
119123
app.kubernetes.io/instance: proxmox-csi-plugin
120124
app.kubernetes.io/version: "v0.15.1"
@@ -132,6 +136,12 @@ apiVersion: rbac.authorization.k8s.io/v1
132136
kind: ClusterRoleBinding
133137
metadata:
134138
name: proxmox-csi-plugin-controller
139+
labels:
140+
helm.sh/chart: proxmox-csi-plugin-0.4.1
141+
app.kubernetes.io/name: proxmox-csi-plugin
142+
app.kubernetes.io/instance: proxmox-csi-plugin
143+
app.kubernetes.io/version: "v0.15.1"
144+
app.kubernetes.io/managed-by: Helm
135145
roleRef:
136146
apiGroup: rbac.authorization.k8s.io
137147
kind: ClusterRole
@@ -162,7 +172,7 @@ metadata:
162172
name: proxmox-csi-plugin-controller
163173
namespace: csi-proxmox
164174
labels:
165-
helm.sh/chart: proxmox-csi-plugin-0.3.18
175+
helm.sh/chart: proxmox-csi-plugin-0.4.1
166176
app.kubernetes.io/name: proxmox-csi-plugin
167177
app.kubernetes.io/instance: proxmox-csi-plugin
168178
app.kubernetes.io/version: "v0.15.1"
@@ -188,6 +198,12 @@ kind: RoleBinding
188198
metadata:
189199
name: proxmox-csi-plugin-controller
190200
namespace: csi-proxmox
201+
labels:
202+
helm.sh/chart: proxmox-csi-plugin-0.4.1
203+
app.kubernetes.io/name: proxmox-csi-plugin
204+
app.kubernetes.io/instance: proxmox-csi-plugin
205+
app.kubernetes.io/version: "v0.15.1"
206+
app.kubernetes.io/managed-by: Helm
191207
roleRef:
192208
apiGroup: rbac.authorization.k8s.io
193209
kind: Role
@@ -204,7 +220,7 @@ metadata:
204220
name: proxmox-csi-plugin-node
205221
namespace: csi-proxmox
206222
labels:
207-
helm.sh/chart: proxmox-csi-plugin-0.3.18
223+
helm.sh/chart: proxmox-csi-plugin-0.4.1
208224
app.kubernetes.io/name: proxmox-csi-plugin
209225
app.kubernetes.io/instance: proxmox-csi-plugin
210226
app.kubernetes.io/version: "v0.15.1"
@@ -344,7 +360,7 @@ metadata:
344360
name: proxmox-csi-plugin-controller
345361
namespace: csi-proxmox
346362
labels:
347-
helm.sh/chart: proxmox-csi-plugin-0.3.18
363+
helm.sh/chart: proxmox-csi-plugin-0.4.1
348364
app.kubernetes.io/name: proxmox-csi-plugin
349365
app.kubernetes.io/instance: proxmox-csi-plugin
350366
app.kubernetes.io/version: "v0.15.1"

‎docs/deploy/proxmox-csi-plugin.yml‎

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ metadata:
1616
name: proxmox-csi-plugin-controller
1717
namespace: csi-proxmox
1818
labels:
19-
helm.sh/chart: proxmox-csi-plugin-0.3.18
19+
helm.sh/chart: proxmox-csi-plugin-0.4.1
2020
app.kubernetes.io/name: proxmox-csi-plugin
2121
app.kubernetes.io/instance: proxmox-csi-plugin
2222
app.kubernetes.io/version: "v0.15.1"
@@ -29,7 +29,7 @@ metadata:
2929
name: proxmox-csi-plugin-node
3030
namespace: csi-proxmox
3131
labels:
32-
helm.sh/chart: proxmox-csi-plugin-0.3.18
32+
helm.sh/chart: proxmox-csi-plugin-0.4.1
3333
app.kubernetes.io/name: proxmox-csi-plugin
3434
app.kubernetes.io/instance: proxmox-csi-plugin
3535
app.kubernetes.io/version: "v0.15.1"
@@ -69,7 +69,7 @@ metadata:
6969
name: proxmox-csi-plugin-controller
7070
namespace: csi-proxmox
7171
labels:
72-
helm.sh/chart: proxmox-csi-plugin-0.3.18
72+
helm.sh/chart: proxmox-csi-plugin-0.4.1
7373
app.kubernetes.io/name: proxmox-csi-plugin
7474
app.kubernetes.io/instance: proxmox-csi-plugin
7575
app.kubernetes.io/version: "v0.15.1"
@@ -107,6 +107,10 @@ rules:
107107
- apiGroups: ["storage.k8s.io"]
108108
resources: ["volumeattachments/status"]
109109
verbs: ["patch"]
110+
111+
- apiGroups: ["snapshot.storage.k8s.io"]
112+
resources: ["volumesnapshots"]
113+
verbs: ["get", "list"]
110114
---
111115
# Source: proxmox-csi-plugin/templates/node-clusterrole.yaml
112116
apiVersion: rbac.authorization.k8s.io/v1
@@ -115,7 +119,7 @@ metadata:
115119
name: proxmox-csi-plugin-node
116120
namespace: csi-proxmox
117121
labels:
118-
helm.sh/chart: proxmox-csi-plugin-0.3.18
122+
helm.sh/chart: proxmox-csi-plugin-0.4.1
119123
app.kubernetes.io/name: proxmox-csi-plugin
120124
app.kubernetes.io/instance: proxmox-csi-plugin
121125
app.kubernetes.io/version: "v0.15.1"
@@ -133,6 +137,12 @@ apiVersion: rbac.authorization.k8s.io/v1
133137
kind: ClusterRoleBinding
134138
metadata:
135139
name: proxmox-csi-plugin-controller
140+
labels:
141+
helm.sh/chart: proxmox-csi-plugin-0.4.1
142+
app.kubernetes.io/name: proxmox-csi-plugin
143+
app.kubernetes.io/instance: proxmox-csi-plugin
144+
app.kubernetes.io/version: "v0.15.1"
145+
app.kubernetes.io/managed-by: Helm
136146
roleRef:
137147
apiGroup: rbac.authorization.k8s.io
138148
kind: ClusterRole
@@ -163,7 +173,7 @@ metadata:
163173
name: proxmox-csi-plugin-controller
164174
namespace: csi-proxmox
165175
labels:
166-
helm.sh/chart: proxmox-csi-plugin-0.3.18
176+
helm.sh/chart: proxmox-csi-plugin-0.4.1
167177
app.kubernetes.io/name: proxmox-csi-plugin
168178
app.kubernetes.io/instance: proxmox-csi-plugin
169179
app.kubernetes.io/version: "v0.15.1"
@@ -189,6 +199,12 @@ kind: RoleBinding
189199
metadata:
190200
name: proxmox-csi-plugin-controller
191201
namespace: csi-proxmox
202+
labels:
203+
helm.sh/chart: proxmox-csi-plugin-0.4.1
204+
app.kubernetes.io/name: proxmox-csi-plugin
205+
app.kubernetes.io/instance: proxmox-csi-plugin
206+
app.kubernetes.io/version: "v0.15.1"
207+
app.kubernetes.io/managed-by: Helm
192208
roleRef:
193209
apiGroup: rbac.authorization.k8s.io
194210
kind: Role
@@ -205,7 +221,7 @@ metadata:
205221
name: proxmox-csi-plugin-node
206222
namespace: csi-proxmox
207223
labels:
208-
helm.sh/chart: proxmox-csi-plugin-0.3.18
224+
helm.sh/chart: proxmox-csi-plugin-0.4.1
209225
app.kubernetes.io/name: proxmox-csi-plugin
210226
app.kubernetes.io/instance: proxmox-csi-plugin
211227
app.kubernetes.io/version: "v0.15.1"
@@ -348,7 +364,7 @@ metadata:
348364
name: proxmox-csi-plugin-controller
349365
namespace: csi-proxmox
350366
labels:
351-
helm.sh/chart: proxmox-csi-plugin-0.3.18
367+
helm.sh/chart: proxmox-csi-plugin-0.4.1
352368
app.kubernetes.io/name: proxmox-csi-plugin
353369
app.kubernetes.io/instance: proxmox-csi-plugin
354370
app.kubernetes.io/version: "v0.15.1"

‎docs/install.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Create `CSI` role in Proxmox:
1818
```shell
1919
pveum role add CSI -privs "VM.Audit VM.Config.Disk Datastore.Allocate Datastore.AllocateSpace Datastore.Audit"
2020
# Or if you need to use Replication feature (zfs replication)
21-
pveum role add CSI -privs "VM.Audit VM.Allocate VM.Clone VM.Config.CPU VM.Config.Disk VM.Config.HWType VM.Config.Memory VM.Config.Options VM.Migrate VM.Monitor VM.PowerMgmt Datastore.Allocate Datastore.AllocateSpace Datastore.Audit"
21+
pveum role add CSI -privs "VM.Audit VM.Allocate VM.Clone VM.Config.CPU VM.Config.Disk VM.Config.HWType VM.Config.Memory VM.Config.Options VM.Migrate VM.PowerMgmt Datastore.Allocate Datastore.AllocateSpace Datastore.Audit"
2222
```
2323

2424
Next create a user `kubernetes-csi@pve` for the CSI plugin and grant it the above role
@@ -198,7 +198,7 @@ cluster:
198198
clusters:
199199
- url: https://cluster-api-1.exmple.com:8006/api2/json
200200
insecure: false
201-
token_id: "kubernetes-csi@pve!ccm"
201+
token_id: "kubernetes@pve!ccm"
202202
token_secret: "secret"
203203
region: Region-1
204204
- name: proxmox-csi-plugin

0 commit comments

Comments
 (0)