[flink-statefun] 02/02: [FLINK-18016] [doc] Add documentation for UDS domain socket transport

[tz...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

tzulitai pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink-statefun.git

commit 8376afa6b064bfa2374eefbda5e149cd490985c0
Author: Tzu-Li (Gordon) Tai <tz...@apache.org>
AuthorDate: Mon Jun 1 16:14:50 2020 +0800

    [FLINK-18016] [doc] Add documentation for UDS domain socket transport
    
    This closes #124.
---
 docs/sdk/modules.md | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/docs/sdk/modules.md b/docs/sdk/modules.md
index c2ad041..5a33482 100644
--- a/docs/sdk/modules.md
+++ b/docs/sdk/modules.md
@@ -93,6 +93,9 @@ A ``function`` is described via a number of properties.
     * The function type, defined as ``<namespace>/<name>``.
 * ``function.spec.endpoint``
     * The endpoint at which the function is reachable.
+    * Supported schemes are: ``http``, ``https``.
+    * Transport via UNIX domain sockets is supported by using the schemes ``http+unix`` or ``https+unix``.
+    * When using UNIX domain sockets, the endpoint format is: ``http+unix://<socket-file-path>/<serve-url-path>``. For example, ``http+unix:///uds.sock/path/of/url``.
 * ``function.spec.states``
     * A list of the persisted values declared within the remote function.
     * Each entry consists of a `name` property and an optional `expireAfter` property.