From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [IPv6:2a01:7e0:0:424::9]) by lore.proxmox.com (Postfix) with ESMTPS id 9E2FD1FF173 for ; Mon, 27 Jan 2025 15:42:07 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 0686A2CB6F; Mon, 27 Jan 2025 15:42:07 +0100 (CET) From: Maximiliano Sandoval To: pbs-devel@lists.proxmox.com Date: Mon, 27 Jan 2025 15:42:03 +0100 Message-Id: <20250127144203.480399-1-m.sandoval@proxmox.com> X-Mailer: git-send-email 2.39.5 MIME-Version: 1.0 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.108 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record T_SCC_BODY_TEXT_LINE -0.01 - Subject: [pbs-devel] [PATCH backup] docs: Add prune.cfg X-BeenThere: pbs-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Backup Server development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: Proxmox Backup Server development discussion Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: pbs-devel-bounces@lists.proxmox.com Sender: "pbs-devel" Add the manpage and documentation for the html admin guide. Signed-off-by: Maximiliano Sandoval --- debian/proxmox-backup-server.install | 1 + docs/Makefile | 2 ++ docs/conf.py | 1 + docs/config/prune/format.rst | 14 ++++++++++++++ docs/config/prune/man5.rst | 23 +++++++++++++++++++++++ docs/configuration-files.rst | 15 +++++++++++++++ src/bin/docgen.rs | 1 + 7 files changed, 57 insertions(+) create mode 100644 docs/config/prune/format.rst create mode 100644 docs/config/prune/man5.rst diff --git a/debian/proxmox-backup-server.install b/debian/proxmox-backup-server.install index ff581e3dd..a562d5e8e 100644 --- a/debian/proxmox-backup-server.install +++ b/debian/proxmox-backup-server.install @@ -40,6 +40,7 @@ usr/share/man/man5/tape-job.cfg.5 usr/share/man/man5/tape.cfg.5 usr/share/man/man5/user.cfg.5 usr/share/man/man5/verification.cfg.5 +usr/share/man/man5/prune.cfg.5 usr/share/proxmox-backup/templates/default/acme-err-body.txt.hbs usr/share/proxmox-backup/templates/default/acme-err-subject.txt.hbs usr/share/proxmox-backup/templates/default/gc-err-body.txt.hbs diff --git a/docs/Makefile b/docs/Makefile index 66da60372..c57cbbc2d 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -13,6 +13,7 @@ GENERATED_SYNOPSIS := \ config/tape/config.rst \ config/user/config.rst \ config/verification/config.rst \ + config/prune/config.rst \ pmt/synopsis.rst \ pmtx/synopsis.rst \ proxmox-backup-client/catalog-shell-synopsis.rst \ @@ -52,6 +53,7 @@ MAN5_PAGES := \ tape.cfg.5 \ user.cfg.5 \ verification.cfg.5 \ + prune.cfg.5 \ PRUNE_SIMULATOR_FILES := \ prune-simulator/index.html \ diff --git a/docs/conf.py b/docs/conf.py index 41d4ab979..a7fa10798 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -115,6 +115,7 @@ man_pages = [ ('config/tape/man5', 'tape.cfg', 'Tape Drive and Changer Configuration', [author], 5), ('config/user/man5', 'user.cfg', 'User Configuration', [author], 5), ('config/verification/man5', 'verification.cfg', 'Verification Job Configuration', [author], 5), + ('config/prune/man5', 'prune.cfg', 'Prune Job Configuration', [author], 5), ('config/notifications/man5', 'notifications.cfg', 'Notification target/matcher configuration', [author], 5), ('config/notifications-priv/man5', 'notifications-priv.cfg', 'Notification target secrets', [author], 5), ] diff --git a/docs/config/prune/format.rst b/docs/config/prune/format.rst new file mode 100644 index 000000000..104f183ef --- /dev/null +++ b/docs/config/prune/format.rst @@ -0,0 +1,14 @@ +Each entry starts with the header ``prune: ``, followed by the job +configuration options. + +:: + + prune: prune-store2 + schedule mon..fri 10:30 + store my-datastore + + prune: ... + + +You can use the ``proxmox-backup-manager prune-job`` command to manipulate this +file. diff --git a/docs/config/prune/man5.rst b/docs/config/prune/man5.rst new file mode 100644 index 000000000..121ed1847 --- /dev/null +++ b/docs/config/prune/man5.rst @@ -0,0 +1,23 @@ +:orphan: + +========= +prune.cfg +========= + +Description +=========== + +The file /etc/proxmox-backup/prune.cfg is a configuration file for Proxmox +Backup Server. It contains the prune job configuration. + +File Format +=========== + +.. include:: format.rst + +Options +======= + +.. include:: config.rst + +.. include:: ../../pbs-copyright.rst diff --git a/docs/configuration-files.rst b/docs/configuration-files.rst index 5fabf48c4..626dfa8c6 100644 --- a/docs/configuration-files.rst +++ b/docs/configuration-files.rst @@ -196,3 +196,18 @@ Options ^^^^^^^ .. include:: config/verification/config.rst + + +``prune.cfg`` +~~~~~~~~~~~~~ + +File Format +^^^^^^^^^^^ + +.. include:: config/prune/format.rst + + +Options +^^^^^^^ + +.. include:: config/prune/config.rst diff --git a/src/bin/docgen.rs b/src/bin/docgen.rs index 66d71423a..e012abe65 100644 --- a/src/bin/docgen.rs +++ b/src/bin/docgen.rs @@ -41,6 +41,7 @@ fn main() -> Result<(), Error> { "remote.cfg" => dump_section_config(&pbs_config::remote::CONFIG), "sync.cfg" => dump_section_config(&pbs_config::sync::CONFIG), "verification.cfg" => dump_section_config(&pbs_config::verify::CONFIG), + "prune.cfg" => dump_section_config(&pbs_config::prune::CONFIG), "media-pool.cfg" => dump_section_config(&pbs_config::media_pool::CONFIG), "config::acl::Role" => dump_enum_properties(&pbs_api_types::Role::API_SCHEMA)?, _ => bail!("docgen: got unknown type"), -- 2.39.5 _______________________________________________ pbs-devel mailing list pbs-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel