diff --git a/website/docs/9-cli-reference/uc.md b/website/docs/9-cli-reference/uc.md index 36547716..4091c553 100644 --- a/website/docs/9-cli-reference/uc.md +++ b/website/docs/9-cli-reference/uc.md @@ -6,7 +6,7 @@ A CLI tool for managing Uncloud resources such as machines, services, and volume ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] -h, --help help for uc --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") @@ -23,11 +23,13 @@ A CLI tool for managing Uncloud resources such as machines, services, and volume * [uc image](uc_image.md) - Manage images on machines in the cluster. * [uc images](uc_images.md) - List images on machines in the cluster. * [uc inspect](uc_inspect.md) - Display detailed information on a service. +* [uc logs](uc_logs.md) - View service logs. * [uc ls](uc_ls.md) - List services. -* [uc machine](uc_machine.md) - Manage machines in an Uncloud cluster. +* [uc machine](uc_machine.md) - Manage machines in the cluster. +* [uc ps](uc_ps.md) - List all service containers in the cluster * [uc rm](uc_rm.md) - Remove one or more services. * [uc run](uc_run.md) - Run a service. * [uc scale](uc_scale.md) - Scale a replicated service by changing the number of replicas. -* [uc service](uc_service.md) - Manage services in an Uncloud cluster. -* [uc volume](uc_volume.md) - Manage volumes in an Uncloud cluster. +* [uc service](uc_service.md) - Manage services in the cluster. +* [uc volume](uc_volume.md) - Manage volumes in the cluster. diff --git a/website/docs/9-cli-reference/uc_build.md b/website/docs/9-cli-reference/uc_build.md index 831b5857..55890ae2 100644 --- a/website/docs/9-cli-reference/uc_build.md +++ b/website/docs/9-cli-reference/uc_build.md @@ -58,7 +58,7 @@ uc build [FLAGS] [SERVICE...] [flags] ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` diff --git a/website/docs/9-cli-reference/uc_caddy.md b/website/docs/9-cli-reference/uc_caddy.md index 4e13c8b6..179b599e 100644 --- a/website/docs/9-cli-reference/uc_caddy.md +++ b/website/docs/9-cli-reference/uc_caddy.md @@ -12,7 +12,7 @@ Manage Caddy reverse proxy service. ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` diff --git a/website/docs/9-cli-reference/uc_caddy_config.md b/website/docs/9-cli-reference/uc_caddy_config.md index d7bf1e0e..c320eb19 100644 --- a/website/docs/9-cli-reference/uc_caddy_config.md +++ b/website/docs/9-cli-reference/uc_caddy_config.md @@ -22,7 +22,7 @@ uc caddy config [flags] ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` diff --git a/website/docs/9-cli-reference/uc_caddy_deploy.md b/website/docs/9-cli-reference/uc_caddy_deploy.md index 1af11a82..8ef859cb 100644 --- a/website/docs/9-cli-reference/uc_caddy_deploy.md +++ b/website/docs/9-cli-reference/uc_caddy_deploy.md @@ -24,7 +24,7 @@ uc caddy deploy [flags] ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` diff --git a/website/docs/9-cli-reference/uc_ctx.md b/website/docs/9-cli-reference/uc_ctx.md index 55ccb50c..2f7dfff8 100644 --- a/website/docs/9-cli-reference/uc_ctx.md +++ b/website/docs/9-cli-reference/uc_ctx.md @@ -16,7 +16,7 @@ uc ctx [flags] ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` diff --git a/website/docs/9-cli-reference/uc_ctx_connection.md b/website/docs/9-cli-reference/uc_ctx_connection.md index 279621e3..970897ce 100644 --- a/website/docs/9-cli-reference/uc_ctx_connection.md +++ b/website/docs/9-cli-reference/uc_ctx_connection.md @@ -16,7 +16,7 @@ uc ctx connection [flags] ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` diff --git a/website/docs/9-cli-reference/uc_ctx_ls.md b/website/docs/9-cli-reference/uc_ctx_ls.md index 7ad9f515..53c46b6f 100644 --- a/website/docs/9-cli-reference/uc_ctx_ls.md +++ b/website/docs/9-cli-reference/uc_ctx_ls.md @@ -16,7 +16,7 @@ uc ctx ls [flags] ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` diff --git a/website/docs/9-cli-reference/uc_ctx_use.md b/website/docs/9-cli-reference/uc_ctx_use.md index 4914928e..f97855ea 100644 --- a/website/docs/9-cli-reference/uc_ctx_use.md +++ b/website/docs/9-cli-reference/uc_ctx_use.md @@ -20,7 +20,7 @@ uc ctx use [CONTEXT] [flags] ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` diff --git a/website/docs/9-cli-reference/uc_deploy.md b/website/docs/9-cli-reference/uc_deploy.md index 986f8aec..0224a072 100644 --- a/website/docs/9-cli-reference/uc_deploy.md +++ b/website/docs/9-cli-reference/uc_deploy.md @@ -26,7 +26,7 @@ uc deploy [FLAGS] [SERVICE...] [flags] ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` diff --git a/website/docs/9-cli-reference/uc_dns.md b/website/docs/9-cli-reference/uc_dns.md index 32f2dc3c..bad6335a 100644 --- a/website/docs/9-cli-reference/uc_dns.md +++ b/website/docs/9-cli-reference/uc_dns.md @@ -17,7 +17,7 @@ DNS commands allow you to reserve or release a unique '\.cluster.uncloud.run ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` diff --git a/website/docs/9-cli-reference/uc_dns_release.md b/website/docs/9-cli-reference/uc_dns_release.md index 9c5f2c42..f7e2532f 100644 --- a/website/docs/9-cli-reference/uc_dns_release.md +++ b/website/docs/9-cli-reference/uc_dns_release.md @@ -16,7 +16,7 @@ uc dns release [flags] ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` diff --git a/website/docs/9-cli-reference/uc_dns_reserve.md b/website/docs/9-cli-reference/uc_dns_reserve.md index 89282edf..f7ade294 100644 --- a/website/docs/9-cli-reference/uc_dns_reserve.md +++ b/website/docs/9-cli-reference/uc_dns_reserve.md @@ -17,7 +17,7 @@ uc dns reserve [flags] ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` diff --git a/website/docs/9-cli-reference/uc_dns_show.md b/website/docs/9-cli-reference/uc_dns_show.md index b2df98ff..98645c6b 100644 --- a/website/docs/9-cli-reference/uc_dns_show.md +++ b/website/docs/9-cli-reference/uc_dns_show.md @@ -16,7 +16,7 @@ uc dns show [flags] ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` diff --git a/website/docs/9-cli-reference/uc_exec.md b/website/docs/9-cli-reference/uc_exec.md index fbeffffb..5cb30468 100644 --- a/website/docs/9-cli-reference/uc_exec.md +++ b/website/docs/9-cli-reference/uc_exec.md @@ -45,7 +45,7 @@ uc exec [OPTIONS] SERVICE [COMMAND ARGS...] [flags] ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` diff --git a/website/docs/9-cli-reference/uc_image.md b/website/docs/9-cli-reference/uc_image.md index cca61431..09d581ca 100644 --- a/website/docs/9-cli-reference/uc_image.md +++ b/website/docs/9-cli-reference/uc_image.md @@ -12,7 +12,7 @@ Manage images on machines in the cluster. ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` diff --git a/website/docs/9-cli-reference/uc_image_ls.md b/website/docs/9-cli-reference/uc_image_ls.md index 827802cb..7c8978ff 100644 --- a/website/docs/9-cli-reference/uc_image_ls.md +++ b/website/docs/9-cli-reference/uc_image_ls.md @@ -40,7 +40,7 @@ uc image ls [REPO:[TAG]] [flags] ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` diff --git a/website/docs/9-cli-reference/uc_image_push.md b/website/docs/9-cli-reference/uc_image_push.md index c4713cb1..1f9bfd37 100644 --- a/website/docs/9-cli-reference/uc_image_push.md +++ b/website/docs/9-cli-reference/uc_image_push.md @@ -40,7 +40,7 @@ uc image push IMAGE [flags] ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` diff --git a/website/docs/9-cli-reference/uc_images.md b/website/docs/9-cli-reference/uc_images.md index a29a45ce..3fa869f6 100644 --- a/website/docs/9-cli-reference/uc_images.md +++ b/website/docs/9-cli-reference/uc_images.md @@ -40,7 +40,7 @@ uc images [IMAGE] [flags] ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` diff --git a/website/docs/9-cli-reference/uc_inspect.md b/website/docs/9-cli-reference/uc_inspect.md index 13ad165b..8793e460 100644 --- a/website/docs/9-cli-reference/uc_inspect.md +++ b/website/docs/9-cli-reference/uc_inspect.md @@ -16,7 +16,7 @@ uc inspect SERVICE [flags] ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` diff --git a/website/docs/9-cli-reference/uc_logs.md b/website/docs/9-cli-reference/uc_logs.md new file mode 100644 index 00000000..c6340d38 --- /dev/null +++ b/website/docs/9-cli-reference/uc_logs.md @@ -0,0 +1,77 @@ +# uc logs + +View service logs. + +## Synopsis + +View logs from all replicas of the specified service(s) across all machines in the cluster. + +If no services are specified, streams logs from all services defined in the Compose file +(compose.yaml by default or the file(s) specified with --file). + +``` +uc logs [SERVICE...] [flags] +``` + +## Examples + +``` + # View recent logs for a service. + uc logs web + + # Stream logs in real-time (follow mode). + uc logs -f web + + # View logs from multiple services. + uc logs web api db + + # View logs from all services in compose.yaml. + uc logs + + # Show last 20 lines per replica (default is 100). + uc logs -n 20 web + + # Show all logs without line limit. + uc logs -n all web + + # View logs from a specific time range. + uc logs --since 3h --until 1h30m web + + # View logs only from replicas running on specific machines. + uc logs -m machine1,machine2 web api +``` + +## Options + +``` + --file strings One or more Compose files to load service names from when no services are specified. (default compose.yaml) + -f, --follow Continually stream new logs. + -h, --help help for logs + -m, --machine strings Filter logs by machine name or ID. Can be specified multiple times or as a comma-separated list. + --since string Show logs generated on or after the given timestamp. Accepts relative duration, RFC 3339 date, or Unix timestamp. + Examples: + --since 2m30s Relative duration (2 minutes 30 seconds ago) + --since 1h Relative duration (1 hour ago) + --since 2025-11-24 RFC 3339 date only (midnight using local timezone) + --since 2024-05-14T22:50:00 RFC 3339 date/time using local timezone + --since 2024-01-31T10:30:00Z RFC 3339 date/time in UTC + --since 1763953966 Unix timestamp (seconds since January 1, 1970) + -n, --tail string Show the most recent logs and limit the number of lines shown per replica. Use 'all' to show all logs. (default "100") + --until string Show logs generated before the given timestamp. Accepts relative duration, RFC 3339 date, or Unix timestamp. + See --since for examples. + --utc Print timestamps in UTC instead of local timezone. +``` + +## Options inherited from parent commands + +``` + --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock + -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] + --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 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 b374cf04..a3e914e7 100644 --- a/website/docs/9-cli-reference/uc_ls.md +++ b/website/docs/9-cli-reference/uc_ls.md @@ -16,7 +16,7 @@ uc ls [flags] ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` diff --git a/website/docs/9-cli-reference/uc_machine.md b/website/docs/9-cli-reference/uc_machine.md index d78f5da5..5b8e543b 100644 --- a/website/docs/9-cli-reference/uc_machine.md +++ b/website/docs/9-cli-reference/uc_machine.md @@ -1,6 +1,6 @@ # uc machine -Manage machines in an Uncloud cluster. +Manage machines in the cluster. ## Options @@ -12,7 +12,7 @@ Manage machines in an Uncloud cluster. ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` diff --git a/website/docs/9-cli-reference/uc_machine_add.md b/website/docs/9-cli-reference/uc_machine_add.md index c00734a1..36521356 100644 --- a/website/docs/9-cli-reference/uc_machine_add.md +++ b/website/docs/9-cli-reference/uc_machine_add.md @@ -30,12 +30,12 @@ uc machine add [USER@]HOST[:PORT] [flags] ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` ## See also -* [uc machine](uc_machine.md) - Manage machines in an Uncloud cluster. +* [uc machine](uc_machine.md) - Manage machines in the cluster. diff --git a/website/docs/9-cli-reference/uc_machine_init.md b/website/docs/9-cli-reference/uc_machine_init.md index c13e0b47..a6be0751 100644 --- a/website/docs/9-cli-reference/uc_machine_init.md +++ b/website/docs/9-cli-reference/uc_machine_init.md @@ -52,11 +52,11 @@ uc machine init [USER@HOST:PORT] [flags] ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` ## See also -* [uc machine](uc_machine.md) - Manage machines in an Uncloud cluster. +* [uc machine](uc_machine.md) - Manage machines in the cluster. diff --git a/website/docs/9-cli-reference/uc_machine_ls.md b/website/docs/9-cli-reference/uc_machine_ls.md index bb78f471..1f5f190b 100644 --- a/website/docs/9-cli-reference/uc_machine_ls.md +++ b/website/docs/9-cli-reference/uc_machine_ls.md @@ -16,12 +16,12 @@ uc machine ls [flags] ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` ## See also -* [uc machine](uc_machine.md) - Manage machines in an Uncloud cluster. +* [uc machine](uc_machine.md) - Manage machines in the cluster. diff --git a/website/docs/9-cli-reference/uc_machine_rename.md b/website/docs/9-cli-reference/uc_machine_rename.md index 1ba0ff6b..e042ab59 100644 --- a/website/docs/9-cli-reference/uc_machine_rename.md +++ b/website/docs/9-cli-reference/uc_machine_rename.md @@ -23,12 +23,12 @@ uc machine rename OLD_NAME NEW_NAME [flags] ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` ## See also -* [uc machine](uc_machine.md) - Manage machines in an Uncloud cluster. +* [uc machine](uc_machine.md) - Manage machines in the cluster. diff --git a/website/docs/9-cli-reference/uc_machine_rm.md b/website/docs/9-cli-reference/uc_machine_rm.md index 8396b680..43ddaafb 100644 --- a/website/docs/9-cli-reference/uc_machine_rm.md +++ b/website/docs/9-cli-reference/uc_machine_rm.md @@ -18,12 +18,12 @@ uc machine rm MACHINE [flags] ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` ## See also -* [uc machine](uc_machine.md) - Manage machines in an Uncloud cluster. +* [uc machine](uc_machine.md) - Manage machines in the cluster. diff --git a/website/docs/9-cli-reference/uc_machine_token.md b/website/docs/9-cli-reference/uc_machine_token.md index 229bd2aa..52bbfb07 100644 --- a/website/docs/9-cli-reference/uc_machine_token.md +++ b/website/docs/9-cli-reference/uc_machine_token.md @@ -17,12 +17,12 @@ uc machine token [flags] ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` ## See also -* [uc machine](uc_machine.md) - Manage machines in an Uncloud cluster. +* [uc machine](uc_machine.md) - Manage machines in the cluster. diff --git a/website/docs/9-cli-reference/uc_machine_update.md b/website/docs/9-cli-reference/uc_machine_update.md index 31e81ea5..2294698a 100644 --- a/website/docs/9-cli-reference/uc_machine_update.md +++ b/website/docs/9-cli-reference/uc_machine_update.md @@ -28,12 +28,12 @@ uc machine update [flags] ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` ## See also -* [uc machine](uc_machine.md) - Manage machines in an Uncloud cluster. +* [uc machine](uc_machine.md) - Manage machines in the cluster. diff --git a/website/docs/9-cli-reference/uc_ps.md b/website/docs/9-cli-reference/uc_ps.md new file mode 100644 index 00000000..a71875ed --- /dev/null +++ b/website/docs/9-cli-reference/uc_ps.md @@ -0,0 +1,35 @@ +# uc ps + +List all service containers in the cluster + +## Synopsis + +List all service containers across all machines in the cluster. + +This command provides a comprehensive overview of all running containers that are part of a service, +making it easy to see the distribution and status of containers across the cluster. + +``` +uc ps [flags] +``` + +## Options + +``` + -h, --help help for ps + -s, --sort string Sort containers by 'service', 'machine' or 'health' (default "service") +``` + +## Options inherited from parent commands + +``` + --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock + -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] + --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 machines, services, and volumes. + diff --git a/website/docs/9-cli-reference/uc_rm.md b/website/docs/9-cli-reference/uc_rm.md index 66b40de1..a9b32370 100644 --- a/website/docs/9-cli-reference/uc_rm.md +++ b/website/docs/9-cli-reference/uc_rm.md @@ -24,7 +24,7 @@ uc rm SERVICE [SERVICE...] [flags] ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` diff --git a/website/docs/9-cli-reference/uc_run.md b/website/docs/9-cli-reference/uc_run.md index fa34f389..84147a80 100644 --- a/website/docs/9-cli-reference/uc_run.md +++ b/website/docs/9-cli-reference/uc_run.md @@ -46,7 +46,7 @@ uc run IMAGE [COMMAND...] [flags] ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` diff --git a/website/docs/9-cli-reference/uc_scale.md b/website/docs/9-cli-reference/uc_scale.md index 246f977e..4445721c 100644 --- a/website/docs/9-cli-reference/uc_scale.md +++ b/website/docs/9-cli-reference/uc_scale.md @@ -20,7 +20,7 @@ uc scale SERVICE REPLICAS [flags] ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` diff --git a/website/docs/9-cli-reference/uc_service.md b/website/docs/9-cli-reference/uc_service.md index 0c61daed..6bc5c1cc 100644 --- a/website/docs/9-cli-reference/uc_service.md +++ b/website/docs/9-cli-reference/uc_service.md @@ -1,6 +1,6 @@ # uc service -Manage services in an Uncloud cluster. +Manage services in the cluster. ## Options @@ -12,7 +12,7 @@ Manage services in an Uncloud cluster. ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` @@ -22,8 +22,11 @@ Manage services in an Uncloud cluster. * [uc](uc.md) - A CLI tool for managing Uncloud resources such as machines, services, and volumes. * [uc service exec](uc_service_exec.md) - Execute a command in a running service container * [uc service inspect](uc_service_inspect.md) - Display detailed information on a service. +* [uc service logs](uc_service_logs.md) - View service logs. * [uc service ls](uc_service_ls.md) - List services. * [uc service rm](uc_service_rm.md) - Remove one or more services. * [uc service run](uc_service_run.md) - Run a service. * [uc service scale](uc_service_scale.md) - Scale a replicated service by changing the number of replicas. +* [uc service start](uc_service_start.md) - Start one or more services. +* [uc service stop](uc_service_stop.md) - Stop one or more services. diff --git a/website/docs/9-cli-reference/uc_service_exec.md b/website/docs/9-cli-reference/uc_service_exec.md index d69d9ee6..dd9927ce 100644 --- a/website/docs/9-cli-reference/uc_service_exec.md +++ b/website/docs/9-cli-reference/uc_service_exec.md @@ -45,12 +45,12 @@ uc service exec [OPTIONS] SERVICE [COMMAND ARGS...] [flags] ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` ## See also -* [uc service](uc_service.md) - Manage services in an Uncloud cluster. +* [uc service](uc_service.md) - Manage services in the cluster. diff --git a/website/docs/9-cli-reference/uc_service_inspect.md b/website/docs/9-cli-reference/uc_service_inspect.md index 66df90c3..9e4a6798 100644 --- a/website/docs/9-cli-reference/uc_service_inspect.md +++ b/website/docs/9-cli-reference/uc_service_inspect.md @@ -16,12 +16,12 @@ uc service inspect SERVICE [flags] ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` ## See also -* [uc service](uc_service.md) - Manage services in an Uncloud cluster. +* [uc service](uc_service.md) - Manage services in the cluster. diff --git a/website/docs/9-cli-reference/uc_service_logs.md b/website/docs/9-cli-reference/uc_service_logs.md new file mode 100644 index 00000000..4af9a569 --- /dev/null +++ b/website/docs/9-cli-reference/uc_service_logs.md @@ -0,0 +1,77 @@ +# uc service logs + +View service logs. + +## Synopsis + +View logs from all replicas of the specified service(s) across all machines in the cluster. + +If no services are specified, streams logs from all services defined in the Compose file +(compose.yaml by default or the file(s) specified with --file). + +``` +uc service logs [SERVICE...] [flags] +``` + +## Examples + +``` + # View recent logs for a service. + uc logs web + + # Stream logs in real-time (follow mode). + uc logs -f web + + # View logs from multiple services. + uc logs web api db + + # View logs from all services in compose.yaml. + uc logs + + # Show last 20 lines per replica (default is 100). + uc logs -n 20 web + + # Show all logs without line limit. + uc logs -n all web + + # View logs from a specific time range. + uc logs --since 3h --until 1h30m web + + # View logs only from replicas running on specific machines. + uc logs -m machine1,machine2 web api +``` + +## Options + +``` + --file strings One or more Compose files to load service names from when no services are specified. (default compose.yaml) + -f, --follow Continually stream new logs. + -h, --help help for logs + -m, --machine strings Filter logs by machine name or ID. Can be specified multiple times or as a comma-separated list. + --since string Show logs generated on or after the given timestamp. Accepts relative duration, RFC 3339 date, or Unix timestamp. + Examples: + --since 2m30s Relative duration (2 minutes 30 seconds ago) + --since 1h Relative duration (1 hour ago) + --since 2025-11-24 RFC 3339 date only (midnight using local timezone) + --since 2024-05-14T22:50:00 RFC 3339 date/time using local timezone + --since 2024-01-31T10:30:00Z RFC 3339 date/time in UTC + --since 1763953966 Unix timestamp (seconds since January 1, 1970) + -n, --tail string Show the most recent logs and limit the number of lines shown per replica. Use 'all' to show all logs. (default "100") + --until string Show logs generated before the given timestamp. Accepts relative duration, RFC 3339 date, or Unix timestamp. + See --since for examples. + --utc Print timestamps in UTC instead of local timezone. +``` + +## Options inherited from parent commands + +``` + --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock + -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] + --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") +``` + +## See also + +* [uc service](uc_service.md) - Manage services in the cluster. + diff --git a/website/docs/9-cli-reference/uc_service_ls.md b/website/docs/9-cli-reference/uc_service_ls.md index 850f9b37..4820d5c9 100644 --- a/website/docs/9-cli-reference/uc_service_ls.md +++ b/website/docs/9-cli-reference/uc_service_ls.md @@ -16,12 +16,12 @@ uc service ls [flags] ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` ## See also -* [uc service](uc_service.md) - Manage services in an Uncloud cluster. +* [uc service](uc_service.md) - Manage services in the cluster. diff --git a/website/docs/9-cli-reference/uc_service_rm.md b/website/docs/9-cli-reference/uc_service_rm.md index d4f687c1..05b1ca4b 100644 --- a/website/docs/9-cli-reference/uc_service_rm.md +++ b/website/docs/9-cli-reference/uc_service_rm.md @@ -24,12 +24,12 @@ uc service rm SERVICE [SERVICE...] [flags] ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` ## See also -* [uc service](uc_service.md) - Manage services in an Uncloud cluster. +* [uc service](uc_service.md) - Manage services in the cluster. diff --git a/website/docs/9-cli-reference/uc_service_run.md b/website/docs/9-cli-reference/uc_service_run.md index 6b289f5e..de57203a 100644 --- a/website/docs/9-cli-reference/uc_service_run.md +++ b/website/docs/9-cli-reference/uc_service_run.md @@ -46,12 +46,12 @@ uc service run IMAGE [COMMAND...] [flags] ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` ## See also -* [uc service](uc_service.md) - Manage services in an Uncloud cluster. +* [uc service](uc_service.md) - Manage services in the cluster. diff --git a/website/docs/9-cli-reference/uc_service_scale.md b/website/docs/9-cli-reference/uc_service_scale.md index 0cca3dcb..1b1a4007 100644 --- a/website/docs/9-cli-reference/uc_service_scale.md +++ b/website/docs/9-cli-reference/uc_service_scale.md @@ -20,12 +20,12 @@ uc service scale SERVICE REPLICAS [flags] ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` ## See also -* [uc service](uc_service.md) - Manage services in an Uncloud cluster. +* [uc service](uc_service.md) - Manage services in the cluster. diff --git a/website/docs/9-cli-reference/uc_service_start.md b/website/docs/9-cli-reference/uc_service_start.md new file mode 100644 index 00000000..6fbc33db --- /dev/null +++ b/website/docs/9-cli-reference/uc_service_start.md @@ -0,0 +1,31 @@ +# uc service start + +Start one or more services. + +## Synopsis + +Start one or more services. + +``` +uc service start SERVICE [SERVICE...] [flags] +``` + +## Options + +``` + -h, --help help for start +``` + +## Options inherited from parent commands + +``` + --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock + -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] + --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") +``` + +## See also + +* [uc service](uc_service.md) - Manage services in the cluster. + diff --git a/website/docs/9-cli-reference/uc_service_stop.md b/website/docs/9-cli-reference/uc_service_stop.md new file mode 100644 index 00000000..19698a8b --- /dev/null +++ b/website/docs/9-cli-reference/uc_service_stop.md @@ -0,0 +1,33 @@ +# uc service stop + +Stop one or more services. + +## Synopsis + +Stop one or more services. + +``` +uc service stop SERVICE [SERVICE...] [flags] +``` + +## Options + +``` + -h, --help help for stop + -s, --signal string Signal to send to the container + -t, --timeout int Seconds to wait before killing the container +``` + +## Options inherited from parent commands + +``` + --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock + -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] + --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") +``` + +## See also + +* [uc service](uc_service.md) - Manage services in the cluster. + diff --git a/website/docs/9-cli-reference/uc_volume.md b/website/docs/9-cli-reference/uc_volume.md index be24823d..62665c42 100644 --- a/website/docs/9-cli-reference/uc_volume.md +++ b/website/docs/9-cli-reference/uc_volume.md @@ -1,6 +1,6 @@ # uc volume -Manage volumes in an Uncloud cluster. +Manage volumes in the cluster. ## Options @@ -12,7 +12,7 @@ Manage volumes in an Uncloud cluster. ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` diff --git a/website/docs/9-cli-reference/uc_volume_create.md b/website/docs/9-cli-reference/uc_volume_create.md index 542a6e0c..f7370f8c 100644 --- a/website/docs/9-cli-reference/uc_volume_create.md +++ b/website/docs/9-cli-reference/uc_volume_create.md @@ -20,12 +20,12 @@ uc volume create VOLUME_NAME [flags] ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` ## See also -* [uc volume](uc_volume.md) - Manage volumes in an Uncloud cluster. +* [uc volume](uc_volume.md) - Manage volumes in the cluster. diff --git a/website/docs/9-cli-reference/uc_volume_inspect.md b/website/docs/9-cli-reference/uc_volume_inspect.md index a9ca99ba..de4c30b2 100644 --- a/website/docs/9-cli-reference/uc_volume_inspect.md +++ b/website/docs/9-cli-reference/uc_volume_inspect.md @@ -17,12 +17,12 @@ uc volume inspect VOLUME_NAME [flags] ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` ## See also -* [uc volume](uc_volume.md) - Manage volumes in an Uncloud cluster. +* [uc volume](uc_volume.md) - Manage volumes in the cluster. diff --git a/website/docs/9-cli-reference/uc_volume_ls.md b/website/docs/9-cli-reference/uc_volume_ls.md index e9553377..98a1007d 100644 --- a/website/docs/9-cli-reference/uc_volume_ls.md +++ b/website/docs/9-cli-reference/uc_volume_ls.md @@ -18,12 +18,12 @@ uc volume ls [flags] ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` ## See also -* [uc volume](uc_volume.md) - Manage volumes in an Uncloud cluster. +* [uc volume](uc_volume.md) - Manage volumes in the cluster. diff --git a/website/docs/9-cli-reference/uc_volume_rm.md b/website/docs/9-cli-reference/uc_volume_rm.md index f60940e7..c5d81214 100644 --- a/website/docs/9-cli-reference/uc_volume_rm.md +++ b/website/docs/9-cli-reference/uc_volume_rm.md @@ -24,12 +24,12 @@ uc volume rm VOLUME_NAME [VOLUME_NAME...] [flags] ``` --connect string Connect to a remote cluster machine without using the Uncloud configuration file. [$UNCLOUD_CONNECT] - Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], or tcp://host:port + Format: [ssh://]user@host[:port], ssh+cli://user@host[:port], tcp://host:port, or unix:///path/to/uncloud.sock -c, --context string Name of the cluster context to use (default is the current context). [$UNCLOUD_CONTEXT] --uncloud-config string Path to the Uncloud configuration file. [$UNCLOUD_CONFIG] (default "~/.config/uncloud/config.yaml") ``` ## See also -* [uc volume](uc_volume.md) - Manage volumes in an Uncloud cluster. +* [uc volume](uc_volume.md) - Manage volumes in the cluster.