diff --git a/flyctl/cmd/fly.md b/flyctl/cmd/fly.md index 9a6eb9d989..f7a3e6c98c 100644 --- a/flyctl/cmd/fly.md +++ b/flyctl/cmd/fly.md @@ -28,6 +28,7 @@ fly [flags] * [litefs-cloud](/docs/flyctl/litefs-cloud/) - LiteFS Cloud management commands * [logs](/docs/flyctl/logs/) - View app logs * [machine](/docs/flyctl/machine/) - Manage Fly Machines. +* [mysql](/docs/flyctl/mysql/) - Provision and manage MySQL databases * [orgs](/docs/flyctl/orgs/) - Commands for managing Fly organizations * [ping](/docs/flyctl/ping/) - Test connectivity with ICMP ping messages * [platform](/docs/flyctl/platform/) - Fly platform information @@ -43,6 +44,7 @@ fly [flags] * [ssh](/docs/flyctl/ssh/) - Use SSH to log into or run commands on Machines * [status](/docs/flyctl/status/) - Show app status * [storage](/docs/flyctl/storage/) - Provision and manage Tigris object storage buckets +* [synthetics](/docs/flyctl/synthetics/) - Synthetic monitoring * [tokens](/docs/flyctl/tokens/) - Manage Fly.io API tokens * [version](/docs/flyctl/version/) - Show version information for the flyctl command * [volumes](/docs/flyctl/volumes/) - Manage Fly Volumes. diff --git a/flyctl/cmd/fly_apps.md b/flyctl/cmd/fly_apps.md index 4d56bd3899..4b40b57188 100644 --- a/flyctl/cmd/fly_apps.md +++ b/flyctl/cmd/fly_apps.md @@ -7,7 +7,7 @@ fly apps [command] [flags] ## Available Commands * [create](/docs/flyctl/apps-create/) - Create a new application. -* [destroy](/docs/flyctl/apps-destroy/) - Permanently destroy an app. +* [destroy](/docs/flyctl/apps-destroy/) - Permanently destroy one or more appa. * [errors](/docs/flyctl/apps-errors/) - View application errors on Sentry.io * [list](/docs/flyctl/apps-list/) - List applications. * [move](/docs/flyctl/apps-move/) - Move an app to another organization. diff --git a/flyctl/cmd/fly_apps_destroy.md b/flyctl/cmd/fly_apps_destroy.md index 03df991725..6862feba62 100644 --- a/flyctl/cmd/fly_apps_destroy.md +++ b/flyctl/cmd/fly_apps_destroy.md @@ -1,8 +1,8 @@ -Delete an application from the Fly platform. +Delete one or more applications from the Fly platform. ## Usage ~~~ -fly apps destroy [flags] +fly apps destroy [flags] ~~~ ## Options diff --git a/flyctl/cmd/fly_apps_list.md b/flyctl/cmd/fly_apps_list.md index 8303d15da4..aa0ef81529 100644 --- a/flyctl/cmd/fly_apps_list.md +++ b/flyctl/cmd/fly_apps_list.md @@ -15,6 +15,7 @@ fly apps list [flags] -h, --help help for list -j, --json JSON output -o, --org string The target Fly.io organization + -q, --quiet Only list app names ~~~ ## Global Options diff --git a/flyctl/cmd/fly_apps_move.md b/flyctl/cmd/fly_apps_move.md index 0a6a94fbde..8bcc3e4243 100644 --- a/flyctl/cmd/fly_apps_move.md +++ b/flyctl/cmd/fly_apps_move.md @@ -1,6 +1,6 @@ Move an application to another organization the current user belongs to. - +For details, see https://fly.io/docs/apps/move-app-org/. ## Usage ~~~ diff --git a/flyctl/cmd/fly_console.md b/flyctl/cmd/fly_console.md index f28e4f2b61..36d713f74a 100644 --- a/flyctl/cmd/fly_console.md +++ b/flyctl/cmd/fly_console.md @@ -32,7 +32,7 @@ fly console [flags] -u, --user string Unix username to connect as (default "root") --vm-cpu-kind string The kind of CPU to use ('shared' or 'performance') --vm-cpus int Number of CPUs - --vm-gpu-kind string If set, the GPU model to attach (a100-pcie-40gb, a100-sxm4-80gb, l40s, a10) + --vm-gpu-kind string If set, the GPU model to attach (a100-pcie-40gb, a100-sxm4-80gb, l40s, a10, none) --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 --vm-size string The VM size to set machines to. See "fly platform vm-sizes" for valid values diff --git a/flyctl/cmd/fly_deploy.md b/flyctl/cmd/fly_deploy.md index ce35debd1a..a9f9839a00 100644 --- a/flyctl/cmd/fly_deploy.md +++ b/flyctl/cmd/fly_deploy.md @@ -31,6 +31,8 @@ fly deploy [WORKING_DIRECTORY] [flags] Repeat for each volume in order (comma-separated lists not accepted) -c, --config string Path to application configuration file + --deploy-retries string Number of times to retry a deployment if it fails (default "auto") + --depot Deploy using depot to build the image --detach Return immediately instead of monitoring deployment progress --dns-checks Perform DNS checks during deployment (default true) --dockerfile string Path to a Dockerfile. Defaults to the Dockerfile in the working directory. @@ -40,6 +42,7 @@ fly deploy [WORKING_DIRECTORY] [flags] --file-literal stringArray Set of literals in the form of /path/inside/machine=VALUE pairs where VALUE is the content. Can be specified multiple times. --file-local stringArray Set of files in the form of /path/inside/machine= pairs. Can be specified multiple times. --file-secret stringArray Set of secrets in the form of /path/inside/machine=SECRET pairs where SECRET is the name of the secret. Can be specified multiple times. + --flycast Allocate a private IPv6 addresses --ha Create spare machines that increases app availability (default true) -h, --help help for deploy --host-dedication-id string The dedication id of the reserved hosts for your organization (if any) @@ -70,7 +73,7 @@ fly deploy [WORKING_DIRECTORY] [flags] --update-only Do not create Machines for new process groups --vm-cpu-kind string The kind of CPU to use ('shared' or 'performance') --vm-cpus int Number of CPUs - --vm-gpu-kind string If set, the GPU model to attach (a100-pcie-40gb, a100-sxm4-80gb, l40s, a10) + --vm-gpu-kind string If set, the GPU model to attach (a100-pcie-40gb, a100-sxm4-80gb, l40s, a10, none) --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 --vm-size string The VM size to set machines to. See "fly platform vm-sizes" for valid values diff --git a/flyctl/cmd/fly_extensions.md b/flyctl/cmd/fly_extensions.md index ce960e2c5d..7db7e081be 100644 --- a/flyctl/cmd/fly_extensions.md +++ b/flyctl/cmd/fly_extensions.md @@ -9,10 +9,13 @@ fly extensions [command] [flags] * [arcjet](/docs/flyctl/extensions-arcjet/) - Provision and manage Arcjet * [enveloop](/docs/flyctl/extensions-enveloop/) - Provision and manage Enveloop projects * [kafka](/docs/flyctl/extensions-kafka/) - Provision and manage Upstash Kafka clusters +* [kubernetes](/docs/flyctl/extensions-kubernetes/) - Provision and manage Kubernetes clusters +* [mysql](/docs/flyctl/extensions-mysql/) - Provision and manage MySQL databases * [sentry](/docs/flyctl/extensions-sentry/) - Setup a Sentry project for this app * [storage](/docs/flyctl/extensions-storage/) - Provision and manage Tigris object storage buckets * [supabase](/docs/flyctl/extensions-supabase/) - Provision and manage Supabase Postgres databases * [vector](/docs/flyctl/extensions-vector/) - Provision and manage Upstash Vector index +* [wafris](/docs/flyctl/extensions-wafris/) - Provision and manage Wafris WAFs (Web Application Firewalls) ## Options diff --git a/flyctl/cmd/fly_extensions_kubernetes.md b/flyctl/cmd/fly_extensions_kubernetes.md new file mode 100644 index 0000000000..8261da469b --- /dev/null +++ b/flyctl/cmd/fly_extensions_kubernetes.md @@ -0,0 +1,32 @@ +Provision and manage Kubernetes clusters + + +## Usage +~~~ +fly extensions kubernetes [command] [flags] +~~~ + +## Available Commands +* [create](/docs/flyctl/extensions-kubernetes-create/) - Provision a Kubernetes cluster for an organization +* [destroy](/docs/flyctl/extensions-kubernetes-destroy/) - Permanently destroy a Kubernetes cluster +* [list](/docs/flyctl/extensions-kubernetes-list/) - List your Kubernetes clusters +* [save-kubeconfig](/docs/flyctl/extensions-kubernetes-save-kubeconfig/) - Save the kubeconfig file of your cluster + +## Options + +~~~ + -h, --help help for kubernetes +~~~ + +## Global Options + +~~~ + -t, --access-token string Fly API Access Token + --debug Print additional logs and traces + --verbose Verbose output +~~~ + +## See Also + +* [fly extensions](/docs/flyctl/extensions/) - Extensions are additional functionality that can be added to your Fly apps + diff --git a/flyctl/cmd/fly_extensions_kubernetes_create.md b/flyctl/cmd/fly_extensions_kubernetes_create.md new file mode 100644 index 0000000000..825d7685da --- /dev/null +++ b/flyctl/cmd/fly_extensions_kubernetes_create.md @@ -0,0 +1,30 @@ +Provision a Kubernetes cluster for an organization + + +## Usage +~~~ +fly extensions kubernetes create [flags] +~~~ + +## Options + +~~~ + -h, --help help for create + -n, --name string The name of your cluster + -o, --org string The target Fly.io organization + --output string The output path to save the kubeconfig file + -r, --region string The target region (see 'flyctl platform regions') +~~~ + +## Global Options + +~~~ + -t, --access-token string Fly API Access Token + --debug Print additional logs and traces + --verbose Verbose output +~~~ + +## See Also + +* [fly extensions kubernetes](/docs/flyctl/extensions-kubernetes/) - Provision and manage Kubernetes clusters + diff --git a/flyctl/cmd/fly_extensions_kubernetes_destroy.md b/flyctl/cmd/fly_extensions_kubernetes_destroy.md new file mode 100644 index 0000000000..b250813612 --- /dev/null +++ b/flyctl/cmd/fly_extensions_kubernetes_destroy.md @@ -0,0 +1,26 @@ +Permanently destroy a Kubernetes cluster + +## Usage +~~~ +fly extensions kubernetes destroy [name] [flags] +~~~ + +## Options + +~~~ + -h, --help help for destroy + -y, --yes Accept all confirmations +~~~ + +## Global Options + +~~~ + -t, --access-token string Fly API Access Token + --debug Print additional logs and traces + --verbose Verbose output +~~~ + +## See Also + +* [fly extensions kubernetes](/docs/flyctl/extensions-kubernetes/) - Provision and manage Kubernetes clusters + diff --git a/flyctl/cmd/fly_extensions_kubernetes_list.md b/flyctl/cmd/fly_extensions_kubernetes_list.md new file mode 100644 index 0000000000..bbdf02c50c --- /dev/null +++ b/flyctl/cmd/fly_extensions_kubernetes_list.md @@ -0,0 +1,25 @@ +List your Kubernetes clusters + +## Usage +~~~ +fly extensions kubernetes list [flags] +~~~ + +## Options + +~~~ + -h, --help help for list +~~~ + +## Global Options + +~~~ + -t, --access-token string Fly API Access Token + --debug Print additional logs and traces + --verbose Verbose output +~~~ + +## See Also + +* [fly extensions kubernetes](/docs/flyctl/extensions-kubernetes/) - Provision and manage Kubernetes clusters + diff --git a/flyctl/cmd/fly_extensions_kubernetes_save-kubeconfig.md b/flyctl/cmd/fly_extensions_kubernetes_save-kubeconfig.md new file mode 100644 index 0000000000..09dd11820d --- /dev/null +++ b/flyctl/cmd/fly_extensions_kubernetes_save-kubeconfig.md @@ -0,0 +1,26 @@ +Save the kubeconfig file of your cluster + +## Usage +~~~ +fly extensions kubernetes save-kubeconfig [cluster name] [flags] +~~~ + +## Options + +~~~ + -h, --help help for save-kubeconfig + --output string The output path to save the kubeconfig file +~~~ + +## Global Options + +~~~ + -t, --access-token string Fly API Access Token + --debug Print additional logs and traces + --verbose Verbose output +~~~ + +## See Also + +* [fly extensions kubernetes](/docs/flyctl/extensions-kubernetes/) - Provision and manage Kubernetes clusters + diff --git a/flyctl/cmd/fly_extensions_mysql.md b/flyctl/cmd/fly_extensions_mysql.md new file mode 100644 index 0000000000..0e7d8764c8 --- /dev/null +++ b/flyctl/cmd/fly_extensions_mysql.md @@ -0,0 +1,32 @@ +Provision and manage MySQL databases + + +## Usage +~~~ +fly extensions mysql [command] [flags] +~~~ + +## Available Commands +* [create](/docs/flyctl/extensions-mysql-create/) - Provision a MySQL database +* [destroy](/docs/flyctl/extensions-mysql-destroy/) - Permanently destroy a MySQL database +* [list](/docs/flyctl/extensions-mysql-list/) - List your MySQL databases +* [status](/docs/flyctl/extensions-mysql-status/) - Show details about a MySQL database + +## Options + +~~~ + -h, --help help for mysql +~~~ + +## Global Options + +~~~ + -t, --access-token string Fly API Access Token + --debug Print additional logs and traces + --verbose Verbose output +~~~ + +## See Also + +* [fly extensions](/docs/flyctl/extensions/) - Extensions are additional functionality that can be added to your Fly apps + diff --git a/flyctl/cmd/fly_extensions_mysql_create.md b/flyctl/cmd/fly_extensions_mysql_create.md new file mode 100644 index 0000000000..c83c4402de --- /dev/null +++ b/flyctl/cmd/fly_extensions_mysql_create.md @@ -0,0 +1,32 @@ +Provision a MySQL database + + +## Usage +~~~ +fly extensions mysql create [flags] +~~~ + +## Options + +~~~ + -a, --app string Application name + -c, --config string Path to application configuration file + -h, --help help for create + -n, --name string The name of your database + -o, --org string The target Fly.io organization + -r, --region string The target region (see 'flyctl platform regions') + -y, --yes Accept all confirmations +~~~ + +## Global Options + +~~~ + -t, --access-token string Fly API Access Token + --debug Print additional logs and traces + --verbose Verbose output +~~~ + +## See Also + +* [fly extensions mysql](/docs/flyctl/extensions-mysql/) - Provision and manage MySQL databases + diff --git a/flyctl/cmd/fly_extensions_mysql_destroy.md b/flyctl/cmd/fly_extensions_mysql_destroy.md new file mode 100644 index 0000000000..daffa9fadb --- /dev/null +++ b/flyctl/cmd/fly_extensions_mysql_destroy.md @@ -0,0 +1,28 @@ +Permanently destroy a MySQL database + +## Usage +~~~ +fly extensions mysql destroy [name] [flags] +~~~ + +## Options + +~~~ + -a, --app string Application name + -c, --config string Path to application configuration file + -h, --help help for destroy + -y, --yes Accept all confirmations +~~~ + +## Global Options + +~~~ + -t, --access-token string Fly API Access Token + --debug Print additional logs and traces + --verbose Verbose output +~~~ + +## See Also + +* [fly extensions mysql](/docs/flyctl/extensions-mysql/) - Provision and manage MySQL databases + diff --git a/flyctl/cmd/fly_extensions_mysql_list.md b/flyctl/cmd/fly_extensions_mysql_list.md new file mode 100644 index 0000000000..192ade3cb8 --- /dev/null +++ b/flyctl/cmd/fly_extensions_mysql_list.md @@ -0,0 +1,27 @@ +List your MySQL databases + +## Usage +~~~ +fly extensions mysql list [flags] +~~~ + +## Options + +~~~ + -h, --help help for list + -o, --org string The target Fly.io organization + -y, --yes Accept all confirmations +~~~ + +## Global Options + +~~~ + -t, --access-token string Fly API Access Token + --debug Print additional logs and traces + --verbose Verbose output +~~~ + +## See Also + +* [fly extensions mysql](/docs/flyctl/extensions-mysql/) - Provision and manage MySQL databases + diff --git a/flyctl/cmd/fly_extensions_mysql_status.md b/flyctl/cmd/fly_extensions_mysql_status.md new file mode 100644 index 0000000000..9bb4f4d635 --- /dev/null +++ b/flyctl/cmd/fly_extensions_mysql_status.md @@ -0,0 +1,29 @@ +Show details about a MySQL database + + +## Usage +~~~ +fly extensions mysql status [name] [flags] +~~~ + +## Options + +~~~ + -a, --app string Application name + -c, --config string Path to application configuration file + -h, --help help for status + -y, --yes Accept all confirmations +~~~ + +## Global Options + +~~~ + -t, --access-token string Fly API Access Token + --debug Print additional logs and traces + --verbose Verbose output +~~~ + +## See Also + +* [fly extensions mysql](/docs/flyctl/extensions-mysql/) - Provision and manage MySQL databases + diff --git a/flyctl/cmd/fly_extensions_wafris.md b/flyctl/cmd/fly_extensions_wafris.md new file mode 100644 index 0000000000..37d13aa72f --- /dev/null +++ b/flyctl/cmd/fly_extensions_wafris.md @@ -0,0 +1,31 @@ +Provision and manage Wafris WAFs (Web Application Firewalls) + + +## Usage +~~~ +fly extensions wafris [command] [flags] +~~~ + +## Available Commands +* [create](/docs/flyctl/extensions-wafris-create/) - Provision a Wafris WAF +* [dashboard](/docs/flyctl/extensions-wafris-dashboard/) - Visit the Wafris dashboard +* [destroy](/docs/flyctl/extensions-wafris-destroy/) - Permanently destroy a Wafris WAF + +## Options + +~~~ + -h, --help help for wafris +~~~ + +## Global Options + +~~~ + -t, --access-token string Fly API Access Token + --debug Print additional logs and traces + --verbose Verbose output +~~~ + +## See Also + +* [fly extensions](/docs/flyctl/extensions/) - Extensions are additional functionality that can be added to your Fly apps + diff --git a/flyctl/cmd/fly_extensions_wafris_create.md b/flyctl/cmd/fly_extensions_wafris_create.md new file mode 100644 index 0000000000..e4dc0664c7 --- /dev/null +++ b/flyctl/cmd/fly_extensions_wafris_create.md @@ -0,0 +1,32 @@ +Provision a Wafris WAF + + +## Usage +~~~ +fly extensions wafris create [flags] +~~~ + +## Options + +~~~ + -a, --app string Application name + -c, --config string Path to application configuration file + -h, --help help for create + -n, --name string The name of your WAF + -o, --org string The target Fly.io organization + -r, --region string The target region (see 'flyctl platform regions') + -y, --yes Accept all confirmations +~~~ + +## Global Options + +~~~ + -t, --access-token string Fly API Access Token + --debug Print additional logs and traces + --verbose Verbose output +~~~ + +## See Also + +* [fly extensions wafris](/docs/flyctl/extensions-wafris/) - Provision and manage Wafris WAFs (Web Application Firewalls) + diff --git a/flyctl/cmd/fly_extensions_wafris_dashboard.md b/flyctl/cmd/fly_extensions_wafris_dashboard.md new file mode 100644 index 0000000000..528c7a447d --- /dev/null +++ b/flyctl/cmd/fly_extensions_wafris_dashboard.md @@ -0,0 +1,29 @@ +Visit the Wafris dashboard + +## Usage +~~~ +fly extensions wafris dashboard [firewall_name] [flags] +~~~ + +## Options + +~~~ + -a, --app string Application name + -c, --config string Path to application configuration file + -h, --help help for dashboard + -o, --org string The target Fly.io organization + -y, --yes Accept all confirmations +~~~ + +## Global Options + +~~~ + -t, --access-token string Fly API Access Token + --debug Print additional logs and traces + --verbose Verbose output +~~~ + +## See Also + +* [fly extensions wafris](/docs/flyctl/extensions-wafris/) - Provision and manage Wafris WAFs (Web Application Firewalls) + diff --git a/flyctl/cmd/fly_extensions_wafris_destroy.md b/flyctl/cmd/fly_extensions_wafris_destroy.md new file mode 100644 index 0000000000..76950e3384 --- /dev/null +++ b/flyctl/cmd/fly_extensions_wafris_destroy.md @@ -0,0 +1,28 @@ +Permanently destroy a Wafris WAF + +## Usage +~~~ +fly extensions wafris destroy [name] [flags] +~~~ + +## Options + +~~~ + -a, --app string Application name + -c, --config string Path to application configuration file + -h, --help help for destroy + -y, --yes Accept all confirmations +~~~ + +## Global Options + +~~~ + -t, --access-token string Fly API Access Token + --debug Print additional logs and traces + --verbose Verbose output +~~~ + +## See Also + +* [fly extensions wafris](/docs/flyctl/extensions-wafris/) - Provision and manage Wafris WAFs (Web Application Firewalls) + diff --git a/flyctl/cmd/fly_launch.md b/flyctl/cmd/fly_launch.md index 56930e4dc3..28c38d11e2 100644 --- a/flyctl/cmd/fly_launch.md +++ b/flyctl/cmd/fly_launch.md @@ -8,6 +8,7 @@ fly launch [flags] ## Options ~~~ + --attach Attach this new application to the current application --build-arg stringArray Set of build time variables in the form of NAME=VALUE pairs. Can be specified multiple times. --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 @@ -28,6 +29,8 @@ fly launch [flags] -c, --config string Path to application configuration file --copy-config Use the configuration file if present without prompting + --deploy-retries string Number of times to retry a deployment if it fails (default "auto") + --depot Deploy using depot to build the image --detach Return immediately instead of monitoring deployment progress --dns-checks Perform DNS checks during deployment (default true) --dockerfile string Path to a Dockerfile. Defaults to the Dockerfile in the working directory. @@ -38,6 +41,7 @@ fly launch [flags] --file-literal stringArray Set of literals in the form of /path/inside/machine=VALUE pairs where VALUE is the content. Can be specified multiple times. --file-local stringArray Set of files in the form of /path/inside/machine= pairs. Can be specified multiple times. --file-secret stringArray Set of secrets in the form of /path/inside/machine=SECRET pairs where SECRET is the name of the secret. Can be specified multiple times. + --flycast Allocate a private IPv6 addresses --from string A github repo URL to use as a template for the new app --generate-name Always generate a name for the app, without prompting --ha Create spare machines that increases app availability (default true) @@ -48,6 +52,7 @@ fly launch [flags] -i, --image string The Docker image to deploy --image-label string Image label to use when tagging and pushing to the fly registry. Defaults to "deployment-{timestamp}". --internal-port int Set internal_port for all services in the generated fly.toml (default -1) + --into string Destination directory for github repo specified with --from --json Generate configuration in JSON format --label stringArray Add custom metadata to an image via docker labels --lease-timeout string Time duration to lease individual machines while running deployment. All machines are leased at the beginning and released at the end.The lease is refreshed periodically for this same time, which is why it is short.flyctl releases leases in most cases. (default "13s") @@ -57,6 +62,7 @@ fly launch [flags] --name string Name of the new app --nixpacks Deploy using nixpacks to build the image --no-cache Do not use the build cache when building the image + --no-create Do not create an app, only generate configuration files --no-deploy Do not immediately deploy the new app after fly launch creates and configures it --no-public-ips Do not allocate any new public IP addresses --now Deploy now without confirmation @@ -75,7 +81,7 @@ fly launch [flags] --strategy string The strategy for replacing running instances. Options are canary, rolling, bluegreen, or immediate. The default strategy is rolling. --vm-cpu-kind string The kind of CPU to use ('shared' or 'performance') --vm-cpus int Number of CPUs - --vm-gpu-kind string If set, the GPU model to attach (a100-pcie-40gb, a100-sxm4-80gb, l40s, a10) + --vm-gpu-kind string If set, the GPU model to attach (a100-pcie-40gb, a100-sxm4-80gb, l40s, a10, none) --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 --vm-size string The VM size to set machines to. See "fly platform vm-sizes" for valid values diff --git a/flyctl/cmd/fly_machine_clone.md b/flyctl/cmd/fly_machine_clone.md index 5d57cd5dc3..825b963996 100644 --- a/flyctl/cmd/fly_machine_clone.md +++ b/flyctl/cmd/fly_machine_clone.md @@ -23,7 +23,7 @@ fly machine clone [machine_id] [flags] --standby-for strings Comma separated list of Machine IDs to watch for. You can use '--standby-for=source' to create a standby for the cloned Machine. --vm-cpu-kind string The kind of CPU to use ('shared' or 'performance') --vm-cpus int Number of CPUs - --vm-gpu-kind string If set, the GPU model to attach (a100-pcie-40gb, a100-sxm4-80gb, l40s, a10) + --vm-gpu-kind string If set, the GPU model to attach (a100-pcie-40gb, a100-sxm4-80gb, l40s, a10, none) --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 --vm-size string The VM size to set machines to. See "fly platform vm-sizes" for valid values diff --git a/flyctl/cmd/fly_machine_create.md b/flyctl/cmd/fly_machine_create.md index 9659a64d24..18f3a9b768 100644 --- a/flyctl/cmd/fly_machine_create.md +++ b/flyctl/cmd/fly_machine_create.md @@ -11,7 +11,8 @@ fly machine create [command] [flags] ~~~ -a, --app string Application name --autostart Automatically start a stopped Machine when a network request is received (default true) - --autostop Automatically stop a Machine when there are no network requests for it (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 -c, --config string Path to application configuration file --detach Return immediately instead of monitoring deployment progress @@ -40,7 +41,7 @@ fly machine create [command] [flags] --standby-for strings For Machines without services, a comma separated list of Machine IDs to act as standby for. --vm-cpu-kind string The kind of CPU to use ('shared' or 'performance') --vm-cpus int Number of CPUs - --vm-gpu-kind string If set, the GPU model to attach (a100-pcie-40gb, a100-sxm4-80gb, l40s, a10) + --vm-gpu-kind string If set, the GPU model to attach (a100-pcie-40gb, a100-sxm4-80gb, l40s, a10, none) --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 --vm-size string The VM size to set machines to. See "fly platform vm-sizes" for valid values diff --git a/flyctl/cmd/fly_machine_destroy.md b/flyctl/cmd/fly_machine_destroy.md index 3fe9a9840a..42ad813646 100644 --- a/flyctl/cmd/fly_machine_destroy.md +++ b/flyctl/cmd/fly_machine_destroy.md @@ -1,5 +1,5 @@ Destroy one or more Fly machines. -This command requires a machine to be in a stopped state unless the force flag is used. +This command requires a machine to be in a stopped or suspended state unless the force flag is used. ## Usage diff --git a/flyctl/cmd/fly_machine_run.md b/flyctl/cmd/fly_machine_run.md index 8e6db58f65..bb76c07b12 100644 --- a/flyctl/cmd/fly_machine_run.md +++ b/flyctl/cmd/fly_machine_run.md @@ -11,7 +11,8 @@ fly machine run [command] [flags] ~~~ -a, --app string Application name --autostart Automatically start a stopped Machine when a network request is received (default true) - --autostop Automatically stop a Machine when there are no network requests for it (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 --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 @@ -43,7 +44,7 @@ fly machine run [command] [flags] --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') --vm-cpus int Number of CPUs - --vm-gpu-kind string If set, the GPU model to attach (a100-pcie-40gb, a100-sxm4-80gb, l40s, a10) + --vm-gpu-kind string If set, the GPU model to attach (a100-pcie-40gb, a100-sxm4-80gb, l40s, a10, none) --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 --vm-size string The VM size to set machines to. See "fly platform vm-sizes" for valid values diff --git a/flyctl/cmd/fly_machine_update.md b/flyctl/cmd/fly_machine_update.md index 469624764b..b03285d563 100644 --- a/flyctl/cmd/fly_machine_update.md +++ b/flyctl/cmd/fly_machine_update.md @@ -11,7 +11,8 @@ fly machine update [machine_id] [flags] ~~~ -a, --app string Application name --autostart Automatically start a stopped Machine when a network request is received (default true) - --autostop Automatically stop a Machine when there are no network requests for it (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 -C, --command string Command to run -c, --config string Path to application configuration file @@ -40,7 +41,7 @@ fly machine update [machine_id] [flags] --standby-for strings For Machines without services, a comma separated list of Machine IDs to act as standby for. --vm-cpu-kind string The kind of CPU to use ('shared' or 'performance') --vm-cpus int Number of CPUs - --vm-gpu-kind string If set, the GPU model to attach (a100-pcie-40gb, a100-sxm4-80gb, l40s, a10) + --vm-gpu-kind string If set, the GPU model to attach (a100-pcie-40gb, a100-sxm4-80gb, l40s, a10, none) --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 --vm-size string The VM size to set machines to. See "fly platform vm-sizes" for valid values diff --git a/flyctl/cmd/fly_mysql.md b/flyctl/cmd/fly_mysql.md new file mode 100644 index 0000000000..7e732b5968 --- /dev/null +++ b/flyctl/cmd/fly_mysql.md @@ -0,0 +1,32 @@ +Provision and manage MySQL databases + + +## Usage +~~~ +fly mysql [command] [flags] +~~~ + +## Available Commands +* [create](/docs/flyctl/mysql-create/) - Provision a MySQL database +* [destroy](/docs/flyctl/mysql-destroy/) - Permanently destroy a MySQL database +* [list](/docs/flyctl/mysql-list/) - List your MySQL databases +* [status](/docs/flyctl/mysql-status/) - Show details about a MySQL database + +## Options + +~~~ + -h, --help help for mysql +~~~ + +## Global Options + +~~~ + -t, --access-token string Fly API Access Token + --debug Print additional logs and traces + --verbose Verbose output +~~~ + +## See Also + +* [fly](/docs/flyctl/help/) - The Fly.io command line interface + diff --git a/flyctl/cmd/fly_mysql_create.md b/flyctl/cmd/fly_mysql_create.md new file mode 100644 index 0000000000..0a87bff163 --- /dev/null +++ b/flyctl/cmd/fly_mysql_create.md @@ -0,0 +1,32 @@ +Provision a MySQL database + + +## Usage +~~~ +fly mysql create [flags] +~~~ + +## Options + +~~~ + -a, --app string Application name + -c, --config string Path to application configuration file + -h, --help help for create + -n, --name string The name of your database + -o, --org string The target Fly.io organization + -r, --region string The target region (see 'flyctl platform regions') + -y, --yes Accept all confirmations +~~~ + +## Global Options + +~~~ + -t, --access-token string Fly API Access Token + --debug Print additional logs and traces + --verbose Verbose output +~~~ + +## See Also + +* [fly mysql](/docs/flyctl/mysql/) - Provision and manage MySQL databases + diff --git a/flyctl/cmd/fly_mysql_destroy.md b/flyctl/cmd/fly_mysql_destroy.md new file mode 100644 index 0000000000..96532c0d0f --- /dev/null +++ b/flyctl/cmd/fly_mysql_destroy.md @@ -0,0 +1,28 @@ +Permanently destroy a MySQL database + +## Usage +~~~ +fly mysql destroy [name] [flags] +~~~ + +## Options + +~~~ + -a, --app string Application name + -c, --config string Path to application configuration file + -h, --help help for destroy + -y, --yes Accept all confirmations +~~~ + +## Global Options + +~~~ + -t, --access-token string Fly API Access Token + --debug Print additional logs and traces + --verbose Verbose output +~~~ + +## See Also + +* [fly mysql](/docs/flyctl/mysql/) - Provision and manage MySQL databases + diff --git a/flyctl/cmd/fly_mysql_list.md b/flyctl/cmd/fly_mysql_list.md new file mode 100644 index 0000000000..8858fa7fa4 --- /dev/null +++ b/flyctl/cmd/fly_mysql_list.md @@ -0,0 +1,27 @@ +List your MySQL databases + +## Usage +~~~ +fly mysql list [flags] +~~~ + +## Options + +~~~ + -h, --help help for list + -o, --org string The target Fly.io organization + -y, --yes Accept all confirmations +~~~ + +## Global Options + +~~~ + -t, --access-token string Fly API Access Token + --debug Print additional logs and traces + --verbose Verbose output +~~~ + +## See Also + +* [fly mysql](/docs/flyctl/mysql/) - Provision and manage MySQL databases + diff --git a/flyctl/cmd/fly_postgres_barman_show-backup.md b/flyctl/cmd/fly_mysql_status.md similarity index 59% rename from flyctl/cmd/fly_postgres_barman_show-backup.md rename to flyctl/cmd/fly_mysql_status.md index e184b4ef92..209cf71c9a 100644 --- a/flyctl/cmd/fly_postgres_barman_show-backup.md +++ b/flyctl/cmd/fly_mysql_status.md @@ -1,8 +1,9 @@ -Show a single barman backup +Show details about a MySQL database + ## Usage ~~~ -fly postgres barman show-backup [flags] +fly mysql status [name] [flags] ~~~ ## Options @@ -10,7 +11,8 @@ fly postgres barman show-backup [flags] ~~~ -a, --app string Application name -c, --config string Path to application configuration file - -h, --help help for show-backup + -h, --help help for status + -y, --yes Accept all confirmations ~~~ ## Global Options @@ -23,5 +25,5 @@ fly postgres barman show-backup [flags] ## See Also -* [fly postgres barman](/docs/flyctl/postgres-barman/) - Manage databases in a cluster +* [fly mysql](/docs/flyctl/mysql/) - Provision and manage MySQL databases diff --git a/flyctl/cmd/fly_postgres.md b/flyctl/cmd/fly_postgres.md index cda276b71e..79d3c237c8 100644 --- a/flyctl/cmd/fly_postgres.md +++ b/flyctl/cmd/fly_postgres.md @@ -8,7 +8,7 @@ fly postgres [command] [flags] ## Available Commands * [attach](/docs/flyctl/postgres-attach/) - Attach a postgres cluster to an app -* [barman](/docs/flyctl/postgres-barman/) - Manage databases in a cluster +* [backup](/docs/flyctl/postgres-backup/) - Backup commands * [config](/docs/flyctl/postgres-config/) - Show and manage Postgres configuration. * [connect](/docs/flyctl/postgres-connect/) - Connect to the Postgres console * [create](/docs/flyctl/postgres-create/) - Create a new Postgres cluster diff --git a/flyctl/cmd/fly_postgres_backup.md b/flyctl/cmd/fly_postgres_backup.md new file mode 100644 index 0000000000..ebfec301ff --- /dev/null +++ b/flyctl/cmd/fly_postgres_backup.md @@ -0,0 +1,33 @@ +Backup commands + + +## Usage +~~~ +fly postgres backup [command] [flags] +~~~ + +## Available Commands +* [config](/docs/flyctl/postgres-backup-config/) - Manage backup configuration +* [create](/docs/flyctl/postgres-backup-create/) - Create a backup +* [enable](/docs/flyctl/postgres-backup-enable/) - Enable backups on a Postgres cluster, creating a Tigris bucket for storage +* [list](/docs/flyctl/postgres-backup-list/) - List backups +* [restore](/docs/flyctl/postgres-backup-restore/) - Performs a WAL-based restore into a new Postgres cluster. + +## Options + +~~~ + -h, --help help for backup +~~~ + +## Global Options + +~~~ + -t, --access-token string Fly API Access Token + --debug Print additional logs and traces + --verbose Verbose output +~~~ + +## See Also + +* [fly postgres](/docs/flyctl/postgres/) - Manage Postgres clusters. + diff --git a/flyctl/cmd/fly_postgres_backup_config.md b/flyctl/cmd/fly_postgres_backup_config.md new file mode 100644 index 0000000000..be8b33c4c0 --- /dev/null +++ b/flyctl/cmd/fly_postgres_backup_config.md @@ -0,0 +1,30 @@ +Manage backup configuration + + +## Usage +~~~ +fly postgres backup config [command] [flags] +~~~ + +## Available Commands +* [show](/docs/flyctl/postgres-backup-config-show/) - Show backup configuration +* [update](/docs/flyctl/postgres-backup-config-update/) - Update backup configuration + +## Options + +~~~ + -h, --help help for config +~~~ + +## Global Options + +~~~ + -t, --access-token string Fly API Access Token + --debug Print additional logs and traces + --verbose Verbose output +~~~ + +## See Also + +* [fly postgres backup](/docs/flyctl/postgres-backup/) - Backup commands + diff --git a/flyctl/cmd/fly_postgres_barman_list-backup.md b/flyctl/cmd/fly_postgres_backup_config_show.md similarity index 62% rename from flyctl/cmd/fly_postgres_barman_list-backup.md rename to flyctl/cmd/fly_postgres_backup_config_show.md index 5a4e20c545..d8c485f9fc 100644 --- a/flyctl/cmd/fly_postgres_barman_list-backup.md +++ b/flyctl/cmd/fly_postgres_backup_config_show.md @@ -1,8 +1,9 @@ -List your barman backups +Show backup configuration + ## Usage ~~~ -fly postgres barman list-backup [flags] +fly postgres backup config show [flags] ~~~ ## Options @@ -10,7 +11,7 @@ fly postgres barman list-backup [flags] ~~~ -a, --app string Application name -c, --config string Path to application configuration file - -h, --help help for list-backup + -h, --help help for show ~~~ ## Global Options @@ -23,5 +24,5 @@ fly postgres barman list-backup [flags] ## See Also -* [fly postgres barman](/docs/flyctl/postgres-barman/) - Manage databases in a cluster +* [fly postgres backup config](/docs/flyctl/postgres-backup-config/) - Manage backup configuration diff --git a/flyctl/cmd/fly_postgres_backup_config_update.md b/flyctl/cmd/fly_postgres_backup_config_update.md new file mode 100644 index 0000000000..9b91ab6954 --- /dev/null +++ b/flyctl/cmd/fly_postgres_backup_config_update.md @@ -0,0 +1,32 @@ +Update backup configuration + + +## Usage +~~~ +fly postgres backup config update [flags] +~~~ + +## Options + +~~~ + -a, --app string Application name + --archive-timeout string Archive timeout + -c, --config string Path to application configuration file + --full-backup-frequency string Full backup frequency + -h, --help help for update + --minimum-redundancy string Minimum redundancy + --recovery-window string Recovery window +~~~ + +## Global Options + +~~~ + -t, --access-token string Fly API Access Token + --debug Print additional logs and traces + --verbose Verbose output +~~~ + +## See Also + +* [fly postgres backup config](/docs/flyctl/postgres-backup-config/) - Manage backup configuration + diff --git a/flyctl/cmd/fly_postgres_backup_create.md b/flyctl/cmd/fly_postgres_backup_create.md new file mode 100644 index 0000000000..624e57d3ef --- /dev/null +++ b/flyctl/cmd/fly_postgres_backup_create.md @@ -0,0 +1,30 @@ +Create a backup + + +## Usage +~~~ +fly postgres backup create [flags] +~~~ + +## Options + +~~~ + -a, --app string Application name + -c, --config string Path to application configuration file + -h, --help help for create + -i, --immediate-checkpoint Forces Postgres to perform an immediate checkpoint + -n, --name string Backup name +~~~ + +## Global Options + +~~~ + -t, --access-token string Fly API Access Token + --debug Print additional logs and traces + --verbose Verbose output +~~~ + +## See Also + +* [fly postgres backup](/docs/flyctl/postgres-backup/) - Backup commands + diff --git a/flyctl/cmd/fly_postgres_barman_backup.md b/flyctl/cmd/fly_postgres_backup_enable.md similarity index 60% rename from flyctl/cmd/fly_postgres_barman_backup.md rename to flyctl/cmd/fly_postgres_backup_enable.md index cb14674327..ad53dab4b7 100644 --- a/flyctl/cmd/fly_postgres_barman_backup.md +++ b/flyctl/cmd/fly_postgres_backup_enable.md @@ -1,8 +1,9 @@ -Backup your database on barman +Enable backups on a Postgres cluster, creating a Tigris bucket for storage + ## Usage ~~~ -fly postgres barman backup [flags] +fly postgres backup enable [flags] ~~~ ## Options @@ -10,7 +11,7 @@ fly postgres barman backup [flags] ~~~ -a, --app string Application name -c, --config string Path to application configuration file - -h, --help help for backup + -h, --help help for enable ~~~ ## Global Options @@ -23,5 +24,5 @@ fly postgres barman backup [flags] ## See Also -* [fly postgres barman](/docs/flyctl/postgres-barman/) - Manage databases in a cluster +* [fly postgres backup](/docs/flyctl/postgres-backup/) - Backup commands diff --git a/flyctl/cmd/fly_postgres_barman_check.md b/flyctl/cmd/fly_postgres_backup_list.md similarity index 64% rename from flyctl/cmd/fly_postgres_barman_check.md rename to flyctl/cmd/fly_postgres_backup_list.md index 68026e20ca..9ce6d69aea 100644 --- a/flyctl/cmd/fly_postgres_barman_check.md +++ b/flyctl/cmd/fly_postgres_backup_list.md @@ -1,8 +1,9 @@ -Check your barman connection +List backups + ## Usage ~~~ -fly postgres barman check [flags] +fly postgres backup list [flags] ~~~ ## Options @@ -10,7 +11,7 @@ fly postgres barman check [flags] ~~~ -a, --app string Application name -c, --config string Path to application configuration file - -h, --help help for check + -h, --help help for list ~~~ ## Global Options @@ -23,5 +24,5 @@ fly postgres barman check [flags] ## See Also -* [fly postgres barman](/docs/flyctl/postgres-barman/) - Manage databases in a cluster +* [fly postgres backup](/docs/flyctl/postgres-backup/) - Backup commands diff --git a/flyctl/cmd/fly_postgres_backup_restore.md b/flyctl/cmd/fly_postgres_backup_restore.md new file mode 100644 index 0000000000..2b4b26c310 --- /dev/null +++ b/flyctl/cmd/fly_postgres_backup_restore.md @@ -0,0 +1,33 @@ +Performs a WAL-based restore into a new Postgres cluster. + + +## Usage +~~~ +fly postgres backup restore [flags] +~~~ + +## Options + +~~~ + -a, --app string Application name + -c, --config string Path to application configuration file + --detach Return immediately instead of monitoring deployment progress + -h, --help help for restore + --image-ref string Specify a non-default base image for the restored Postgres app + --restore-target-inclusive Set to true to stop recovery after the specified time, or false to stop before it (default true) + --restore-target-name string ID or alias of backup to restore. + --restore-target-time string RFC3339-formatted timestamp up to which recovery will proceed. Example: 2021-07-16T12:34:56Z +~~~ + +## Global Options + +~~~ + -t, --access-token string Fly API Access Token + --debug Print additional logs and traces + --verbose Verbose output +~~~ + +## See Also + +* [fly postgres backup](/docs/flyctl/postgres-backup/) - Backup commands + diff --git a/flyctl/cmd/fly_postgres_barman.md b/flyctl/cmd/fly_postgres_barman.md deleted file mode 100644 index 49e8a4054b..0000000000 --- a/flyctl/cmd/fly_postgres_barman.md +++ /dev/null @@ -1,36 +0,0 @@ -Manage databases in a cluster - - -## Usage -~~~ -fly postgres barman [command] [flags] -~~~ - -## Available Commands -* [backup](/docs/flyctl/postgres-barman-backup/) - Backup your database on barman -* [check](/docs/flyctl/postgres-barman-check/) - Check your barman connection -* [create](/docs/flyctl/postgres-barman-create/) - create barman machine -* [list-backup](/docs/flyctl/postgres-barman-list-backup/) - List your barman backups -* [recover](/docs/flyctl/postgres-barman-recover/) - Recover primary database with a barman backup -* [show-backup](/docs/flyctl/postgres-barman-show-backup/) - Show a single barman backup -* [switch-wal](/docs/flyctl/postgres-barman-switch-wal/) - Switch WAL to sync barman - -## Options - -~~~ - -h, --help help for barman - -j, --json JSON output -~~~ - -## Global Options - -~~~ - -t, --access-token string Fly API Access Token - --debug Print additional logs and traces - --verbose Verbose output -~~~ - -## See Also - -* [fly postgres](/docs/flyctl/postgres/) - Manage Postgres clusters. - diff --git a/flyctl/cmd/fly_postgres_barman_create.md b/flyctl/cmd/fly_postgres_barman_create.md deleted file mode 100644 index ab715a8eb5..0000000000 --- a/flyctl/cmd/fly_postgres_barman_create.md +++ /dev/null @@ -1,31 +0,0 @@ -create barman machine - - -## Usage -~~~ -fly postgres barman create [flags] -~~~ - -## Options - -~~~ - -a, --app string Application name - -c, --config string Path to application configuration file - -h, --help help for create - -r, --region string The target region (see 'flyctl platform regions') - --vm-size string the size of the VM - --volume-size int The volume size in GB -~~~ - -## Global Options - -~~~ - -t, --access-token string Fly API Access Token - --debug Print additional logs and traces - --verbose Verbose output -~~~ - -## See Also - -* [fly postgres barman](/docs/flyctl/postgres-barman/) - Manage databases in a cluster - diff --git a/flyctl/cmd/fly_postgres_barman_recover.md b/flyctl/cmd/fly_postgres_barman_recover.md deleted file mode 100644 index a40f5a1d43..0000000000 --- a/flyctl/cmd/fly_postgres_barman_recover.md +++ /dev/null @@ -1,29 +0,0 @@ -Recover primary database with a barman backup - -## Usage -~~~ -fly postgres barman recover [flags] -~~~ - -## Options - -~~~ - -a, --app string Application name - -b, --backup-id string choose one backup ID. Default: latest (default "latest") - -c, --config string Path to application configuration file - -h, --help help for recover - -T, --target-time string choose a target time for PITR. Example: "2023-05-16 20:55:05.958774+00:00". Default: last WAL file on barman -~~~ - -## Global Options - -~~~ - -t, --access-token string Fly API Access Token - --debug Print additional logs and traces - --verbose Verbose output -~~~ - -## See Also - -* [fly postgres barman](/docs/flyctl/postgres-barman/) - Manage databases in a cluster - diff --git a/flyctl/cmd/fly_postgres_barman_switch-wal.md b/flyctl/cmd/fly_postgres_barman_switch-wal.md deleted file mode 100644 index 961a8875e1..0000000000 --- a/flyctl/cmd/fly_postgres_barman_switch-wal.md +++ /dev/null @@ -1,27 +0,0 @@ -Switch WAL to sync barman - -## Usage -~~~ -fly postgres barman switch-wal [flags] -~~~ - -## Options - -~~~ - -a, --app string Application name - -c, --config string Path to application configuration file - -h, --help help for switch-wal -~~~ - -## Global Options - -~~~ - -t, --access-token string Fly API Access Token - --debug Print additional logs and traces - --verbose Verbose output -~~~ - -## See Also - -* [fly postgres barman](/docs/flyctl/postgres-barman/) - Manage databases in a cluster - diff --git a/flyctl/cmd/fly_postgres_create.md b/flyctl/cmd/fly_postgres_create.md index ba8af4661e..62828ce410 100644 --- a/flyctl/cmd/fly_postgres_create.md +++ b/flyctl/cmd/fly_postgres_create.md @@ -12,6 +12,7 @@ fly postgres create [flags] --autostart Automatically start a stopped Postgres app when a network request is received --consul-url string Opt into using an existing consul as the backend store by specifying the target consul url. --detach Return immediately instead of monitoring deployment progress + --enable-backups Create a new tigris bucket and enable WAL-based backups --flex Create a postgres cluster that's managed by Repmgr (default true) --fork-from string Specify a source Postgres application to fork from. Format: or : -h, --help help for create diff --git a/flyctl/cmd/fly_proxy.md b/flyctl/cmd/fly_proxy.md index c97acc58d5..c0823963db 100644 --- a/flyctl/cmd/fly_proxy.md +++ b/flyctl/cmd/fly_proxy.md @@ -16,6 +16,7 @@ fly proxy [remote_host] [flags] -o, --org string The target Fly.io organization -q, --quiet Don't print progress indicators for WireGuard -s, --select Prompt to select from available Machines from the current application + --watch-stdin Watches stdin and terminates once it gets closed ~~~ ## Global Options diff --git a/flyctl/cmd/fly_scale_count.md b/flyctl/cmd/fly_scale_count.md index 11368e9650..b39ed3fe2b 100644 --- a/flyctl/cmd/fly_scale_count.md +++ b/flyctl/cmd/fly_scale_count.md @@ -20,7 +20,7 @@ fly scale count [count] [flags] -r, --region string Comma separated list of regions to act on. Defaults to all regions where there is at least one machine running for the app --vm-cpu-kind string The kind of CPU to use ('shared' or 'performance') --vm-cpus int Number of CPUs - --vm-gpu-kind string If set, the GPU model to attach (a100-pcie-40gb, a100-sxm4-80gb, l40s, a10) + --vm-gpu-kind string If set, the GPU model to attach (a100-pcie-40gb, a100-sxm4-80gb, l40s, a10, none) --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 --vm-size string The VM size to set machines to. See "fly platform vm-sizes" for valid values diff --git a/flyctl/cmd/fly_settings.md b/flyctl/cmd/fly_settings.md index 5c6c0d29e6..fada20a524 100644 --- a/flyctl/cmd/fly_settings.md +++ b/flyctl/cmd/fly_settings.md @@ -8,6 +8,7 @@ fly settings [command] [flags] ## Available Commands * [analytics](/docs/flyctl/settings-analytics/) - Control anonymized analytics collection * [autoupdate](/docs/flyctl/settings-autoupdate/) - Control automatic updates +* [synthetics](/docs/flyctl/settings-synthetics/) - Control synthetics agent execution ## Options diff --git a/flyctl/cmd/fly_settings_synthetics.md b/flyctl/cmd/fly_settings_synthetics.md new file mode 100644 index 0000000000..72be448fd3 --- /dev/null +++ b/flyctl/cmd/fly_settings_synthetics.md @@ -0,0 +1,29 @@ +Control synthetics agent execution + +## Usage +~~~ +fly settings synthetics [flags] +~~~ + +## Available Commands +* [disable](/docs/flyctl/settings-synthetics-disable/) - Disable synthetics +* [enable](/docs/flyctl/settings-synthetics-enable/) - Enable synthetics + +## Options + +~~~ + -h, --help help for synthetics +~~~ + +## Global Options + +~~~ + -t, --access-token string Fly API Access Token + --debug Print additional logs and traces + --verbose Verbose output +~~~ + +## See Also + +* [fly settings](/docs/flyctl/settings/) - Manage flyctl settings + diff --git a/flyctl/cmd/fly_settings_synthetics_disable.md b/flyctl/cmd/fly_settings_synthetics_disable.md new file mode 100644 index 0000000000..0b57ea2743 --- /dev/null +++ b/flyctl/cmd/fly_settings_synthetics_disable.md @@ -0,0 +1,25 @@ +Disable synthetics + +## Usage +~~~ +fly settings synthetics disable [flags] +~~~ + +## Options + +~~~ + -h, --help help for disable +~~~ + +## Global Options + +~~~ + -t, --access-token string Fly API Access Token + --debug Print additional logs and traces + --verbose Verbose output +~~~ + +## See Also + +* [fly settings synthetics](/docs/flyctl/settings-synthetics/) - Control synthetics agent execution + diff --git a/flyctl/cmd/fly_settings_synthetics_enable.md b/flyctl/cmd/fly_settings_synthetics_enable.md new file mode 100644 index 0000000000..ba6e45904e --- /dev/null +++ b/flyctl/cmd/fly_settings_synthetics_enable.md @@ -0,0 +1,25 @@ +Enable synthetics + +## Usage +~~~ +fly settings synthetics enable [flags] +~~~ + +## Options + +~~~ + -h, --help help for enable +~~~ + +## Global Options + +~~~ + -t, --access-token string Fly API Access Token + --debug Print additional logs and traces + --verbose Verbose output +~~~ + +## See Also + +* [fly settings synthetics](/docs/flyctl/settings-synthetics/) - Control synthetics agent execution + diff --git a/flyctl/cmd/fly_synthetics.md b/flyctl/cmd/fly_synthetics.md new file mode 100644 index 0000000000..ec599ccbdd --- /dev/null +++ b/flyctl/cmd/fly_synthetics.md @@ -0,0 +1,28 @@ +Synthetic monitoring management. + +## Usage +~~~ +fly synthetics [command] [flags] +~~~ + +## Available Commands +* [agent](/docs/flyctl/synthetics-agent/) - Runs the Synthetics agent + +## Options + +~~~ + -h, --help help for synthetics +~~~ + +## Global Options + +~~~ + -t, --access-token string Fly API Access Token + --debug Print additional logs and traces + --verbose Verbose output +~~~ + +## See Also + +* [fly](/docs/flyctl/help/) - The Fly.io command line interface + diff --git a/flyctl/cmd/fly_synthetics_agent.md b/flyctl/cmd/fly_synthetics_agent.md new file mode 100644 index 0000000000..30595c859e --- /dev/null +++ b/flyctl/cmd/fly_synthetics_agent.md @@ -0,0 +1,25 @@ +Runs the Synthetics agent in the foreground. + +## Usage +~~~ +fly synthetics agent [flags] +~~~ + +## Options + +~~~ + -h, --help help for agent +~~~ + +## Global Options + +~~~ + -t, --access-token string Fly API Access Token + --debug Print additional logs and traces + --verbose Verbose output +~~~ + +## See Also + +* [fly synthetics](/docs/flyctl/synthetics/) - Synthetic monitoring + diff --git a/flyctl/cmd/fly_volumes.md b/flyctl/cmd/fly_volumes.md index 96ba3ec31b..c384d2edeb 100644 --- a/flyctl/cmd/fly_volumes.md +++ b/flyctl/cmd/fly_volumes.md @@ -1,4 +1,4 @@ -Manage Fly Volumes. Volumes are persistent storage for Fly Machines. Learn how how volumes work: https://fly.io/docs/reference/volumes/. +Manage Fly Volumes. Volumes are persistent storage for Fly Machines. Learn how how volumes work: https://fly.io/docs/volumes/overview/. ## Usage ~~~ diff --git a/flyctl/cmd/fly_volumes_create.md b/flyctl/cmd/fly_volumes_create.md index bbef242a45..8bebda8691 100644 --- a/flyctl/cmd/fly_volumes_create.md +++ b/flyctl/cmd/fly_volumes_create.md @@ -1,4 +1,4 @@ -Create a new volume for an app. Volumes are persistent storage for Fly Machines. Learn how to add a volume to your app: https://fly.io/docs/apps/volume-storage/. +Create a new volume for an app. Volumes are persistent storage for Fly Machines. Learn how to add a volume to your app: https://fly.io/docs/launch/volume-storage/. ## Usage ~~~ @@ -22,7 +22,7 @@ fly volumes create [flags] --snapshot-retention int Snapshot retention in days (default 5) --vm-cpu-kind string The kind of CPU to use ('shared' or 'performance') --vm-cpus int Number of CPUs - --vm-gpu-kind string If set, the GPU model to attach (a100-pcie-40gb, a100-sxm4-80gb, l40s, a10) + --vm-gpu-kind string If set, the GPU model to attach (a100-pcie-40gb, a100-sxm4-80gb, l40s, a10, none) --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 --vm-size string The VM size to set machines to. See "fly platform vm-sizes" for valid values diff --git a/flyctl/cmd/fly_volumes_fork.md b/flyctl/cmd/fly_volumes_fork.md index 4db5acc05d..c9b6d8c7f6 100644 --- a/flyctl/cmd/fly_volumes_fork.md +++ b/flyctl/cmd/fly_volumes_fork.md @@ -18,7 +18,7 @@ fly volumes fork [flags] --require-unique-zone Place the volume in a separate hardware zone from existing volumes. This is the default. (default true) --vm-cpu-kind string The kind of CPU to use ('shared' or 'performance') --vm-cpus int Number of CPUs - --vm-gpu-kind string If set, the GPU model to attach (a100-pcie-40gb, a100-sxm4-80gb, l40s, a10) + --vm-gpu-kind string If set, the GPU model to attach (a100-pcie-40gb, a100-sxm4-80gb, l40s, a10, none) --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 --vm-size string The VM size to set machines to. See "fly platform vm-sizes" for valid values