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

Regenerate REFERENCE.md #306

Merged
merged 1 commit into from
Oct 19, 2019
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
14 changes: 7 additions & 7 deletions REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ _Public Classes_
_Private Classes_

* `selinux::build`: Configure the system for module building
* `selinux::config`: Configure the system to use SELinux on the system. It is included in the main class ::selinux
* `selinux::config`: Configure the system to use SELinux on the system.
* `selinux::package`: Manages additional packages required to support some of the functions.
* `selinux::params`: This class provides default parameters for the selinux class
* `selinux::refpolicy_package`: Manages additional packages required to support some of the functions.
Expand Down Expand Up @@ -94,7 +94,7 @@ Data type: `String`
sets the name for the selinux tools package
Default value: OS dependent (see params.pp)

Default value: $::selinux::params::package_name
Default value: $selinux::params::package_name

##### `refpolicy_package_name`

Expand All @@ -112,7 +112,7 @@ Data type: `Stdlib::Absolutepath`

directory where modules are built. Defaults to `$vardir/puppet-selinux`

Default value: $::selinux::params::module_build_root
Default value: $selinux::params::module_build_root

##### `default_builder`

Expand Down Expand Up @@ -182,15 +182,15 @@ Manage the state of an SELinux boolean.

```puppet
selinux::boolean{ 'named_write_master_zones':
ensure => 'on',
ensure => 'on',
}
```

##### Ensure `named_write_master_zones` boolean is disabled

```puppet
selinux::boolean{ 'named_write_master_zones':
ensure => 'off',
ensure => 'off',
}
```

Expand Down Expand Up @@ -284,8 +284,8 @@ selinux::fcontext::equivalence

```puppet
selinux::fcontext{'set-mysql-log-context':
seltype => "mysqld_log_t",
pathspec => "/u01/log/mysql(/.*)?",
seltype => 'mysqld_log_t',
pathspec => '/u01/log/mysql(/.*)?',
}
```

Expand Down
6 changes: 3 additions & 3 deletions manifests/boolean.pp
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Manage the state of an SELinux boolean.
# @summary Manage the state of an SELinux boolean.
#
# @example Enable `named_write_master_zones` boolean
# selinux::boolean{ 'named_write_master_zones':
# ensure => 'on',
# ensure => 'on',
# }
#
# @example Ensure `named_write_master_zones` boolean is disabled
# selinux::boolean{ 'named_write_master_zones':
# ensure => 'off',
# ensure => 'off',
# }
#
# @param ensure Set to on or off
Expand Down
4 changes: 2 additions & 2 deletions manifests/config.pp
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Configure the system to use SELinux on the system.
# @summary Configure the system to use SELinux on the system.
#
# It is included in the main class ::selinux
# It is included in the main class `selinux`
#
# @param mode See main class
# @param type See main class
Expand Down
2 changes: 1 addition & 1 deletion manifests/fcontext.pp
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
#
# @example Add a file-context for mysql log files at non standard location
# selinux::fcontext{'set-mysql-log-context':
# seltype => 'mysqld_log_t',
# seltype => 'mysqld_log_t',
# pathspec => '/u01/log/mysql(/.*)?',
# }
#
Expand Down
2 changes: 1 addition & 1 deletion manifests/fcontext/equivalence.pp
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Manage SELinux fcontext equivalences
# @summary Manage SELinux fcontext equivalences
#
# @param path the path to define and equivalence for. Default: Resource title
# @param target the path that this resource will be equivalent to.
Expand Down
2 changes: 1 addition & 1 deletion manifests/package.pp
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Manages additional packages required to support some of the functions.
# @summary Manages additional packages required to support some of the functions.
#
# @api private
#
Expand Down