walkero
/
nghttp2
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

Update man pages

This commit is contained in:
Tatsuhiro Tsujikawa 2016-06-09 23:36:30 +09:00
parent 38f4f50e93
commit 11e66510e4
5 changed files with 90 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/h2load.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "H2LOAD" "1" "June 04, 2016" "1.12.0-DEV" "nghttp2" .TH "H2LOAD" "1" "June 09, 2016" "1.12.0-DEV" "nghttp2"
.SH NAME .SH NAME
h2load \- HTTP/2 benchmarking tool h2load \- HTTP/2 benchmarking tool
. .

2
doc/nghttp.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "NGHTTP" "1" "June 04, 2016" "1.12.0-DEV" "nghttp2" .TH "NGHTTP" "1" "June 09, 2016" "1.12.0-DEV" "nghttp2"
.SH NAME .SH NAME
nghttp \- HTTP/2 client nghttp \- HTTP/2 client
. .

2
doc/nghttpd.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "NGHTTPD" "1" "June 04, 2016" "1.12.0-DEV" "nghttp2" .TH "NGHTTPD" "1" "June 09, 2016" "1.12.0-DEV" "nghttp2"
.SH NAME .SH NAME
nghttpd \- HTTP/2 server nghttpd \- HTTP/2 server
. .

53
doc/nghttpx.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "NGHTTPX" "1" "June 04, 2016" "1.12.0-DEV" "nghttp2" .TH "NGHTTPX" "1" "June 09, 2016" "1.12.0-DEV" "nghttp2"
.SH NAME .SH NAME
nghttpx \- HTTP/2 proxy nghttpx \- HTTP/2 proxy
. .
@ -120,12 +120,13 @@ together forming load balancing group.
Several parameters <PARAM> are accepted after <PATTERN>. Several parameters <PARAM> are accepted after <PATTERN>.
The parameters are delimited by ";". The available The parameters are delimited by ";". The available
parameters are: "proto=<PROTO>", "tls", parameters are: "proto=<PROTO>", "tls",
"sni=<SNI_HOST>", "fall=<N>", and "rise=<N>". The "sni=<SNI_HOST>", "fall=<N>", "rise=<N>", and
parameter consists of keyword, and optionally followed "affinity=<METHOD>". The parameter consists of keyword,
by "=" and value. For example, the parameter "proto=h2" and optionally followed by "=" and value. For example,
consists of the keyword "proto" and value "h2". The the parameter "proto=h2" consists of the keyword "proto"
parameter "tls" consists of the keyword "tls" without and value "h2". The parameter "tls" consists of the
value. Each parameter is described as follows. keyword "tls" without value. Each parameter is
described as follows.
.sp .sp
The backend application protocol can be specified using The backend application protocol can be specified using
optional "proto" parameter, and in the form of optional "proto" parameter, and in the form of
@ -160,6 +161,20 @@ eligible for load balancing target. If <N> is 0, a
backend is permanently offline, once it goes in that backend is permanently offline, once it goes in that
state, and this is the default behaviour. state, and this is the default behaviour.
.sp .sp
The session affinity is enabled using
"affinity=<METHOD>" parameter. If "ip" is given in
<METHOD>, client IP based session affinity is enabled.
If "none" is given in <METHOD>, session affinity is
disabled, and this is the default. The session affinity
is enabled per <PATTERN>. If at least one backend has
"affinity" parameter, and its <METHOD> is not "none",
session affinity is enabled for all backend servers
sharing the same <PATTERN>. It is advised to set
"affinity" parameter to all backend explicitly if
session affinity is desired. The session affinity may
break if one of the backend gets unreachable, or backend
settings are reload or replaced by API.
.sp
Since ";" and ":" are used as delimiter, <PATTERN> must Since ";" and ":" are used as delimiter, <PATTERN> must
not contain these characters. Since ";" has special not contain these characters. Since ";" has special
meaning in shell, the option value must be quoted. meaning in shell, the option value must be quoted.
@ -1705,6 +1720,30 @@ frontend for API using \fI\%\-\-frontend\fP option with "api"
parameter. All requests which come from this frontend address, will parameter. All requests which come from this frontend address, will
be treated as API request. be treated as API request.
.sp .sp
The response is normally JSON dictionary, and at least includes the
following keys:
.INDENT 0.0
.TP
.B status
The status of the request processing. The following values are
defined:
.INDENT 7.0
.TP
.B Success
The request was successful.
.TP
.B Failure
The request was faield. No change has been made.
.UNINDENT
.TP
.B code
HTTP status code
.UNINDENT
.sp
We wrote "normally", since nghttpx may return ordinal HTML response in
some cases where the error has occurred before reaching API endpoint
(e.g., header field is too large).
.sp
The following section describes available API endpoints. The following section describes available API endpoints.
.SS PUT /api/v1beta1/backend/replace .SS PUT /api/v1beta1/backend/replace
.sp .sp

47
doc/nghttpx.1.rst
View File

@ -104,12 +104,13 @@ Connections
Several parameters <PARAM> are accepted after <PATTERN>. Several parameters <PARAM> are accepted after <PATTERN>.
The parameters are delimited by ";". The available The parameters are delimited by ";". The available
parameters are: "proto=<PROTO>", "tls", parameters are: "proto=<PROTO>", "tls",
"sni=<SNI_HOST>", "fall=<N>", and "rise=<N>". The "sni=<SNI_HOST>", "fall=<N>", "rise=<N>", and
parameter consists of keyword, and optionally followed "affinity=<METHOD>". The parameter consists of keyword,
by "=" and value. For example, the parameter "proto=h2" and optionally followed by "=" and value. For example,
consists of the keyword "proto" and value "h2". The the parameter "proto=h2" consists of the keyword "proto"
parameter "tls" consists of the keyword "tls" without and value "h2". The parameter "tls" consists of the
value. Each parameter is described as follows. keyword "tls" without value. Each parameter is
described as follows.
The backend application protocol can be specified using The backend application protocol can be specified using
optional "proto" parameter, and in the form of optional "proto" parameter, and in the form of
@ -144,6 +145,20 @@ Connections
backend is permanently offline, once it goes in that backend is permanently offline, once it goes in that
state, and this is the default behaviour. state, and this is the default behaviour.
The session affinity is enabled using
"affinity=<METHOD>" parameter. If "ip" is given in
<METHOD>, client IP based session affinity is enabled.
If "none" is given in <METHOD>, session affinity is
disabled, and this is the default. The session affinity
is enabled per <PATTERN>. If at least one backend has
"affinity" parameter, and its <METHOD> is not "none",
session affinity is enabled for all backend servers
sharing the same <PATTERN>. It is advised to set
"affinity" parameter to all backend explicitly if
session affinity is desired. The session affinity may
break if one of the backend gets unreachable, or backend
settings are reload or replaced by API.
Since ";" and ":" are used as delimiter, <PATTERN> must Since ";" and ":" are used as delimiter, <PATTERN> must
not contain these characters. Since ";" has special not contain these characters. Since ";" has special
meaning in shell, the option value must be quoted. meaning in shell, the option value must be quoted.
@ -1548,6 +1563,26 @@ frontend for API using :option:`--frontend` option with "api"
parameter. All requests which come from this frontend address, will parameter. All requests which come from this frontend address, will
be treated as API request. be treated as API request.
The response is normally JSON dictionary, and at least includes the
following keys:
status
The status of the request processing. The following values are
defined:
Success
The request was successful.
Failure
The request was faield. No change has been made.
code
HTTP status code
We wrote "normally", since nghttpx may return ordinal HTML response in
some cases where the error has occurred before reaching API endpoint
(e.g., header field is too large).
The following section describes available API endpoints. The following section describes available API endpoints.
PUT /api/v1beta1/backend/replace PUT /api/v1beta1/backend/replace