* Added the alteeve-repo-setup man page and updated it to show that when called with '-h'.

* Updated scancore to use the new Get->switches() list parameter.

Signed-off-by: Digimer <digimer@alteeve.ca>
main
Digimer 2 years ago
parent d9910fc951
commit b3b185a43c
  1. 4
      man/Makefile.am
  2. 52
      man/alteeve-repo-setup.8
  3. 2
      man/anvil-daemon.8
  4. 32
      man/scancore.8
  5. 22
      tools/anvil-daemon
  6. 5
      tools/scancore

@ -7,4 +7,6 @@ dist_man5_MANS = \
anvil.conf.5
dist_man8_MANS = \
anvil-daemon.8
alteeve-repo-setup.8 \
anvil-daemon.8 \
scancore.8

@ -0,0 +1,52 @@
.\" Manpage for the Alteeve! repo setup tool
.\" Contact mkelly@alteeve.com to report issues, concerns or suggestions.
.TH alteeve-repo-setup "8" "August 02 2022" "Anvil! Intelligent Availability™ Platform"
.SH NAME
alteeve-repo-setup \- Tool used to configure the Anvil! repository.
.SH SYNOPSIS
.B alteeve-repo-setup
\fI\,<command> \/\fR[\fI\,options\/\fR]
.SH DESCRIPTION
alteeve-repo-setup \- This tool configures the local repository needed to install the Anvil! Intelligent Availability™ platform. The repository will be based on the OS running on this system. For example, if the host is RHEL 8, the repo will be configured for 'rhel-8'. Similarly, if this host is CentOS 8 Stream, the repo will be configured for 'centos-8-stream'.
.TP
There are two main repos for the Anvil! system;
.TP
- community: This repo is free for use, and tracks the latest available release of the Anvil! platform.
.TP
For support on the Community version is provided through;
.TP
* Alteeve Wiki - https://wiki.alteeve.com/
.TP
* Alteeve Support - https://www.alteeve.com/c/supportandresources/contact-support/
.TP
* ClusterLabs Users - https://lists.clusterlabs.org/mailman/listinfo/users
.TP
* ClusterLabs on Libera Chat's #clusterlabs channel
.TP
- enterprise: This repo has additional testing and hardening, but is slower to get new features.
.TP
To access our enterprise repository with Alteeve support please visit:
.TP
* https://www.alteeve.com/c/supportandresources/contact-support/
.SH OPTIONS
.TP
\-?, \-h, \fB\-\-help\fR
Show this man page.
.TP
\fB\-\-log-secure\fR
When logging, record sensitive data, like passwords.
.TP
\-d, \fB\-\-debug\fR
This tool does not use the main Anvil::Tools modules, so debugging is limited to messaged shown during the run. This enables those debug messages.
.SS "Commands:"
.TP
\-k, \fB\-\---key\fR <uuid>
If you have a key, provide it this way. This will configure the host to use the enterprise repository.
.TP
\-y, \fB\-\-yes\fR
Do not ask to confirm the use of the community repository.
.IP
.SH AUTHOR
Written by Madison Kelly, Alteeve staff and the Anvil! project contributors.
.SH "REPORTING BUGS"
Report bugs to users@clusterlabs.org

@ -30,7 +30,7 @@ This skips the one-time, start-up tasks and just goes into the main-loop.
This will prevent any pending jobs from being picked up and started in this run. Note that other job checks will still happen.
.TP
\fB\-\-run-once\fR
This will tell the program to exit after runn the main loop once.
This will tell the program to exit after running the main loop once.
.TP
\fB\-\-startup-only\fR
This will tell the program to exit after running the start up tasks, so the main loop won't run.

@ -0,0 +1,32 @@
.\" Manpage for the ScanCore daemon.
.\" Contact mkelly@alteeve.com to report issues, concerns or suggestions.
.TH scancore "8" "July 29 2022" "Anvil! Intelligent Availability™ Platform"
.SH NAME
scancore \- ScanCore systemd daemon for the M3 Anvil! Cluster.
.SH SYNOPSIS
.B scancore
\fI\,<command> \/\fR[\fI\,options\/\fR]
.SH DESCRIPTION
scancore \- ScanCore provides all of the decision engine logic that provides all of the autonomous operation logic. How exactly it behaves depends on whether it is running on a Striker dashboard, Anvil! sub-node or DR host.
.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\-\-purge\fR
If passed, all scancore agents will be invoked with '\fB\-\-purge\fR'. This will cause all ScanCore data to be purged from the databases.
.TP
\fB\-\-run-once\fR
This will tell the program to exit after one run of all scan agents and after doing to post-scan logic.
.IP
.SH AUTHOR
Written by Madison Kelly, Alteeve staff and the Anvil! project contributors.
.SH "REPORTING BUGS"
Report bugs to users@clusterlabs.org

@ -25,28 +25,6 @@
# - For later; 'reboot --force --force' immediately kills the OS, like disabling ACPI on EL6 and hitting the
# power button. Might be useful in ScanCore down the road.
#
# Switches:
#
# --main-loop-only
#
# This skips the one-time, start-up tasks and just goes into the main-loop,
#
# --no-start
#
# This will prevent any pending jobs from being picked up and started in this run. Note that other job checks will still happen.
#
# --refresh-json
#
# This just updates the JSON files used by the web interface. It is the same as '--run-once --main-loop-only --no-start'
#
# --run-once
#
# This will tell the program to exit after runn the main loop once.
#
# --startup-only
#
# This will tell the program to exit after running the start up tasks, so the main loop won't run.
#
use strict;
use warnings;

@ -68,9 +68,8 @@ $anvil->data->{scancore} = {
$anvil->Storage->read_config();
# Read switches
$anvil->data->{switches}{purge} = "";
$anvil->data->{switches}{'run-once'} = "";
$anvil->Get->switches;
$anvil->Get->switches({list => ["purge", "run-once"], man => $THIS_FILE});
$anvil->Log->variables({source => $THIS_FILE, line => __LINE__, level => 2, list => $anvil->data->{switches}});
$anvil->Log->entry({source => $THIS_FILE, line => __LINE__, 'print' => 1, level => 1, key => "log_0115", variables => { program => $THIS_FILE }});
# If purging, also set 'run-once'.

Loading…
Cancel
Save