chore(doc): update documentation

kangasta · github-actions[bot] · commit fd87a413683a · 2022-05-05T09:31:06.000Z
diff --git a/docs/upctl.md b/docs/upctl.md
@@ -28,5 +28,6 @@ upctl a CLI tool for managing your UpCloud services.
 * [upctl server](upctl_server.md)	 - Manage servers
 * [upctl storage](upctl_storage.md)	 - Manage storages
 * [upctl version](upctl_version.md)	 - Display software information
+* [upctl zone](upctl_zone.md)	 - Display zone information
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_account.md b/docs/upctl_account.md
@@ -28,4 +28,4 @@ upctl account [flags]
 * [upctl](upctl.md)	 - UpCloud CLI
 * [upctl account show](upctl_account_show.md)	 - Show account
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_account_show.md b/docs/upctl_account_show.md
@@ -33,4 +33,4 @@ upctl account show
 
 * [upctl account](upctl_account.md)	 - Manage account
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_completion.md b/docs/upctl_completion.md
@@ -33,4 +33,4 @@ upctl completion bash
 
 * [upctl](upctl.md)	 - UpCloud CLI
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_ip-address.md b/docs/upctl_ip-address.md
@@ -32,4 +32,4 @@ upctl ip-address [flags]
 * [upctl ip-address remove](upctl_ip-address_remove.md)	 - Remove an IP address
 * [upctl ip-address show](upctl_ip-address_show.md)	 - Show current IP address
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_ip-address_assign.md b/docs/upctl_ip-address_assign.md
@@ -42,4 +42,4 @@ upctl ip-address assign --server 00b78f8b-521d-4ffb-8baa-adf96c7b8f45 --floating
 
 * [upctl ip-address](upctl_ip-address.md)	 - Manage ip address
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_ip-address_list.md b/docs/upctl_ip-address_list.md
@@ -33,4 +33,4 @@ upctl ip-address list
 
 * [upctl ip-address](upctl_ip-address.md)	 - Manage ip address
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_ip-address_modify.md b/docs/upctl_ip-address_modify.md
@@ -36,4 +36,4 @@ upctl ip-address modify 185.70.197.175 --mac d6:0e:4a:6f:2b:06
 
 * [upctl ip-address](upctl_ip-address.md)	 - Manage ip address
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_ip-address_remove.md b/docs/upctl_ip-address_remove.md
@@ -34,4 +34,4 @@ upctl ip-address remove 2a04:3544:8000:1000:d40e:4aff:fe6f:2c85
 
 * [upctl ip-address](upctl_ip-address.md)	 - Manage ip address
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_ip-address_show.md b/docs/upctl_ip-address_show.md
@@ -34,4 +34,4 @@ upctl ip-address show 2a04:3544:8000:1000:d40e:4aff:fe6f:5d34
 
 * [upctl ip-address](upctl_ip-address.md)	 - Manage ip address
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_network.md b/docs/upctl_network.md
@@ -32,4 +32,4 @@ upctl network <UUID/Name...> [flags]
 * [upctl network modify](upctl_network_modify.md)	 - Modify a network
 * [upctl network show](upctl_network_show.md)	 - Show network details
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_network_create.md b/docs/upctl_network_create.md
@@ -46,4 +46,4 @@ upctl network create --name my_net --zone pl-waw1 --ip-network address=10.0.2.0/
 
 * [upctl network](upctl_network.md)	 - Manage network
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_network_delete.md b/docs/upctl_network_delete.md
@@ -35,4 +35,4 @@ upctl network delete "My Network 1"
 
 * [upctl network](upctl_network.md)	 - Manage network
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_network_list.md b/docs/upctl_network_list.md
@@ -41,4 +41,4 @@ upctl network list --zone pl-waw1 --all
 
 * [upctl network](upctl_network.md)	 - Manage network
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_network_modify.md b/docs/upctl_network_modify.md
@@ -45,4 +45,4 @@ upctl network modify "My Network" --name "My Super Network"
 
 * [upctl network](upctl_network.md)	 - Manage network
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_network_show.md b/docs/upctl_network_show.md
@@ -35,4 +35,4 @@ upctl network show "My Network"
 
 * [upctl network](upctl_network.md)	 - Manage network
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_router.md b/docs/upctl_router.md
@@ -32,4 +32,4 @@ upctl router [flags]
 * [upctl router modify](upctl_router_modify.md)	 - Modify a router
 * [upctl router show](upctl_router_show.md)	 - Show current router
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_router_create.md b/docs/upctl_router_create.md
@@ -35,4 +35,4 @@ upctl router create --name "My Router"
 
 * [upctl router](upctl_router.md)	 - Manage router
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_router_delete.md b/docs/upctl_router_delete.md
@@ -34,4 +34,4 @@ upctl router delete my_router
 
 * [upctl router](upctl_router.md)	 - Manage router
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_router_list.md b/docs/upctl_router_list.md
@@ -37,4 +37,4 @@ upctl router list --all
 
 * [upctl router](upctl_router.md)	 - Manage router
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_router_modify.md b/docs/upctl_router_modify.md
@@ -35,4 +35,4 @@ upctl router modify "My Router" --name "My Turbo Router"
 
 * [upctl router](upctl_router.md)	 - Manage router
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_router_show.md b/docs/upctl_router_show.md
@@ -35,4 +35,4 @@ upctl router show "My Turbo Router" my_super_router
 
 * [upctl router](upctl_router.md)	 - Manage router
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_server.md b/docs/upctl_server.md
@@ -41,4 +41,4 @@ upctl server [flags]
 * [upctl server stop](upctl_server_stop.md)	 - Stop a server
 * [upctl server storage](upctl_server_storage.md)	 - Manage server storages
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_server_create.md b/docs/upctl_server_create.md
@@ -68,4 +68,4 @@ upctl server create --zone fi-hel1 --hostname myapp --ssh-keys /path/to/publicke
 
 * [upctl server](upctl_server.md)	 - Manage servers
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_server_delete.md b/docs/upctl_server_delete.md
@@ -36,4 +36,4 @@ upctl delete my_server
 
 * [upctl server](upctl_server.md)	 - Manage servers
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_server_eject.md b/docs/upctl_server_eject.md
@@ -33,4 +33,4 @@ upctl server eject my_server
 
 * [upctl server](upctl_server.md)	 - Manage servers
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_server_firewall.md b/docs/upctl_server_firewall.md
@@ -30,4 +30,4 @@ upctl server firewall [flags]
 * [upctl server firewall delete](upctl_server_firewall_delete.md)	 - Removes a firewall rule from a server. Firewall rules must be removed individually. The positions of remaining firewall rules will be adjusted after a rule is removed.
 * [upctl server firewall show](upctl_server_firewall_show.md)	 - Show server firewall details.
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_server_firewall_create.md b/docs/upctl_server_firewall_create.md
@@ -47,4 +47,4 @@ upctl server firewall create 00038afc-d526-4148-af0e-d2f1eeaded9b --direction in
 
 * [upctl server firewall](upctl_server_firewall.md)	 - Manage server firewall rules. Enabling or disabling the firewall is done in server modify.
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_server_firewall_delete.md b/docs/upctl_server_firewall_delete.md
@@ -34,4 +34,4 @@ upctl server firewall delete 00038afc-d526-4148-af0e-d2f1eeaded9b --position 1
 
 * [upctl server firewall](upctl_server_firewall.md)	 - Manage server firewall rules. Enabling or disabling the firewall is done in server modify.
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_server_firewall_show.md b/docs/upctl_server_firewall_show.md
@@ -35,4 +35,4 @@ upctl server firewall show my_server
 
 * [upctl server firewall](upctl_server_firewall.md)	 - Manage server firewall rules. Enabling or disabling the firewall is done in server modify.
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_server_list.md b/docs/upctl_server_list.md
@@ -33,4 +33,4 @@ upctl server list
 
 * [upctl server](upctl_server.md)	 - Manage servers
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_server_load.md b/docs/upctl_server_load.md
@@ -34,4 +34,4 @@ upctl server load my_server4 --storage 01000000-0000-4000-8000-000080030101
 
 * [upctl server](upctl_server.md)	 - Manage servers
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_server_modify.md b/docs/upctl_server_modify.md
@@ -55,4 +55,4 @@ upctl server modify myapp --hostname superapp
 
 * [upctl server](upctl_server.md)	 - Manage servers
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_server_network-interface.md b/docs/upctl_server_network-interface.md
@@ -30,4 +30,4 @@ upctl server network-interface [flags]
 * [upctl server network-interface delete](upctl_server_network-interface_delete.md)	 - Delete a network interface
 * [upctl server network-interface modify](upctl_server_network-interface_modify.md)	 - Modify a network interface
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_server_network-interface_create.md b/docs/upctl_server_network-interface_create.md
@@ -45,4 +45,4 @@ upctl server network-interface create my_server2 --network 037a530b-533e-4cef-b6
 
 * [upctl server network-interface](upctl_server_network-interface.md)	 - Manage network interface
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_server_network-interface_delete.md b/docs/upctl_server_network-interface_delete.md
@@ -35,4 +35,4 @@ upctl server network-interface delete my_server --index 7
 
 * [upctl server network-interface](upctl_server_network-interface.md)	 - Manage network interface
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_server_network-interface_modify.md b/docs/upctl_server_network-interface_modify.md
@@ -39,4 +39,4 @@ upctl server network-interface modify 009d7f4e-99ce-4c78-88f1-e695d4c37743 --ind
 
 * [upctl server network-interface](upctl_server_network-interface.md)	 - Manage network interface
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_server_plans.md b/docs/upctl_server_plans.md
@@ -33,4 +33,4 @@ upctl server plans
 
 * [upctl server](upctl_server.md)	 - Manage servers
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_server_restart.md b/docs/upctl_server_restart.md
@@ -36,4 +36,4 @@ upctl server restart my_server1 my_server2
 
 * [upctl server](upctl_server.md)	 - Manage servers
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_server_show.md b/docs/upctl_server_show.md
@@ -36,4 +36,4 @@ upctl server show my_server1 my_server2
 
 * [upctl server](upctl_server.md)	 - Manage servers
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_server_start.md b/docs/upctl_server_start.md
@@ -35,4 +35,4 @@ upctl server start my_server1
 
 * [upctl server](upctl_server.md)	 - Manage servers
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_server_stop.md b/docs/upctl_server_stop.md
@@ -36,4 +36,4 @@ upctl server stop my_server
 
 * [upctl server](upctl_server.md)	 - Manage servers
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_server_storage.md b/docs/upctl_server_storage.md
@@ -29,4 +29,4 @@ upctl server storage [flags]
 * [upctl server storage attach](upctl_server_storage_attach.md)	 - Attach a storage as a device to a server
 * [upctl server storage detach](upctl_server_storage_detach.md)	 - Detaches a storage resource from a server
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_server_storage_attach.md b/docs/upctl_server_storage_attach.md
@@ -41,4 +41,4 @@ upctl server storage attach my_server1 --storage "My Storage"
 
 * [upctl server storage](upctl_server_storage.md)	 - Manage server storages
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_server_storage_detach.md b/docs/upctl_server_storage_detach.md
@@ -35,4 +35,4 @@ upctl server storage detach my_server1 --address virtio:2
 
 * [upctl server storage](upctl_server_storage.md)	 - Manage server storages
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_storage.md b/docs/upctl_storage.md
@@ -36,4 +36,4 @@ upctl storage [flags]
 * [upctl storage show](upctl_storage_show.md)	 - Show storage details
 * [upctl storage templatise](upctl_storage_templatise.md)	 - Templatise a storage
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_storage_backup.md b/docs/upctl_storage_backup.md
@@ -29,4 +29,4 @@ upctl storage backup [flags]
 * [upctl storage backup create](upctl_storage_backup_create.md)	 - Create backup of a storage
 * [upctl storage backup restore](upctl_storage_backup_restore.md)	 - Restore backup of a storage
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_storage_backup_create.md b/docs/upctl_storage_backup_create.md
@@ -35,4 +35,4 @@ upctl storage backup create "My Storage" --title second_backup
 
 * [upctl storage backup](upctl_storage_backup.md)	 - Manage backups
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_storage_backup_restore.md b/docs/upctl_storage_backup_restore.md
@@ -34,4 +34,4 @@ upctl storage backup restore second_backup
 
 * [upctl storage backup](upctl_storage_backup.md)	 - Manage backups
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_storage_clone.md b/docs/upctl_storage_clone.md
@@ -38,4 +38,4 @@ upctl storage clone "My Storage" --title my_storage_clone3 --zone pl-waw1  --tie
 
 * [upctl storage](upctl_storage.md)	 - Manage storages
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_storage_create.md b/docs/upctl_storage_create.md
@@ -42,4 +42,4 @@ upctl storage create --zone pl-waw1 --title my_storage --size 20 --backup-interv
 
 * [upctl storage](upctl_storage.md)	 - Manage storages
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_storage_delete.md b/docs/upctl_storage_delete.md
@@ -35,4 +35,4 @@ upctl storage delete "My Storage"
 
 * [upctl storage](upctl_storage.md)	 - Manage storages
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_storage_import.md b/docs/upctl_storage_import.md
@@ -44,4 +44,4 @@ upctl storage import --source-location https://cdimage.debian.org/debian-cd/curr
 
 * [upctl storage](upctl_storage.md)	 - Manage storages
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_storage_list.md b/docs/upctl_storage_list.md
@@ -41,4 +41,4 @@ upctl storage list --all
 
 * [upctl storage](upctl_storage.md)	 - Manage storages
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_storage_modify.md b/docs/upctl_storage_modify.md
@@ -41,4 +41,4 @@ upctl storage modify "My Storage" --size 25
 
 * [upctl storage](upctl_storage.md)	 - Manage storages
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_storage_show.md b/docs/upctl_storage_show.md
@@ -35,4 +35,4 @@ upctl storage show "My Storage"
 
 * [upctl storage](upctl_storage.md)	 - Manage storages
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_storage_templatise.md b/docs/upctl_storage_templatise.md
@@ -35,4 +35,4 @@ upctl storage templatise "My Storage" --title super_template
 
 * [upctl storage](upctl_storage.md)	 - Manage storages
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_version.md b/docs/upctl_version.md
@@ -33,4 +33,4 @@ upctl version
 
 * [upctl](upctl.md)	 - UpCloud CLI
 
-###### Auto generated by spf13/cobra on 2-May-2022
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_zone.md b/docs/upctl_zone.md
@@ -0,0 +1,31 @@
+## upctl zone
+
+Display zone information
+
+```
+upctl zone [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for zone
+```
+
+### Options inherited from parent commands
+
+```
+  -t, --client-timeout duration   CLI timeout when using interactive mode on some commands
+      --config string             Config file
+      --debug                     Print out more verbose debug logs
+      --force-colours[=true]      force coloured output despite detected terminal support
+      --no-colours[=true]         disable coloured output despite detected terminal support
+  -o, --output string             Output format (supported: json, yaml and human) (default "human")
+```
+
+### SEE ALSO
+
+* [upctl](upctl.md)	 - UpCloud CLI
+* [upctl zone list](upctl_zone_list.md)	 - List available zones
+
+###### Auto generated by spf13/cobra on 5-May-2022
diff --git a/docs/upctl_zone_list.md b/docs/upctl_zone_list.md
