Skip to content

Commit

Permalink
Markdown syntax: avoid a table here because it cannot handle pipes in…
Browse files Browse the repository at this point in the history
… cells (#495)
  • Loading branch information
trentm committed Oct 6, 2021
1 parent 4fbe75e commit 6fde01b
Showing 1 changed file with 10 additions and 14 deletions.
24 changes: 10 additions & 14 deletions specs/agents/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,20 +33,16 @@ emit a log warning about the ignored value.

### Configuration Value Types

The following table enumerates the available configuration types across the
agents:


| Type | Description (if needed) |
|------|-------------------------|
| String | |
| Integer | |
| Float | |
| Boolean | Encoded as a lower-case boolean string: `"false"`, `"true"` |
| List | Encoded as a comma-separated string (whitespace surrounding items should be stripped): `"foo,bar,baz"` |
| Mapping | Encoded as a string, with `"key=value"` pairs separated by commas (whitespace surrounding items should be stripped): `"foo=bar,baz=foo"` |
| Duration | Case-sensitive string with duration encoded using unit suffixes (`ms` for millisecond, `s` for second, `m` for minute). Validating regex: `^(-)?(\d+)(ms|s|m)$` |
| Size | Case-insensitive string with a positive size encoded using unit suffixes (`b` for bytes, `kb` for kilobytes, `mb` for megabytes, `gb` for gigabytes, with a 1024 multiplier between each unit). Validating regex: `^(\d+)(b|kb|mb|gb)$` |
The following list enumerates the available configuration types across the agents:

- `String`
- `Integer`
- `Float`
- `Boolean`: Encoded as a lower-case boolean string: `"false"`, `"true"`.
- `List`: Encoded as a comma-separated string (whitespace surrounding items should be stripped): `"foo,bar,baz"`.
- `Mapping`: Encoded as a string, with `"key=value"` pairs separated by commas (whitespace surrounding items should be stripped): `"foo=bar,baz=foo"`.
- `Duration`: Case-sensitive string with duration encoded using unit suffixes (`ms` for millisecond, `s` for second, `m` for minute). Validating regex: `^(-)?(\d+)(ms|s|m)$`.
- `Size`: Case-insensitive string with a positive size encoded using unit suffixes (`b` for bytes, `kb` for kilobytes, `mb` for megabytes, `gb` for gigabytes, with a 1024 multiplier between each unit). Validating regex: `^(\d+)(b|kb|mb|gb)$`.

#### Duration/Size Config Legacy Considerations

Expand Down

0 comments on commit 6fde01b

Please sign in to comment.