Elgato_dark/fleet
1
0
Fork 0
mirror of https://github.com/fleetdm/fleet synced 2026-05-05 22:39:17 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 116

fix: update heading to conform to Fleet's style guide (#4153)

Browse source 
* fix: update heading to conform to Fleet's style guide

* fix: update heading link to conform to style guide
This commit is contained in:
Kelvin Oghenerhoro Omereshone 2022-02-15 10:16:58 +01:00 committed by GitHub
parent 4dc10f6a26
commit afa63805c8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
docs/01-Using-Fleet/02-fleetctl-CLI.md
View file

@ -22,7 +22,7 @@ Fleetctl also provides a quick way to work with all the data exposed by Fleet wi
## Setting up Fleet
This section walks through setting up and configuring Fleet via the CLI. If you already have a running fleet instance, skip ahead to [Logging In To An Existing Fleet Instance](#logging-in-to-an-existing-fleet-instance) to configure the `fleetctl` CLI.
This section walks through setting up and configuring Fleet via the CLI. If you already have a running fleet instance, skip ahead to [Logging in to an existing Fleet instance](#logging-in-to-an-existing-fleet-instance) to configure the `fleetctl` CLI.
This guide illustrates:
@ -44,7 +44,7 @@ make
The `fleet serve` command will be the long running command that runs the Fleet server.
### fleetctl config
### Fleetctl config
At this point, the MySQL database doesn't have any users in it. Because of this, Fleet is exposing a one-time setup endpoint. Before we can hit that endpoint (by running `fleetctl setup`), we have to first configure the local `fleetctl` context.
@ -63,7 +63,7 @@ fleetctl config set --address https://fleet.corp.example.com
[+] Set the address config key to "https://fleet.corp.example.com" in the "default" context
```
### fleetctl setup
### Fleetctl setup
Now that we've configured our local CLI context, lets go ahead and create our admin account:
@ -150,17 +150,17 @@ A Fleet configuration is defined using one or more declarative "messages" in yam
Fleet configuration can be retrieved and applied using the `fleetctl` tool.
### fleetctl get
### Fleetctl get
The `fleetctl get <fleet-entity-here> > <configuration-file-name-here>.yml` command allows you retrieve the current configuration and create a new file for specified Fleet entity (queries, packs, etc.)
### fleetctl apply
### Fleetctl apply
The `fleetctl apply -f <configuration-file-name-here>.yml` allows you to apply the current configuration in the specified file.
Check out the [configuration files](./configuration-files/README.md) section of the documentation for example yaml files.
### fleetctl convert
### Fleetctl convert
`fleetctl` includes easy tooling to convert osquery pack JSON into the
`fleetctl` format. Use `fleetctl convert` with a path to the pack file:
@ -271,7 +271,7 @@ Carve contents remain available for 24 hours after the first data is provided fr
The same is not true if S3 is used as the storage backend. In that scenario, it is suggested to setup a [bucket lifecycle configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) to avoid retaining data in excess. Fleet, in an "eventual consistent" manner (i.e. by periodically performing comparisons), will keep the metadata relative to the files carves in sync with what it is actually available in the bucket.
### Alternative Carving backends
### Alternative carving backends
#### Minio