Skip to content
This repository was archived by the owner on Jan 30, 2020. It is now read-only.

docs: update fleetctl docs per new default driver #1188

Merged
bcwaldon merged 1 commit into from
Apr 14, 2015
Merged

docs: update fleetctl docs per new default driver #1188

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion Documentation/deployment-and-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ ListenStream=127.0.0.1:49153
After you've written the file, call `systemctl daemon-reload` to load the new drop-in, followed by `systemctl stop fleet.service; systemctl restart fleet.socket; systemctl start fleet.service`.

Once the socket is running, the fleet API will be available at `http://${ListenStream}/fleet/v1`, where `${ListenStream}` is the value of the `ListenStream` option used in your socket file.
This endpoint is accessible directly using tools such as curl and wget, or you can use fleetctl like so: `fleetctl --driver API --endpoint http://${ListenStream} <command>`.
This endpoint is accessible directly using tools such as curl and wget, or you can use fleetctl like so: `fleetctl --endpoint http://${ListenStream} <command>`.
For more information, see the [official API documentation][api-doc].

[api-doc]: https://github.com/coreos/fleet/blob/master/Documentation/api-v1.md
Expand Down
6 changes: 2 additions & 4 deletions Documentation/using-the-client.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,16 @@ fleetctl are analogous to those of systemd's CLI, `systemctl`.

The `fleetctl` binary is included in all CoreOS distributions, so it is as simple as SSH'ing in to your CoreOS machine and executing `fleetctl`.

### Custom etcd Endpoint
### Custom API Endpoint

fleetctl currently requires direct communication with the etcd cluster that your fleet machines are configured to use. Use the `--endpoint` flag to override the default of `http://127.0.0.1:2379,http://127.0.0.1:4001`:
fleetctl communicates directly with an HTTP API hosted by the fleet cluster. Use the `--endpoint` flag to override the default of `unix:///var/run/fleet.sock`:

fleetctl --endpoint http://<IP:PORT> list-units

Alternatively, `--endpoint` can be provided through the `FLEETCTL_ENDPOINT` environment variable:

FLEETCTL_ENDPOINT=http://<IP:[PORT]> fleetctl list-units

In future, fleetctl will communicate exclusively with a fleet API endpoint, and will no longer require direct access to etcd.

### From an External Host

If you prefer to execute fleetctl from an external host (i.e. your laptop), the `--tunnel` flag can be used to tunnel communication with your fleet cluster over SSH:
Expand Down