From afa63805c835f49d1cd077b0c8b8b32912d0ca74 Mon Sep 17 00:00:00 2001 From: Kelvin Oghenerhoro Omereshone Date: Tue, 15 Feb 2022 10:16:58 +0100 Subject: [PATCH] fix: update heading to conform to Fleet's style guide (#4153) * fix: update heading to conform to Fleet's style guide * fix: update heading link to conform to style guide --- docs/01-Using-Fleet/02-fleetctl-CLI.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/01-Using-Fleet/02-fleetctl-CLI.md b/docs/01-Using-Fleet/02-fleetctl-CLI.md index 6399087c00..c7e740f5c3 100644 --- a/docs/01-Using-Fleet/02-fleetctl-CLI.md +++ b/docs/01-Using-Fleet/02-fleetctl-CLI.md @@ -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 > .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 .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