From d34a6aefac29ac6211311e1e592d9bf643f53320 Mon Sep 17 00:00:00 2001 From: Trent Mick Date: Tue, 24 Aug 2021 09:41:13 -0700 Subject: [PATCH] Markdown syntax: avoid a table here because it cannot handle pipes in cells --- specs/agents/configuration.md | 24 ++++++++++-------------- 1 file changed, 10 insertions(+), 14 deletions(-) diff --git a/specs/agents/configuration.md b/specs/agents/configuration.md index 8c722cf6..d3852aa0 100644 --- a/specs/agents/configuration.md +++ b/specs/agents/configuration.md @@ -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