yamllint, REFERENCE.md

REFERENCE.md

@@ -7,8 +7,9 @@
 ### Classes
 
 * [`profile_user_environment`](#profile_user_environment): Configure various environment settings for users
-* [`profile_user_environment::history`](#profile_user_environmenthistory): Configure default history environment for all users
-* [`profile_user_environment::timeout`](#profile_user_environmenttimeout): Configure session timeouts for all users
+* [`profile_user_environment::history`](#profile_user_environment--history): Configure default history environment for all users
+* [`profile_user_environment::quota`](#profile_user_environment--quota): Install login scripts to run user quota commands.
+* [`profile_user_environment::timeout`](#profile_user_environment--timeout): Configure session timeouts for all users
 
 ## Classes
 
@@ -24,7 +25,7 @@ Configure various environment settings for users
 include profile_user_environment
 ```
 
-### <a name="profile_user_environmenthistory"></a>`profile_user_environment::history`
+### <a name="profile_user_environment--history"></a>`profile_user_environment::history`
 
 Configure default history environment for all users
 
@@ -40,23 +41,74 @@ include profile_user_environment::history
 
 The following parameters are available in the `profile_user_environment::history` class:
 
-* [`filename`](#filename)
-* [`size`](#size)
+* [`filename`](#-profile_user_environment--history--filename)
+* [`size`](#-profile_user_environment--history--size)
 
-##### <a name="filename"></a>`filename`
+##### <a name="-profile_user_environment--history--filename"></a>`filename`
 
 Data type: `String`
 
 Name of history file.
 This string will be prepended by either '.bash_' or '.csh_' for the actual file.
 
-##### <a name="size"></a>`size`
+##### <a name="-profile_user_environment--history--size"></a>`size`
 
 Data type: `Integer`
 
 Number of history records to keep in history file.
 
-### <a name="profile_user_environmenttimeout"></a>`profile_user_environment::timeout`
+### <a name="profile_user_environment--quota"></a>`profile_user_environment::quota`
+
+Install login scripts to run user quota commands.
+
+#### Examples
+
+##### 
+
+```puppet
+include profile_user_environment::quota
+```
+
+#### Parameters
+
+The following parameters are available in the `profile_user_environment::quota` class:
+
+* [`command_paths`](#-profile_user_environment--quota--command_paths)
+* [`file_prefix`](#-profile_user_environment--quota--file_prefix)
+* [`skip_users`](#-profile_user_environment--quota--skip_users)
+* [`timeout_interval`](#-profile_user_environment--quota--timeout_interval)
+
+##### <a name="-profile_user_environment--quota--command_paths"></a>`command_paths`
+
+Data type: `Array`
+
+Paths to commands/scripts to run to display user
+quota information. Leave empty to NOT run any
+quota commands at login.
+
+##### <a name="-profile_user_environment--quota--file_prefix"></a>`file_prefix`
+
+Data type: `String`
+
+Run-script files will be added for various shells in /etc/profile.d/
+to wrap the quota scripts. This parameter specifies the prefix for
+these run-scripts. Will be applied as ${file_prefix}_quota.[extension].
+
+##### <a name="-profile_user_environment--quota--skip_users"></a>`skip_users`
+
+Data type: `Array`
+
+When these users log in quota commands will NOT be run.
+
+##### <a name="-profile_user_environment--quota--timeout_interval"></a>`timeout_interval`
+
+Data type: `Integer`
+
+Quota commands are wrapped in 'timeout' and will be aborted after
+this number of seconds. Can be useful to prevent long "hangs" at
+login if there are filesystem problems.
+
+### <a name="profile_user_environment--timeout"></a>`profile_user_environment::timeout`
 
 Configure session timeouts for all users
 
@@ -72,17 +124,17 @@ include profile_user_environment::timeout
 
 The following parameters are available in the `profile_user_environment::timeout` class:
 
-* [`limit_ssh_hours`](#limit_ssh_hours)
-* [`session_minutes`](#session_minutes)
+* [`limit_ssh_hours`](#-profile_user_environment--timeout--limit_ssh_hours)
+* [`session_minutes`](#-profile_user_environment--timeout--session_minutes)
 
-##### <a name="limit_ssh_hours"></a>`limit_ssh_hours`
+##### <a name="-profile_user_environment--timeout--limit_ssh_hours"></a>`limit_ssh_hours`
 
 Data type: `Integer`
 
 Number of elapsed hours to limit a ssh session.
 A value of <= 0 results in NO limit.
 
-##### <a name="session_minutes"></a>`session_minutes`
+##### <a name="-profile_user_environment--timeout--session_minutes"></a>`session_minutes`
 
 Data type: `Integer`
 

data/common.yaml

@@ -1,7 +1,7 @@
 ---
 lookup_options:
-  profile_user_environment::quota::command_paths
-    merge: 
+  profile_user_environment::quota::command_paths:
+    merge:
       strategy: "unique"
   profile_user_environment::quota::skip_users:
     merge:

manifests/quota.pp

@@ -2,6 +2,24 @@
 #
 # Install login scripts to run user quota commands.
 #
+# @param command_paths
+#   Paths to commands/scripts to run to display user
+#   quota information. Leave empty to NOT run any
+#   quota commands at login.
+#
+# @param file_prefix
+#   Run-script files will be added for various shells in /etc/profile.d/
+#   to wrap the quota scripts. This parameter specifies the prefix for
+#   these run-scripts. Will be applied as ${file_prefix}_quota.[extension].
+#
+# @param skip_users
+#   When these users log in quota commands will NOT be run.
+#
+# @param timeout_interval
+#   Quota commands are wrapped in 'timeout' and will be aborted after
+#   this number of seconds. Can be useful to prevent long "hangs" at
+#   login if there are filesystem problems.
+#
 # @example
 #   include profile_user_environment::quota
 class profile_user_environment::quota (