philipp/uncloud
1
0
Fork 0
mirror of https://github.com/psviderski/uncloud.git synced 2026-08-26 19:13:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: generate CLI reference docs

Browse Source
This commit is contained in:
Pasha Sviderski
2025-09-17 15:11:36 +10:00
parent 7239cd3a6b
commit da03ed8ece
37 changed files with 118 additions and 93 deletions
Download Patch File Download Diff File Expand all files Collapse all files
website/docs/9-cli-reference/uc.md
+3 -3
View File
@@ -1,14 +1,14 @@
# uc # uc
A CLI tool for managing Uncloud resources such as clusters, machines, and services. A CLI tool for managing Uncloud resources such as machines, services, and volumes.
## Options ## Options
``` ```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port Format: [ssh://]user@host[:port] or tcp://host:port
-h, --help help for uc -h, --help help for uc
--uncloud-config string Path to the Uncloud configuration file. (default "~/.config/uncloud/config.yaml") --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
``` ```
## See also ## See also
website/docs/9-cli-reference/uc_build.md
+3 -3
View File
@@ -19,12 +19,12 @@ uc build [FLAGS] [SERVICE...] [flags]
## Options inherited from parent commands ## Options inherited from parent commands
``` ```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port Format: [ssh://]user@host[:port] or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. (default "~/.config/uncloud/config.yaml") --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
``` ```
## See also ## See also
* [uc](uc.md) - A CLI tool for managing Uncloud resources such as clusters, machines, and services. * [uc](uc.md) - A CLI tool for managing Uncloud resources such as machines, services, and volumes.
website/docs/9-cli-reference/uc_caddy.md
+3 -3
View File
@@ -11,14 +11,14 @@ Manage Caddy reverse proxy service.
## Options inherited from parent commands ## Options inherited from parent commands
``` ```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port Format: [ssh://]user@host[:port] or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. (default "~/.config/uncloud/config.yaml") --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
``` ```
## See also ## See also
* [uc](uc.md) - A CLI tool for managing Uncloud resources such as clusters, machines, and services. * [uc](uc.md) - A CLI tool for managing Uncloud resources such as machines, services, and volumes.
* [uc caddy config](uc_caddy_config.md) - Show the current Caddy configuration (Caddyfile). * [uc caddy config](uc_caddy_config.md) - Show the current Caddy configuration (Caddyfile).
* [uc caddy deploy](uc_caddy_deploy.md) - Deploy or upgrade Caddy reverse proxy across all machines in the cluster. * [uc caddy deploy](uc_caddy_deploy.md) - Deploy or upgrade Caddy reverse proxy across all machines in the cluster.
website/docs/9-cli-reference/uc_caddy_config.md
+2 -2
View File
@@ -22,9 +22,9 @@ uc caddy config [flags]
## Options inherited from parent commands ## Options inherited from parent commands
``` ```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port Format: [ssh://]user@host[:port] or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. (default "~/.config/uncloud/config.yaml") --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
``` ```
## See also ## See also
website/docs/9-cli-reference/uc_caddy_deploy.md
+2 -2
View File
@@ -24,9 +24,9 @@ uc caddy deploy [flags]
## Options inherited from parent commands ## Options inherited from parent commands
``` ```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port Format: [ssh://]user@host[:port] or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. (default "~/.config/uncloud/config.yaml") --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
``` ```
## See also ## See also
website/docs/9-cli-reference/uc_ctx.md
+3 -3
View File
@@ -15,14 +15,14 @@ uc ctx [flags]
## Options inherited from parent commands ## Options inherited from parent commands
``` ```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port Format: [ssh://]user@host[:port] or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. (default "~/.config/uncloud/config.yaml") --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
``` ```
## See also ## See also
* [uc](uc.md) - A CLI tool for managing Uncloud resources such as clusters, machines, and services. * [uc](uc.md) - A CLI tool for managing Uncloud resources such as machines, services, and volumes.
* [uc ctx ls](uc_ctx_ls.md) - List available cluster contexts. * [uc ctx ls](uc_ctx_ls.md) - List available cluster contexts.
* [uc ctx use](uc_ctx_use.md) - Switch to a different cluster context. * [uc ctx use](uc_ctx_use.md) - Switch to a different cluster context.
website/docs/9-cli-reference/uc_ctx_ls.md
+3 -4
View File
@@ -9,16 +9,15 @@ uc ctx ls [flags]
## Options ## Options
``` ```
-c, --context string Name of the cluster context. (default is the current context) -h, --help help for ls
-h, --help help for ls
``` ```
## Options inherited from parent commands ## Options inherited from parent commands
``` ```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port Format: [ssh://]user@host[:port] or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. (default "~/.config/uncloud/config.yaml") --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
``` ```
## See also ## See also
website/docs/9-cli-reference/uc_ctx_use.md
+2 -2
View File
@@ -19,9 +19,9 @@ uc ctx use [CONTEXT] [flags]
## Options inherited from parent commands ## Options inherited from parent commands
``` ```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port Format: [ssh://]user@host[:port] or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. (default "~/.config/uncloud/config.yaml") --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
``` ```
## See also ## See also
website/docs/9-cli-reference/uc_deploy.md
+5 -3
View File
@@ -15,17 +15,19 @@ uc deploy [FLAGS] [SERVICE...] [flags]
-n, --no-build Do not build images before deploying services. (default false) -n, --no-build Do not build images before deploying services. (default false)
-p, --profile strings One or more Compose profiles to enable. -p, --profile strings One or more Compose profiles to enable.
--recreate Recreate containers even if their configuration and image haven't changed. --recreate Recreate containers even if their configuration and image haven't changed.
-y, --yes Auto-confirm deployment plan. Enabled by default when running non-interactively,
e.g., in CI/CD pipelines.
``` ```
## Options inherited from parent commands ## Options inherited from parent commands
``` ```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port Format: [ssh://]user@host[:port] or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. (default "~/.config/uncloud/config.yaml") --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
``` ```
## See also ## See also
* [uc](uc.md) - A CLI tool for managing Uncloud resources such as clusters, machines, and services. * [uc](uc.md) - A CLI tool for managing Uncloud resources such as machines, services, and volumes.
website/docs/9-cli-reference/uc_dns.md
+3 -3
View File
@@ -16,14 +16,14 @@ DNS commands allow you to reserve or release a unique '\<id>.cluster.uncloud.run
## Options inherited from parent commands ## Options inherited from parent commands
``` ```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port Format: [ssh://]user@host[:port] or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. (default "~/.config/uncloud/config.yaml") --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
``` ```
## See also ## See also
* [uc](uc.md) - A CLI tool for managing Uncloud resources such as clusters, machines, and services. * [uc](uc.md) - A CLI tool for managing Uncloud resources such as machines, services, and volumes.
* [uc dns release](uc_dns_release.md) - Release the reserved cluster domain. * [uc dns release](uc_dns_release.md) - Release the reserved cluster domain.
* [uc dns reserve](uc_dns_reserve.md) - Reserve a cluster domain in Uncloud DNS. * [uc dns reserve](uc_dns_reserve.md) - Reserve a cluster domain in Uncloud DNS.
* [uc dns show](uc_dns_show.md) - Print the cluster domain name. * [uc dns show](uc_dns_show.md) - Print the cluster domain name.
website/docs/9-cli-reference/uc_dns_release.md
+2 -2
View File
@@ -16,9 +16,9 @@ uc dns release [flags]
## Options inherited from parent commands ## Options inherited from parent commands
``` ```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port Format: [ssh://]user@host[:port] or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. (default "~/.config/uncloud/config.yaml") --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
``` ```
## See also ## See also
website/docs/9-cli-reference/uc_dns_reserve.md
+2 -2
View File
@@ -17,9 +17,9 @@ uc dns reserve [flags]
## Options inherited from parent commands ## Options inherited from parent commands
``` ```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port Format: [ssh://]user@host[:port] or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. (default "~/.config/uncloud/config.yaml") --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
``` ```
## See also ## See also
website/docs/9-cli-reference/uc_dns_show.md
+2 -2
View File
@@ -16,9 +16,9 @@ uc dns show [flags]
## Options inherited from parent commands ## Options inherited from parent commands
``` ```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port Format: [ssh://]user@host[:port] or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. (default "~/.config/uncloud/config.yaml") --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
``` ```
## See also ## See also
website/docs/9-cli-reference/uc_inspect.md
+3 -3
View File
@@ -16,12 +16,12 @@ uc inspect SERVICE [flags]
## Options inherited from parent commands ## Options inherited from parent commands
``` ```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port Format: [ssh://]user@host[:port] or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. (default "~/.config/uncloud/config.yaml") --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
``` ```
## See also ## See also
* [uc](uc.md) - A CLI tool for managing Uncloud resources such as clusters, machines, and services. * [uc](uc.md) - A CLI tool for managing Uncloud resources such as machines, services, and volumes.
website/docs/9-cli-reference/uc_ls.md
+3 -3
View File
@@ -16,12 +16,12 @@ uc ls [flags]
## Options inherited from parent commands ## Options inherited from parent commands
``` ```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port Format: [ssh://]user@host[:port] or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. (default "~/.config/uncloud/config.yaml") --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
``` ```
## See also ## See also
* [uc](uc.md) - A CLI tool for managing Uncloud resources such as clusters, machines, and services. * [uc](uc.md) - A CLI tool for managing Uncloud resources such as machines, services, and volumes.
website/docs/9-cli-reference/uc_machine.md
+3 -3
View File
@@ -11,14 +11,14 @@ Manage machines in an Uncloud cluster.
## Options inherited from parent commands ## Options inherited from parent commands
``` ```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port Format: [ssh://]user@host[:port] or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. (default "~/.config/uncloud/config.yaml") --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
``` ```
## See also ## See also
* [uc](uc.md) - A CLI tool for managing Uncloud resources such as clusters, machines, and services. * [uc](uc.md) - A CLI tool for managing Uncloud resources such as machines, services, and volumes.
* [uc machine add](uc_machine_add.md) - Add a remote machine to a cluster. * [uc machine add](uc_machine_add.md) - Add a remote machine to a cluster.
* [uc machine init](uc_machine_init.md) - Initialise a new cluster with a remote machine as the first member. * [uc machine init](uc_machine_init.md) - Initialise a new cluster with a remote machine as the first member.
* [uc machine ls](uc_machine_ls.md) - List machines in a cluster. * [uc machine ls](uc_machine_ls.md) - List machines in a cluster.
website/docs/9-cli-reference/uc_machine_add.md
+3 -2
View File
@@ -13,6 +13,7 @@ uc machine add [USER@]HOST[:PORT] [flags]
-h, --help help for add -h, --help help for add
-n, --name string Assign a name to the machine. -n, --name string Assign a name to the machine.
--no-caddy Don't deploy Caddy reverse proxy service to the machine. --no-caddy Don't deploy Caddy reverse proxy service to the machine.
--no-install Skip installation of Docker, Uncloud daemon, and dependencies on the machine. Assumes they're already installed and running.
--public-ip string Public IP address of the machine for ingress configuration. Use 'auto' for automatic detection, blank '' or 'none' to disable ingress on this machine, or specify an IP address. (default "auto") --public-ip string Public IP address of the machine for ingress configuration. Use 'auto' for automatic detection, blank '' or 'none' to disable ingress on this machine, or specify an IP address. (default "auto")
-i, --ssh-key string Path to SSH private key for remote login (if not already added to SSH agent). (default "~/.ssh/id_ed25519") -i, --ssh-key string Path to SSH private key for remote login (if not already added to SSH agent). (default "~/.ssh/id_ed25519")
--version string Version of the Uncloud daemon to install on the machine. (default "latest") --version string Version of the Uncloud daemon to install on the machine. (default "latest")
@@ -21,9 +22,9 @@ uc machine add [USER@]HOST[:PORT] [flags]
## Options inherited from parent commands ## Options inherited from parent commands
``` ```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port Format: [ssh://]user@host[:port] or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. (default "~/.config/uncloud/config.yaml") --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
``` ```
## See also ## See also
website/docs/9-cli-reference/uc_machine_init.md
+28 -5
View File
@@ -2,20 +2,43 @@
Initialise a new cluster with a remote machine as the first member. Initialise a new cluster with a remote machine as the first member.
## Synopsis
Initialise a new cluster by setting up a remote machine as the first member.
This command creates a new context in your Uncloud config to manage the cluster.
``` ```
uc machine init [USER@HOST:PORT] [flags] uc machine init [USER@HOST:PORT] [flags]
``` ```
## Examples
```
# Initialise a new cluster with default settings.
uc machine init root@<your-server-ip>
# Initialise with a context name 'prod' in the Uncloud config (~/.config/uncloud/config.yaml) and machine name 'vps1'.
uc machine init root@<your-server-ip> -c prod -n vps1
# Initialise with a non-root user and custom SSH port and key.
uc machine init ubuntu@<your-server-ip>:2222 -i ~/.ssh/mykey
# Initialise without Caddy (no reverse proxy) and without an automatically managed domain name (xxxxxx.cluster.uncloud.run).
# You can deploy Caddy with 'uc caddy deploy' and reserve a domain with 'uc dns reserve' later.
uc machine init root@<your-server-ip> --no-caddy --no-dns
```
## Options ## Options
``` ```
-c, --context string Name of the created context for the initialised cluster in the Uncloud config. (default "default") -c, --context string Name of the new context to be created for the initialised cluster in the Uncloud config. (default "default")
--dns-endpoint string API endpoint for the Uncloud DNS service. (default "https://dns.uncloud.run/v1") --dns-endpoint string API endpoint for the Uncloud DNS service. (default "https://dns.uncloud.run/v1")
-h, --help help for init -h, --help help for init
-n, --name string Assign a name to the machine. -n, --name string Assign a name to the machine.
--network string IPv4 network CIDR to use for machines and services. (default "10.210.0.0/16") --network string IPv4 network CIDR to use for machines and services. (default "10.210.0.0/16")
--no-caddy Don't deploy Caddy reverse proxy service to the machine. --no-caddy Don't deploy Caddy reverse proxy service to the machine. You can deploy it later with 'uc caddy deploy'.
--no-dns Don't reserve a cluster domain in Uncloud DNS. --no-dns Don't reserve a cluster domain in Uncloud DNS. You can reserve it later with 'uc dns reserve'.
--no-install Skip installation of Docker, Uncloud daemon, and dependencies on the machine. Assumes they're already installed and running.
--public-ip string Public IP address of the machine for ingress configuration. Use 'auto' for automatic detection, blank '' or 'none' to disable ingress on this machine, or specify an IP address. (default "auto") --public-ip string Public IP address of the machine for ingress configuration. Use 'auto' for automatic detection, blank '' or 'none' to disable ingress on this machine, or specify an IP address. (default "auto")
-i, --ssh-key string Path to SSH private key for remote login (if not already added to SSH agent). (default "~/.ssh/id_ed25519") -i, --ssh-key string Path to SSH private key for remote login (if not already added to SSH agent). (default "~/.ssh/id_ed25519")
--version string Version of the Uncloud daemon to install on the machine. (default "latest") --version string Version of the Uncloud daemon to install on the machine. (default "latest")
@@ -24,9 +47,9 @@ uc machine init [USER@HOST:PORT] [flags]
## Options inherited from parent commands ## Options inherited from parent commands
``` ```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port Format: [ssh://]user@host[:port] or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. (default "~/.config/uncloud/config.yaml") --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
``` ```
## See also ## See also
website/docs/9-cli-reference/uc_machine_ls.md
+2 -2
View File
@@ -16,9 +16,9 @@ uc machine ls [flags]
## Options inherited from parent commands ## Options inherited from parent commands
``` ```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port Format: [ssh://]user@host[:port] or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. (default "~/.config/uncloud/config.yaml") --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
``` ```
## See also ## See also
website/docs/9-cli-reference/uc_machine_rename.md
+2 -2
View File
@@ -23,9 +23,9 @@ uc machine rename OLD_NAME NEW_NAME [flags]
## Options inherited from parent commands ## Options inherited from parent commands
``` ```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port Format: [ssh://]user@host[:port] or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. (default "~/.config/uncloud/config.yaml") --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
``` ```
## See also ## See also
website/docs/9-cli-reference/uc_machine_rm.md
+2 -2
View File
@@ -18,9 +18,9 @@ uc machine rm MACHINE [flags]
## Options inherited from parent commands ## Options inherited from parent commands
``` ```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port Format: [ssh://]user@host[:port] or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. (default "~/.config/uncloud/config.yaml") --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
``` ```
## See also ## See also
website/docs/9-cli-reference/uc_machine_token.md
+2 -2
View File
@@ -16,9 +16,9 @@ uc machine token [flags]
## Options inherited from parent commands ## Options inherited from parent commands
``` ```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port Format: [ssh://]user@host[:port] or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. (default "~/.config/uncloud/config.yaml") --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
``` ```
## See also ## See also
website/docs/9-cli-reference/uc_machine_update.md
+2 -2
View File
@@ -28,9 +28,9 @@ uc machine update [flags]
## Options inherited from parent commands ## Options inherited from parent commands
``` ```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port Format: [ssh://]user@host[:port] or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. (default "~/.config/uncloud/config.yaml") --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
``` ```
## See also ## See also
website/docs/9-cli-reference/uc_rm.md
+3 -3
View File
@@ -16,12 +16,12 @@ uc rm SERVICE [SERVICE...] [flags]
## Options inherited from parent commands ## Options inherited from parent commands
``` ```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port Format: [ssh://]user@host[:port] or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. (default "~/.config/uncloud/config.yaml") --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
``` ```
## See also ## See also
* [uc](uc.md) - A CLI tool for managing Uncloud resources such as clusters, machines, and services. * [uc](uc.md) - A CLI tool for managing Uncloud resources such as machines, services, and volumes.
website/docs/9-cli-reference/uc_run.md
+3 -3
View File
@@ -46,12 +46,12 @@ uc run IMAGE [COMMAND...] [flags]
## Options inherited from parent commands ## Options inherited from parent commands
``` ```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port Format: [ssh://]user@host[:port] or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. (default "~/.config/uncloud/config.yaml") --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
``` ```
## See also ## See also
* [uc](uc.md) - A CLI tool for managing Uncloud resources such as clusters, machines, and services. * [uc](uc.md) - A CLI tool for managing Uncloud resources such as machines, services, and volumes.
website/docs/9-cli-reference/uc_scale.md
+3 -3
View File
@@ -20,12 +20,12 @@ uc scale SERVICE REPLICAS [flags]
## Options inherited from parent commands ## Options inherited from parent commands
``` ```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port Format: [ssh://]user@host[:port] or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. (default "~/.config/uncloud/config.yaml") --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
``` ```
## See also ## See also
* [uc](uc.md) - A CLI tool for managing Uncloud resources such as clusters, machines, and services. * [uc](uc.md) - A CLI tool for managing Uncloud resources such as machines, services, and volumes.
website/docs/9-cli-reference/uc_service.md
+3 -3
View File
@@ -11,14 +11,14 @@ Manage services in an Uncloud cluster.
## Options inherited from parent commands ## Options inherited from parent commands
``` ```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port Format: [ssh://]user@host[:port] or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. (default "~/.config/uncloud/config.yaml") --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
``` ```
## See also ## See also
* [uc](uc.md) - A CLI tool for managing Uncloud resources such as clusters, machines, and services. * [uc](uc.md) - A CLI tool for managing Uncloud resources such as machines, services, and volumes.
* [uc service inspect](uc_service_inspect.md) - Display detailed information on a service. * [uc service inspect](uc_service_inspect.md) - Display detailed information on a service.
* [uc service ls](uc_service_ls.md) - List services. * [uc service ls](uc_service_ls.md) - List services.
* [uc service rm](uc_service_rm.md) - Remove one or more services. * [uc service rm](uc_service_rm.md) - Remove one or more services.
website/docs/9-cli-reference/uc_service_inspect.md
+2 -2
View File
@@ -16,9 +16,9 @@ uc service inspect SERVICE [flags]
## Options inherited from parent commands ## Options inherited from parent commands
``` ```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port Format: [ssh://]user@host[:port] or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. (default "~/.config/uncloud/config.yaml") --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
``` ```
## See also ## See also
website/docs/9-cli-reference/uc_service_ls.md
+2 -2
View File
@@ -16,9 +16,9 @@ uc service ls [flags]
## Options inherited from parent commands ## Options inherited from parent commands
``` ```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port Format: [ssh://]user@host[:port] or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. (default "~/.config/uncloud/config.yaml") --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
``` ```
## See also ## See also
website/docs/9-cli-reference/uc_service_rm.md
+2 -2
View File
@@ -16,9 +16,9 @@ uc service rm SERVICE [SERVICE...] [flags]
## Options inherited from parent commands ## Options inherited from parent commands
``` ```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port Format: [ssh://]user@host[:port] or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. (default "~/.config/uncloud/config.yaml") --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
``` ```
## See also ## See also
website/docs/9-cli-reference/uc_service_run.md
+2 -2
View File
@@ -46,9 +46,9 @@ uc service run IMAGE [COMMAND...] [flags]
## Options inherited from parent commands ## Options inherited from parent commands
``` ```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port Format: [ssh://]user@host[:port] or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. (default "~/.config/uncloud/config.yaml") --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
``` ```
## See also ## See also
website/docs/9-cli-reference/uc_service_scale.md
+2 -2
View File
@@ -20,9 +20,9 @@ uc service scale SERVICE REPLICAS [flags]
## Options inherited from parent commands ## Options inherited from parent commands
``` ```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port Format: [ssh://]user@host[:port] or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. (default "~/.config/uncloud/config.yaml") --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
``` ```
## See also ## See also
website/docs/9-cli-reference/uc_volume.md
+3 -3
View File
@@ -11,14 +11,14 @@ Manage volumes in an Uncloud cluster.
## Options inherited from parent commands ## Options inherited from parent commands
``` ```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port Format: [ssh://]user@host[:port] or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. (default "~/.config/uncloud/config.yaml") --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
``` ```
## See also ## See also
* [uc](uc.md) - A CLI tool for managing Uncloud resources such as clusters, machines, and services. * [uc](uc.md) - A CLI tool for managing Uncloud resources such as machines, services, and volumes.
* [uc volume create](uc_volume_create.md) - Create a volume on a specific machine. * [uc volume create](uc_volume_create.md) - Create a volume on a specific machine.
* [uc volume inspect](uc_volume_inspect.md) - Display detailed information on a volume. * [uc volume inspect](uc_volume_inspect.md) - Display detailed information on a volume.
* [uc volume ls](uc_volume_ls.md) - List volumes across all machines in the cluster. * [uc volume ls](uc_volume_ls.md) - List volumes across all machines in the cluster.
website/docs/9-cli-reference/uc_volume_create.md
+2 -2
View File
@@ -20,9 +20,9 @@ uc volume create VOLUME_NAME [flags]
## Options inherited from parent commands ## Options inherited from parent commands
``` ```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port Format: [ssh://]user@host[:port] or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. (default "~/.config/uncloud/config.yaml") --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
``` ```
## See also ## See also
website/docs/9-cli-reference/uc_volume_inspect.md
+2 -2
View File
@@ -17,9 +17,9 @@ uc volume inspect VOLUME_NAME [flags]
## Options inherited from parent commands ## Options inherited from parent commands
``` ```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port Format: [ssh://]user@host[:port] or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. (default "~/.config/uncloud/config.yaml") --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
``` ```
## See also ## See also
website/docs/9-cli-reference/uc_volume_ls.md
+2 -2
View File
@@ -18,9 +18,9 @@ uc volume ls [flags]
## Options inherited from parent commands ## Options inherited from parent commands
``` ```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port Format: [ssh://]user@host[:port] or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. (default "~/.config/uncloud/config.yaml") --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
``` ```
## See also ## See also
website/docs/9-cli-reference/uc_volume_rm.md
+2 -2
View File
@@ -24,9 +24,9 @@ uc volume rm VOLUME_NAME [VOLUME_NAME...] [flags]
## Options inherited from parent commands ## Options inherited from parent commands
``` ```
--connect string Connect to a remote cluster machine without using the Uncloud configuration file. --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT]
Format: [ssh://]user@host[:port] or tcp://host:port Format: [ssh://]user@host[:port] or tcp://host:port
--uncloud-config string Path to the Uncloud configuration file. (default "~/.config/uncloud/config.yaml") --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml")
``` ```
## See also ## See also