ovh/the-bastion
1
1
Fork 0
mirror of https://github.com/ovh/the-bastion.git synced 2025-09-04 12:04:11 +08:00
Code Issues Projects Releases Packages Wiki Activity

doc: add osh-piv-grace-reaper.pl config reference

Browse source
This commit is contained in:
Stéphane Lesimple 2021-07-30 11:53:33 +00:00 • committed by Stéphane Lesimple
parent 9f28dfa977
commit 92d4a46ac5
3 changed files with 52 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
bin/cron/osh-piv-grace-reaper.pl
View file

@ -27,8 +27,12 @@ else {
}
}
# set default values
$config = {} if ref $config ne 'HASH';
$config->{'SyslogFacility'} //= 'local6';
# logging
if ($config && $config->{'SyslogFacility'}) {
if ($config->{'SyslogFacility'}) {
OVH::SimpleLog::setSyslog($config->{'SyslogFacility'});
}

35
doc/sphinx/administration/configuration/osh-piv-grace-reaper_conf.rst Normal file
View file

@ -0,0 +1,35 @@
===================================
osh-piv-grace-reaper.conf reference
===================================
.. note::
The osh-piv-grace-reaper script is called by cron and is responsible for removing
temporary grace periods on PIV policies, once they expire. If you don't use PIV keys,
this script won't do anything (see :doc:`/using/piv`).
Option List
===========
Logging options
---------------
These options configure the way the script logs its actions
- `SyslogFacility`_
Option Reference
================
Logging
-------
SyslogFacility
**************
:Type: ``string``
:Default: ``local6``
The syslog facility to use for logging the script output. If set to the empty string, we'll not log through syslog at all. If this configuration option is missing from your config file altogether, the default value will be used (local6), which means that we'll log to syslog.

13
etc/bastion/osh-piv-grace-reaper.conf.dist
View file

@ -1,3 +1,14 @@
###################################################################
## Config for /opt/bastion/bin/cron/osh-piv-grace-reaper.pl, the script
## responsible for expiring the grace period of relaxed PIV policies.
## This is a JSON file.
###################################################################
{
"SyslogFacility": "local6"
# > Logging
# >> These options configure the way the script logs its actions
#
# SyslogFacility (string)
# DESC: The syslog facility to use for logging the script output. If set to the empty string, we'll not log through syslog at all. If this configuration option is missing from your config file altogether, the default value will be used (local6), which means that we'll log to syslog.
# DEFAULT: local6
"SyslogFacility": "local6"
}