Docs: add syntax highlighting keywords to code blocks (#13963)
Closes: #13691 Changes: - Added keywords for syntax highlighting to code blocks in documentation Markdown files. --------- Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
This commit is contained in:
@@ -12,7 +12,7 @@ Agent options are validated using the latest version of osquery.
|
||||
|
||||
When updating agent options, you may see an error similar to this:
|
||||
|
||||
```
|
||||
```sh
|
||||
[...] unsupported key provided: "logger_plugin"
|
||||
If you’re not using the latest osquery, use the fleetctl apply --force command to override validation.
|
||||
```
|
||||
@@ -21,7 +21,9 @@ This error indicates that you're providing a config option that isn't valid in t
|
||||
|
||||
If you are not using the latest version of osquery, you can create a config YAML file and apply it with `fleetctl` using the `--force` flag to override the validation:
|
||||
|
||||
```fleetctl apply --force -f config.yaml```
|
||||
```sh
|
||||
fleetctl apply --force -f config.yaml
|
||||
```
|
||||
|
||||
You can verify that your agent options are valid by using [the fleetctl apply command](https://fleetdm.com/docs/using-fleet/fleetctl-cli#fleetctl-apply) with the `--dry-run` flag. This will report any error and do nothing if the configuration was valid. If you don't use the latest version of osquery, you can override validation using the `--force` flag. This will update agent options even if they are invalid.
|
||||
|
||||
@@ -160,7 +162,7 @@ If you prefer to deploy a new package with the updated enroll secret:
|
||||
|
||||
> In order for these options to be applied to your hosts, the `osquery` agent must be configured to use the `tls` config plugin and pointed to the correct endpoint. If you are using Fleetd to enroll your hosts, this is done automatically.
|
||||
|
||||
```
|
||||
```go
|
||||
"--config_plugin=tls",
|
||||
"--config_tls_endpoint=" + path.Join(prefix, "/api/v1/osquery/config")
|
||||
```
|
||||
|
||||
@@ -146,7 +146,7 @@ To do this with `fleetctl` (assuming the existing secret is `oldsecret` and the
|
||||
|
||||
Begin by retrieving the existing secret configuration:
|
||||
|
||||
```
|
||||
```sh
|
||||
$ fleetctl get enroll_secret
|
||||
---
|
||||
apiVersion: v1
|
||||
@@ -159,7 +159,7 @@ spec:
|
||||
|
||||
Apply the new configuration with both secrets:
|
||||
|
||||
```
|
||||
```sh
|
||||
$ echo '
|
||||
---
|
||||
apiVersion: v1
|
||||
@@ -176,7 +176,7 @@ $ fleetctl apply -f secrets.yml
|
||||
Now transition clients to using only the new secret. When the transition is completed, remove the
|
||||
old secret:
|
||||
|
||||
```
|
||||
```sh
|
||||
$ echo '
|
||||
---
|
||||
apiVersion: v1
|
||||
@@ -269,7 +269,7 @@ The `secrets` section provides the list of enroll secrets that will be valid for
|
||||
- Optional setting (array of dictionaries)
|
||||
- Default value: none (empty)
|
||||
- Config file format:
|
||||
```
|
||||
```yaml
|
||||
team:
|
||||
name: Client Platform Engineering
|
||||
secrets:
|
||||
@@ -283,18 +283,18 @@ You can modify an existing team by applying a new team configuration file with t
|
||||
|
||||
Retrieve the team configuration and output to a YAML file:
|
||||
|
||||
```console
|
||||
```sh
|
||||
% fleetctl get teams --name Workstations --yaml > workstation_config.yml
|
||||
```
|
||||
After updating the generated YAML, apply the changes:
|
||||
|
||||
```console
|
||||
```sh
|
||||
% fleetctl apply -f workstation_config.yml
|
||||
```
|
||||
|
||||
Depending on your Fleet version, you may see `unsupported key` errors for the following keys when applying the new team configuration:
|
||||
|
||||
```
|
||||
```text
|
||||
id
|
||||
user_count
|
||||
host_count
|
||||
@@ -645,7 +645,7 @@ in a public channel or a GitHub issue.
|
||||
- Optional setting (array of integers)
|
||||
- Default value: empty
|
||||
- Config file format:
|
||||
```
|
||||
```yaml
|
||||
server_settings:
|
||||
debug_host_ids:
|
||||
- 342
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user