Merge branch 'evilham-authorized_keys-man' into 'master'

[__ssh_authorizedkey{,s}] Improve documentation.

See merge request ungleich-public/cdist!877
This commit is contained in:
poljakowski 2020-05-18 19:49:50 +02:00
commit 8d639d54d0
2 changed files with 25 additions and 20 deletions

View file

@ -15,25 +15,27 @@ This type was created to be used by the __ssh_authorized_keys type.
REQUIRED PARAMETERS REQUIRED PARAMETERS
------------------- -------------------
file file
the authorized_keys file to which the given key should be added The authorized_keys file where the given key should be managed.
key key
a string containing the ssh keytype, base 64 encoded key and optional The ssh key which shall be managed in this authorized_keys file.
trailing comment which shall be added to the given authorized_keys file. Must be a string containing the ssh keytype, base 64 encoded key and
optional trailing comment which shall be added to the given
authorized_keys file.
OPTIONAL PARAMETERS OPTIONAL PARAMETERS
------------------- -------------------
comment comment
explicit comment instead of the one which may be trailing the given key Use this comment instead of the one which may be trailing in the key.
option option
an option to set for this authorized_key entry. An option to set for this authorized_key entry.
Can be specified multiple times. Can be specified multiple times.
See sshd(8) for available options. See sshd(8) for available options.
state state
if the given keys should be 'present' or 'absent', defaults to 'present'. If the managed key should be 'present' or 'absent', defaults to 'present'.
MESSAGES MESSAGES
@ -64,7 +66,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
:strong:`cdist__ssh_authorized_keys`\ (7), :strong:`sshd`\ (8) :strong:`cdist-type__ssh_authorized_keys`\ (7), :strong:`sshd`\ (8)
AUTHORS AUTHORS

View file

@ -20,42 +20,45 @@ then left to the user to ensure that the file exists and that ownership and
permissions work with ssh. permissions work with ssh.
REQUIRED PARAMETERS REQUIRED MULTIPLE PARAMETERS
------------------- ----------------------------
key key
the ssh key which shall be added to this authorized_keys file. An ssh key which shall be managed in this authorized_keys file.
Must be a string and can be specified multiple times. Must be a string containing the ssh keytype, base 64 encoded key and
optional trailing comment which shall be added to the given
authorized_keys file.
Can be specified multiple times.
OPTIONAL PARAMETERS OPTIONAL PARAMETERS
------------------- -------------------
comment comment
explicit comment instead of the one which may be trailing the given key Use this comment instead of the one which may be trailing in each key.
file file
an alternative destination file, defaults to ~$owner/.ssh/authorized_keys An alternative destination file, defaults to ~$owner/.ssh/authorized_keys.
option option
an option to set for all created authorized_key entries. An option to set for all authorized_key entries in the key parameter.
Can be specified multiple times. Can be specified multiple times.
See sshd(8) for available options. See sshd(8) for available options.
owner owner
the user owning the authorized_keys file, defaults to object_id. The user owning the authorized_keys file, defaults to object_id.
state state
if the given keys should be 'present' or 'absent', defaults to 'present'. If the given keys should be 'present' or 'absent', defaults to 'present'.
BOOLEAN PARAMETERS BOOLEAN PARAMETERS
------------------ ------------------
noparent noparent
don't create or change ownership and permissions of the directory containing Don't create or change ownership and permissions of the directory containing
the authorized_keys file the authorized_keys file.
nofile nofile
don't manage existence, ownership and permissions of the the authorized_keys Don't manage existence, ownership and permissions of the the authorized_keys
file file.
EXAMPLES EXAMPLES