Update cli

manifests/cli.pp

@@ -1,4 +1,47 @@
-# @summary This class is used to manage cli resources.
+# @summary Class to manage installation and configuration of Rundeck CLI.
+#
+# @example Use cli with token and project config.
+#   class { 'rundeck::cli':
+#     manage_repo => false,
+#     url         => 'https://rundeck01.example.com',
+#     bypass_url  => 'https://rundeck.example.com',
+#     token       => 'very_secure',
+#     projects    => {
+#       'MyProject' => {
+#         'update_method' => 'set',
+#         'config' => {
+#           'project.description' => 'This is My rundeck project',
+#           'project.disable.executions' => 'false',
+#         },
+#       },
+#       'TestProject' => {
+#         'config' => {
+#           'project.description' => 'This is a rundeck test project',
+#           'project.disable.schedule' => 'false',
+#         },
+#       },
+#     },
+#   }
+#
+# @param repo_config
+#   A hash of repository attributes for configuring the rundeck cli package repositories.
+#   Examples/defaults for yumrepo can be found at RedHat.yaml, and for apt at Debian.yaml
+# @param manage_repo
+#   Whether to manage the cli package repository.
+# @param version
+#   Ensure the state of the rundeck cli package, either present, absent or a specific version.
+# @param url
+#   Rundeck instance/api url.
+# @param bypass_url
+#   Rundeck external url to bypass. This will rewrite any redirect to $bypass_url as $url
+# @param user
+#   Cli user to authenticate.
+# @param password
+#   Cli password to authenticate.
+# @param token
+#   Cli token to authenticate.
+# @param projects
+#   Cli projects config. See example for structure and rundeck::config::project for available params.
 #
 class rundeck::cli (
   Hash $repo_config,
@@ -9,7 +52,7 @@
   String[1] $user = 'admin',
   String[1] $password = 'admin',
   Optional[String[8]] $token = undef,
-  Hash $projects = {},
+  Hash[String, Rundeck::Project] $projects = {},
 ) {
   ensure_resource('package', 'jq', { 'ensure' => 'present' })
 

types/project.pp

@@ -0,0 +1,5 @@
+# Rundeck project config type.
+type Rundeck::Project = Struct[{
+    Optional['config']        => Hash[String, String],
+    Optional['update_method'] => String,
+}]