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

doc: Generate docs

Browse Source
This commit is contained in:
Anton Ovchinnikov
2025-11-05 23:48:30 +01:00
parent abea3e229e
commit 06d988583d
6 changed files with 60 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files
website/docs/9-cli-reference/uc_build.md
+44 -5
View File
@@ -2,18 +2,57 @@
Build services from a Compose file. Build services from a Compose file.
## Synopsis
Build images for services from a Compose file using local Docker.
By default, built images remain on the local Docker host. Use --push to upload them
to cluster machines or --push-registry to upload them to external registries.
``` ```
uc build [FLAGS] [SERVICE...] [flags] uc build [FLAGS] [SERVICE...] [flags]
``` ```
## Examples
```
# Build all services that have a build section in compose.yaml.
uc build
# Build specific services that have a build section.
uc build web api
# Build services and push images to all cluster machines or service x-machines if specified.
uc build --push
# Build services and push images to specific machines.
uc build --push -m machine1,machine2
# Build services and push images to external registries (e.g., Docker Hub).
uc build --push-registry
# Build services with build arguments, pull newer base images before building, and don't use cache.
uc build --build-arg NODE_VERSION=24 --build-arg ENV=production --no-cache --pull
```
## Options ## Options
``` ```
-f, --file strings One or more Compose files to build (default compose.yaml) --build-arg stringArray Set a build-time variable for services. Used in Dockerfiles that declare the variable with ARG.
-h, --help help for build Can be specified multiple times. Format: --build-arg VAR=VALUE
-n, --no-cache Do not use cache when building images. (default false) --check Check the build configuration for services without building them.
-p, --profile strings One or more Compose profiles to enable. -c, --context string Name of the cluster context. (default is the current context)
-P, --push Push built images to the registry after building. (default false) --deps Also build services declared as dependencies of the selected services.
-f, --file strings One or more Compose files to build. (default compose.yaml)
-h, --help help for build
-m, --machine strings Machine names or IDs to push the built images to (requires --push).
Can be specified multiple times or as a comma-separated list. (default is all machines or x-machines)
--no-cache Do not use cache when building images.
-p, --profile strings One or more Compose profiles to enable.
--pull Always attempt to pull newer versions of base images before building.
--push Upload the built images to cluster machines after building.
Use --machine to specify which machines. (default is all machines)
--push-registry Upload the built images to external registries (e.g., Docker Hub) after building.
``` ```
## Options inherited from parent commands ## Options inherited from parent commands
website/docs/9-cli-reference/uc_caddy_deploy.md
+1 -1
View File
@@ -18,7 +18,7 @@ uc caddy deploy [flags]
-c, --context string Name of the cluster context to deploy to. (default is the current context) -c, --context string Name of the cluster context to deploy to. (default is the current context)
-h, --help help for deploy -h, --help help for deploy
--image string Caddy Docker image to deploy. (default caddy:LATEST_VERSION) --image string Caddy Docker image to deploy. (default caddy:LATEST_VERSION)
-m, --machine strings Machine names to deploy to. Can be specified multiple times or as a comma-separated list of machine names. (default is all machines) -m, --machine strings Machine names or IDs to deploy to. Can be specified multiple times or as a comma-separated list. (default is all machines)
``` ```
## Options inherited from parent commands ## Options inherited from parent commands
website/docs/9-cli-reference/uc_deploy.md
+12 -8
View File
@@ -9,14 +9,18 @@ uc deploy [FLAGS] [SERVICE...] [flags]
## Options ## Options
``` ```
-c, --context string Name of the cluster context to deploy to (default is the current context) --build-arg stringArray Set a build-time variable for services. Used in Dockerfiles that declare the variable with ARG.
-f, --file strings One or more Compose files to deploy services from. (default compose.yaml) Can be specified multiple times. Format: --build-arg VAR=VALUE
-h, --help help for deploy --build-pull Always attempt to pull newer versions of base images before building service images.
-n, --no-build Do not build images before deploying services. (default false) -c, --context string Name of the cluster context to deploy to (default is the current context)
-p, --profile strings One or more Compose profiles to enable. -f, --file strings One or more Compose files to deploy services from. (default compose.yaml)
--recreate Recreate containers even if their configuration and image haven't changed. -h, --help help for deploy
-y, --yes Auto-confirm deployment plan. Should be explicitly set when running non-interactively, --no-build Do not build new images before deploying services.
e.g., in CI/CD pipelines. [$UNCLOUD_AUTO_CONFIRM] --no-cache Do not use cache when building images.
-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. Should be explicitly set when running non-interactively,
e.g., in CI/CD pipelines. [$UNCLOUD_AUTO_CONFIRM]
``` ```
## Options inherited from parent commands ## Options inherited from parent commands
website/docs/9-cli-reference/uc_exec.md
+1 -1
View File
@@ -26,7 +26,7 @@ uc exec [OPTIONS] SERVICE [COMMAND ARGS...] [flags]
uc exec --container d792ea7347e5 web-service ls -la uc exec --container d792ea7347e5 web-service ls -la
# Pipe input to a command inside the service container # Pipe input to a command inside the service container
cat /var/log/app.log | uc exec -T web-service grep "ERROR" cat backup.sql | uc exec -T db-service psql -U postgres mydb
# Run a task in the background (detached mode) # Run a task in the background (detached mode)
uc exec -d web-service /scripts/cleanup.sh uc exec -d web-service /scripts/cleanup.sh
website/docs/9-cli-reference/uc_image_push.md
+1 -2
View File
@@ -35,8 +35,7 @@ uc image push IMAGE [flags]
``` ```
-c, --context string Name of the cluster context. (default is the current context) -c, --context string Name of the cluster context. (default is the current context)
-h, --help help for push -h, --help help for push
-m, --machine strings Machine names to push the image to. Can be specified multiple times or as a comma-separated list of machine names. -m, --machine strings Machine names or IDs to push the image to. Can be specified multiple times or as a comma-separated list. (default is all machines)
Use 'all' to push to all machines. (default is connected machine)
--platform string Push a specific platform of a multi-platform image (e.g., linux/amd64, linux/arm64). --platform string Push a specific platform of a multi-platform image (e.g., linux/amd64, linux/arm64).
Local Docker must be configured to use containerd image store to support multi-platform images. Local Docker must be configured to use containerd image store to support multi-platform images.
``` ```
website/docs/9-cli-reference/uc_service_exec.md
+1 -1
View File
@@ -26,7 +26,7 @@ uc service exec [OPTIONS] SERVICE [COMMAND ARGS...] [flags]
uc exec --container d792ea7347e5 web-service ls -la uc exec --container d792ea7347e5 web-service ls -la
# Pipe input to a command inside the service container # Pipe input to a command inside the service container
cat /var/log/app.log | uc exec -T web-service grep "ERROR" cat backup.sql | uc exec -T db-service psql -U postgres mydb
# Run a task in the background (detached mode) # Run a task in the background (detached mode)
uc exec -d web-service /scripts/cleanup.sh uc exec -d web-service /scripts/cleanup.sh