Skip to content

use simplyblock.io as a annotation prefix #125

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
noctarius merged 1 commit into from
May 13, 2026
+20 −12
Merged

use simplyblock.io as a annotation prefix #125

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 14 additions & 10 deletions docs/usage/simplyblock-csi/quality-of-service.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,10 @@ apiVersion: v1
metadata:
name: my-pvc
annotations:
simplybk/qos-rw-iops: "1000"
simplybk/qos-rw-mbytes: "125"
simplybk/qos-r-mbytes: "125"
simplybk/qos-w-mbytes: "125"
simplyblock.io/qos-rw-iops: "1000"
simplyblock.io/qos-rw-mbps: "125"
simplyblock.io/qos-r-mbps: "125"
simplyblock.io/qos-w-mbps: "125"
spec:
accessModes:
- ReadWriteOnce
Expand All @@ -63,13 +63,17 @@ spec:

All parameters are optional. Default is `0` (no limit).

| StorageClass Parameter | Annotation | Description |
|------------------------|--------------------------|----------------------------------|
| `qos_rw_iops` | `simplybk/qos-rw-iops` | Max read+write IOPS |
| `qos_rw_mbytes` | `simplybk/qos-rw-mbytes` | Max read+write throughput (MB/s) |
| `qos_r_mbytes` | `simplybk/qos-r-mbytes` | Max read throughput (MB/s) |
| `qos_w_mbytes` | `simplybk/qos-w-mbytes` | Max write throughput (MB/s) |
| StorageClass Parameter | Annotation | Description |
|------------------------|---------------------------------|----------------------------------|
| `qos_rw_iops` | `simplyblock.io/qos-rw-iops` | Max read+write IOPS |
| `qos_rw_mbytes` | `simplyblock.io/qos-rw-mbps` | Max read+write throughput (MB/s) |
| `qos_r_mbytes` | `simplyblock.io/qos-r-mbps` | Max read throughput (MB/s) |
| `qos_w_mbytes` | `simplyblock.io/qos-w-mbps` | Max write throughput (MB/s) |

!!! note
Annotation values override StorageClass values per parameter. You must only use annotations for values you want to
override.

!!! warning "Deprecated annotation prefix"
The `simplybk/` annotation prefix (e.g. `simplybk/qos-rw-iops`) is deprecated. Existing PVCs using the old prefix
continue to work for backward compatibility, but new deployments should use the `simplyblock.io/` prefix.
8 changes: 6 additions & 2 deletions snippets/kubernetes-csi-encryption.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,8 @@ apiVersion: v1
kind: PersistentVolumeClaim
metadata:
annotations:
simplybk/secret-name: my-encryption-keys # Encryption keys
simplybk/secret-namespace: default # Namespace of the secret
simplyblock.io/secret-name: my-encryption-keys # Encryption keys
simplyblock.io/secret-namespace: default # Namespace of the secret
name: my-encrypted-volume-claim
spec:
storageClassName: my-encrypted-volumes # StorageClass
Expand All @@ -92,3 +92,7 @@ spec:
requests:
storage: 200Gi
```

!!! warning "Deprecated annotation prefix"
The `simplybk/` annotation prefix (e.g. `simplybk/secret-name`) is deprecated. Existing PVCs using the old prefix
continue to work for backward compatibility, but new deployments should use the `simplyblock.io/` prefix.
Loading