diff --git a/website/docs/9-cli-reference/uc.md b/website/docs/9-cli-reference/uc.md index 10cbbacb..0f89cef0 100644 --- a/website/docs/9-cli-reference/uc.md +++ b/website/docs/9-cli-reference/uc.md @@ -1,14 +1,14 @@ # 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 ``` - --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 -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 diff --git a/website/docs/9-cli-reference/uc_build.md b/website/docs/9-cli-reference/uc_build.md index 8de94907..108637e6 100644 --- a/website/docs/9-cli-reference/uc_build.md +++ b/website/docs/9-cli-reference/uc_build.md @@ -19,12 +19,12 @@ uc build [FLAGS] [SERVICE...] [flags] ## 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 - --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 -* [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. diff --git a/website/docs/9-cli-reference/uc_caddy.md b/website/docs/9-cli-reference/uc_caddy.md index 9b4aac31..7b69b4cb 100644 --- a/website/docs/9-cli-reference/uc_caddy.md +++ b/website/docs/9-cli-reference/uc_caddy.md @@ -11,14 +11,14 @@ Manage Caddy reverse proxy service. ## 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 - --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 -* [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 deploy](uc_caddy_deploy.md) - Deploy or upgrade Caddy reverse proxy across all machines in the cluster. diff --git a/website/docs/9-cli-reference/uc_caddy_config.md b/website/docs/9-cli-reference/uc_caddy_config.md index 2497f26b..763723a2 100644 --- a/website/docs/9-cli-reference/uc_caddy_config.md +++ b/website/docs/9-cli-reference/uc_caddy_config.md @@ -22,9 +22,9 @@ uc caddy config [flags] ## 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 - --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 diff --git a/website/docs/9-cli-reference/uc_caddy_deploy.md b/website/docs/9-cli-reference/uc_caddy_deploy.md index 37816acb..f6c15bc3 100644 --- a/website/docs/9-cli-reference/uc_caddy_deploy.md +++ b/website/docs/9-cli-reference/uc_caddy_deploy.md @@ -24,9 +24,9 @@ uc caddy deploy [flags] ## 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 - --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 diff --git a/website/docs/9-cli-reference/uc_ctx.md b/website/docs/9-cli-reference/uc_ctx.md index 0c94e6c6..b3b56f2c 100644 --- a/website/docs/9-cli-reference/uc_ctx.md +++ b/website/docs/9-cli-reference/uc_ctx.md @@ -15,14 +15,14 @@ uc ctx [flags] ## 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 - --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 -* [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 use](uc_ctx_use.md) - Switch to a different cluster context. diff --git a/website/docs/9-cli-reference/uc_ctx_ls.md b/website/docs/9-cli-reference/uc_ctx_ls.md index 30211d33..826970d2 100644 --- a/website/docs/9-cli-reference/uc_ctx_ls.md +++ b/website/docs/9-cli-reference/uc_ctx_ls.md @@ -9,16 +9,15 @@ uc ctx ls [flags] ## 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 ``` - --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 - --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 diff --git a/website/docs/9-cli-reference/uc_ctx_use.md b/website/docs/9-cli-reference/uc_ctx_use.md index e709fa2a..8392459e 100644 --- a/website/docs/9-cli-reference/uc_ctx_use.md +++ b/website/docs/9-cli-reference/uc_ctx_use.md @@ -19,9 +19,9 @@ uc ctx use [CONTEXT] [flags] ## 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 - --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 diff --git a/website/docs/9-cli-reference/uc_deploy.md b/website/docs/9-cli-reference/uc_deploy.md index 46343860..86d3826d 100644 --- a/website/docs/9-cli-reference/uc_deploy.md +++ b/website/docs/9-cli-reference/uc_deploy.md @@ -15,17 +15,19 @@ uc deploy [FLAGS] [SERVICE...] [flags] -n, --no-build Do not build images before deploying services. (default false) -p, --profile strings One or more Compose profiles to enable. --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 ``` - --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 - --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 -* [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. diff --git a/website/docs/9-cli-reference/uc_dns.md b/website/docs/9-cli-reference/uc_dns.md index 3526bddf..c217876a 100644 --- a/website/docs/9-cli-reference/uc_dns.md +++ b/website/docs/9-cli-reference/uc_dns.md @@ -16,14 +16,14 @@ DNS commands allow you to reserve or release a unique '\.cluster.uncloud.run ## 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 - --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 -* [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 reserve](uc_dns_reserve.md) - Reserve a cluster domain in Uncloud DNS. * [uc dns show](uc_dns_show.md) - Print the cluster domain name. diff --git a/website/docs/9-cli-reference/uc_dns_release.md b/website/docs/9-cli-reference/uc_dns_release.md index 11b905f7..b61e0754 100644 --- a/website/docs/9-cli-reference/uc_dns_release.md +++ b/website/docs/9-cli-reference/uc_dns_release.md @@ -16,9 +16,9 @@ uc dns release [flags] ## 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 - --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 diff --git a/website/docs/9-cli-reference/uc_dns_reserve.md b/website/docs/9-cli-reference/uc_dns_reserve.md index 446a5ac0..ba309617 100644 --- a/website/docs/9-cli-reference/uc_dns_reserve.md +++ b/website/docs/9-cli-reference/uc_dns_reserve.md @@ -17,9 +17,9 @@ uc dns reserve [flags] ## 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 - --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 diff --git a/website/docs/9-cli-reference/uc_dns_show.md b/website/docs/9-cli-reference/uc_dns_show.md index a64c6c16..d2c36e08 100644 --- a/website/docs/9-cli-reference/uc_dns_show.md +++ b/website/docs/9-cli-reference/uc_dns_show.md @@ -16,9 +16,9 @@ uc dns show [flags] ## 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 - --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 diff --git a/website/docs/9-cli-reference/uc_inspect.md b/website/docs/9-cli-reference/uc_inspect.md index 66c67e22..3684d892 100644 --- a/website/docs/9-cli-reference/uc_inspect.md +++ b/website/docs/9-cli-reference/uc_inspect.md @@ -16,12 +16,12 @@ uc inspect SERVICE [flags] ## 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 - --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 -* [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. diff --git a/website/docs/9-cli-reference/uc_ls.md b/website/docs/9-cli-reference/uc_ls.md index 75c5d85e..a944b985 100644 --- a/website/docs/9-cli-reference/uc_ls.md +++ b/website/docs/9-cli-reference/uc_ls.md @@ -16,12 +16,12 @@ uc ls [flags] ## 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 - --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 -* [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. diff --git a/website/docs/9-cli-reference/uc_machine.md b/website/docs/9-cli-reference/uc_machine.md index d7f2c641..75f4006e 100644 --- a/website/docs/9-cli-reference/uc_machine.md +++ b/website/docs/9-cli-reference/uc_machine.md @@ -11,14 +11,14 @@ Manage machines in an Uncloud cluster. ## 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 - --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 -* [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 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. diff --git a/website/docs/9-cli-reference/uc_machine_add.md b/website/docs/9-cli-reference/uc_machine_add.md index 818a167d..609960fb 100644 --- a/website/docs/9-cli-reference/uc_machine_add.md +++ b/website/docs/9-cli-reference/uc_machine_add.md @@ -13,6 +13,7 @@ uc machine add [USER@]HOST[:PORT] [flags] -h, --help help for add -n, --name string Assign a name 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") -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") @@ -21,9 +22,9 @@ uc machine add [USER@]HOST[:PORT] [flags] ## 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 - --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 diff --git a/website/docs/9-cli-reference/uc_machine_init.md b/website/docs/9-cli-reference/uc_machine_init.md index b31c32eb..66266aeb 100644 --- a/website/docs/9-cli-reference/uc_machine_init.md +++ b/website/docs/9-cli-reference/uc_machine_init.md @@ -2,20 +2,43 @@ 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] ``` +## Examples + +``` + # Initialise a new cluster with default settings. + uc machine init root@ + + # Initialise with a context name 'prod' in the Uncloud config (~/.config/uncloud/config.yaml) and machine name 'vps1'. + uc machine init root@ -c prod -n vps1 + + # Initialise with a non-root user and custom SSH port and key. + uc machine init ubuntu@: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@ --no-caddy --no-dns +``` + ## 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") -h, --help help for init -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") - --no-caddy Don't deploy Caddy reverse proxy service to the machine. - --no-dns Don't reserve a cluster domain in Uncloud DNS. + --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. 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") -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") @@ -24,9 +47,9 @@ uc machine init [USER@HOST:PORT] [flags] ## 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 - --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 diff --git a/website/docs/9-cli-reference/uc_machine_ls.md b/website/docs/9-cli-reference/uc_machine_ls.md index 6dc10291..a8e3de31 100644 --- a/website/docs/9-cli-reference/uc_machine_ls.md +++ b/website/docs/9-cli-reference/uc_machine_ls.md @@ -16,9 +16,9 @@ uc machine ls [flags] ## 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 - --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 diff --git a/website/docs/9-cli-reference/uc_machine_rename.md b/website/docs/9-cli-reference/uc_machine_rename.md index f7e08953..4373607d 100644 --- a/website/docs/9-cli-reference/uc_machine_rename.md +++ b/website/docs/9-cli-reference/uc_machine_rename.md @@ -23,9 +23,9 @@ uc machine rename OLD_NAME NEW_NAME [flags] ## 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 - --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 diff --git a/website/docs/9-cli-reference/uc_machine_rm.md b/website/docs/9-cli-reference/uc_machine_rm.md index c5d3cae6..b1344e41 100644 --- a/website/docs/9-cli-reference/uc_machine_rm.md +++ b/website/docs/9-cli-reference/uc_machine_rm.md @@ -18,9 +18,9 @@ uc machine rm MACHINE [flags] ## 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 - --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 diff --git a/website/docs/9-cli-reference/uc_machine_token.md b/website/docs/9-cli-reference/uc_machine_token.md index 19ada1a7..d28cfd68 100644 --- a/website/docs/9-cli-reference/uc_machine_token.md +++ b/website/docs/9-cli-reference/uc_machine_token.md @@ -16,9 +16,9 @@ uc machine token [flags] ## 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 - --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 diff --git a/website/docs/9-cli-reference/uc_machine_update.md b/website/docs/9-cli-reference/uc_machine_update.md index 1df55b02..d3599a0b 100644 --- a/website/docs/9-cli-reference/uc_machine_update.md +++ b/website/docs/9-cli-reference/uc_machine_update.md @@ -28,9 +28,9 @@ uc machine update [flags] ## 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 - --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 diff --git a/website/docs/9-cli-reference/uc_rm.md b/website/docs/9-cli-reference/uc_rm.md index 75260b38..244d65fb 100644 --- a/website/docs/9-cli-reference/uc_rm.md +++ b/website/docs/9-cli-reference/uc_rm.md @@ -16,12 +16,12 @@ uc rm SERVICE [SERVICE...] [flags] ## 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 - --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 -* [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. diff --git a/website/docs/9-cli-reference/uc_run.md b/website/docs/9-cli-reference/uc_run.md index 325c85ea..ecefbe6a 100644 --- a/website/docs/9-cli-reference/uc_run.md +++ b/website/docs/9-cli-reference/uc_run.md @@ -46,12 +46,12 @@ uc run IMAGE [COMMAND...] [flags] ## 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 - --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 -* [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. diff --git a/website/docs/9-cli-reference/uc_scale.md b/website/docs/9-cli-reference/uc_scale.md index 9e0c0342..5251341e 100644 --- a/website/docs/9-cli-reference/uc_scale.md +++ b/website/docs/9-cli-reference/uc_scale.md @@ -20,12 +20,12 @@ uc scale SERVICE REPLICAS [flags] ## 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 - --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 -* [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. diff --git a/website/docs/9-cli-reference/uc_service.md b/website/docs/9-cli-reference/uc_service.md index d24bc34f..4ba418bd 100644 --- a/website/docs/9-cli-reference/uc_service.md +++ b/website/docs/9-cli-reference/uc_service.md @@ -11,14 +11,14 @@ Manage services in an Uncloud cluster. ## 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 - --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 -* [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 ls](uc_service_ls.md) - List services. * [uc service rm](uc_service_rm.md) - Remove one or more services. diff --git a/website/docs/9-cli-reference/uc_service_inspect.md b/website/docs/9-cli-reference/uc_service_inspect.md index 32c1f882..988fd3d3 100644 --- a/website/docs/9-cli-reference/uc_service_inspect.md +++ b/website/docs/9-cli-reference/uc_service_inspect.md @@ -16,9 +16,9 @@ uc service inspect SERVICE [flags] ## 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 - --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 diff --git a/website/docs/9-cli-reference/uc_service_ls.md b/website/docs/9-cli-reference/uc_service_ls.md index d46a7a7d..f661f0ae 100644 --- a/website/docs/9-cli-reference/uc_service_ls.md +++ b/website/docs/9-cli-reference/uc_service_ls.md @@ -16,9 +16,9 @@ uc service ls [flags] ## 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 - --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 diff --git a/website/docs/9-cli-reference/uc_service_rm.md b/website/docs/9-cli-reference/uc_service_rm.md index e8e0026c..6a785499 100644 --- a/website/docs/9-cli-reference/uc_service_rm.md +++ b/website/docs/9-cli-reference/uc_service_rm.md @@ -16,9 +16,9 @@ uc service rm SERVICE [SERVICE...] [flags] ## 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 - --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 diff --git a/website/docs/9-cli-reference/uc_service_run.md b/website/docs/9-cli-reference/uc_service_run.md index 0a40d5dd..14e6c44a 100644 --- a/website/docs/9-cli-reference/uc_service_run.md +++ b/website/docs/9-cli-reference/uc_service_run.md @@ -46,9 +46,9 @@ uc service run IMAGE [COMMAND...] [flags] ## 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 - --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 diff --git a/website/docs/9-cli-reference/uc_service_scale.md b/website/docs/9-cli-reference/uc_service_scale.md index 869834f4..7f779350 100644 --- a/website/docs/9-cli-reference/uc_service_scale.md +++ b/website/docs/9-cli-reference/uc_service_scale.md @@ -20,9 +20,9 @@ uc service scale SERVICE REPLICAS [flags] ## 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 - --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 diff --git a/website/docs/9-cli-reference/uc_volume.md b/website/docs/9-cli-reference/uc_volume.md index b90acd74..2b4ef995 100644 --- a/website/docs/9-cli-reference/uc_volume.md +++ b/website/docs/9-cli-reference/uc_volume.md @@ -11,14 +11,14 @@ Manage volumes in an Uncloud cluster. ## 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 - --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 -* [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 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. diff --git a/website/docs/9-cli-reference/uc_volume_create.md b/website/docs/9-cli-reference/uc_volume_create.md index 7e91ec7d..8c9948d2 100644 --- a/website/docs/9-cli-reference/uc_volume_create.md +++ b/website/docs/9-cli-reference/uc_volume_create.md @@ -20,9 +20,9 @@ uc volume create VOLUME_NAME [flags] ## 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 - --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 diff --git a/website/docs/9-cli-reference/uc_volume_inspect.md b/website/docs/9-cli-reference/uc_volume_inspect.md index 5785093f..d78db49e 100644 --- a/website/docs/9-cli-reference/uc_volume_inspect.md +++ b/website/docs/9-cli-reference/uc_volume_inspect.md @@ -17,9 +17,9 @@ uc volume inspect VOLUME_NAME [flags] ## 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 - --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 diff --git a/website/docs/9-cli-reference/uc_volume_ls.md b/website/docs/9-cli-reference/uc_volume_ls.md index 6ca5b3d6..16cd9419 100644 --- a/website/docs/9-cli-reference/uc_volume_ls.md +++ b/website/docs/9-cli-reference/uc_volume_ls.md @@ -18,9 +18,9 @@ uc volume ls [flags] ## 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 - --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 diff --git a/website/docs/9-cli-reference/uc_volume_rm.md b/website/docs/9-cli-reference/uc_volume_rm.md index 309217c5..c917547b 100644 --- a/website/docs/9-cli-reference/uc_volume_rm.md +++ b/website/docs/9-cli-reference/uc_volume_rm.md @@ -24,9 +24,9 @@ uc volume rm VOLUME_NAME [VOLUME_NAME...] [flags] ## 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 - --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