mravi/cdist
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Merge pull request #719 from tom-ee/docs-patches

Browse source 
Docs patches
This commit is contained in:
Darko Poljak 2018-11-02 15:24:37 +01:00 committed by GitHub
commit 14b1952edf
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
docs/src/cdist-best-practice.rst
View file

@ -13,15 +13,18 @@ See sshd_config(5) and ssh-keygen(1).
Speeding up ssh connections Speeding up ssh connections
--------------------------- ---------------------------
When connecting to a new host, the initial delay with ssh connections When connecting to a new host, the initial delay with ssh connections
is pretty big. You can work around this by is pretty big. As cdist makes many connections to each host successive
"sharing of multiple sessions over a single network connection" connections can be sped up by "sharing of multiple sessions over a single
(quote from ssh_config(5)). The following code is suitable for network connection" (quote from ssh_config(5)). This is also called "connection
inclusion into your ~/.ssh/config:: multiplexing".
Host * Cdist implements this since v4.0.0 by executing ssh with the appropriate
ControlPath ~/.ssh/master-%l-%r@%h:%p options (`-o ControlMaster=auto -o ControlPath=/tmp/<tmpdir>/s -o
ControlMaster auto ControlPersist=2h`).
ControlPersist 10
Note that the sshd_config on the server can configure the maximum number of
parallel multiplexed connections this with `MaxSessions N` (N defaults to 10
for OpenSSH v7.4).
Speeding up shell execution Speeding up shell execution

5
docs/src/cdist-hacker.rst
View file

@ -59,10 +59,9 @@ How to submit a new type
For detailed information about types, see `cdist type <cdist-type.html>`_. For detailed information about types, see `cdist type <cdist-type.html>`_.
Submitting a type works as described above, with the additional requirement Submitting a type works as described above, with the additional requirement
that a corresponding manpage named man.text in asciidoc format with that a corresponding manpage named man.rst in ReSTructured text format with
the manpage-name "cdist-type__NAME" is included in the type directory the manpage-name "cdist-type__NAME" is included in the type directory
AND asciidoc is able to compile it (i.e. do NOT have to many "=" in the second AND the manpage builds (`make man`).
line).
Warning: Submitting "exec" or "run" types that simply echo their parameter in Warning: Submitting "exec" or "run" types that simply echo their parameter in
**gencode** will not be accepted, because they are of no use. Every type can output **gencode** will not be accepted, because they are of no use. Every type can output