summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMartin Styk <mastyk@redhat.com>2018-12-14 11:02:25 +0100
committerMartin Styk <mastyk@redhat.com>2018-12-14 14:38:40 +0100
commita56ff5d81d495f439a2a2abdb3f5d1a50e87aef6 (patch)
treebec8939d7938a6020e567a1d809e72a60ab3a393
parent34a07dab0242fa629a5c5210ff7d53dc32da764a (diff)
admin-guide/man: Added beaker-log-delete man page.
Architecture-guide/log-storage updated with reference Bug: 968828 Change-Id: I24c13c9459e07b84691993b4e45e595b770ffd97
-rw-r--r--documentation/admin-guide/man/beaker-log-delete.rst75
-rw-r--r--documentation/admin-guide/man/index.rst1
-rw-r--r--documentation/architecture-guide/log-storage.rst2
3 files changed, 77 insertions, 1 deletions
diff --git a/documentation/admin-guide/man/beaker-log-delete.rst b/documentation/admin-guide/man/beaker-log-delete.rst
new file mode 100644
index 0000000..00b1750
--- /dev/null
+++ b/documentation/admin-guide/man/beaker-log-delete.rst
@@ -0,0 +1,75 @@
+.. _beaker-log-delete:
+
+beaker-log-delete: Delete expired jobs
+======================================
+
+.. program:: beaker-log-delete
+
+Synopsis
+--------
+
+| :program:`beaker-log-delete` [*options*]
+
+Description
+-----------
+
+Deletes expired jobs and permanently purges log files from Beaker and/or archive server.
+
+This command reads the server configuration and connects to the database in the same way
+as the Beaker application itself does. Ensure you have configured the database
+in :file:`/etc/beaker/server.cfg` before you run this command so that it can connect to
+the database in order to find expired jobs and remove them.
+
+HTTP server must be able to handle WebDAV DELETE operations on the log directory’s base
+path (HTTP digest and Kerberos authentication are supported).
+
+To enable HTTP digest, configure account in :file:`/etc/beaker/server.cfg`::
+
+ beaker.log_delete_user = ""
+ beaker.log_delete_password = ""
+
+This command requires read access to the Beaker server configuration. Run it as root.
+
+Options
+-------
+
+.. option:: -c <path>, --config <path>
+
+ Read server configuration from <path> instead of the default /etc/beaker/server.cfg.
+
+.. option:: -v, --verbose
+
+ Print the path/URL of deleted files to stdout
+
+.. option:: --debug
+
+ Show detailed progress information and debugging messages.
+
+.. option:: --dry-run
+
+ Expired jobs are not removed.
+
+.. option:: --limit
+
+ Limit number of expired jobs whose logs will be deleted.
+
+Exit status
+-----------
+
+For normal operations the exit status is zero on success, or non-zero on error.
+
+Examples
+--------
+
+Delete first 50 expired jobs::
+
+ beaker-log-delete --limit 50
+
+Delete expired jobs and display debug messages::
+
+ beaker-log-delete --debug
+
+Expired jobs are only listed and not deleted::
+
+ beaker-log-delete --dry-run --verbose
+
diff --git a/documentation/admin-guide/man/index.rst b/documentation/admin-guide/man/index.rst
index c54cc08..cc9cff4 100644
--- a/documentation/admin-guide/man/index.rst
+++ b/documentation/admin-guide/man/index.rst
@@ -8,6 +8,7 @@ Administrative command reference
beaker-create-kickstart
beaker-import
beaker-init
+ beaker-log-delete
beaker-repo-update
beaker-usage-reminder
beaker-sync-tasks
diff --git a/documentation/architecture-guide/log-storage.rst b/documentation/architecture-guide/log-storage.rst
index b37c39f..63810de 100644
--- a/documentation/architecture-guide/log-storage.rst
+++ b/documentation/architecture-guide/log-storage.rst
@@ -16,7 +16,7 @@ You can configure the lab controller to work with an
:ref:`archive server <archive-server>`.
Beaker requires the archive server to be running a HTTP server and
`rsyncd <http://linux.die.net/man/5/rsyncd.conf>`_.
-If you wish to be able to delete log files via `beaker-log-delete`,
+If you wish to be able to delete log files via :ref:`beaker-log-delete <beaker-log-delete>`,
you must `configure <http://httpd.apache.org/docs/2.2/mod/mod_dav.html>`_
the HTTP server to handle WebDAV DELETE operations on the log directory's
base path (HTTP digest and kerberos authentication are supported by