Skip to content

Commit

Permalink
docs: added automatically generated resource tables
Browse files Browse the repository at this point in the history
  • Loading branch information
@joergsteffens
joergsteffens committed May 7, 2019
1 parent 0cafe48 commit 3a250aa
Show file tree
Hide file tree
Showing 40 changed files with 1,164 additions and 86 deletions.
2 changes: 1 addition & 1 deletion docs/manuals/en/new_main_reference/autogenerated
View file
@@ -1 +1 @@
../main/autogenerated
source/include/autogenerated
74 changes: 6 additions & 68 deletions docs/manuals/en/new_main_reference/source/Configuration/Console.rst
View file
Expand Up @@ -3,7 +3,8 @@
Console Configuration
=====================

:index:`\ <single: Configuration; Console>`\ :index:`\ <single: Console Configuration>`\
:index:`\ <single: Configuration; Console>`
:index:`\ <single: Console Configuration>`

The Console configuration file is the simplest of all the configuration files, and in general, you should not need to change it except for the password. It simply contains the information necessary to contact the Director or Directors.

Expand All @@ -16,39 +17,12 @@ The following Console Resource definition must be defined:
Director Resource
-----------------

:index:`\ <single: Director Resource>`\ :index:`\ <single: Resource; Director>`\
:index:`\ <single: Director Resource>`
:index:`\ <single: Resource; Director>`

The Director resource defines the attributes of the Director running on the network. You may have multiple Director resource specifications in a single Console configuration file. If you have more than one, you will be prompted to choose one when you start the Console program.






























.. include:: /include/autogenerated/bconsole-resource-director-table.rst.inc

.. include:: /include/autogenerated/bconsole-resource-director-description.rst.inc

Expand Down Expand Up @@ -95,39 +69,7 @@ information.

Note, the Console resource is optional, but can be useful for restricted consoles as noted above.


































.. include:: /include/autogenerated/bconsole-resource-console-table.rst.inc

.. include:: /include/autogenerated/bconsole-resource-console-description.rst.inc

Expand Down Expand Up @@ -240,7 +182,3 @@ The second Director referenced at :config:option:`Dir/Director = secondserver`\
CommandACL = run, restore
WhereACL = "/"
}
4 changes: 4 additions & 0 deletions docs/manuals/en/new_main_reference/source/Configuration/FileDaemon.rst
View file
Expand Up @@ -109,6 +109,8 @@ Start of the Client records. There must be one and only one Client resource in t




.. include:: /include/autogenerated/bareos-fd-resource-client-table.rst.inc

.. include:: /include/autogenerated/bareos-fd-resource-client-description.rst.inc

Expand Down Expand Up @@ -174,6 +176,8 @@ The Director resource defines the name and password of the Directors that are pe




.. include:: /include/autogenerated/bareos-fd-resource-director-table.rst.inc

.. include:: /include/autogenerated/bareos-fd-resource-director-description.rst.inc

Expand Down
2 changes: 2 additions & 0 deletions docs/manuals/en/new_main_reference/source/Configuration/Messages.rst
View file
Expand Up @@ -71,6 +71,8 @@ destination = address = message-type1, message-type2, message-type3, ...




.. include:: /include/autogenerated/bareos-dir-resource-messages-table.rst.inc

.. include:: /include/autogenerated/bareos-dir-resource-messages-description.rst.inc

Expand Down
8 changes: 8 additions & 0 deletions docs/manuals/en/new_main_reference/source/Configuration/Monitor.rst
View file
Expand Up @@ -40,6 +40,8 @@ The Monitor resource defines the attributes of the Monitor running on the networ



.. include:: /include/autogenerated/bareos-tray-monitor-resource-monitor-table.rst.inc

.. include:: /include/autogenerated/bareos-tray-monitor-resource-monitor-description.rst.inc

.. _DirectorResource2:
Expand All @@ -65,6 +67,8 @@ You may have multiple Director resource specifications in a single Monitor confi



.. include:: /include/autogenerated/bareos-tray-monitor-resource-director-table.rst.inc

.. include:: /include/autogenerated/bareos-tray-monitor-resource-director-description.rst.inc

.. _ClientResource1:
Expand Down Expand Up @@ -92,6 +96,8 @@ You may have multiple Director resource specifications in a single Monitor confi



.. include:: /include/autogenerated/bareos-tray-monitor-resource-client-table.rst.inc

.. include:: /include/autogenerated/bareos-tray-monitor-resource-client-description.rst.inc

.. _StorageResource1:
Expand Down Expand Up @@ -123,6 +129,8 @@ You may have multiple Director resource specifications in a single Monitor confi



.. include:: /include/autogenerated/bareos-tray-monitor-resource-storage-table.rst.inc

.. include:: /include/autogenerated/bareos-tray-monitor-resource-storage-description.rst.inc

Tray Monitor
Expand Down
10 changes: 10 additions & 0 deletions docs/manuals/en/new_main_reference/source/Configuration/StorageDaemon.rst
View file
Expand Up @@ -33,6 +33,8 @@ Storage Resource

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.

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

.. include:: /include/autogenerated/bareos-sd-resource-storage-description.rst.inc

The following is a typical Storage daemon storage resource definition.
Expand All @@ -59,6 +61,8 @@ Director Resource

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.

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

.. include:: /include/autogenerated/bareos-sd-resource-director-description.rst.inc

The following is an example of a valid Director resource definition:
Expand All @@ -83,6 +87,8 @@ NDMP Resource

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.

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

.. include:: /include/autogenerated/bareos-sd-resource-ndmp-description.rst.inc


Expand All @@ -96,6 +102,8 @@ Device Resource

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.

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

.. include:: /include/autogenerated/bareos-sd-resource-device-description.rst.inc

.. _mountcodes:
Expand Down Expand Up @@ -198,6 +206,8 @@ Autochanger Resource

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).

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

.. include:: /include/autogenerated/bareos-sd-resource-autochanger-description.rst.inc

The following is an example of a valid Autochanger resource definition:
Expand Down
25 changes: 25 additions & 0 deletions ...new_main_reference/source/include/autogenerated/bareos-dir-resource-catalog-table.rst.inc
View file
@@ -0,0 +1,25 @@
.. csv-table::
:header: "configuration directive name", "type of data", "default value", "remark"

:config:option:`dir/catalog/Address`\ , "*= STRING* ", "", "*alias* "
:config:option:`dir/catalog/DbAddress`\ , "= STRING", "", ""
:config:option:`dir/catalog/DbDriver`\ , "**= STRING** ", "", "**required** "
:config:option:`dir/catalog/DbName`\ , "**= STRING** ", "", "**required** "
:config:option:`dir/catalog/DbPassword`\ , "= AUTOPASSWORD", "", ""
:config:option:`dir/catalog/DbPort`\ , "= PINT32", "", ""
:config:option:`dir/catalog/DbSocket`\ , "= STRING", "", ""
:config:option:`dir/catalog/DbUser`\ , "= STRING", "", ""
:config:option:`dir/catalog/Description`\ , "= STRING", "", ""
:config:option:`dir/catalog/DisableBatchInsert`\ , "= BOOLEAN", "no", ""
:config:option:`dir/catalog/ExitOnFatal`\ , "= BOOLEAN", "no", ""
:config:option:`dir/catalog/IdleTimeout`\ , "= PINT32", "30", ""
:config:option:`dir/catalog/IncConnections`\ , "= PINT32", "1", ""
:config:option:`dir/catalog/MaxConnections`\ , "= PINT32", "5", ""
:config:option:`dir/catalog/MinConnections`\ , "= PINT32", "1", ""
:config:option:`dir/catalog/MultipleConnections`\ , "= BIT", "", ""
:config:option:`dir/catalog/Name`\ , "**= NAME** ", "", "**required** "
:config:option:`dir/catalog/Password`\ , "*= AUTOPASSWORD* ", "", "*alias* "
:config:option:`dir/catalog/Reconnect`\ , "= BOOLEAN", "no", ""
:config:option:`dir/catalog/User`\ , "*= STRING* ", "", "*alias* "
:config:option:`dir/catalog/ValidateTimeout`\ , "= PINT32", "120", ""

48 changes: 48 additions & 0 deletions .../new_main_reference/source/include/autogenerated/bareos-dir-resource-client-table.rst.inc
View file
@@ -0,0 +1,48 @@
.. csv-table::
:header: "configuration directive name", "type of data", "default value", "remark"

:config:option:`dir/client/Address`\ , "**= STRING** ", "", "**required** "
:config:option:`dir/client/AllowClientConnect`\ , "*= BOOLEAN* ", "", "*alias, deprecated* "
:config:option:`dir/client/AuthType`\ , "= AUTH_TYPE", "None", ""
:config:option:`dir/client/AutoPrune`\ , "= BOOLEAN", "no", ""
:config:option:`dir/client/Catalog`\ , "= RES", "", ""
:config:option:`dir/client/ConnectionFromClientToDirector`\ , "= BOOLEAN", "no", ""
:config:option:`dir/client/ConnectionFromDirectorToClient`\ , "= BOOLEAN", "yes", ""
:config:option:`dir/client/Description`\ , "= STRING", "", ""
:config:option:`dir/client/Enabled`\ , "= BOOLEAN", "yes", ""
:config:option:`dir/client/FdAddress`\ , "*= STRING* ", "", "*alias* "
:config:option:`dir/client/FdPassword`\ , "*= AUTOPASSWORD* ", "", "*alias* "
:config:option:`dir/client/FdPort`\ , "*= PINT32* ", "*9102* ", "*alias* "
:config:option:`dir/client/FileRetention`\ , "= TIME", "5184000", ""
:config:option:`dir/client/HardQuota`\ , "= SIZE64", "0", ""
:config:option:`dir/client/HeartbeatInterval`\ , "= TIME", "0", ""
:config:option:`dir/client/JobRetention`\ , "= TIME", "15552000", ""
:config:option:`dir/client/LanAddress`\ , "= STRING", "", ""
:config:option:`dir/client/MaximumBandwidthPerJob`\ , "= SPEED", "", ""
:config:option:`dir/client/MaximumConcurrentJobs`\ , "= PINT32", "1", ""
:config:option:`dir/client/Name`\ , "**= NAME** ", "", "**required** "
:config:option:`dir/client/NdmpBlockSize`\ , "= SIZE32", "64512", ""
:config:option:`dir/client/NdmpLogLevel`\ , "= PINT32", "4", ""
:config:option:`dir/client/NdmpUseLmdb`\ , "= BOOLEAN", "yes", ""
:config:option:`dir/client/Passive`\ , "= BOOLEAN", "no", ""
:config:option:`dir/client/Password`\ , "**= AUTOPASSWORD** ", "", "**required** "
:config:option:`dir/client/Port`\ , "= PINT32", "9102", ""
:config:option:`dir/client/Protocol`\ , "= AUTH_PROTOCOL_TYPE", "Native", ""
:config:option:`dir/client/QuotaIncludeFailedJobs`\ , "= BOOLEAN", "yes", ""
:config:option:`dir/client/SoftQuota`\ , "= SIZE64", "0", ""
:config:option:`dir/client/SoftQuotaGracePeriod`\ , "= TIME", "0", ""
:config:option:`dir/client/StrictQuotas`\ , "= BOOLEAN", "no", ""
:config:option:`dir/client/TlsAllowedCn`\ , "= STRING_LIST", "", ""
:config:option:`dir/client/TlsAuthenticate`\ , "= BOOLEAN", "no", ""
:config:option:`dir/client/TlsCaCertificateDir`\ , "= DIRECTORY", "", ""
:config:option:`dir/client/TlsCaCertificateFile`\ , "= DIRECTORY", "", ""
:config:option:`dir/client/TlsCertificate`\ , "= DIRECTORY", "", ""
:config:option:`dir/client/TlsCertificateRevocationList`\ , "= DIRECTORY", "", ""
:config:option:`dir/client/TlsCipherList`\ , "= DIRECTORY", "", ""
:config:option:`dir/client/TlsDhFile`\ , "= DIRECTORY", "", ""
:config:option:`dir/client/TlsEnable`\ , "= BOOLEAN", "yes", ""
:config:option:`dir/client/TlsKey`\ , "= DIRECTORY", "", ""
:config:option:`dir/client/TlsRequire`\ , "= BOOLEAN", "no", ""
:config:option:`dir/client/TlsVerifyPeer`\ , "= BOOLEAN", "no", ""
:config:option:`dir/client/Username`\ , "= STRING", "", ""

32 changes: 32 additions & 0 deletions ...new_main_reference/source/include/autogenerated/bareos-dir-resource-console-table.rst.inc
View file
@@ -0,0 +1,32 @@
.. csv-table::
:header: "configuration directive name", "type of data", "default value", "remark"

:config:option:`dir/console/CatalogACL`\ , "= ACL", "", ""
:config:option:`dir/console/ClientACL`\ , "= ACL", "", ""
:config:option:`dir/console/CommandACL`\ , "= ACL", "", ""
:config:option:`dir/console/Description`\ , "= STRING", "", ""
:config:option:`dir/console/FileSetACL`\ , "= ACL", "", ""
:config:option:`dir/console/JobACL`\ , "= ACL", "", ""
:config:option:`dir/console/Name`\ , "**= NAME** ", "", "**required** "
:config:option:`dir/console/Password`\ , "**= AUTOPASSWORD** ", "", "**required** "
:config:option:`dir/console/PluginOptionsACL`\ , "= ACL", "", ""
:config:option:`dir/console/PoolACL`\ , "= ACL", "", ""
:config:option:`dir/console/Profile`\ , "= RESOURCE_LIST", "", ""
:config:option:`dir/console/RunACL`\ , "= ACL", "", ""
:config:option:`dir/console/ScheduleACL`\ , "= ACL", "", ""
:config:option:`dir/console/StorageACL`\ , "= ACL", "", ""
:config:option:`dir/console/TlsAllowedCn`\ , "= STRING_LIST", "", ""
:config:option:`dir/console/TlsAuthenticate`\ , "= BOOLEAN", "no", ""
:config:option:`dir/console/TlsCaCertificateDir`\ , "= DIRECTORY", "", ""
:config:option:`dir/console/TlsCaCertificateFile`\ , "= DIRECTORY", "", ""
:config:option:`dir/console/TlsCertificate`\ , "= DIRECTORY", "", ""
:config:option:`dir/console/TlsCertificateRevocationList`\ , "= DIRECTORY", "", ""
:config:option:`dir/console/TlsCipherList`\ , "= DIRECTORY", "", ""
:config:option:`dir/console/TlsDhFile`\ , "= DIRECTORY", "", ""
:config:option:`dir/console/TlsEnable`\ , "= BOOLEAN", "yes", ""
:config:option:`dir/console/TlsKey`\ , "= DIRECTORY", "", ""
:config:option:`dir/console/TlsRequire`\ , "= BOOLEAN", "no", ""
:config:option:`dir/console/TlsVerifyPeer`\ , "= BOOLEAN", "no", ""
:config:option:`dir/console/UsePamAuthentication`\ , "= BOOLEAN", "no", ""
:config:option:`dir/console/WhereACL`\ , "= ACL", "", ""

10 changes: 10 additions & 0 deletions ...new_main_reference/source/include/autogenerated/bareos-dir-resource-counter-table.rst.inc
View file
@@ -0,0 +1,10 @@
.. csv-table::
:header: "configuration directive name", "type of data", "default value", "remark"

:config:option:`dir/counter/Catalog`\ , "= RES", "", ""
:config:option:`dir/counter/Description`\ , "= STRING", "", ""
:config:option:`dir/counter/Maximum`\ , "= PINT32", "2147483647", ""
:config:option:`dir/counter/Minimum`\ , "= INT32", "0", ""
:config:option:`dir/counter/Name`\ , "**= NAME** ", "", "**required** "
:config:option:`dir/counter/WrapCounter`\ , "= RES", "", ""

4 changes: 4 additions & 0 deletions .../new_main_reference/source/include/autogenerated/bareos-dir-resource-device-table.rst.inc
View file
@@ -0,0 +1,4 @@
.. csv-table::
:header: "configuration directive name", "type of data", "default value", "remark"


0 comments on commit 3a250aa

Please sign in to comment.