vrr/g3
2
0
Fork 0
mirror of https://github.com/bytedance/g3.git synced 2026-05-05 15:31:21 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

g3proxy: update sphinx doc

Browse source
This commit is contained in:
Zhang Jingqiang 2024-04-08 10:58:36 +08:00
parent 5274cc5fa1
commit 8e94c99541
6 changed files with 61 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

2
g3proxy/doc/configuration/auditors/index.rst
View file

@ -9,7 +9,7 @@ The type for each auditor config is *map*, the keys are as follows:
name
----
**required**, **type**: str
**required**, **type**: :ref:`metrics name <conf_value_metrics_name>`
Set the auditor name, which will can be referenced in :ref:`server config <conf_server_common_auditor>`.

22
g3proxy/doc/configuration/escapers/index.rst
View file

@ -6,8 +6,8 @@ Escaper
The type for each escaper config is *map*, with two always required keys:
* *name*, which specify the name of the escaper.
* *type*, which specify the real type of the escaper, decides how to parse other keys.
* :ref:`name <conf_escaper_common_name>`, which specify the name of the escaper.
* :ref:`type <conf_escaper_common_type>`, which specify the real type of the escaper, decides how to parse other keys.
There are many types of escaper, each with a section below.
@ -39,6 +39,24 @@ Common Keys
This section describes the common keys, they may be used by many escapers.
.. _conf_escaper_common_name:
name
----
**required**, **type**: :ref:`metrics name <conf_value_metrics_name>`
Set the name of the escaper.
.. _conf_escaper_common_type:
type
----
**required**, **type**: str
Set the type of the escaper.
.. _conf_escaper_common_shared_logger:
shared_logger

22
g3proxy/doc/configuration/resolvers/index.rst
View file

@ -6,8 +6,8 @@ Resolver
The type for each resolver config is *map*, with two always required keys:
* *name*, which specify the name of the resolver.
* *type*, which specify the real type of the resolver, decides how to parse other keys.
* :ref:`name <conf_resolver_common_name>`, which specify the name of the resolver.
* :ref:`type <conf_resolver_common_type>`, which specify the real type of the resolver, decides how to parse other keys.
There are many types of resolver, each with a section below.
@ -29,6 +29,24 @@ This section describes the common keys, they may be used by many resolvers.
Most of them are the runtime (of the standalone resolver thread) config.
.. _conf_resolver_common_name:
name
----
**required**, **type**: :ref:`metrics name <conf_value_metrics_name>`
Set the name of the resolver.
.. _conf_resolver_common_type:
type
----
**required**, **type**: str
Set the type of the resolver.
graceful_stop_wait
------------------

16
g3proxy/doc/configuration/servers/index.rst
View file

@ -6,8 +6,8 @@ Server
The type for each server config is *map*, with two always required keys:
* *name*, which specify the name of the escaper.
* *type*, which specify the real type of the escaper, decides how to parse other keys.
* :ref:`name <conf_server_common_name>`, which specify the name of the server.
* :ref:`type <conf_server_common_type>`, which specify the real type of the server, decides how to parse other keys.
There are many types of server, each with a section below.
@ -36,6 +36,18 @@ Common Keys
This section describes the common keys, they may be used by many escapers.
.. _conf_server_common_name:
**required**, **type**: :ref:`metrics name <conf_value_metrics_name>`
Set the name of the server.
.. _conf_server_common_type:
**required**, **type**: str
Set the type of the server.
.. _conf_server_common_escaper:
escaper