Skip to content

Commit 687ed1c

Browse files
committed
Fix spacing and regererate REFERENCE.md
1 parent 71883ec commit 687ed1c

File tree

4 files changed

+145
-109
lines changed

4 files changed

+145
-109
lines changed

REFERENCE.md

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -785,11 +785,13 @@ The following parameters are available in the `bacula::storage` class:
785785
* [`device_name`](#-bacula--storage--device_name)
786786
* [`device_owner`](#-bacula--storage--device_owner)
787787
* [`device_seltype`](#-bacula--storage--device_seltype)
788+
* [`device_max_concurrent_jobs`](#-bacula--storage--device_max_concurrent_jobs)
788789
* [`director_name`](#-bacula--storage--director_name)
789790
* [`group`](#-bacula--storage--group)
790791
* [`homedir`](#-bacula--storage--homedir)
791792
* [`listen_address`](#-bacula--storage--listen_address)
792793
* [`maxconcurjobs`](#-bacula--storage--maxconcurjobs)
794+
* [`max_concurrent_jobs`](#-bacula--storage--max_concurrent_jobs)
793795
* [`media_type`](#-bacula--storage--media_type)
794796
* [`password`](#-bacula--storage--password)
795797
* [`port`](#-bacula--storage--port)
@@ -866,6 +868,14 @@ SELinux type for the device
866868

867869
Default value: `$bacula::device_seltype`
868870

871+
##### <a name="-bacula--storage--device_max_concurrent_jobs"></a>`device_max_concurrent_jobs`
872+
873+
Data type: `Integer[1]`
874+
875+
The maximum number of Jobs that may run concurrently on the device
876+
877+
Default value: `5`
878+
869879
##### <a name="-bacula--storage--director_name"></a>`director_name`
870880

871881
Data type: `String[1]`
@@ -901,11 +911,19 @@ Default value: `[]`
901911

902912
##### <a name="-bacula--storage--maxconcurjobs"></a>`maxconcurjobs`
903913

914+
Data type: `Optional[Integer[1]]`
915+
916+
DEPRECATED maximum number of Jobs that may run concurrently
917+
918+
Default value: `undef`
919+
920+
##### <a name="-bacula--storage--max_concurrent_jobs"></a>`max_concurrent_jobs`
921+
904922
Data type: `Integer[1]`
905923

906-
maximum number of Jobs that may run concurrently
924+
The maximum number of Jobs that may run concurrently
907925

908-
Default value: `5`
926+
Default value: `20`
909927

910928
##### <a name="-bacula--storage--media_type"></a>`media_type`
911929

@@ -1316,6 +1334,7 @@ The following parameters are available in the `bacula::director::storage` define
13161334
* [`device_name`](#-bacula--director--storage--device_name)
13171335
* [`media_type`](#-bacula--director--storage--media_type)
13181336
* [`maxconcurjobs`](#-bacula--director--storage--maxconcurjobs)
1337+
* [`max_concurrent_jobs`](#-bacula--director--storage--max_concurrent_jobs)
13191338
* [`conf_dir`](#-bacula--director--storage--conf_dir)
13201339

13211340
##### <a name="-bacula--director--storage--address"></a>`address`
@@ -1360,6 +1379,14 @@ Default value: `'File'`
13601379

13611380
##### <a name="-bacula--director--storage--maxconcurjobs"></a>`maxconcurjobs`
13621381

1382+
Data type: `Optional[Integer[1]]`
1383+
1384+
DEPRECATED Bacula director configuration for Storage option 'Maximum Concurrent Jobs'
1385+
1386+
Default value: `undef`
1387+
1388+
##### <a name="-bacula--director--storage--max_concurrent_jobs"></a>`max_concurrent_jobs`
1389+
13631390
Data type: `Integer[1]`
13641391

13651392
Bacula director configuration for Storage option 'Maximum Concurrent Jobs'
@@ -1990,6 +2017,7 @@ The following parameters are available in the `bacula::storage::device` defined
19902017
* [`removable_media`](#-bacula--storage--device--removable_media)
19912018
* [`always_open`](#-bacula--storage--device--always_open)
19922019
* [`maxconcurjobs`](#-bacula--storage--device--maxconcurjobs)
2020+
* [`max_concurrent_jobs`](#-bacula--storage--device--max_concurrent_jobs)
19932021
* [`conf_dir`](#-bacula--storage--device--conf_dir)
19942022
* [`device_mode`](#-bacula--storage--device--device_mode)
19952023
* [`device_owner`](#-bacula--storage--device--device_owner)
@@ -2063,6 +2091,14 @@ Default value: `false`
20632091

20642092
##### <a name="-bacula--storage--device--maxconcurjobs"></a>`maxconcurjobs`
20652093

2094+
Data type: `Optional[Integer[1]]`
2095+
2096+
DEPRECATED Bacula director configuration for Device option 'Maximum Concurrent Jobs'
2097+
2098+
Default value: `undef`
2099+
2100+
##### <a name="-bacula--storage--device--max_concurrent_jobs"></a>`max_concurrent_jobs`
2101+
20662102
Data type: `Integer[1]`
20672103

20682104
Bacula director configuration for Device option 'Maximum Concurrent Jobs'

manifests/director/storage.pp

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -7,36 +7,36 @@
77
# resource, so that each storage server is available as a configuration on the
88
# director.
99
#
10-
# @param address Bacula director configuration for Storage option 'SDAddress'
11-
# @param port Bacula director configuration for Storage option 'SDPort'
12-
# @param password Bacula director configuration for Storage option 'Password'
13-
# @param device_name Bacula director configuration for Storage option 'Device'
14-
# @param media_type Bacula director configuration for Storage option 'Media Type'
15-
# @param maxconcurjobs DEPRECATED Bacula director configuration for Storage option 'Maximum Concurrent Jobs'
10+
# @param address Bacula director configuration for Storage option 'SDAddress'
11+
# @param port Bacula director configuration for Storage option 'SDPort'
12+
# @param password Bacula director configuration for Storage option 'Password'
13+
# @param device_name Bacula director configuration for Storage option 'Device'
14+
# @param media_type Bacula director configuration for Storage option 'Media Type'
15+
# @param maxconcurjobs DEPRECATED Bacula director configuration for Storage option 'Maximum Concurrent Jobs'
1616
# @param max_concurrent_jobs Bacula director configuration for Storage option 'Maximum Concurrent Jobs'
17-
# @param conf_dir Bacula configuration directory
17+
# @param conf_dir Bacula configuration directory
1818
#
1919
define bacula::director::storage (
20-
String[1] $address = $name,
21-
Stdlib::Port $port = 9103,
22-
Bacula::Password $password = 'secret',
23-
String[1] $device_name = "${facts['networking']['fqdn']}-device",
24-
String[1] $media_type = 'File',
25-
Optional[Integer[1]] $maxconcurjobs = undef,
20+
String[1] $address = $name,
21+
Stdlib::Port $port = 9103,
22+
Bacula::Password $password = 'secret',
23+
String[1] $device_name = "${facts['networking']['fqdn']}-device",
24+
String[1] $media_type = 'File',
25+
Optional[Integer[1]] $maxconcurjobs = undef,
2626
Integer[1] $max_concurrent_jobs = 1,
27-
Stdlib::Absolutepath $conf_dir = $bacula::conf_dir,
27+
Stdlib::Absolutepath $conf_dir = $bacula::conf_dir,
2828
) {
2929
if $maxconcurjobs {
3030
deprecation('bacula::director::maxconcurjobs', 'This parameter is deprecated. Use bacula::director::max_concurrent_jobs instead.')
3131
}
3232

3333
$epp_storage_variables = {
34-
name => $name,
35-
address => $address,
36-
port => $port,
37-
password => $password,
38-
device_name => $device_name,
39-
media_type => $media_type,
34+
name => $name,
35+
address => $address,
36+
port => $port,
37+
password => $password,
38+
device_name => $device_name,
39+
media_type => $media_type,
4040
max_concurrent_jobs => pick($maxconcurjobs, $max_concurrent_jobs),
4141
}
4242

manifests/storage.pp

Lines changed: 49 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -2,55 +2,55 @@
22
#
33
# This class configures the Bacula storage daemon.
44
#
5-
# @param services A list of services to operate; loaded from hiera
6-
# @param packages A list of packages to install; loaded from hiera
7-
# @param ensure What state the package should be in.
8-
# @param conf_dir Path to bacula configuration directory
9-
# @param device The system file name of the storage device managed by this storage daemon
10-
# @param device_mode The posix mode for device
11-
# @param device_name The Name that the Director will use when asking to backup or restore to or from to this device
12-
# @param device_owner The posix user owning the device directory
13-
# @param device_seltype SELinux type for the device
5+
# @param services A list of services to operate; loaded from hiera
6+
# @param packages A list of packages to install; loaded from hiera
7+
# @param ensure What state the package should be in.
8+
# @param conf_dir Path to bacula configuration directory
9+
# @param device The system file name of the storage device managed by this storage daemon
10+
# @param device_mode The posix mode for device
11+
# @param device_name The Name that the Director will use when asking to backup or restore to or from to this device
12+
# @param device_owner The posix user owning the device directory
13+
# @param device_seltype SELinux type for the device
1414
# @param device_max_concurrent_jobs The maximum number of Jobs that may run concurrently on the device
15-
# @param director_name Specifies the Name of the Director allowed to connect to the Storage daemon
16-
# @param group The posix group for bacula
17-
# @param homedir The directory in which the Storage daemon may put its status files
18-
# @param listen_address The listening IP addresses for the storage daemon
15+
# @param director_name Specifies the Name of the Director allowed to connect to the Storage daemon
16+
# @param group The posix group for bacula
17+
# @param homedir The directory in which the Storage daemon may put its status files
18+
# @param listen_address The listening IP addresses for the storage daemon
1919
# The notes for `bacula::client::listen_address` apply.
20-
# @param maxconcurjobs DEPRECATED maximum number of Jobs that may run concurrently
21-
# @param max_concurrent_jobs The maximum number of Jobs that may run concurrently
22-
# @param media_type The type of media supported by this device
23-
# @param password Specifies the password that must be supplied by the named Director
24-
# @param port The listening port for the Storage Daemon
25-
# @param rundir The directory in which the Director may put its process Id file files
26-
# @param storage The address to be configured on the director to communicate with this storage server
27-
# @param address The listening address for the Storage Daemon
28-
# @param user The posix user for bacula
20+
# @param maxconcurjobs DEPRECATED maximum number of Jobs that may run concurrently
21+
# @param max_concurrent_jobs The maximum number of Jobs that may run concurrently
22+
# @param media_type The type of media supported by this device
23+
# @param password Specifies the password that must be supplied by the named Director
24+
# @param port The listening port for the Storage Daemon
25+
# @param rundir The directory in which the Director may put its process Id file files
26+
# @param storage The address to be configured on the director to communicate with this storage server
27+
# @param address The listening address for the Storage Daemon
28+
# @param user The posix user for bacula
2929
#
3030
class bacula::storage (
3131
String[1] $services,
3232
Array[String[1]] $packages,
33-
String[1] $ensure = 'present',
34-
Stdlib::Absolutepath $conf_dir = $bacula::conf_dir,
35-
Stdlib::Absolutepath $device = '/bacula',
36-
Stdlib::Filemode $device_mode = '0770',
37-
String[1] $device_name = "${trusted['certname']}-device",
38-
String[1] $device_owner = $bacula::bacula_user,
39-
String[1] $device_seltype = $bacula::device_seltype,
33+
String[1] $ensure = 'present',
34+
Stdlib::Absolutepath $conf_dir = $bacula::conf_dir,
35+
Stdlib::Absolutepath $device = '/bacula',
36+
Stdlib::Filemode $device_mode = '0770',
37+
String[1] $device_name = "${trusted['certname']}-device",
38+
String[1] $device_owner = $bacula::bacula_user,
39+
String[1] $device_seltype = $bacula::device_seltype,
4040
Integer[1] $device_max_concurrent_jobs = 5,
41-
String[1] $director_name = $bacula::director_name,
42-
String[1] $group = $bacula::bacula_group,
43-
Stdlib::Absolutepath $homedir = $bacula::homedir,
44-
Array[String[1]] $listen_address = [],
45-
Optional[Integer[1]] $maxconcurjobs = undef,
46-
Integer[1] $max_concurrent_jobs = 20,
47-
String[1] $media_type = 'File',
48-
Bacula::Password $password = 'secret',
49-
Stdlib::Port $port = 9103,
50-
Stdlib::Absolutepath $rundir = $bacula::rundir,
51-
String[1] $storage = $trusted['certname'], # storage here is not storage_name
52-
String[1] $address = $facts['networking']['fqdn'],
53-
String[1] $user = $bacula::bacula_user,
41+
String[1] $director_name = $bacula::director_name,
42+
String[1] $group = $bacula::bacula_group,
43+
Stdlib::Absolutepath $homedir = $bacula::homedir,
44+
Array[String[1]] $listen_address = [],
45+
Optional[Integer[1]] $maxconcurjobs = undef,
46+
Integer[1] $max_concurrent_jobs = 20,
47+
String[1] $media_type = 'File',
48+
Bacula::Password $password = 'secret',
49+
Stdlib::Port $port = 9103,
50+
Stdlib::Absolutepath $rundir = $bacula::rundir,
51+
String[1] $storage = $trusted['certname'], # storage here is not storage_name
52+
String[1] $address = $facts['networking']['fqdn'],
53+
String[1] $user = $bacula::bacula_user,
5454
) inherits bacula {
5555
if $maxconcurjobs {
5656
deprecation('bacula::storage::maxconcurjobs', 'This parameter is deprecated. Use bacula::storage::device_max_concurrent_jobs instead.')
@@ -79,7 +79,7 @@
7979
}
8080

8181
bacula::storage::device { $device_name:
82-
device => $device,
82+
device => $device,
8383
max_concurrent_jobs => pick($maxconcurjobs, $device_max_concurrent_jobs),
8484
}
8585

@@ -107,12 +107,12 @@
107107
}
108108

109109
@@bacula::director::storage { $storage:
110-
address => $address,
111-
port => $port,
112-
password => $password,
113-
device_name => $device_name,
114-
media_type => $media_type,
110+
address => $address,
111+
port => $port,
112+
password => $password,
113+
device_name => $device_name,
114+
media_type => $media_type,
115115
max_concurrent_jobs => $max_concurrent_jobs,
116-
tag => "bacula-${director_name}",
116+
tag => "bacula-${director_name}",
117117
}
118118
}

manifests/storage/device.pp

Lines changed: 38 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -3,54 +3,54 @@
33
# This define creates a storage device declaration. This informs the
44
# storage daemon which storage devices are available to send client backups to.
55
#
6-
# @param device_name Bacula director configuration for Device option 'Name'
7-
# @param media_type Bacula director configuration for Device option 'Media Type'
8-
# @param device Bacula director configuration for Device option 'Archive Device'
9-
# @param label_media Bacula director configuration for Device option 'LabelMedia'
10-
# @param random_access Bacula director configuration for Device option 'Random Access'
11-
# @param automatic_mount Bacula director configuration for Device option 'AutomaticMount'
12-
# @param removable_media Bacula director configuration for Device option 'RemovableMedia'
13-
# @param always_open Bacula director configuration for Device option 'AlwaysOpen'
14-
# @param maxconcurjobs DEPRECATED Bacula director configuration for Device option 'Maximum Concurrent Jobs'
6+
# @param device_name Bacula director configuration for Device option 'Name'
7+
# @param media_type Bacula director configuration for Device option 'Media Type'
8+
# @param device Bacula director configuration for Device option 'Archive Device'
9+
# @param label_media Bacula director configuration for Device option 'LabelMedia'
10+
# @param random_access Bacula director configuration for Device option 'Random Access'
11+
# @param automatic_mount Bacula director configuration for Device option 'AutomaticMount'
12+
# @param removable_media Bacula director configuration for Device option 'RemovableMedia'
13+
# @param always_open Bacula director configuration for Device option 'AlwaysOpen'
14+
# @param maxconcurjobs DEPRECATED Bacula director configuration for Device option 'Maximum Concurrent Jobs'
1515
# @param max_concurrent_jobs Bacula director configuration for Device option 'Maximum Concurrent Jobs'
16-
# @param conf_dir Path to bacula configuration directory
17-
# @param device_mode Unix mode of the Archive Device directory
18-
# @param device_owner Owner of the Archive Device directory
19-
# @param device_seltype SELinux type for the device
20-
# @param director_name Name of the Director allowed to connect to the Storage daemon
21-
# @param group The posix group for bacula
16+
# @param conf_dir Path to bacula configuration directory
17+
# @param device_mode Unix mode of the Archive Device directory
18+
# @param device_owner Owner of the Archive Device directory
19+
# @param device_seltype SELinux type for the device
20+
# @param director_name Name of the Director allowed to connect to the Storage daemon
21+
# @param group The posix group for bacula
2222
#
2323
define bacula::storage::device (
24-
String[1] $device_name = $name,
25-
String[1] $media_type = 'File',
26-
Stdlib::Absolutepath $device = '/bacula',
27-
Bacula::Yesno $label_media = true,
28-
Bacula::Yesno $random_access = true,
29-
Bacula::Yesno $automatic_mount = true,
30-
Bacula::Yesno $removable_media = false,
31-
Bacula::Yesno $always_open = false,
32-
Optional[Integer[1]] $maxconcurjobs = undef,
24+
String[1] $device_name = $name,
25+
String[1] $media_type = 'File',
26+
Stdlib::Absolutepath $device = '/bacula',
27+
Bacula::Yesno $label_media = true,
28+
Bacula::Yesno $random_access = true,
29+
Bacula::Yesno $automatic_mount = true,
30+
Bacula::Yesno $removable_media = false,
31+
Bacula::Yesno $always_open = false,
32+
Optional[Integer[1]] $maxconcurjobs = undef,
3333
Integer[1] $max_concurrent_jobs = 1,
34-
Stdlib::Absolutepath $conf_dir = $bacula::conf_dir,
35-
Stdlib::Filemode $device_mode = '0770',
36-
String[1] $device_owner = $bacula::bacula_user,
37-
String[1] $device_seltype = $bacula::device_seltype,
38-
String[1] $director_name = $bacula::director_name,
39-
String[1] $group = $bacula::bacula_group,
34+
Stdlib::Absolutepath $conf_dir = $bacula::conf_dir,
35+
Stdlib::Filemode $device_mode = '0770',
36+
String[1] $device_owner = $bacula::bacula_user,
37+
String[1] $device_seltype = $bacula::device_seltype,
38+
String[1] $director_name = $bacula::director_name,
39+
String[1] $group = $bacula::bacula_group,
4040
) {
4141
if $maxconcurjobs {
4242
deprecation('bacula::storage::device::maxconcurjobs', 'This parameter is deprecated. Use bacula::storage::device::max_concurrent_jobs instead.')
4343
}
4444

4545
$epp_device_variables = {
46-
device_name => $device_name,
47-
media_type => $media_type,
48-
device => $device,
49-
label_media => $label_media,
50-
random_access => $random_access,
51-
automatic_mount => $automatic_mount,
52-
removable_media => $removable_media,
53-
always_open => $always_open,
46+
device_name => $device_name,
47+
media_type => $media_type,
48+
device => $device,
49+
label_media => $label_media,
50+
random_access => $random_access,
51+
automatic_mount => $automatic_mount,
52+
removable_media => $removable_media,
53+
always_open => $always_open,
5454
max_concurrent_jobs => pick($maxconcurjobs, $max_concurrent_jobs),
5555
}
5656

0 commit comments

Comments
 (0)