Skip to content

Commit ba8f12a

Browse files
authored
Merge pull request bareos#2225
fix MaximumConcurrentJobs in docs and defaultsconfig
2 parents 4661242 + 91205af commit ba8f12a

File tree

11 files changed

+127
-80
lines changed

11 files changed

+127
-80
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2828
- cleanup: fix multi-config tests [PR #2202]
2929
- mssqlvdi-fd: add support for filestream backups [PR #2072]
3030
- cmake: fix not including BareosTargetTools in systemtests, needed for get_target_output_dir [PR #2232]
31+
- fix MaximumConcurrentJobs in docs and defaultsconfig [PR #2225]
3132

3233
### Documentation
3334
- docs: fix grpc-fd plugin call [PR #2068]
@@ -111,5 +112,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
111112
[PR #2202]: https://github.com/bareos/bareos/pull/2202
112113
[PR #2211]: https://github.com/bareos/bareos/pull/2211
113114
[PR #2220]: https://github.com/bareos/bareos/pull/2220
115+
[PR #2225]: https://github.com/bareos/bareos/pull/2225
114116
[PR #2232]: https://github.com/bareos/bareos/pull/2232
115117
[unreleased]: https://github.com/bareos/bareos/tree/master

core/src/defaultconfigs/bareos-fd.d/client/myself.conf.in

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
Client {
22
Name = @basename@-fd
3-
Maximum Concurrent Jobs = 20
43

54
# remove comment from "Plugin Directory" to load plugins from specified directory.
65
# if "Plugin Names" is defined, only the specified plugins will be loaded,

core/src/defaultconfigs/bareos-sd.d/device/FileStorage.conf.in

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@ Device {
22
Name = FileStorage
33
Media Type = File
44
Archive Device = @archivedir@
5-
LabelMedia = yes; # lets Bareos label unlabeled media
6-
Random Access = yes;
7-
AutomaticMount = yes; # when device opened, read it
8-
RemovableMedia = no;
9-
AlwaysOpen = no;
5+
Label Media = yes # lets Bareos label unlabeled media
6+
Random Access = yes
7+
Automatic Mount = yes # when device opened, read it
8+
Removable Media = no
9+
Always Open = no
1010
Description = "File device. A connecting Director must have the same Name and MediaType."
1111
}

core/src/defaultconfigs/bareos-sd.d/storage/bareos-sd.conf.in

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
Storage {
22
Name = bareos-sd
3-
Maximum Concurrent Jobs = 20
43

54
# remove comment from "Plugin Directory" to load plugins from specified directory.
65
# if "Plugin Names" is defined, only the specified plugins will be loaded,

core/src/stored/device_resource.cc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
Copyright (C) 2000-2011 Free Software Foundation Europe e.V.
55
Copyright (C) 2011-2012 Planets Communications B.V.
6-
Copyright (C) 2013-2024 Bareos GmbH & Co. KG
6+
Copyright (C) 2013-2025 Bareos GmbH & Co. KG
77
88
This program is Free Software; you can redistribute it and/or
99
modify it under the terms of version three of the GNU Affero General Public
@@ -223,7 +223,7 @@ static void WarnOnSetMaxBlockSize(const DeviceResource& resource)
223223
if (resource.IsMemberPresent("MaximumBlockSize")) {
224224
my_config->AddWarning(fmt::format(
225225
FMT_STRING(
226-
"Device {:s}: Setting 'Maximum Block Size' is only supported on "
226+
"Device {:s}: Setting 'Maximum Block Size' is only supported on "
227227
"tape devices"),
228228
resource.resource_name_));
229229
}
@@ -235,7 +235,7 @@ static void WarnOnZeroMaxConcurrentJobs(int max_concurrent_jobs,
235235
if (max_concurrent_jobs == 0) {
236236
my_config->AddWarning(
237237
fmt::format(FMT_STRING("Device {:s}: unlimited (0) 'Maximum Concurrent "
238-
"Jobs' reduces the restore peformance."),
238+
"Jobs' reduces the restore performance."),
239239
name));
240240
}
241241
}

docs/manuals/source/Appendix/Troubleshooting.rst

Lines changed: 42 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -108,13 +108,8 @@ Bareos can run multiple concurrent jobs. Using the :strong:`Maximum Concurrent J
108108

109109
|sd|
110110

111-
- :config:option:`sd/storage/MaximumConcurrentJobs`\
112-
113111
- :config:option:`sd/device/MaximumConcurrentJobs`\
114112

115-
|fd|
116-
117-
- :config:option:`fd/client/MaximumConcurrentJobs`\
118113

119114
For example, if you want two different jobs to run simultaneously backing up the same Client to the same Storage device, they will run concurrently only if you have set :strong:`Maximum Concurrent Jobs`\ greater than one in the :config:option:`Dir/Director`\ resource, the :config:option:`Dir/Client`\ resource, and the :config:option:`Dir/Storage`\ resource in |dir| configuration.
120115

@@ -128,35 +123,52 @@ Below is a super stripped down |dir| configuration showing you the four places w
128123
.. code-block:: bareosconfig
129124
:caption: Concurrent Jobs Example
130125
131-
#
132-
# Bareos Director Configuration /etc/bareos/bareos-dir.d/*
133-
#
134-
Director {
135-
Name = bareos-dir
136-
Maximum Concurrent Jobs = 4
137-
...
138-
}
139-
Job {
140-
Name = "NightlySave"
141-
Maximum Concurrent Jobs = 4
142-
Client = bareos-fd
143-
Storage = File
144-
...
145-
}
146-
Client {
147-
Name = bareos-fd
148-
Maximum Concurrent Jobs = 4
149-
...
150-
}
151-
Storage {
152-
Name = File
153-
Maximum Concurrent Jobs = 4
154-
...
155-
}
126+
#
127+
# Bareos Director Configuration /etc/bareos/bareos-dir.d/*
128+
#
129+
Director {
130+
Name = bareos-dir
131+
Maximum Concurrent Jobs = 4
132+
...
133+
}
134+
Client {
135+
Name = bareos-fd
136+
Maximum Concurrent Jobs = 4
137+
...
138+
}
139+
Storage {
140+
Name = File
141+
Maximum Concurrent Jobs = 4
142+
...
143+
}
144+
Job {
145+
Name = "NightlySave"
146+
Maximum Concurrent Jobs = 4
147+
Client = bareos-fd
148+
Storage = File
149+
...
150+
}
151+
152+
153+
154+
.. note::
155+
156+
:sinceVersion:`24.0.0: Maximum Concurrent Jobs` the following directives have been deprecated and
157+
can be removed from any configuration.
158+
159+
|sd|
160+
161+
- :config:option:`fd/client/MaximumConcurrentJobs`\
162+
163+
|fd|
164+
165+
- :config:option:`fd/client/MaximumConcurrentJobs`\
166+
156167

157168

158169
.. _AnsiLabelsChapter:
159170

171+
160172
Tape Labels: ANSI or IBM
161173
------------------------
162174

docs/manuals/source/Configuration/Director.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1425,8 +1425,7 @@ The directives within an Options resource may be one of the following:
14251425
14261426
:type: yes|no
14271427

1428-
The default is :strong:`no`. On Windows systems, you will almost surely
1429-
want to set this to :strong:`yes`. When this directive is set to :strong:`yes`
1428+
The default is :strong:`no`. When this directive is set to :strong:`yes`
14301429
all the case of character will be ignored in wild-card and regex
14311430
comparisons. That is an uppercase A will match a lowercase a.
14321431

docs/manuals/source/Configuration/StorageDaemon.rst

Lines changed: 71 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,21 @@
33
Storage Daemon Configuration
44
============================
55

6-
:index:`\ <single: Configuration>`\ :index:`\ <single: Storage Daemon; Configuration>`\ :index:`\ <single: Configuration; Storage Daemon>`\
6+
.. index::
7+
single: Configuration
8+
single: Storage Daemon; Configuration
9+
single: Configuration; Storage Daemon
710

8-
The |sd| configuration file has relatively few resource definitions. However, due to the great variation in backup media and system capabilities, the storage daemon must be highly configurable. As a consequence, there are quite a large number of directives in the Device Resource definition that allow you to define all the characteristics of your Storage device (normally a tape drive). Fortunately, with modern storage devices, the defaults are sufficient, and very few directives
9-
are actually needed.
11+
The |sd| configuration file has relatively few resource definitions. However, due to the great variation
12+
in backup media and system capabilities, the storage daemon must be highly configurable. As a consequence,
13+
there are quite a large number of directives in the Device Resource definition that allow you to define
14+
all the characteristics of your Storage device (normally a tape drive). Fortunately, with modern
15+
storage devices, the defaults are sufficient, and very few directives are actually needed.
1016

11-
For a general discussion of configuration file and resources including the data types recognized by Bareos, please see the :ref:`Configuration <ConfigureChapter>` chapter of this manual. The following Storage Resource definitions must be defined:
17+
For a general discussion of configuration file and resources including the data types recognized by
18+
Bareos, please see the :ref:`Configuration <ConfigureChapter>` chapter of this manual.
19+
20+
The following Storage Resource definitions must be defined:
1221

1322
- :ref:`Storage <StorageResourceStorage>` – to define the name of the Storage daemon.
1423

@@ -29,9 +38,13 @@ Following resources are optional:
2938
Storage Resource
3039
----------------
3140

32-
:index:`\ <single: Resource; Storage>`\ :index:`\ <single: Storage; Resource>`\
41+
.. index::
42+
single: Resource; Storage
43+
single: Storage; Resource
3344

34-
In general, the properties specified under the Storage resource define global properties of the Storage daemon. Each Storage daemon configuration file must have one and only one Storage resource definition.
45+
In general, the properties specified under the Storage resource define global properties of the
46+
Storage daemon. Each Storage daemon configuration file must have one and only one Storage resource
47+
definition.
3548

3649
.. include:: /include/autogenerated/bareos-sd-resource-storage-table.rst.inc
3750

@@ -48,18 +61,21 @@ The following is a typical Storage daemon storage resource definition.
4861
#
4962
Storage {
5063
Name = "Storage daemon"
51-
Address = localhost
64+
Address = bareos-sd.example.com
5265
}
5366
5467
.. _StorageResourceDirector:
5568

5669
Director Resource
5770
-----------------
5871

59-
:index:`\ <single: Resource; Director>`
60-
:index:`\ <single: Director; Resource>`
72+
.. index::
73+
single: Resource; Director
74+
single: Director; Resource
6175

62-
The Director resource specifies the Name of the Director which is permitted to use the services of the Storage daemon. There may be multiple Director resources. The Director Name and Password must match the corresponding values in the Director’s configuration file.
76+
The Director resource specifies the Name of the Director which is permitted to use the services of
77+
the Storage daemon. There may be multiple Director resources. The Director Name and Password must
78+
match the corresponding values in the Director’s configuration file.
6379

6480
.. include:: /include/autogenerated/bareos-sd-resource-director-table.rst.inc
6581

@@ -82,10 +98,13 @@ The following is an example of a valid Director resource definition:
8298
NDMP Resource
8399
-------------
84100

85-
:index:`\ <single: Resource; NDMP>`
86-
:index:`\ <single: NDMP; Resource>`
101+
.. index::
102+
single: Resource; NDMP
103+
single: NDMP; Resource
87104

88-
The NDMP Resource specifies the authentication details of each NDMP client. There may be multiple NDMP resources for a single Storage daemon. In general, the properties specified within the NDMP resource are specific to one client.
105+
The NDMP Resource specifies the authentication details of each NDMP client. There may be multiple
106+
NDMP resources for a single Storage daemon. In general, the properties specified within the NDMP
107+
resource are specific to one client.
89108

90109
.. include:: /include/autogenerated/bareos-sd-resource-ndmp-table.rst.inc
91110

@@ -97,10 +116,13 @@ The NDMP Resource specifies the authentication details of each NDMP client. Ther
97116
Device Resource
98117
---------------
99118

100-
:index:`\ <single: Resource; Device>`
101-
:index:`\ <single: Device; Resource>`
119+
.. index.:
120+
single: Resource; Device
121+
single: Device; Resource
102122
103-
The Device Resource specifies the details of each device (normally a tape drive) that can be used by the Storage daemon. There may be multiple Device resources for a single Storage daemon. In general, the properties specified within the Device resource are specific to the Device.
123+
The Device Resource specifies the details of each device (normally a tape drive) that can be used by
124+
the Storage daemon. There may be multiple Device resources for a single Storage daemon. In general,
125+
the properties specified within the Device resource are specific to the Device.
104126

105127
.. include:: /include/autogenerated/bareos-sd-resource-device-table.rst.inc
106128

@@ -111,10 +133,12 @@ The Device Resource specifies the details of each device (normally a tape drive)
111133
Edit Codes for Mount and Unmount Directives
112134
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
113135

114-
:index:`\ <single: Edit Codes for Mount and Unmount Directives>`
115-
:index:`\ <single: Mount and Unmount: use variables in directives>`
136+
.. index::
137+
single: Edit Codes for Mount and Unmount Directives
138+
single: Mount and Unmount: use variables in directives
116139

117-
Before submitting the Mount Command, or Unmount Command directives to the operating system, Bareos performs character substitution of the following characters:
140+
Before submitting the Mount Command, or Unmount Command directives to the operating system, Bareos
141+
performs character substitution of the following characters:
118142

119143

120144

@@ -132,7 +156,8 @@ Before submitting the Mount Command, or Unmount Command directives to the operat
132156
Devices that require a mount (USB)
133157
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
134158

135-
:index:`\ <single: Devices that require a mount (USB)>`\
159+
.. index::
160+
single: Devices that require a mount (USB)
136161

137162
:config:option:`sd/device/RequiresMount`
138163
You must set this directive to :strong:`yes` for removable devices such as
@@ -201,10 +226,13 @@ Devices that require a mount (USB)
201226
Autochanger Resource
202227
--------------------
203228

204-
:index:`\ <single: Autochanger Resource>`
205-
:index:`\ <single: Resource; Autochanger>`
229+
.. index::
230+
single: Autochanger Resource
231+
single: Resource; Autochanger
206232

207-
The Autochanger resource supports single or multiple drive autochangers by grouping one or more Device resources into one unit called an autochanger in Bareos (often referred to as a "tape library" by autochanger manufacturers).
233+
The Autochanger resource supports single or multiple drive autochangers by grouping one or more
234+
Device resources into one unit called an autochanger in Bareos (often referred to as a "tape library"
235+
by autochanger manufacturers).
208236

209237
.. include:: /include/autogenerated/bareos-sd-resource-autochanger-table.rst.inc
210238

@@ -216,33 +244,36 @@ The following is an example of a valid Autochanger resource definition:
216244
:caption: Autochanger Configuration Example
217245
218246
Autochanger {
219-
Name = "DDS-4-changer"
220-
Device = DDS-4-1, DDS-4-2, DDS-4-3
247+
Name = "LTO8-changer"
248+
Device = LTO8-1, LTO8-2, LTO8-3
221249
Changer Device = /dev/sg0
222250
Changer Command = "/usr/lib/bareos/scripts/mtx-changer %c %o %S %a %d"
223251
}
224252
Device {
225-
Name = "DDS-4-1"
253+
Name = "LTO8-1"
226254
Drive Index = 0
227255
Autochanger = yes
228256
...
229257
}
230258
Device {
231-
Name = "DDS-4-2"
259+
Name = "LTO8-2"
232260
Drive Index = 1
233261
Autochanger = yes
234262
...
235263
Device {
236-
Name = "DDS-4-3"
264+
Name = "LTO8-3"
237265
Drive Index = 2
238266
Autochanger = yes
239267
Autoselect = no
240268
...
241269
}
242270
243-
Please note that it is important to include the :config:option:`sd/device/Autochanger = yes`\ directive in each device definition that belongs to an Autochanger. A device definition should not belong to more than one Autochanger resource.
271+
Please note that it is important to include the :config:option:`sd/device/Autochanger = yes`\ directive
272+
in each device definition that belongs to an Autochanger. A device definition should not belong to more
273+
than one Autochanger resource.
244274

245-
Also, your :config:option:`dir/storage/Device`\ must refer to the Autochanger’s resource name rather than a name of one of the Devices.
275+
Also, your :config:option:`dir/storage/Device`\ must refer to the Autochanger’s resource name rather
276+
than a name of one of the Devices.
246277

247278
For details refer to the :ref:`AutochangersChapter` chapter.
248279

@@ -254,9 +285,12 @@ Multiplied Device
254285
The Multiplied Device feature can be used when multiple identical devices are needed.
255286
In this case the :config:option:`sd/device/Count` can be added to the regarding Device resource.
256287

257-
When the configuration is loaded the |bareosSD| will then automatically multiply this device :config:option:`sd/device/Count` times. The number of multiplied devices includes the original Device.
288+
When the configuration is loaded the |bareosSD| will then automatically multiply this device
289+
:config:option:`sd/device/Count` times. The number of multiplied devices includes the original Device.
258290

259-
A number "0001" will be appended to name of the initial Device. All other multiplied Devices have increasing numbers "0002", "0003", accordingly. In the example below the name of the multiplied devices will be "MultiFileStorage0001", "MultiFileStorage0002", and so on.
291+
A number "0001" will be appended to name of the initial Device. All other multiplied Devices have
292+
increasing numbers "0002", "0003", accordingly. In the example below the name of the multiplied
293+
devices will be "MultiFileStorage0001", "MultiFileStorage0002", and so on.
260294

261295
.. code-block:: bareosconfig
262296
:caption: bareos-sd.d/device/multiplied_device.conf
@@ -278,7 +312,8 @@ A number "0001" will be appended to name of the initial Device. All other multip
278312
279313
In the |bareosDir| any of the Multiplied Devices can be referred to using their numbered names.
280314

281-
However, in the autochanger resource of the |bareosSD| the original name of the initial Multiplied Device Resource can be used.
315+
However, in the autochanger resource of the |bareosSD| the original name of the initial
316+
Multiplied Device Resource can be used.
282317

283318
.. code-block:: bareosconfig
284319
:caption: bareos-sd.d/autochanger/autochanger.conf
@@ -300,6 +335,8 @@ When the configuration is exported, again only the name of the initial Multiplie
300335
Messages Resource
301336
-----------------
302337

303-
:index:`\ <single: Resource; Messages>`\ :index:`\ <single: Messages; Resource>`\
338+
.. index::
339+
single: Resource; Messages
340+
single: Messages; Resource
304341

305342
For a description of the Messages Resource, please see the :ref:`MessagesChapter` chapter of this manual.

0 commit comments

Comments
 (0)