You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by da...@apache.org on 2018/09/24 21:38:43 UTC
[trafficserver] branch master updated: Fix doc building warnings
for recent plugin docs
This is an automated email from the ASF dual-hosted git repository.
dagit pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficserver.git
The following commit(s) were added to refs/heads/master by this push:
new ca38e1c Fix doc building warnings for recent plugin docs
ca38e1c is described below
commit ca38e1cc444433d4cf6b53cf75face2ff60dc6f4
Author: dyrock <ze...@gmail.com>
AuthorDate: Mon Sep 24 21:18:59 2018 +0000
Fix doc building warnings for recent plugin docs
---
doc/admin-guide/plugins/certifier.en.rst | 39 +++++++++++++++++------------
doc/admin-guide/plugins/traffic_dump.en.rst | 4 ++-
2 files changed, 26 insertions(+), 17 deletions(-)
diff --git a/doc/admin-guide/plugins/certifier.en.rst b/doc/admin-guide/plugins/certifier.en.rst
index 90b5859..c946b88 100644
--- a/doc/admin-guide/plugins/certifier.en.rst
+++ b/doc/admin-guide/plugins/certifier.en.rst
@@ -1,7 +1,7 @@
.. _admin-plugins-certifier:
Certifier Plugin
-***************
+****************
.. Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
@@ -47,20 +47,27 @@ Setup
Plugin Configuration
====================
.. program:: certifier.so
+
* Specify certificate generation related files. If any of the following parameters is missing, the dynamic generation will be disabled.
.. option:: --sign-cert <path_to_certificate>
+
(`optional`, default:empty/unused) - specifies the path to the root CA certficate. In most cases, this would be a self-signed certificate that is configured to be trusted by all potential clients. Path should be the path and file name of the cert. If it is relative, it is relative to the Traffic Server configuration directory.
.. option:: --sign-key <path_to_key>
+
(`optional`, default:empty/unused) - specifies the path to the root CA private key. In most cases, this would be generated alongside the self-signed root CA certificate.
.. option:: --sign-serial <path_to_serial>
+
(`optional`, default:empty/unused) - specifies the path to the serial number file. This will be used to assign serial numbers to certificates and keep all generated ones in sync. Serial file should be a number with a trailing newline.
+
* Specify the certificates management related settings.
.. option:: --store <path_to_certs_dir>
+
(`required`, default:empty) - specifies the directory to use as the root of file system certificates storage.
.. option:: --max <N>
+
(`required`, default:empty) - specifies the upper limit on number of files kept in memory.
@@ -74,18 +81,18 @@ One use case would be routing incoming CONNECT request to another port on traffi
.. uml::
:align: center
- actor "User"
- participant "Traffic_Server"
- participant "Origin_Server"
- [User] -> [Traffic_Server]: CONNECT request
- [Traffic_Server] -> [Traffic_Server]: Route CONNECT\nback to self
- [User] -->> [Traffic_Server]: Client Hello
- [Traffic_Server] -->> [User]: Server Hello with fake certs from certifier
- [User] -->> [Traffic_Server]: ClientKeyExchange [ChangeCipherSpec]
- [Traffic_Server] -->> [User]: ChangeCipherSpec
- [User] <-> [Traffic_Server]: Tunnel established
- [User] -> [Traffic_Server]: User request via tunnel
- [Traffic_Server] -> [Origin_Server]: Request
- [Origin_Server] --> [Traffic_Server]: Response
- [Traffic_Server] --> [User]: TS response via tunnel
-@enduml
+
+ actor User
+ participant Traffic_Server
+ participant Origin_Server
+ User -> Traffic_Server: CONNECT request
+ Traffic_Server -> Traffic_Server: Route CONNECT\nback to self
+ User -> Traffic_Server: Client Hello
+ Traffic_Server -> User: Server Hello with fake certs from certifier
+ User -> Traffic_Server: ClientKeyExchange ChangeCipherSpec
+ Traffic_Server -> User: ChangeCipherSpec
+ User <-> Traffic_Server: Tunnel established
+ User -> Traffic_Server: User request via tunnel
+ Traffic_Server -> Origin_Server: Request
+ Origin_Server -> Traffic_Server: Response
+ Traffic_Server -> User: TS response via tunnel
diff --git a/doc/admin-guide/plugins/traffic_dump.en.rst b/doc/admin-guide/plugins/traffic_dump.en.rst
index 114edd2..be57f4b 100644
--- a/doc/admin-guide/plugins/traffic_dump.en.rst
+++ b/doc/admin-guide/plugins/traffic_dump.en.rst
@@ -18,7 +18,7 @@
.. include:: ../../common.defs
-.. _admin-plugins-access_control:
+.. _admin-plugins-traffic_dump:
Traffic Dump Plugin
@@ -35,9 +35,11 @@ Plugin Configuration
* ``Traffic Dump`` is a global plugin and is configured via :file:`plugin.config`.
.. option:: --logdir <path_to_dump>
+
(`required`, default:empty/unused) - specifies the directory for writing all dump files. If path is relative, it is relative to the Traffic Server directory. The plugin will use first three characters of client ip to create subdirs in an attempt to spread dumps evenly and avoid too many files in a single directory.
.. option:: --sample <N>
+
(`optional`, default:1000) - specifies the sampling ratio N. Traffic Dump will capture every one out of N sessions. This ratio can also be changed via traffic_ctl without restarting ATS.
* ``traffic_ctl`` command.