rudimentary lexicon

sozu-proxy · Aug 9, 2022 · 8860c94 · 8860c94
1 parent 4ccd277
commit 8860c94
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/bin/README.md b/bin/README.md
@@ -6,7 +6,7 @@ receives configuration commands through anonymous unix sockets.
 
 This executable requires a configuration file in the TOML format, that describes
 the worker types and numbers, along with global information. This file can
-describe the clusters handled by the proxy, but it is more recommended to
+describe clusters handled by the proxy, but it is more recommended to
 use the command unix socket, through which the proxy listens for orders or
 configuration changes. The path of that unix socket is set in the configuration
 file.

diff --git a/doc/lexicon.md b/doc/lexicon.md
@@ -0,0 +1,13 @@
+# Lexicon
+
+What terms are used in Sōzu.
+
+## User-facing
+
+*backend*: a socket address towards which Sōzu will redirect traffic.
+
+*cluster*: a set of frontends, routing rules, and backends.
+
+*frontend*: a socket address on which a cluster receives connections. Should be defined with a matching listener.
+
+*listener*: a socket address on which Sōzu will accept incoming connections.