Skip to content

Commit

Permalink
[flyctl-bot] Update docs from flyctl
Browse files Browse the repository at this point in the history
  • Loading branch information
jsierles committed Aug 2, 2024
1 parent abe6185 commit 93ef885
Show file tree
Hide file tree
Showing 58 changed files with 879 additions and 160 deletions.
2 changes: 2 additions & 0 deletions flyctl/cmd/fly.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion flyctl/cmd/fly_apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions flyctl/cmd/fly_apps_destroy.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Delete an application from the Fly platform.
Delete one or more applications from the Fly platform.

## Usage
~~~
fly apps destroy <app name> [flags]
fly apps destroy <app name(s)> [flags]
~~~

## Options
Expand Down
1 change: 1 addition & 0 deletions flyctl/cmd/fly_apps_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion flyctl/cmd/fly_apps_move.md
Original file line number Diff line number Diff line change
@@ -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
~~~
Expand Down
2 changes: 1 addition & 1 deletion flyctl/cmd/fly_console.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 4 additions & 1 deletion flyctl/cmd/fly_deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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=<local/path> 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)
Expand Down Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions flyctl/cmd/fly_extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
32 changes: 32 additions & 0 deletions flyctl/cmd/fly_extensions_kubernetes.md
Original file line number Diff line number Diff line change
@@ -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

30 changes: 30 additions & 0 deletions flyctl/cmd/fly_extensions_kubernetes_create.md
Original file line number Diff line number Diff line change
@@ -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

26 changes: 26 additions & 0 deletions flyctl/cmd/fly_extensions_kubernetes_destroy.md
Original file line number Diff line number Diff line change
@@ -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

25 changes: 25 additions & 0 deletions flyctl/cmd/fly_extensions_kubernetes_list.md
Original file line number Diff line number Diff line change
@@ -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

26 changes: 26 additions & 0 deletions flyctl/cmd/fly_extensions_kubernetes_save-kubeconfig.md
Original file line number Diff line number Diff line change
@@ -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

32 changes: 32 additions & 0 deletions flyctl/cmd/fly_extensions_mysql.md
Original file line number Diff line number Diff line change
@@ -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

32 changes: 32 additions & 0 deletions flyctl/cmd/fly_extensions_mysql_create.md
Original file line number Diff line number Diff line change
@@ -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

28 changes: 28 additions & 0 deletions flyctl/cmd/fly_extensions_mysql_destroy.md
Original file line number Diff line number Diff line change
@@ -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

27 changes: 27 additions & 0 deletions flyctl/cmd/fly_extensions_mysql_list.md
Original file line number Diff line number Diff line change
@@ -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

29 changes: 29 additions & 0 deletions flyctl/cmd/fly_extensions_mysql_status.md
Original file line number Diff line number Diff line change
@@ -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

Loading

0 comments on commit 93ef885

Please sign in to comment.