taigrr/nats.docs
1
0
Fork 0
mirror of https://github.com/taigrr/nats.docs synced 2025-01-18 04:03:23 -08:00
Code Issues Projects Releases Wiki Activity

Add section on naming streams, consumers, and accounts

Browse Source 
Signed-off-by: Colin Sullivan <colin@synadia.com>
This commit is contained in:
Colin Sullivan
2021-05-13 14:40:42 -06:00
parent 453c58e474
commit 30514de274
4 changed files with 22 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
jetstream/administration/naming.md Normal file
View File

@@ -0,0 +1,19 @@
# Stream, Consumer, and Account Names
Stream, Consumer (durable name), and Account names are used in both the
subject namespace used by JetStream and the filesystem backing JetStream
persistence. This means that when naming streams, consumers, and
accounts, names must adhere to subject naming rules as well as being
friendly to the file system.
We recommend the following guideline for stream, consumer, and account names:
* Alphanumeric values are recommended.
* Spaces, tabs, period \(`.`\), greater than \(`>`\) or asterix \(`*`\) are prohibited.
* Limit names to 255 characters or less.
* Do not use reserved file names like NUL, LPT1, etc.
* Be aware that some file systems are case insentitive so do not
use stream or account names that would collide in a file system.
For example, `Foo` and `foo` would collide on a Windows or Mac OSx System.
We plan to address these limitations in a future release.