Skip to content

Commit

Permalink
docs: jobdefs warn about runscript
Browse files Browse the repository at this point in the history
  • Loading branch information
bruno-at-bareos committed Nov 6, 2023
1 parent 814058b commit 1a1ac00
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 3 deletions.
14 changes: 11 additions & 3 deletions docs/manuals/source/Configuration/Director.rst
Original file line number Diff line number Diff line change
Expand Up @@ -123,16 +123,24 @@ The following is an example of a valid Job resource definition:
JobDefs Resource
----------------

:index:`\ <single: Job; JobDefs Resource>`\ :index:`\ <single: Resource; JobDefs>`\
.. index::
single: Job; JobDefs Resource
single: Resource; JobDefs

The JobDefs resource permits all the same directives that can appear in a Job resource. However, a JobDefs resource does not create a Job, rather it can be referenced within a Job to provide defaults for that Job. This permits you to concisely define several nearly identical Jobs, each one referencing a JobDefs resource which contains the defaults. Only the changes from the defaults need to be mentioned in each Job.
The JobDefs resource permits all the same directives that can appear in a Job resource.
However, a JobDefs resource does not create a Job, rather it can be referenced within
a Job to provide defaults for that Job. This permits you to concisely define several nearly
identical Jobs, each one referencing a JobDefs resource which contains the defaults.
Only the changes from the defaults need to be mentioned in each Job.

.. _DirectorResourceSchedule:

Schedule Resource
-----------------

:index:`\ <single: Resource; Schedule>`\ :index:`\ <single: Schedule; Resource>`\
.. index::
single: Resource; Schedule
single: Schedule; Resource

The Schedule resource provides a means of automatically scheduling a Job as well as the ability to override the default Level, Pool, Storage and Messages resources. If a Schedule resource is not referenced in a Job, the Job can only be run manually. In general, you specify an action to be taken and when.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,2 +1,7 @@
If a :ref:`Job Defs <DirectorResourceJobDefs>` resource name is specified, all the values contained in the named :ref:`Job Defs <DirectorResourceJobDefs>` resource will be used as the defaults for the current Job. Any value that you explicitly define in the current Job resource, will override any defaults specified in the :ref:`Job Defs <DirectorResourceJobDefs>` resource. The use of this directive permits writing much more compact Job resources where the
bulk of the directives are defined in one or more :ref:`Job Defs <DirectorResourceJobDefs>`. This is particularly useful if you have many similar Jobs but with minor variations such as different Clients. To structure the configuration even more, :ref:`Job Defs <DirectorResourceJobDefs>` themselves can also refer to other :ref:`Job Defs <DirectorResourceJobDefs>`.

.. warning::
While most of the parsed configuration will replace the oldest read parameter by the most recent, Instructions that can handle several instantiations like `RunScript` will simply be added.


0 comments on commit 1a1ac00

Please sign in to comment.