Skip to content

Commit

Permalink
Update module reference doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Joris VAN ACOLEYEN committed Aug 12, 2024
1 parent 6d06005 commit fc5c93a
Showing 1 changed file with 122 additions and 0 deletions.
122 changes: 122 additions & 0 deletions REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
* [`Rundeck::Loglevel`](#Rundeck--Loglevel): Rundeck log level type.
* [`Rundeck::Mail_config`](#Rundeck--Mail_config): Rundeck mail config type.
* [`Rundeck::Project`](#Rundeck--Project): Rundeck project type.
* [`Rundeck::Scm`](#Rundeck--Scm): Rundeck scm type.

## Classes

Expand Down Expand Up @@ -1008,6 +1009,63 @@ rundeck::config::project { 'MyProject':
}
```

##### Advanced usage with jobs.

```puppet
rundeck::config::project { 'MyProject':
config => {
'project.description' => 'My test project',
'project.disable.schedule' => 'false',
},
jobs => {
'MyJob1' => {
'path' => '/etc/myjob1',
'format' => 'yaml',
},
'MyJob2' => {
'path' => '/etc/myjob2',
'format' => 'xml',
},
'DeleteJob1' => {
'ensure' => 'absent',
'path' => '/etc/testjob1',
'format' => 'yaml',
},
},
}
```

##### Advanced usage with scm_config.

```puppet
rundeck::config::project { 'MyProject':
config => {
'project.description' => 'My test project',
'project.disable.schedule' => 'false',
},
scm_config => {
'import' => {
'type' => 'git-import',
'config' => {
'strictHostKeyChecking' => 'yes',
'gitPasswordPath' => 'keys/example-access-token',
'format' => 'xml',
'dir' => '/var/lib/rundeck/projects/MyProject/ScmImport',
'branch' => 'master',
'url' => 'https://[email protected]/example/example.git',
'filePattern' => '*.xml',
'useFilePattern' => 'true',
'pathTemplate' => "\${job.id}.\${config.format}",
'importUuidBehavior' => 'preserve',
'sshPrivateKeyPath' => '',
'fetchAutomatically' => 'true',
'pullAutomatically' => 'true',
},
},
},
}
```

#### Parameters

The following parameters are available in the `rundeck::config::project` defined type:
Expand All @@ -1016,6 +1074,10 @@ The following parameters are available in the `rundeck::config::project` defined
* [`config`](#-rundeck--config--project--config)
* [`update_method`](#-rundeck--config--project--update_method)
* [`jobs`](#-rundeck--config--project--jobs)
* [`owner`](#-rundeck--config--project--owner)
* [`group`](#-rundeck--config--project--group)
* [`projects_dir`](#-rundeck--config--project--projects_dir)
* [`scm_config`](#-rundeck--config--project--scm_config)

##### <a name="-rundeck--config--project--ensure"></a>`ensure`

Expand Down Expand Up @@ -1065,6 +1127,38 @@ Rundeck jobs related to a project.

Default value: `{}`

##### <a name="-rundeck--config--project--owner"></a>`owner`

Data type: `String[1]`

The user that rundeck is installed as.

Default value: `'rundeck'`

##### <a name="-rundeck--config--project--group"></a>`group`

Data type: `String[1]`

The group permission that rundeck is installed as.

Default value: `'rundeck'`

##### <a name="-rundeck--config--project--projects_dir"></a>`projects_dir`

Data type: `Stdlib::Absolutepath`

Directory where some project config will be stored.

Default value: `'/var/lib/rundeck/projects'`

##### <a name="-rundeck--config--project--scm_config"></a>`scm_config`

Data type: `Optional[Rundeck::Scm]`

A hash of name value pairs representing properties for the scm.json file.

Default value: `undef`

### <a name="rundeck--config--secret"></a>`rundeck::config::secret`

This define will manage secrets in key storage.
Expand Down Expand Up @@ -1261,3 +1355,31 @@ Struct[{
}]
```

### <a name="Rundeck--Scm"></a>`Rundeck::Scm`

Rundeck scm type.

Alias of

```puppet
Variant[Struct[{
'import' => Struct[{
'type' => String[1],
'config' => Hash[String[1], String],
}],
Optional['export'] => Struct[{
'type' => String[1],
'config' => Hash[String[1], String],
}],
}], Struct[{
'export' => Struct[{
'type' => String[1],
'config' => Hash[String[1], String],
}],
Optional['import'] => Struct[{
'type' => String[1],
'config' => Hash[String[1], String],
}],
}]]
```

0 comments on commit fc5c93a

Please sign in to comment.