Skip to content

Commit

Permalink
Merge pull request superfly#1151 from superfly/flyctl-docs_v0.1.117
Browse files Browse the repository at this point in the history
[flybot] Fly CLI docs update
  • Loading branch information
docs-syncer[bot] committed Nov 2, 2023
2 parents bd08f56 + c42ce54 commit 1be270c
Show file tree
Hide file tree
Showing 4 changed files with 72 additions and 6 deletions.
1 change: 1 addition & 0 deletions flyctl/cmd/flyctl_machine.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ flyctl machine [command] [flags]
* [api-proxy](/docs/flyctl/machine-api-proxy/) - Establish a proxy to the Machine API through a Wireguard tunnel for local connections
* [clone](/docs/flyctl/machine-clone/) - Clone a Fly machine
* [cordon](/docs/flyctl/machine-cordon/) - Deactivate all services on a machine
* [create](/docs/flyctl/machine-create/) - Create, but don't start, a machine
* [destroy](/docs/flyctl/machine-destroy/) - Destroy a Fly machine.
* [exec](/docs/flyctl/machine-exec/) - Execute a command on a machine
* [kill](/docs/flyctl/machine-kill/) - Kill (SIGKILL) a Fly machine
Expand Down
59 changes: 59 additions & 0 deletions flyctl/cmd/flyctl_machine_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
Create, but don't start, a machine


## Usage
~~~
flyctl machine create <image> [command] [flags]
~~~

## Options

~~~
-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 aren't network requests for it (default true)
--build-nixpacks Build your image with nixpacks
-c, --config string Path to application configuration file
--detach Return immediately instead of monitoring deployment progress
--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 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.
-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 List of kernel arguments to be provided to the init. Can be specified multiple times.
-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 missing
--org string The organization that will own the app
-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')
--restart string Set the restart policy for a Machine. Options include 'no', 'always', and 'on-fail'.
Default is 'on-fail' 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
--schedule string Schedule a machine run at hourly, daily and monthly intervals
--skip-dns-registration Do not register the machine's 6PN IP with the internal DNS system
--standby-for strings Comma separated list of machine ids to watch for
--vm-cpu-kind string The kind of CPU to use ('shared' or 'performance')
--vm-cpus int Number of CPUs
--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
-v, --volume strings Volumes to mount in the form of <volume_id_or_name>:/path/inside/machine[:<options>]
~~~

## Global Options

~~~
-t, --access-token string Fly API Access Token
--debug Print additional logs and traces
--verbose Verbose output
~~~

## See Also

* [flyctl machine](/docs/flyctl/machine/) - Commands that manage machines

1 change: 1 addition & 0 deletions flyctl/cmd/flyctl_machine_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ flyctl machine update [machine_id] [flags]
--schedule string Schedule a machine run at hourly, daily 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 Comma separated list of machine ids to watch for
--vm-cpu-kind string The kind of CPU to use ('shared' or 'performance')
--vm-cpus int Number of CPUs
Expand Down
17 changes: 11 additions & 6 deletions flyctl/cmd/flyctl_volumes_fork.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,17 @@ flyctl volumes fork [id] [flags]
## Options

~~~
-a, --app string Application name
-c, --config string Path to application configuration file
-h, --help help for fork
-j, --json JSON output
-n, --name string The name of the new volume
--require-unique-zone Place the volume in a separate hardware zone from existing volumes. This is the default.
-a, --app string Application name
-c, --config string Path to application configuration file
-h, --help help for fork
--host-dedication-id string The dedication id of the reserved hosts for your organization (if any)
-j, --json JSON output
-n, --name string The name of the new volume
--require-unique-zone Place the volume in a separate hardware zone from existing volumes. This is the default.
--vm-cpu-kind string The kind of CPU to use ('shared' or 'performance')
--vm-cpus int Number of CPUs
--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
~~~

## Global Options
Expand Down

0 comments on commit 1be270c

Please sign in to comment.