add documentation for resizing a volume

Signed-off-by: Zuhair AlSader <zuhair@devzero.io>
devzero-inc · Oct 24, 2024 · 7bc0b5c · 7bc0b5c
1 parent 34798d2
commit 7bc0b5c
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 10 deletions.
diff --git a/devzero-storage/overview.md b/devzero-storage/overview.md
@@ -13,7 +13,7 @@ Ceph is a free and open-source software-defined storage platform that provides o
 
 ## Mount
 
-The methodology that's used to enable a workspace to have access to persistent volumes (can be verified by running mount in a UNIX shell).
+The method that's used to enable a workspace to have access to persistent volumes (can be verified by running mount in a UNIX shell).
 
 ## Persistent Volumes
 

diff --git a/devzero-storage/volume-elastic-nfs.md b/devzero-storage/volume-elastic-nfs.md
@@ -13,8 +13,8 @@ Volumes are regional in nature and can be attached to any workspace in that regi
 {% code %}
 ```
 $ dz storage volume create --name=my-fancy-volume --size=50
-ID                                    Name             Total size (GB)  Region         
-7947b1c8-881c-49fb-b5c7-c3e0367a76f2  my-fancy-volume  50               Portland, USA  
+ID                                       Name             Total size (GB)  Region         
+volume-7947b1c8881c49fbb5c7c3e0367a76f2  my-fancy-volume  50               Portland, USA  
 ```
 {% endcode %}
 
@@ -23,8 +23,8 @@ ID                                    Name             Total size (GB)  Region
 {% code %}
 ```
 $ dz storage volume create --name=other-fancy-volume --size=50 --region=eu-north-1
-ID                                    Name                        Total size (GB)  Region         
-e71e024e-ba0a-443a-b452-c931e8ce39a5  other-fancy-volume          50               Stockholm, Sweden  
+ID                                       Name                        Total size (GB)  Region         
+volume-e71e024eba0a443ab452c931e8ce39a5  other-fancy-volume          50               Stockholm, Sweden  
 ```
 {% endcode %}
 
@@ -33,9 +33,9 @@ e71e024e-ba0a-443a-b452-c931e8ce39a5  other-fancy-volume          50
 {% code %}
 ```
 $ dz storage volume list
-ID                                    Name                        Total size (GB)  Region             
-7947b1c8-881c-49fb-b5c7-c3e0367a76f2  my-fancy-volume             50               Portland, USA      
-e71e024e-ba0a-443a-b452-c931e8ce39a5  other-fancy-volume          50               Stockholm, Sweden  
+ID                                       Name                        Total size (GB)  Region             
+volume-7947b1c8881c49fbb5c7c3e0367a76f2  my-fancy-volume             50               Portland, USA      
+volume-e71e024eba0a443ab452c931e8ce39a5  other-fancy-volume          50               Stockholm, Sweden  
 ```
 {% endcode %}
 
@@ -45,7 +45,7 @@ The volume is mounted at the path specified by the `--mount` flag.
 
 {% code %}
 ```
-$ dz workspace launch "My Recipe Name" --region=us-west-2 --mount /mnt/my-shared-volume=7947b1c8-881c-49fb-b5c7-c3e0367a76f2
+$ dz workspace launch "My Recipe Name" --region=us-west-2 --mount /mnt/my-shared-volume=volume-7947b1c8881c49fbb5c7c3e0367a76f2
 Your workspace is currently being built... please wait!
 🚀 workspace launch: success
 Successfully deployed workspace dear-filly-ubhg
@@ -54,7 +54,7 @@ dz workspace connect dear-filly-ubhg
 
 # OR
 
-$ dz workspace launch "My Recipe Name" --region=eu-north-1 --mount /mnt/my-shared-volume=e71e024e-ba0a-443a-b452-c931e8ce39a5
+$ dz workspace launch "My Recipe Name" --region=eu-north-1 --mount /mnt/my-shared-volume=volume-e71e024eba0a443ab452c931e8ce39a5
 Your workspace is currently being built... please wait!
 🚀 workspace launch: success
 Successfully deployed workspace abominal-monkey-ytui
@@ -80,3 +80,14 @@ Filesystem      K-blocks     Used Available Use% Mounted on
 [some path..]   10485760        0  10485760   0% /mnt/my-shared-volume
 ```
 {% endcode %}
+
+## Resizing a volume
+
+To change the size of a volume, you can run:
+{% code %}
+```
+$ dz storage volume edit volume-7947b1c8881c49fbb5c7c3e0367a76f2 --size 100
+ID                                       Name                        Total size (GB)  Region            
+volume-7947b1c8881c49fbb5c7c3e0367a76f2  my-fancy-volume             100              Portland, USA      
+```
+{% endcode %}