docs: Add info about variable item key name restrictions (#15966)

While you can use any string value for a variable Item's key name
using characters that are outside of the set [unicode.Letter,
unicode.Number,`_`] will require the `index` function for direct
access.
This commit is contained in:
Charlie Voiselle 2023-01-30 15:10:15 -05:00 committed by GitHub
parent d94f22bee2
commit cd4043abb2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 0 deletions

View File

@ -44,6 +44,13 @@ includes alphanumeric characters and the special characters `-`, `_`, `~`, and
`/`. Paths may be up to 128 bytes long. The following regex matches the allowed
paths: `^[a-zA-Z0-9-_~/]{1,128}$`
The keys for the items in a variable may contain any character, but keys
containing characters outside the set of Unicode letters, Unicode digits, and
the underscore (`_`) can not be read directly using dotted references in Nomad's
template engine. Instead, they require the use of the `index` template function
to directly access their values. This does not impact cases where the keys and
values are read using the `range` function.
Variable items are restricted to 16KiB in size. This limit is calculated by
taking the sum of the length in bytes of all of the unencrypted keys and values.