Skip to content

Commit efc15bd

Browse files
docs-syncer[bot]Fly.io CI
docs-syncer[bot]
and
Fly.io CI
authored
[flyctl-bot] Update docs from flyctl (#1735)
Co-authored-by: Fly.io CI <[email protected]>
1 parent abe6185 commit efc15bd

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+879
-160
lines changed

‎flyctl/cmd/fly.md

+2
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ fly [flags]
2828
* [litefs-cloud](/docs/flyctl/litefs-cloud/) - LiteFS Cloud management commands
2929
* [logs](/docs/flyctl/logs/) - View app logs
3030
* [machine](/docs/flyctl/machine/) - Manage Fly Machines.
31+
* [mysql](/docs/flyctl/mysql/) - Provision and manage MySQL databases
3132
* [orgs](/docs/flyctl/orgs/) - Commands for managing Fly organizations
3233
* [ping](/docs/flyctl/ping/) - Test connectivity with ICMP ping messages
3334
* [platform](/docs/flyctl/platform/) - Fly platform information
@@ -43,6 +44,7 @@ fly [flags]
4344
* [ssh](/docs/flyctl/ssh/) - Use SSH to log into or run commands on Machines
4445
* [status](/docs/flyctl/status/) - Show app status
4546
* [storage](/docs/flyctl/storage/) - Provision and manage Tigris object storage buckets
47+
* [synthetics](/docs/flyctl/synthetics/) - Synthetic monitoring
4648
* [tokens](/docs/flyctl/tokens/) - Manage Fly.io API tokens
4749
* [version](/docs/flyctl/version/) - Show version information for the flyctl command
4850
* [volumes](/docs/flyctl/volumes/) - Manage Fly Volumes.

‎flyctl/cmd/fly_apps.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ fly apps [command] [flags]
77

88
## Available Commands
99
* [create](/docs/flyctl/apps-create/) - Create a new application.
10-
* [destroy](/docs/flyctl/apps-destroy/) - Permanently destroy an app.
10+
* [destroy](/docs/flyctl/apps-destroy/) - Permanently destroy one or more appa.
1111
* [errors](/docs/flyctl/apps-errors/) - View application errors on Sentry.io
1212
* [list](/docs/flyctl/apps-list/) - List applications.
1313
* [move](/docs/flyctl/apps-move/) - Move an app to another organization.

‎flyctl/cmd/fly_apps_destroy.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
Delete an application from the Fly platform.
1+
Delete one or more applications from the Fly platform.
22

33
## Usage
44
~~~
5-
fly apps destroy <app name> [flags]
5+
fly apps destroy <app name(s)> [flags]
66
~~~
77

88
## Options

‎flyctl/cmd/fly_apps_list.md

+1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ fly apps list [flags]
1515
-h, --help help for list
1616
-j, --json JSON output
1717
-o, --org string The target Fly.io organization
18+
-q, --quiet Only list app names
1819
~~~
1920

2021
## Global Options

‎flyctl/cmd/fly_apps_move.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Move an application to another
22
organization the current user belongs to.
3-
3+
For details, see https://fly.io/docs/apps/move-app-org/.
44

55
## Usage
66
~~~

‎flyctl/cmd/fly_console.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ fly console [flags]
3232
-u, --user string Unix username to connect as (default "root")
3333
--vm-cpu-kind string The kind of CPU to use ('shared' or 'performance')
3434
--vm-cpus int Number of CPUs
35-
--vm-gpu-kind string If set, the GPU model to attach (a100-pcie-40gb, a100-sxm4-80gb, l40s, a10)
35+
--vm-gpu-kind string If set, the GPU model to attach (a100-pcie-40gb, a100-sxm4-80gb, l40s, a10, none)
3636
--vm-gpus int Number of GPUs. Must also choose the GPU model with --vm-gpu-kind flag
3737
--vm-memory string Memory (in megabytes) to attribute to the VM
3838
--vm-size string The VM size to set machines to. See "fly platform vm-sizes" for valid values

‎flyctl/cmd/fly_deploy.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ fly deploy [WORKING_DIRECTORY] [flags]
3131
Repeat for each volume in order (comma-separated lists not accepted)
3232
3333
-c, --config string Path to application configuration file
34+
--deploy-retries string Number of times to retry a deployment if it fails (default "auto")
35+
--depot Deploy using depot to build the image
3436
--detach Return immediately instead of monitoring deployment progress
3537
--dns-checks Perform DNS checks during deployment (default true)
3638
--dockerfile string Path to a Dockerfile. Defaults to the Dockerfile in the working directory.
@@ -40,6 +42,7 @@ fly deploy [WORKING_DIRECTORY] [flags]
4042
--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.
4143
--file-local stringArray Set of files in the form of /path/inside/machine=<local/path> pairs. Can be specified multiple times.
4244
--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.
45+
--flycast Allocate a private IPv6 addresses
4346
--ha Create spare machines that increases app availability (default true)
4447
-h, --help help for deploy
4548
--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]
7073
--update-only Do not create Machines for new process groups
7174
--vm-cpu-kind string The kind of CPU to use ('shared' or 'performance')
7275
--vm-cpus int Number of CPUs
73-
--vm-gpu-kind string If set, the GPU model to attach (a100-pcie-40gb, a100-sxm4-80gb, l40s, a10)
76+
--vm-gpu-kind string If set, the GPU model to attach (a100-pcie-40gb, a100-sxm4-80gb, l40s, a10, none)
7477
--vm-gpus int Number of GPUs. Must also choose the GPU model with --vm-gpu-kind flag
7578
--vm-memory string Memory (in megabytes) to attribute to the VM
7679
--vm-size string The VM size to set machines to. See "fly platform vm-sizes" for valid values

‎flyctl/cmd/fly_extensions.md

+3
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,13 @@ fly extensions [command] [flags]
99
* [arcjet](/docs/flyctl/extensions-arcjet/) - Provision and manage Arcjet
1010
* [enveloop](/docs/flyctl/extensions-enveloop/) - Provision and manage Enveloop projects
1111
* [kafka](/docs/flyctl/extensions-kafka/) - Provision and manage Upstash Kafka clusters
12+
* [kubernetes](/docs/flyctl/extensions-kubernetes/) - Provision and manage Kubernetes clusters
13+
* [mysql](/docs/flyctl/extensions-mysql/) - Provision and manage MySQL databases
1214
* [sentry](/docs/flyctl/extensions-sentry/) - Setup a Sentry project for this app
1315
* [storage](/docs/flyctl/extensions-storage/) - Provision and manage Tigris object storage buckets
1416
* [supabase](/docs/flyctl/extensions-supabase/) - Provision and manage Supabase Postgres databases
1517
* [vector](/docs/flyctl/extensions-vector/) - Provision and manage Upstash Vector index
18+
* [wafris](/docs/flyctl/extensions-wafris/) - Provision and manage Wafris WAFs (Web Application Firewalls)
1619

1720
## Options
1821

‎flyctl/cmd/fly_extensions_kubernetes.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
Provision and manage Kubernetes clusters
2+
3+
4+
## Usage
5+
~~~
6+
fly extensions kubernetes [command] [flags]
7+
~~~
8+
9+
## Available Commands
10+
* [create](/docs/flyctl/extensions-kubernetes-create/) - Provision a Kubernetes cluster for an organization
11+
* [destroy](/docs/flyctl/extensions-kubernetes-destroy/) - Permanently destroy a Kubernetes cluster
12+
* [list](/docs/flyctl/extensions-kubernetes-list/) - List your Kubernetes clusters
13+
* [save-kubeconfig](/docs/flyctl/extensions-kubernetes-save-kubeconfig/) - Save the kubeconfig file of your cluster
14+
15+
## Options
16+
17+
~~~
18+
-h, --help help for kubernetes
19+
~~~
20+
21+
## Global Options
22+
23+
~~~
24+
-t, --access-token string Fly API Access Token
25+
--debug Print additional logs and traces
26+
--verbose Verbose output
27+
~~~
28+
29+
## See Also
30+
31+
* [fly extensions](/docs/flyctl/extensions/) - Extensions are additional functionality that can be added to your Fly apps
32+

‎flyctl/cmd/fly_extensions_kubernetes_create.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
Provision a Kubernetes cluster for an organization
2+
3+
4+
## Usage
5+
~~~
6+
fly extensions kubernetes create [flags]
7+
~~~
8+
9+
## Options
10+
11+
~~~
12+
-h, --help help for create
13+
-n, --name string The name of your cluster
14+
-o, --org string The target Fly.io organization
15+
--output string The output path to save the kubeconfig file
16+
-r, --region string The target region (see 'flyctl platform regions')
17+
~~~
18+
19+
## Global Options
20+
21+
~~~
22+
-t, --access-token string Fly API Access Token
23+
--debug Print additional logs and traces
24+
--verbose Verbose output
25+
~~~
26+
27+
## See Also
28+
29+
* [fly extensions kubernetes](/docs/flyctl/extensions-kubernetes/) - Provision and manage Kubernetes clusters
30+

‎flyctl/cmd/fly_extensions_kubernetes_destroy.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
Permanently destroy a Kubernetes cluster
2+
3+
## Usage
4+
~~~
5+
fly extensions kubernetes destroy [name] [flags]
6+
~~~
7+
8+
## Options
9+
10+
~~~
11+
-h, --help help for destroy
12+
-y, --yes Accept all confirmations
13+
~~~
14+
15+
## Global Options
16+
17+
~~~
18+
-t, --access-token string Fly API Access Token
19+
--debug Print additional logs and traces
20+
--verbose Verbose output
21+
~~~
22+
23+
## See Also
24+
25+
* [fly extensions kubernetes](/docs/flyctl/extensions-kubernetes/) - Provision and manage Kubernetes clusters
26+

‎flyctl/cmd/fly_extensions_kubernetes_list.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
List your Kubernetes clusters
2+
3+
## Usage
4+
~~~
5+
fly extensions kubernetes list [flags]
6+
~~~
7+
8+
## Options
9+
10+
~~~
11+
-h, --help help for list
12+
~~~
13+
14+
## Global Options
15+
16+
~~~
17+
-t, --access-token string Fly API Access Token
18+
--debug Print additional logs and traces
19+
--verbose Verbose output
20+
~~~
21+
22+
## See Also
23+
24+
* [fly extensions kubernetes](/docs/flyctl/extensions-kubernetes/) - Provision and manage Kubernetes clusters
25+

‎flyctl/cmd/fly_extensions_kubernetes_save-kubeconfig.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
Save the kubeconfig file of your cluster
2+
3+
## Usage
4+
~~~
5+
fly extensions kubernetes save-kubeconfig [cluster name] [flags]
6+
~~~
7+
8+
## Options
9+
10+
~~~
11+
-h, --help help for save-kubeconfig
12+
--output string The output path to save the kubeconfig file
13+
~~~
14+
15+
## Global Options
16+
17+
~~~
18+
-t, --access-token string Fly API Access Token
19+
--debug Print additional logs and traces
20+
--verbose Verbose output
21+
~~~
22+
23+
## See Also
24+
25+
* [fly extensions kubernetes](/docs/flyctl/extensions-kubernetes/) - Provision and manage Kubernetes clusters
26+

‎flyctl/cmd/fly_extensions_mysql.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
Provision and manage MySQL databases
2+
3+
4+
## Usage
5+
~~~
6+
fly extensions mysql [command] [flags]
7+
~~~
8+
9+
## Available Commands
10+
* [create](/docs/flyctl/extensions-mysql-create/) - Provision a MySQL database
11+
* [destroy](/docs/flyctl/extensions-mysql-destroy/) - Permanently destroy a MySQL database
12+
* [list](/docs/flyctl/extensions-mysql-list/) - List your MySQL databases
13+
* [status](/docs/flyctl/extensions-mysql-status/) - Show details about a MySQL database
14+
15+
## Options
16+
17+
~~~
18+
-h, --help help for mysql
19+
~~~
20+
21+
## Global Options
22+
23+
~~~
24+
-t, --access-token string Fly API Access Token
25+
--debug Print additional logs and traces
26+
--verbose Verbose output
27+
~~~
28+
29+
## See Also
30+
31+
* [fly extensions](/docs/flyctl/extensions/) - Extensions are additional functionality that can be added to your Fly apps
32+

‎flyctl/cmd/fly_extensions_mysql_create.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
Provision a MySQL database
2+
3+
4+
## Usage
5+
~~~
6+
fly extensions mysql create [flags]
7+
~~~
8+
9+
## Options
10+
11+
~~~
12+
-a, --app string Application name
13+
-c, --config string Path to application configuration file
14+
-h, --help help for create
15+
-n, --name string The name of your database
16+
-o, --org string The target Fly.io organization
17+
-r, --region string The target region (see 'flyctl platform regions')
18+
-y, --yes Accept all confirmations
19+
~~~
20+
21+
## Global Options
22+
23+
~~~
24+
-t, --access-token string Fly API Access Token
25+
--debug Print additional logs and traces
26+
--verbose Verbose output
27+
~~~
28+
29+
## See Also
30+
31+
* [fly extensions mysql](/docs/flyctl/extensions-mysql/) - Provision and manage MySQL databases
32+

‎flyctl/cmd/fly_extensions_mysql_destroy.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
Permanently destroy a MySQL database
2+
3+
## Usage
4+
~~~
5+
fly extensions mysql destroy [name] [flags]
6+
~~~
7+
8+
## Options
9+
10+
~~~
11+
-a, --app string Application name
12+
-c, --config string Path to application configuration file
13+
-h, --help help for destroy
14+
-y, --yes Accept all confirmations
15+
~~~
16+
17+
## Global Options
18+
19+
~~~
20+
-t, --access-token string Fly API Access Token
21+
--debug Print additional logs and traces
22+
--verbose Verbose output
23+
~~~
24+
25+
## See Also
26+
27+
* [fly extensions mysql](/docs/flyctl/extensions-mysql/) - Provision and manage MySQL databases
28+

‎flyctl/cmd/fly_extensions_mysql_list.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
List your MySQL databases
2+
3+
## Usage
4+
~~~
5+
fly extensions mysql list [flags]
6+
~~~
7+
8+
## Options
9+
10+
~~~
11+
-h, --help help for list
12+
-o, --org string The target Fly.io organization
13+
-y, --yes Accept all confirmations
14+
~~~
15+
16+
## Global Options
17+
18+
~~~
19+
-t, --access-token string Fly API Access Token
20+
--debug Print additional logs and traces
21+
--verbose Verbose output
22+
~~~
23+
24+
## See Also
25+
26+
* [fly extensions mysql](/docs/flyctl/extensions-mysql/) - Provision and manage MySQL databases
27+

‎flyctl/cmd/fly_extensions_mysql_status.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
Show details about a MySQL database
2+
3+
4+
## Usage
5+
~~~
6+
fly extensions mysql status [name] [flags]
7+
~~~
8+
9+
## Options
10+
11+
~~~
12+
-a, --app string Application name
13+
-c, --config string Path to application configuration file
14+
-h, --help help for status
15+
-y, --yes Accept all confirmations
16+
~~~
17+
18+
## Global Options
19+
20+
~~~
21+
-t, --access-token string Fly API Access Token
22+
--debug Print additional logs and traces
23+
--verbose Verbose output
24+
~~~
25+
26+
## See Also
27+
28+
* [fly extensions mysql](/docs/flyctl/extensions-mysql/) - Provision and manage MySQL databases
29+

0 commit comments

Comments
 (0)