Added two more man pages.

Signed-off-by: digimer <mkelly@alteeve.ca>
main
digimer 1 year ago
parent 029f226dc5
commit f56c63fa48
  1. 2
      man/Makefile.am
  2. 35
      man/anvil-join-anvil.8
  3. 35
      man/anvil-maintenance-mode.8

@ -17,6 +17,8 @@ dist_man8_MANS = \
anvil-delete-server.8 \
anvil-download-file.8 \
anvil-file-details.8 \
anvil-join-anvil.8 \
anvil-maintenance-mode.8 \
anvil-manage-alerts.8 \
anvil-manage-dr.8 \
anvil-manage-files.8 \

@ -0,0 +1,35 @@
.\" Manpage for the Anvil! node assembly tool
.\" Contact mkelly@alteeve.com to report issues, concerns or suggestions.
.TH anvil-join-anvil "8" "August 10 2023" "Anvil! Intelligent Availability™ Platform"
.SH NAME
anvil-join-anvil \- This tool assembles two subnodes into a node.
.SH SYNOPSIS
.B anvil-join-anvil
\fI\,<command> \/\fR[\fI\,options\/\fR]
.SH DESCRIPTION
This program takes two subnodes and merges them into an Anvil! node. This can be two new subnodes, or an existing subnode with a replacement subnode after a subnode failure.
.TP
.B Note:
.TP
As if this time, this tool only runs from a job registered in the database. As such, the job must be recorded using the Striker web interface
.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
.TP
This is the job UUID that will be run.
.IP
.SH AUTHOR
Written by Madison Kelly, Alteeve staff and the Anvil! project contributors.
.SH "REPORTING BUGS"
Report bugs to users@clusterlabs.org

@ -0,0 +1,35 @@
.\" Manpage for the Anvil! maintenance mode tool.
.\" Contact mkelly@alteeve.com to report issues, concerns or suggestions.
.TH anvil-maintenance-mode "8" "Aug 10 2023" "Anvil! Intelligent Availability™ Platform"
.SH NAME
anvil-maintenance-mode \- This program manages flagging a machine in an Anvil! cluster as being in maintenance mode
.SH SYNOPSIS
.B anvil-maintenance-mode
\fI\,<command> \/\fR[\fI\,options\/\fR]
.SH DESCRIPTION
This can set or unset a machine in the Anvil! cluster as being in maintenance mode or not. When called without any switches, it reports if the machine is in maintenance mode or not.
.TP
.B Note:
.TP
Currently, "maintenance mode" is not fully implemented in the 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\-\-set\fR {0,1}
.TP
Passing '0' disables maintenance mode, '1' enables it.
.IP
.SH AUTHOR
Written by Madison Kelly, Alteeve staff and the Anvil! project contributors.
.SH "REPORTING BUGS"
Report bugs to users@clusterlabs.org
Loading…
Cancel
Save