diff --git a/flyctl/cmd/fly_console.md b/flyctl/cmd/fly_console.md index 61161a5072..4b229232d3 100644 --- a/flyctl/cmd/fly_console.md +++ b/flyctl/cmd/fly_console.md @@ -11,34 +11,35 @@ fly console [flags] ## Options ~~~ - -a, --app string Application name - -C, --command string command to run on SSH session - -c, --config string Path to application configuration file - --container string Container to connect to - --dockerfile string Path to a Dockerfile. Defaults to the Dockerfile in the working directory. - --entrypoint string ENTRYPOINT replacement - -e, --env stringArray Set of environment variables in the form of NAME=VALUE pairs. Can be specified multiple times. - --file-literal stringArray Set of literals to write to the Machine, in the form of /path/inside/machine=VALUE pairs, where VALUE is the base64-encoded raw content. Can be specified multiple times. - --file-local stringArray Set of files to write to the Machine, in the form of /path/inside/machine= pairs. Can be specified multiple times. - --file-secret stringArray Set of secrets to write to the Machine, in the form of /path/inside/machine=SECRET pairs, where SECRET is the name of the secret. The content of the secret must be base64 encoded. Can be specified multiple times. - -h, --help help for console - --host-dedication-id string The dedication id of the reserved hosts for your organization (if any) - -i, --image string image to use (default: current release) - --machine string Run the console in the existing machine with the specified ID - -p, --port strings Publish ports, format: port[:machinePort][/protocol[:handler[:handler...]]]) - i.e.: --port 80/tcp --port 443:80/tcp:http:tls --port 5432/tcp:pg_tls - To remove a port mapping use '-' as handler, i.e.: --port 80/tcp:- - -r, --region string The target region (see 'flyctl platform regions') - -s, --select Select the machine and container on which to execute the console from a list. - -u, --user string Unix username to connect as (default "root") - --vm-cpu-kind string The kind of CPU to use ('shared' or 'performance') (also --vm-cpukind) - --vm-cpus int Number of CPUs (also --cpus) - --vm-gpu-kind string If set, the GPU model to attach (a100-pcie-40gb, a100-sxm4-80gb, l40s, a10, none) (also --vm-gpukind) - --vm-gpus int Number of GPUs. Must also choose the GPU model with --vm-gpu-kind flag - --vm-memory string Memory (in megabytes) to attribute to the VM (also --memory) - --vm-size string The VM size to set machines to. See "fly platform vm-sizes" for valid values - --volume strings Volume to mount, in the form of :/path/inside/machine[:] - --wg Determines whether communication with remote builders are conducted over wireguard or plain internet(https) (default true) + -a, --app string Application name + --build-context-warn-size string Warn when the Docker build context is larger than this. Accepts a plain number (in MB) or a human-readable size (e.g. 512mb, 1gb). Set to 0 to disable. Also set with FLY_BUILD_CONTEXT_WARN_SIZE. + -C, --command string command to run on SSH session + -c, --config string Path to application configuration file + --container string Container to connect to + --dockerfile string Path to a Dockerfile. Defaults to the Dockerfile in the working directory. + --entrypoint string ENTRYPOINT replacement + -e, --env stringArray Set of environment variables in the form of NAME=VALUE pairs. Can be specified multiple times. + --file-literal stringArray Set of literals to write to the Machine, in the form of /path/inside/machine=VALUE pairs, where VALUE is the base64-encoded raw content. Can be specified multiple times. + --file-local stringArray Set of files to write to the Machine, in the form of /path/inside/machine= pairs. Can be specified multiple times. + --file-secret stringArray Set of secrets to write to the Machine, in the form of /path/inside/machine=SECRET pairs, where SECRET is the name of the secret. The content of the secret must be base64 encoded. Can be specified multiple times. + -h, --help help for console + --host-dedication-id string The dedication id of the reserved hosts for your organization (if any) + -i, --image string image to use (default: current release) + --machine string Run the console in the existing machine with the specified ID + -p, --port strings Publish ports, format: port[:machinePort][/protocol[:handler[:handler...]]]) + i.e.: --port 80/tcp --port 443:80/tcp:http:tls --port 5432/tcp:pg_tls + To remove a port mapping use '-' as handler, i.e.: --port 80/tcp:- + -r, --region string The target region (see 'flyctl platform regions') + -s, --select Select the machine and container on which to execute the console from a list. + -u, --user string Unix username to connect as (default "root") + --vm-cpu-kind string The kind of CPU to use ('shared' or 'performance') (also --vm-cpukind) + --vm-cpus int Number of CPUs (also --cpus) + --vm-gpu-kind string If set, the GPU model to attach (a100-pcie-40gb, a100-sxm4-80gb, l40s, a10, none) (also --vm-gpukind) + --vm-gpus int Number of GPUs. Must also choose the GPU model with --vm-gpu-kind flag + --vm-memory string Memory (in megabytes) to attribute to the VM (also --memory) + --vm-size string The VM size to set machines to. See "fly platform vm-sizes" for valid values + --volume strings Volume to mount, in the form of :/path/inside/machine[:] + --wg Determines whether communication with remote builders are conducted over wireguard or plain internet(https) (default true) ~~~ ## Global Options diff --git a/flyctl/cmd/fly_deploy.md b/flyctl/cmd/fly_deploy.md index 9fafc3a376..cc0904eb62 100644 --- a/flyctl/cmd/fly_deploy.md +++ b/flyctl/cmd/fly_deploy.md @@ -13,6 +13,7 @@ fly deploy [WORKING_DIRECTORY] [flags] ~~~ -a, --app string Application name --build-arg stringArray Set of build time variables in the form of NAME=VALUE pairs. Can be specified multiple times. + --build-context-warn-size string Warn when the Docker build context is larger than this. Accepts a plain number (in MB) or a human-readable size (e.g. 512mb, 1gb). Set to 0 to disable. Also set with FLY_BUILD_CONTEXT_WARN_SIZE. --build-only Build but do not deploy --build-secret stringArray Set of build secrets of NAME=VALUE pairs. Can be specified multiple times. See https://docs.docker.com/engine/reference/commandline/buildx_build/#secret --build-target string Set the target build stage to build if the Dockerfile has more than one stage diff --git a/flyctl/cmd/fly_launch.md b/flyctl/cmd/fly_launch.md index 3b12ac5e17..496c29a62a 100644 --- a/flyctl/cmd/fly_launch.md +++ b/flyctl/cmd/fly_launch.md @@ -11,6 +11,7 @@ fly launch [flags] --attach Attach this new application to the current application --auto-stop string Automatically suspend the app after a period of inactivity. Valid values are 'off', 'stop', and 'suspend' (default "stop") --build-arg stringArray Set of build time variables in the form of NAME=VALUE pairs. Can be specified multiple times. + --build-context-warn-size string Warn when the Docker build context is larger than this. Accepts a plain number (in MB) or a human-readable size (e.g. 512mb, 1gb). Set to 0 to disable. Also set with FLY_BUILD_CONTEXT_WARN_SIZE. --build-only Build but do not deploy --build-secret stringArray Set of build secrets of NAME=VALUE pairs. Can be specified multiple times. See https://docs.docker.com/engine/reference/commandline/buildx_build/#secret --build-target string Set the target build stage to build if the Dockerfile has more than one stage diff --git a/flyctl/cmd/fly_machine_create.md b/flyctl/cmd/fly_machine_create.md index a55a63553e..ca3a827ad4 100644 --- a/flyctl/cmd/fly_machine_create.md +++ b/flyctl/cmd/fly_machine_create.md @@ -9,49 +9,50 @@ fly machine create [command] [flags] ## Options ~~~ - -a, --app string Application name - --autostart Automatically start a stopped Machine when a network request is received (default true) - --autostop string[="stop"] Automatically stop a Machine when there are no network requests for it. Options include 'off', 'stop', and 'suspend'. (default "off") - --build-depot Build your image with depot.dev - --build-nixpacks Build your image with nixpacks - --cachedrive-size string Cache drive size in MB. Accepts a plain number (in MB) or a human-readable size (e.g. 512mb, 10gb). Set to 0 to disable. - -c, --config string Path to application configuration file - --detach Return immediately instead of monitoring deployment progress - --dockerfile string The path to a Dockerfile. Defaults to the Dockerfile in the working directory. - --entrypoint string The command to override the Docker ENTRYPOINT. - -e, --env stringArray Set of environment variables in the form of NAME=VALUE pairs. Can be specified multiple times. - --file-literal stringArray Set of literals to write to the Machine, in the form of /path/inside/machine=VALUE pairs, where VALUE is the base64-encoded raw content. Can be specified multiple times. - --file-local stringArray Set of files to write to the Machine, in the form of /path/inside/machine= pairs. Can be specified multiple times. - --file-secret stringArray Set of secrets to write to the Machine, in the form of /path/inside/machine=SECRET pairs, where SECRET is the name of the secret. The content of the secret must be base64 encoded. Can be specified multiple times. - -h, --help help for create - --host-dedication-id string The dedication id of the reserved hosts for your organization (if any) - --id string Machine ID, if previously known - --kernel-arg stringArray A list of kernel arguments to provide to the init. Can be specified multiple times. - --machine-config string Read machine config from json file or string - -m, --metadata stringArray Metadata in the form of NAME=VALUE pairs. Can be specified multiple times. - -n, --name string Machine name. Will be generated if omitted. - --org string The organization that will own the app - -p, --port strings The external ports and handlers for services, in the format: port[:machinePort][/protocol[:handler[:handler...]]]) - For example: --port 80/tcp --port 443:80/tcp:http:tls --port 5432/tcp:pg_tls - To remove a port mapping use '-' as handler. For example: --port 80/tcp:- - -r, --region string The target region (see 'flyctl platform regions') - --restart string Set the restart policy for a Machine. Options include 'no', 'always', and 'on-failure'. - Default is 'on-failure' for Machines created by 'fly deploy' and Machines with a schedule. Default is 'always' for Machines created by 'fly m run'. - --rm Automatically remove the Machine when it exits. Sets the restart-policy to 'never' if not otherwise specified. - --rootfs-persist string Whether to persist the root filesystem across restarts. Options include 'never', 'always', and 'restart'. - --rootfs-size string Root filesystem size in GB. Accepts a plain number (in GB) or a human-readable size (e.g. 2gb, 5gb). Uses an overlayfs to allow the root filesystem to exceed its default size. Set to 0 to unset. - --schedule string Schedule a Machine run at hourly, daily, weekly and monthly intervals - --skip-dns-registration Do not register the machine's 6PN IP with the internal DNS system - --standby-for strings For Machines without services, a comma separated list of Machine IDs to act as standby for. - --swap-size string Swap size in MB. Accepts a plain number (in MB) or a human-readable size (e.g. 512mb, 1gb). - --use-zstd Enable zstd compression for the image - --vm-cpu-kind string The kind of CPU to use ('shared' or 'performance') (also --vm-cpukind) - --vm-cpus int Number of CPUs (also --cpus) - --vm-gpu-kind string If set, the GPU model to attach (a100-pcie-40gb, a100-sxm4-80gb, l40s, a10, none) (also --vm-gpukind) - --vm-gpus int Number of GPUs. Must also choose the GPU model with --vm-gpu-kind flag - --vm-memory string Memory (in megabytes) to attribute to the VM (also --memory) - --vm-size string The VM size to set machines to. See "fly platform vm-sizes" for valid values - -v, --volume strings Volume to mount, in the form of :/path/inside/machine[:] + -a, --app string Application name + --autostart Automatically start a stopped Machine when a network request is received (default true) + --autostop string[="stop"] Automatically stop a Machine when there are no network requests for it. Options include 'off', 'stop', and 'suspend'. (default "off") + --build-context-warn-size string Warn when the Docker build context is larger than this. Accepts a plain number (in MB) or a human-readable size (e.g. 512mb, 1gb). Set to 0 to disable. Also set with FLY_BUILD_CONTEXT_WARN_SIZE. + --build-depot Build your image with depot.dev + --build-nixpacks Build your image with nixpacks + --cachedrive-size string Cache drive size in MB. Accepts a plain number (in MB) or a human-readable size (e.g. 512mb, 10gb). Set to 0 to disable. + -c, --config string Path to application configuration file + --detach Return immediately instead of monitoring deployment progress + --dockerfile string The path to a Dockerfile. Defaults to the Dockerfile in the working directory. + --entrypoint string The command to override the Docker ENTRYPOINT. + -e, --env stringArray Set of environment variables in the form of NAME=VALUE pairs. Can be specified multiple times. + --file-literal stringArray Set of literals to write to the Machine, in the form of /path/inside/machine=VALUE pairs, where VALUE is the base64-encoded raw content. Can be specified multiple times. + --file-local stringArray Set of files to write to the Machine, in the form of /path/inside/machine= pairs. Can be specified multiple times. + --file-secret stringArray Set of secrets to write to the Machine, in the form of /path/inside/machine=SECRET pairs, where SECRET is the name of the secret. The content of the secret must be base64 encoded. Can be specified multiple times. + -h, --help help for create + --host-dedication-id string The dedication id of the reserved hosts for your organization (if any) + --id string Machine ID, if previously known + --kernel-arg stringArray A list of kernel arguments to provide to the init. Can be specified multiple times. + --machine-config string Read machine config from json file or string + -m, --metadata stringArray Metadata in the form of NAME=VALUE pairs. Can be specified multiple times. + -n, --name string Machine name. Will be generated if omitted. + --org string The organization that will own the app + -p, --port strings The external ports and handlers for services, in the format: port[:machinePort][/protocol[:handler[:handler...]]]) + For example: --port 80/tcp --port 443:80/tcp:http:tls --port 5432/tcp:pg_tls + To remove a port mapping use '-' as handler. For example: --port 80/tcp:- + -r, --region string The target region (see 'flyctl platform regions') + --restart string Set the restart policy for a Machine. Options include 'no', 'always', and 'on-failure'. + Default is 'on-failure' for Machines created by 'fly deploy' and Machines with a schedule. Default is 'always' for Machines created by 'fly m run'. + --rm Automatically remove the Machine when it exits. Sets the restart-policy to 'never' if not otherwise specified. + --rootfs-persist string Whether to persist the root filesystem across restarts. Options include 'never', 'always', and 'restart'. + --rootfs-size string Root filesystem size in GB. Accepts a plain number (in GB) or a human-readable size (e.g. 2gb, 5gb). Uses an overlayfs to allow the root filesystem to exceed its default size. Set to 0 to unset. + --schedule string Schedule a Machine run at hourly, daily, weekly and monthly intervals + --skip-dns-registration Do not register the machine's 6PN IP with the internal DNS system + --standby-for strings For Machines without services, a comma separated list of Machine IDs to act as standby for. + --swap-size string Swap size in MB. Accepts a plain number (in MB) or a human-readable size (e.g. 512mb, 1gb). + --use-zstd Enable zstd compression for the image + --vm-cpu-kind string The kind of CPU to use ('shared' or 'performance') (also --vm-cpukind) + --vm-cpus int Number of CPUs (also --cpus) + --vm-gpu-kind string If set, the GPU model to attach (a100-pcie-40gb, a100-sxm4-80gb, l40s, a10, none) (also --vm-gpukind) + --vm-gpus int Number of GPUs. Must also choose the GPU model with --vm-gpu-kind flag + --vm-memory string Memory (in megabytes) to attribute to the VM (also --memory) + --vm-size string The VM size to set machines to. See "fly platform vm-sizes" for valid values + -v, --volume strings Volume to mount, in the form of :/path/inside/machine[:] ~~~ ## Global Options diff --git a/flyctl/cmd/fly_machine_run.md b/flyctl/cmd/fly_machine_run.md index 3922d75827..fd117e2440 100644 --- a/flyctl/cmd/fly_machine_run.md +++ b/flyctl/cmd/fly_machine_run.md @@ -9,54 +9,55 @@ fly machine run [command] [flags] ## Options ~~~ - -a, --app string Application name - --autostart Automatically start a stopped Machine when a network request is received (default true) - --autostop string[="stop"] Automatically stop a Machine when there are no network requests for it. Options include 'off', 'stop', and 'suspend'. (default "off") - --build-depot Build your image with depot.dev - --build-nixpacks Build your image with nixpacks - --cachedrive-size string Cache drive size in MB. Accepts a plain number (in MB) or a human-readable size (e.g. 512mb, 10gb). Set to 0 to disable. - --command string Used with --shell. The command to run, if we're shelling into the Machine now (in case you don't have bash). (default "/bin/bash") - -c, --config string Path to application configuration file - --container string Container to update with the new image, files, etc; defaults to "app" or the first container in the config. - --detach Return immediately instead of monitoring deployment progress - --dockerfile string The path to a Dockerfile. Defaults to the Dockerfile in the working directory. - --entrypoint string The command to override the Docker ENTRYPOINT. - -e, --env stringArray Set of environment variables in the form of NAME=VALUE pairs. Can be specified multiple times. - --file-literal stringArray Set of literals to write to the Machine, in the form of /path/inside/machine=VALUE pairs, where VALUE is the base64-encoded raw content. Can be specified multiple times. - --file-local stringArray Set of files to write to the Machine, in the form of /path/inside/machine= pairs. Can be specified multiple times. - --file-secret stringArray Set of secrets to write to the Machine, in the form of /path/inside/machine=SECRET pairs, where SECRET is the name of the secret. The content of the secret must be base64 encoded. Can be specified multiple times. - -h, --help help for run - --host-dedication-id string The dedication id of the reserved hosts for your organization (if any) - --id string Machine ID, if previously known - --kernel-arg stringArray A list of kernel arguments to provide to the init. Can be specified multiple times. - --machine-config string Read machine config from json file or string - -m, --metadata stringArray Metadata in the form of NAME=VALUE pairs. Can be specified multiple times. - -n, --name string Machine name. Will be generated if omitted. - --org string The organization that will own the app - -p, --port strings The external ports and handlers for services, in the format: port[:machinePort][/protocol[:handler[:handler...]]]) - For example: --port 80/tcp --port 443:80/tcp:http:tls --port 5432/tcp:pg_tls - To remove a port mapping use '-' as handler. For example: --port 80/tcp:- - -r, --region string The target region (see 'flyctl platform regions') - --restart string Set the restart policy for a Machine. Options include 'no', 'always', and 'on-failure'. - Default is 'on-failure' for Machines created by 'fly deploy' and Machines with a schedule. Default is 'always' for Machines created by 'fly m run'. - --rm Automatically remove the Machine when it exits. Sets the restart-policy to 'never' if not otherwise specified. - --rootfs-persist string Whether to persist the root filesystem across restarts. Options include 'never', 'always', and 'restart'. - --rootfs-size string Root filesystem size in GB. Accepts a plain number (in GB) or a human-readable size (e.g. 2gb, 5gb). Uses an overlayfs to allow the root filesystem to exceed its default size. Set to 0 to unset. - --schedule string Schedule a Machine run at hourly, daily, weekly and monthly intervals - --shell Open a shell on the Machine once created (implies --it --rm). If no app is specified, a temporary app is created just for this Machine and destroyed when the Machine is destroyed. See also --command and --user. - --skip-dns-registration Do not register the machine's 6PN IP with the internal DNS system - --standby-for strings For Machines without services, a comma separated list of Machine IDs to act as standby for. - --swap-size string Swap size in MB. Accepts a plain number (in MB) or a human-readable size (e.g. 512mb, 1gb). - --use-zstd Enable zstd compression for the image - --user string Used with --shell. The username, if we're shelling into the Machine now. (default "root") - --vm-cpu-kind string The kind of CPU to use ('shared' or 'performance') (also --vm-cpukind) - --vm-cpus int Number of CPUs (also --cpus) - --vm-gpu-kind string If set, the GPU model to attach (a100-pcie-40gb, a100-sxm4-80gb, l40s, a10, none) (also --vm-gpukind) - --vm-gpus int Number of GPUs. Must also choose the GPU model with --vm-gpu-kind flag - --vm-memory string Memory (in megabytes) to attribute to the VM (also --memory) - --vm-size string The VM size to set machines to. See "fly platform vm-sizes" for valid values - -v, --volume strings Volume to mount, in the form of :/path/inside/machine[:] - --wg Determines whether communication with remote builders are conducted over wireguard or plain internet(https) (default true) + -a, --app string Application name + --autostart Automatically start a stopped Machine when a network request is received (default true) + --autostop string[="stop"] Automatically stop a Machine when there are no network requests for it. Options include 'off', 'stop', and 'suspend'. (default "off") + --build-context-warn-size string Warn when the Docker build context is larger than this. Accepts a plain number (in MB) or a human-readable size (e.g. 512mb, 1gb). Set to 0 to disable. Also set with FLY_BUILD_CONTEXT_WARN_SIZE. + --build-depot Build your image with depot.dev + --build-nixpacks Build your image with nixpacks + --cachedrive-size string Cache drive size in MB. Accepts a plain number (in MB) or a human-readable size (e.g. 512mb, 10gb). Set to 0 to disable. + --command string Used with --shell. The command to run, if we're shelling into the Machine now (in case you don't have bash). (default "/bin/bash") + -c, --config string Path to application configuration file + --container string Container to update with the new image, files, etc; defaults to "app" or the first container in the config. + --detach Return immediately instead of monitoring deployment progress + --dockerfile string The path to a Dockerfile. Defaults to the Dockerfile in the working directory. + --entrypoint string The command to override the Docker ENTRYPOINT. + -e, --env stringArray Set of environment variables in the form of NAME=VALUE pairs. Can be specified multiple times. + --file-literal stringArray Set of literals to write to the Machine, in the form of /path/inside/machine=VALUE pairs, where VALUE is the base64-encoded raw content. Can be specified multiple times. + --file-local stringArray Set of files to write to the Machine, in the form of /path/inside/machine= pairs. Can be specified multiple times. + --file-secret stringArray Set of secrets to write to the Machine, in the form of /path/inside/machine=SECRET pairs, where SECRET is the name of the secret. The content of the secret must be base64 encoded. Can be specified multiple times. + -h, --help help for run + --host-dedication-id string The dedication id of the reserved hosts for your organization (if any) + --id string Machine ID, if previously known + --kernel-arg stringArray A list of kernel arguments to provide to the init. Can be specified multiple times. + --machine-config string Read machine config from json file or string + -m, --metadata stringArray Metadata in the form of NAME=VALUE pairs. Can be specified multiple times. + -n, --name string Machine name. Will be generated if omitted. + --org string The organization that will own the app + -p, --port strings The external ports and handlers for services, in the format: port[:machinePort][/protocol[:handler[:handler...]]]) + For example: --port 80/tcp --port 443:80/tcp:http:tls --port 5432/tcp:pg_tls + To remove a port mapping use '-' as handler. For example: --port 80/tcp:- + -r, --region string The target region (see 'flyctl platform regions') + --restart string Set the restart policy for a Machine. Options include 'no', 'always', and 'on-failure'. + Default is 'on-failure' for Machines created by 'fly deploy' and Machines with a schedule. Default is 'always' for Machines created by 'fly m run'. + --rm Automatically remove the Machine when it exits. Sets the restart-policy to 'never' if not otherwise specified. + --rootfs-persist string Whether to persist the root filesystem across restarts. Options include 'never', 'always', and 'restart'. + --rootfs-size string Root filesystem size in GB. Accepts a plain number (in GB) or a human-readable size (e.g. 2gb, 5gb). Uses an overlayfs to allow the root filesystem to exceed its default size. Set to 0 to unset. + --schedule string Schedule a Machine run at hourly, daily, weekly and monthly intervals + --shell Open a shell on the Machine once created (implies --it --rm). If no app is specified, a temporary app is created just for this Machine and destroyed when the Machine is destroyed. See also --command and --user. + --skip-dns-registration Do not register the machine's 6PN IP with the internal DNS system + --standby-for strings For Machines without services, a comma separated list of Machine IDs to act as standby for. + --swap-size string Swap size in MB. Accepts a plain number (in MB) or a human-readable size (e.g. 512mb, 1gb). + --use-zstd Enable zstd compression for the image + --user string Used with --shell. The username, if we're shelling into the Machine now. (default "root") + --vm-cpu-kind string The kind of CPU to use ('shared' or 'performance') (also --vm-cpukind) + --vm-cpus int Number of CPUs (also --cpus) + --vm-gpu-kind string If set, the GPU model to attach (a100-pcie-40gb, a100-sxm4-80gb, l40s, a10, none) (also --vm-gpukind) + --vm-gpus int Number of GPUs. Must also choose the GPU model with --vm-gpu-kind flag + --vm-memory string Memory (in megabytes) to attribute to the VM (also --memory) + --vm-size string The VM size to set machines to. See "fly platform vm-sizes" for valid values + -v, --volume strings Volume to mount, in the form of :/path/inside/machine[:] + --wg Determines whether communication with remote builders are conducted over wireguard or plain internet(https) (default true) ~~~ ## Global Options diff --git a/flyctl/cmd/fly_machine_update.md b/flyctl/cmd/fly_machine_update.md index e4570ff49f..507a432f7c 100644 --- a/flyctl/cmd/fly_machine_update.md +++ b/flyctl/cmd/fly_machine_update.md @@ -9,51 +9,52 @@ fly machine update [machine_id] [flags] ## Options ~~~ - -a, --app string Application name - --autostart Automatically start a stopped Machine when a network request is received (default true) - --autostop string[="stop"] Automatically stop a Machine when there are no network requests for it. Options include 'off', 'stop', and 'suspend'. (default "off") - --build-depot Build your image with depot.dev - --build-nixpacks Build your image with nixpacks - --buildkit Deploy using buildkit-based remote builder - --cachedrive-size string Cache drive size in MB. Accepts a plain number (in MB) or a human-readable size (e.g. 512mb, 10gb). Set to 0 to disable. - -C, --command string Command to run - -c, --config string Path to application configuration file - --container string Container to update with the new image, files, etc; defaults to "app" or the first container in the config. - --detach Return immediately instead of monitoring deployment progress - --dockerfile string The path to a Dockerfile. Defaults to the Dockerfile in the working directory. - --entrypoint string The command to override the Docker ENTRYPOINT. - -e, --env stringArray Set of environment variables in the form of NAME=VALUE pairs. Can be specified multiple times. - --file-literal stringArray Set of literals to write to the Machine, in the form of /path/inside/machine=VALUE pairs, where VALUE is the base64-encoded raw content. Can be specified multiple times. - --file-local stringArray Set of files to write to the Machine, in the form of /path/inside/machine= pairs. Can be specified multiple times. - --file-secret stringArray Set of secrets to write to the Machine, in the form of /path/inside/machine=SECRET pairs, where SECRET is the name of the secret. The content of the secret must be base64 encoded. Can be specified multiple times. - -h, --help help for update - --host-dedication-id string The dedication id of the reserved hosts for your organization (if any) - -i, --image string The Docker image to deploy - --kernel-arg stringArray A list of kernel arguments to provide to the init. Can be specified multiple times. - --machine-config string Read machine config from json file or string - -m, --metadata stringArray Metadata in the form of NAME=VALUE pairs. Can be specified multiple times. - --mount-point string New volume mount point - -p, --port strings The external ports and handlers for services, in the format: port[:machinePort][/protocol[:handler[:handler...]]]) - For example: --port 80/tcp --port 443:80/tcp:http:tls --port 5432/tcp:pg_tls - To remove a port mapping use '-' as handler. For example: --port 80/tcp:- - --restart string Set the restart policy for a Machine. Options include 'no', 'always', and 'on-failure'. - Default is 'on-failure' for Machines created by 'fly deploy' and Machines with a schedule. Default is 'always' for Machines created by 'fly m run'. - --rootfs-persist string Whether to persist the root filesystem across restarts. Options include 'never', 'always', and 'restart'. - --rootfs-size string Root filesystem size in GB. Accepts a plain number (in GB) or a human-readable size (e.g. 2gb, 5gb). Uses an overlayfs to allow the root filesystem to exceed its default size. Set to 0 to unset. - --schedule string Schedule a Machine run at hourly, daily, weekly and monthly intervals - --skip-dns-registration Do not register the machine's 6PN IP with the internal DNS system - --skip-health-checks Updates machine without waiting for health checks. - --skip-start Updates machine without starting it. - --standby-for strings For Machines without services, a comma separated list of Machine IDs to act as standby for. - --swap-size string Swap size in MB. Accepts a plain number (in MB) or a human-readable size (e.g. 512mb, 1gb). - --vm-cpu-kind string The kind of CPU to use ('shared' or 'performance') (also --vm-cpukind) - --vm-cpus int Number of CPUs (also --cpus) - --vm-gpu-kind string If set, the GPU model to attach (a100-pcie-40gb, a100-sxm4-80gb, l40s, a10, none) (also --vm-gpukind) - --vm-gpus int Number of GPUs. Must also choose the GPU model with --vm-gpu-kind flag - --vm-memory string Memory (in megabytes) to attribute to the VM (also --memory) - --vm-size string The VM size to set machines to. See "fly platform vm-sizes" for valid values - --wait-timeout int Seconds to wait for individual machines to transition states and become healthy. (default 300) (default 300) - -y, --yes Accept all confirmations (also --auto-confirm) + -a, --app string Application name + --autostart Automatically start a stopped Machine when a network request is received (default true) + --autostop string[="stop"] Automatically stop a Machine when there are no network requests for it. Options include 'off', 'stop', and 'suspend'. (default "off") + --build-context-warn-size string Warn when the Docker build context is larger than this. Accepts a plain number (in MB) or a human-readable size (e.g. 512mb, 1gb). Set to 0 to disable. Also set with FLY_BUILD_CONTEXT_WARN_SIZE. + --build-depot Build your image with depot.dev + --build-nixpacks Build your image with nixpacks + --buildkit Deploy using buildkit-based remote builder + --cachedrive-size string Cache drive size in MB. Accepts a plain number (in MB) or a human-readable size (e.g. 512mb, 10gb). Set to 0 to disable. + -C, --command string Command to run + -c, --config string Path to application configuration file + --container string Container to update with the new image, files, etc; defaults to "app" or the first container in the config. + --detach Return immediately instead of monitoring deployment progress + --dockerfile string The path to a Dockerfile. Defaults to the Dockerfile in the working directory. + --entrypoint string The command to override the Docker ENTRYPOINT. + -e, --env stringArray Set of environment variables in the form of NAME=VALUE pairs. Can be specified multiple times. + --file-literal stringArray Set of literals to write to the Machine, in the form of /path/inside/machine=VALUE pairs, where VALUE is the base64-encoded raw content. Can be specified multiple times. + --file-local stringArray Set of files to write to the Machine, in the form of /path/inside/machine= pairs. Can be specified multiple times. + --file-secret stringArray Set of secrets to write to the Machine, in the form of /path/inside/machine=SECRET pairs, where SECRET is the name of the secret. The content of the secret must be base64 encoded. Can be specified multiple times. + -h, --help help for update + --host-dedication-id string The dedication id of the reserved hosts for your organization (if any) + -i, --image string The Docker image to deploy + --kernel-arg stringArray A list of kernel arguments to provide to the init. Can be specified multiple times. + --machine-config string Read machine config from json file or string + -m, --metadata stringArray Metadata in the form of NAME=VALUE pairs. Can be specified multiple times. + --mount-point string New volume mount point + -p, --port strings The external ports and handlers for services, in the format: port[:machinePort][/protocol[:handler[:handler...]]]) + For example: --port 80/tcp --port 443:80/tcp:http:tls --port 5432/tcp:pg_tls + To remove a port mapping use '-' as handler. For example: --port 80/tcp:- + --restart string Set the restart policy for a Machine. Options include 'no', 'always', and 'on-failure'. + Default is 'on-failure' for Machines created by 'fly deploy' and Machines with a schedule. Default is 'always' for Machines created by 'fly m run'. + --rootfs-persist string Whether to persist the root filesystem across restarts. Options include 'never', 'always', and 'restart'. + --rootfs-size string Root filesystem size in GB. Accepts a plain number (in GB) or a human-readable size (e.g. 2gb, 5gb). Uses an overlayfs to allow the root filesystem to exceed its default size. Set to 0 to unset. + --schedule string Schedule a Machine run at hourly, daily, weekly and monthly intervals + --skip-dns-registration Do not register the machine's 6PN IP with the internal DNS system + --skip-health-checks Updates machine without waiting for health checks. + --skip-start Updates machine without starting it. + --standby-for strings For Machines without services, a comma separated list of Machine IDs to act as standby for. + --swap-size string Swap size in MB. Accepts a plain number (in MB) or a human-readable size (e.g. 512mb, 1gb). + --vm-cpu-kind string The kind of CPU to use ('shared' or 'performance') (also --vm-cpukind) + --vm-cpus int Number of CPUs (also --cpus) + --vm-gpu-kind string If set, the GPU model to attach (a100-pcie-40gb, a100-sxm4-80gb, l40s, a10, none) (also --vm-gpukind) + --vm-gpus int Number of GPUs. Must also choose the GPU model with --vm-gpu-kind flag + --vm-memory string Memory (in megabytes) to attribute to the VM (also --memory) + --vm-size string The VM size to set machines to. See "fly platform vm-sizes" for valid values + --wait-timeout int Seconds to wait for individual machines to transition states and become healthy. (default 300) (default 300) + -y, --yes Accept all confirmations (also --auto-confirm) ~~~ ## Global Options