Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Markdown syntax: avoid a table here because it cannot handle pipes in cells #495

Merged
merged 2 commits into from
Aug 25, 2021
Merged
Changes from all commits
Commits
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
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