Skip to content
Snippets Groups Projects
Commit a4978169 authored by Michael Hanselmann's avatar Michael Hanselmann
Browse files

Use Sphinx' :rfc: extension to refer to RFCs


Signed-off-by: default avatarMichael Hanselmann <hansmi@google.com>
Reviewed-by: default avatarIustin Pop <iustin@google.com>
parent 981e0168
No related branches found
No related tags found
No related merge requests found
...@@ -88,7 +88,7 @@ Version 2.2.0 beta 0 ...@@ -88,7 +88,7 @@ Version 2.2.0 beta 0
- Added per-request RPC timeout - Added per-request RPC timeout
- RAPI now requires a Content-Type header for requests with a body (e.g. - RAPI now requires a Content-Type header for requests with a body (e.g.
``PUT`` or ``POST``) which must be set to ``application/json`` (see ``PUT`` or ``POST``) which must be set to ``application/json`` (see
RFC2616 (HTTP/1.1), section 7.2.1) :rfc:`2616` (HTTP/1.1), section 7.2.1)
- ``ganeti-watcher`` attempts to restart ``ganeti-rapi`` if RAPI is not - ``ganeti-watcher`` attempts to restart ``ganeti-rapi`` if RAPI is not
reachable reachable
- Implemented initial support for running Ganeti daemons as separate - Implemented initial support for running Ganeti daemons as separate
......
...@@ -411,7 +411,7 @@ between clusters before instances can be moved. If the third party does ...@@ -411,7 +411,7 @@ between clusters before instances can be moved. If the third party does
not know the secret, it can't forge the certificates or redirect the not know the secret, it can't forge the certificates or redirect the
data. Unless disabled by a new cluster parameter, verifying the HMAC data. Unless disabled by a new cluster parameter, verifying the HMAC
signatures must be mandatory. The HMAC signature for X509 certificates signatures must be mandatory. The HMAC signature for X509 certificates
will be prepended to the certificate similar to an RFC822 header and will be prepended to the certificate similar to an :rfc:`822` header and
only covers the certificate (from ``-----BEGIN CERTIFICATE-----`` to only covers the certificate (from ``-----BEGIN CERTIFICATE-----`` to
``-----END CERTIFICATE-----``). The header name will be ``-----END CERTIFICATE-----``). The header name will be
``X-Ganeti-Signature`` and its value will have the format ``X-Ganeti-Signature`` and its value will have the format
......
...@@ -53,7 +53,7 @@ Example:: ...@@ -53,7 +53,7 @@ Example::
.. [#pwhash] Using the MD5 hash of username, realm and password is .. [#pwhash] Using the MD5 hash of username, realm and password is
described in RFC2617_ ("HTTP Authentication"), sections 3.2.2.2 and described in :rfc:`2617` ("HTTP Authentication"), sections 3.2.2.2 and
3.3. The reason for using it over another algorithm is forward 3.3. The reason for using it over another algorithm is forward
compatibility. If ``ganeti-rapi`` were to implement HTTP Digest compatibility. If ``ganeti-rapi`` were to implement HTTP Digest
authentication in the future, the same hash could be used. authentication in the future, the same hash could be used.
...@@ -65,11 +65,10 @@ Protocol ...@@ -65,11 +65,10 @@ Protocol
-------- --------
The protocol used is JSON_ over HTTP designed after the REST_ principle. The protocol used is JSON_ over HTTP designed after the REST_ principle.
HTTP Basic authentication as per RFC2617_ is supported. HTTP Basic authentication as per :rfc:`2617` is supported.
.. _JSON: http://www.json.org/ .. _JSON: http://www.json.org/
.. _REST: http://en.wikipedia.org/wiki/Representational_State_Transfer .. _REST: http://en.wikipedia.org/wiki/Representational_State_Transfer
.. _RFC2617: http://tools.ietf.org/rfc/rfc2617.txt
A note on JSON as used by RAPI A note on JSON as used by RAPI
...@@ -108,9 +107,9 @@ problems. ...@@ -108,9 +107,9 @@ problems.
PUT or POST? PUT or POST?
------------ ------------
According to RFC2616 the main difference between PUT and POST is that According to :rfc:`2616` the main difference between PUT and POST is
POST can create new resources but PUT can only create the resource the that POST can create new resources but PUT can only create the resource
URI was pointing to on the PUT request. the URI was pointing to on the PUT request.
Unfortunately, due to historic reasons, the Ganeti RAPI library is not Unfortunately, due to historic reasons, the Ganeti RAPI library is not
consistent with this usage, so just use the methods as documented below consistent with this usage, so just use the methods as documented below
......
...@@ -93,7 +93,7 @@ Remote API ...@@ -93,7 +93,7 @@ Remote API
---------- ----------
Starting with Ganeti 2.0, Remote API traffic is encrypted using SSL/TLS Starting with Ganeti 2.0, Remote API traffic is encrypted using SSL/TLS
by default. It supports Basic authentication as per RFC2617. by default. It supports Basic authentication as per :rfc:`2617`.
Paths for certificate, private key and CA files required for SSL/TLS Paths for certificate, private key and CA files required for SSL/TLS
will be set at source configure time. Symlinks or command line will be set at source configure time. Symlinks or command line
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment