Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(docs) Add puppet strings documentation for types #420

Merged
merged 1 commit into from
Nov 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions types/key/type.pp
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# @summary validate SSH key types
#
# From https://github.com/puppetlabs/puppetlabs-sshkeys_core/blob/master/lib/puppet/type/sshkey.rb v1.0.2
#
type Ssh::Key::Type = Enum[
'ssh-dss',
'ssh-ed25519',
Expand Down
2 changes: 2 additions & 0 deletions types/log_level.pp
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# @summary validate SSH log levels
#
type Ssh::Log_level = Enum[
'QUIET',
'FATAL',
Expand Down
3 changes: 3 additions & 0 deletions types/permit_root_login.pp
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# @summary validate configuration options for permit_root_login
#
# 'without-password' is a deprecated alias for 'prohibit-password'
#
type Ssh::Permit_root_login = Enum[
'yes',
'prohibit-password',
Expand Down
3 changes: 2 additions & 1 deletion types/ssh_config.pp
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# ssh_config configuration file parameters
# @summary ssh_config configuration file parameters
#
type Ssh::Ssh_Config = Struct[
{
Optional['Host'] => Stdlib::Host,
Expand Down
3 changes: 2 additions & 1 deletion types/sshd_config.pp
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# sshd_config configuration file parameters
# @summary sshd_config configuration file parameters
#
type Ssh::Sshd_Config = Struct[
{
Optional['AcceptEnv'] => String[1],
Expand Down
2 changes: 2 additions & 0 deletions types/syslog_facility.pp
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# @summary validate syslog facilities used by SSH
#
type Ssh::Syslog_facility = Enum[
'DAEMON',
'USER',
Expand Down
2 changes: 2 additions & 0 deletions types/yes_no.pp
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# @summary validate SSH configuration that uses yes/no.
#
type Ssh::Yes_no = Enum['yes', 'no']