Skip to content

Commit 1fa467e

Browse files
committed
docs: update scope project
Add VolumeAttributesClass and ZFS replication to README.md Signed-off-by: Serge Logvinov <serge.logvinov@sinextra.dev>
1 parent 37d7fb0 commit 1fa467e

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ It enables the use of a single storage class to deploy one or many deployments/s
3030
* [Encrypted volumes](https://kubernetes-csi.github.io/docs/secrets-and-credentials-storage-class.html): Encryption with LUKS.
3131
* [Volume bandwidth](https://pve.proxmox.com/wiki/Manual:_qm.conf): Maximum read/write limits.
3232
* [Volume migration](docs/pvecsictl.md): Offline migration of PV to another Proxmox node (region).
33+
* [Volume attributes class](docs/options.md): Detailed options for StorageClass.
34+
* [Volume zone replication](docs/options.md): ZFS replication to another Proxmox node (zone).
3335

3436
## Overview
3537

@@ -79,14 +81,12 @@ It is very important to use disk controller `VirtIO SCSI single` with `iothread`
7981
Proxmox CSI Plugin uses the well-known node labels/spec to define the disk location
8082
* `topology.kubernetes.io/region` - proxmox cluster name
8183
* `topology.kubernetes.io/zone` - proxmox node name
82-
* `Spec.ProviderID` - providerID magic string to help define the virtual machine ID
84+
* `Spec.ProviderID` - providerID magic string `proxmox://$REGION/$VMID` to help define the virtual machine ID, it cannot be changed after the first update. If it not exists, the plugin will find the VM by the name or UUID.
8385

84-
**Important**: The `topology.kubernetes.io/region` and `topology.kubernetes.io/zone` labels _must_ be set.
86+
**Important**: The `topology.kubernetes.io/region` and `topology.kubernetes.io/zone` labels __must__ be set.
8587
Region is the Proxmox cluster name, and zone is the Proxmox node name.
8688
Cluster name can be human-readable and should be the same as in Cloud config.
8789

88-
**Important**: The `Spec.ProviderID` is immutable and has the format `proxmox://$REGION/$VMID` or `proxmox://$UUID`, it cannot be changed after the first update.
89-
9090
The labels can be set manually using `kubectl`,
9191
or automatically through a tool like [Proxmox CCM](https://github.com/sergelogvinov/proxmox-cloud-controller-manager).
9292
I recommend using the CCM (Cloud Controller Manager).

0 commit comments

Comments
 (0)