Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[flybot] Fly CLI docs update #1831

Merged
merged 1 commit into from
Sep 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions flyctl/cmd/fly_machine.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ fly machine [command] [flags]
* [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 Fly machines
* [egress-ip](/docs/flyctl/machine-egress-ip/) - Manage static egress IPs
* [exec](/docs/flyctl/machine-exec/) - Execute a command on a machine
* [kill](/docs/flyctl/machine-kill/) - Kill (SIGKILL) a Fly machine
* [leases](/docs/flyctl/machine-leases/) - Manage machine leases
Expand Down
29 changes: 29 additions & 0 deletions flyctl/cmd/fly_machine_egress-ip.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
Manage static egress (outgoing) IP addresses for machines

## Usage
~~~
fly machine egress-ip [command] [flags]
~~~

## Available Commands
* [allocate](/docs/flyctl/machine-egress-ip-allocate/) - Allocate static egress IPs
* [list](/docs/flyctl/machine-egress-ip-list/) - List all allocated static egress IPs

## Options

~~~
-h, --help help for egress-ip
~~~

## Global Options

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

## See Also

* [fly machine](/docs/flyctl/machine/) - Manage Fly Machines.

27 changes: 27 additions & 0 deletions flyctl/cmd/fly_machine_egress-ip_allocate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
Allocate a pair of static egress IPv4 and IPv6 for a machine

## Usage
~~~
fly machine egress-ip allocate <machine-id> [flags]
~~~

## Options

~~~
-a, --app string Application name
-c, --config string Path to application configuration file
-h, --help help for allocate
~~~

## Global Options

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

## See Also

* [fly machine egress-ip](/docs/flyctl/machine-egress-ip/) - Manage static egress IPs

27 changes: 27 additions & 0 deletions flyctl/cmd/fly_machine_egress-ip_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
List all allocated static egress IP addresses with their corresponding machine

## Usage
~~~
fly machine egress-ip list [flags]
~~~

## Options

~~~
-a, --app string Application name
-c, --config string Path to application configuration file
-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 machine egress-ip](/docs/flyctl/machine-egress-ip/) - Manage static egress IPs