From 7925a3f42c5fa56dd87624bafd4866332885b039 Mon Sep 17 00:00:00 2001 From: digimer Date: Mon, 21 Aug 2023 10:07:58 -0400 Subject: [PATCH] * Added more man pages. Signed-off-by: digimer --- man/anvil-manage-files.8 | 30 +++++++++++++++++++++++------- man/anvil-manage-firewall.8 | 36 ++++++++++++++++++++++++++++++++++++ man/anvil-manage-host.8 | 21 ++++++++++++--------- tools/fence_pacemaker | 4 +++- 4 files changed, 74 insertions(+), 17 deletions(-) diff --git a/man/anvil-manage-files.8 b/man/anvil-manage-files.8 index bc1a9ab5..1543fdef 100644 --- a/man/anvil-manage-files.8 +++ b/man/anvil-manage-files.8 @@ -1,8 +1,11 @@ -.\" Manpage for the Anvil! server removal tool +.\" Manpage for the Anvil! file management tool .\" Contact mkelly@alteeve.com to report issues, concerns or suggestions. .TH anvil-manage-files "8" "August 02 2022" "Anvil! Intelligent Availability™ Platform" .SH NAME anvil-manage-files \- This program manages the files sync'ed across machines in the Anvil! cluster +.TP +.B Note: +This tool is not yet complete. .SH SYNOPSIS .B anvil-manage-files \fI\, \/\fR[\fI\,options\/\fR] @@ -21,18 +24,31 @@ When logging, record sensitive data, like passwords. Set the log level to 1, 2 or 3 respectively. Be aware that level 3 generates a significant amount of log data. .SS "Commands:" .TP +\fB\-\-add\fR +(not implemented yet) +.TP +\fB\-\-check\fR +This runs a check for files that need to be processed (added, deleted, etc). +.TP \fB\-\-delete\fR This will delete the \fB\-\-file\fR from the entire Anvil! cluster. .TP -This action is permanent! +\fB\-\-download\fR +(not implemented yet) +.TP +\fB\-\-file\fR +This is the file being worked on. +.TP +\fB\-\-is\-script\fR +When set, the file is marked as a script or program. Files marked this way can be used in different places in the Anvil! cluster. +.TP +\fB\-\-rename\fR +The changes the name of a file. Use \fB\-\-file\fR and \fB\-\-to\fR . .TP -\fB\-\-job\-uuid\fR -The program is normally run as a job, with data on how to configure the host defined in the job. This switch allows the running of a specific job. If this is not set, the program will search for a job that has not yet been picked up by another process. If found, that job UUID is used automatically. +\fB\-\-to\fR +The is the new file name that's being changed. .IP .SH AUTHOR Written by Madison Kelly, Alteeve staff and the Anvil! project contributors. .SH "REPORTING BUGS" Report bugs to users@clusterlabs.org - - -", "download", "everywhere", "file", "is-script", "job-uuid", "rename", "to \ No newline at end of file diff --git a/man/anvil-manage-firewall.8 b/man/anvil-manage-firewall.8 index e69de29b..6447b727 100644 --- a/man/anvil-manage-firewall.8 +++ b/man/anvil-manage-firewall.8 @@ -0,0 +1,36 @@ +.\" Manpage for the Anvil! firewall management tool +.\" Contact mkelly@alteeve.com to report issues, concerns or suggestions. +.TH anvil-manage-firewall "8" "August 02 2022" "Anvil! Intelligent Availability™ Platform" +.SH NAME +anvil-manage-firewall \- This program manages the firewall rules on the host. +.TP +.B Note: +This tool is not yet complete. +.SH SYNOPSIS +.B anvil-manage-firewall +\fI\, \/\fR[\fI\,options\/\fR] +.SH DESCRIPTION +This handles dynamically opening and closing ports on the firewall of the various machines in an Anvil! cluster. +.TP +.SH OPTIONS +.TP +\-?, \-h, \fB\-\-help\fR +Show this man page. +.TP +\fB\-\-log-secure\fR +When logging, record sensitive data, like passwords. +.TP +\-v, \-vv, \-vvv +Set the log level to 1, 2 or 3 respectively. Be aware that level 3 generates a significant amount of log data. +.SS "Commands:" +.TP +\fB\-\-job\-uuid\fR +This is the UUID for a job being run. +.TP +\fB\-\-server\fR +This opens or closes the VNC and DRBD ports related to a server +.IP +.SH AUTHOR +Written by Madison Kelly, Alteeve staff and the Anvil! project contributors. +.SH "REPORTING BUGS" +Report bugs to users@clusterlabs.org diff --git a/man/anvil-manage-host.8 b/man/anvil-manage-host.8 index 366a5319..1b85f0e1 100644 --- a/man/anvil-manage-host.8 +++ b/man/anvil-manage-host.8 @@ -1,13 +1,13 @@ .\" Manpage for the Anvil! server boot program .\" Contact mkelly@alteeve.com to report issues, concerns or suggestions. -.TH anvil-manage-host "8" "Octobober 12 2023" "Anvil! Intelligent Availability™ Platform" +.TH anvil-manage-host "8" "October 12 2023" "Anvil! Intelligent Availability™ Platform" .SH NAME anvil-manage-host \- Tool used to check or set various configuration options for a host. .SH SYNOPSIS .B anvil-manage-host \fI\, \/\fR[\fI\,options\/\fR] .SH DESCRIPTION - +This tool provides a way to perform actions on a host that normally are handled by other processes, like marking a system as configure, etc. This will likely grow constantly over time. .TP .SH OPTIONS .TP @@ -22,7 +22,7 @@ Set the log level to 1, 2 or 3 respectively. Be aware that level 3 generates a s .SS "Commands:" .TP \fB\-\-age\-out\-database\fR -This requests the database check for records that are too old and purge them. +This searches the database(s) for data that is old enough that it's no longer needed and deletes it from the database. This helps with the performance of resync operations in particular. .TP \fB\-\-auto\-grow\-pv\fR This looks at LVM physical volumes on the local host. For each one that is found, 'parted' is called to check if there's more that 1 GiB of free space available after it. If so, it will extend the PV partition to use the free space. @@ -30,25 +30,28 @@ This looks at LVM physical volumes on the local host. For each one that is found If you deleted the default '/home' partition during the install of a subnode or DR host, this should give you that space back. .TP \fB\-\-check\-configured\fR -Check to see if the host is marked as configured or yet. +This reports if the host is marked as configured yet or not. .TP \fB\-\-check\-database\fR -This checks to see if the database is enabled or not. +This reports if the database on the local Striker is active or inactive. .TP \fB\-\-confirm\fR This confirms actions that would normally prompt the user to confirm before proceeding. .TP \fB\-\-database\-active\fR -This enables the database on the local Striker dashboard. +This marks the local database to be active. .TP \fB\-\-database\-inactive\fR -This disables the database on the local Striker dashboard. +This marks the local database to be inactive. .TP \fB\-\-mark\-configured\fR -This marks the host as having been configured. +This marks the local system as being configured. This should be used carefully. +.TP +\fB\-\-mark\-unconfigured\fR +This marks the local system as being unconfigured. This should be used carefully. .TP \fB\-\-resync\-database\fR -This forces a database resync if two or more strikers are online. +This forces the databases to be resync'ed, even if they seem synced. .IP .SH AUTHOR Written by Madison Kelly, Alteeve staff and the Anvil! project contributors. diff --git a/tools/fence_pacemaker b/tools/fence_pacemaker index 3d5dec60..af7555f9 100755 --- a/tools/fence_pacemaker +++ b/tools/fence_pacemaker @@ -37,6 +37,8 @@ # - 7 = Fence succeeded # # TODO: +# - Move Cluster->_set_server_constraint() to call here at the same time as we ban the peer. +# # - Read the CIB; 'pcs status xml' or '/usr/sbin/cibadmin --local --query' ? # -- Map the peer's name in pacemaker. # -- Verify that stonith is enabled: @@ -44,7 +46,7 @@ # -- Verify that we're quorate (a-la pacemaker): # - Verify that the resource is 'resource-and-stonith' # - Verify that the resource is 'UpToDate' (if not, should we suicide to give the other node priority, regardless of fence delay? what if both nodes have resources that are not UpToDate?) -# - +# ### NOTE: This doesn't use Anvil::Tools on purpose. We want to be quick and depend on as few things as ### possible.