Update docs with 'rsync.retry.*' and 'rrdp.retry.*' conf args.

diff --git a/docs/usage.md b/docs/usage.md
index bccdd687bb55d88f3381cd21bb7fd35e9947af3c..62279c57931b818bf8c8d8450a4fd744ea61ebd9 100644 (file)
--- a/docs/usage.md
+++ b/docs/usage.md
@@ -41,16 +41,20 @@ command: fort
        30. [`--configuration-file`](#--configuration-file)
        31. [`--rrdp.enabled`](#--rrdpenabled)
        32. [`--rrdp.priority`](#--rrdppriority)
-       33. [`--rsync.enabled`](#--rsyncenabled)
-       34. [`--rsync.priority`](#--rsyncpriority)
-       35. [`--rsync.strategy`](#--rsyncstrategy)
+       33. [`--rrdp.retry.count`](#--rrdpretrycount)
+       34. [`--rrdp.retry.interval`](#--rrdpretryinterval)
+       35. [`--rsync.enabled`](#--rsyncenabled)
+       36. [`--rsync.priority`](#--rsyncpriority)
+       37. [`--rsync.strategy`](#--rsyncstrategy)
                1. [`strict`](#strict)
                2. [`root`](#root)
                3. [`root-except-ta`](#root-except-ta)
-       36. [`rsync.program`](#rsyncprogram)
-       37. [`rsync.arguments-recursive`](#rsyncarguments-recursive)
-       38. [`rsync.arguments-flat`](#rsyncarguments-flat)
-       39. [`incidences`](#incidences)
+       38. [`--rsync.retry.count`](#--rsyncretrycount)
+       39. [`--rsync.retry.interval`](#--rsyncretryinterval)
+       40. [`rsync.program`](#rsyncprogram)
+       41. [`rsync.arguments-recursive`](#rsyncarguments-recursive)
+       42. [`rsync.arguments-flat`](#rsyncarguments-flat)
+       43. [`incidences`](#incidences)
 
 ## Syntax
 
@@ -81,9 +85,13 @@ command: fort
         [--log.file-name-format=global-url|local-path|file-name]
         [--rrdp.enabled=true|false]
         [--rrdp.priority=<unsigned integer>]
+        [--rrdp.retry.count=<unsigned integer>]
+        [--rrdp.retry.interval=<unsigned integer>]
         [--rsync.enabled=true|false]
         [--rsync.priority=<unsigned integer>]
         [--rsync.strategy=strict|root|root-except-ta]
+        [--rsync.retry.count=<unsigned integer>]
+        [--rsync.retry.interval=<unsigned integer>]
         [--http.user-agent=<string>]
         [--http.connect-timeout=<unsigned integer>]
         [--http.transfer-timeout=<unsigned integer>]
@@ -587,13 +595,21 @@ The configuration options are mostly the same as the ones from the `argv` interf
 
        "rrdp": {
                "<a href="#--rrdpenabled">enabled</a>": true,
-               "<a href="#--rrdppriority">priority</a>": 50
+               "<a href="#--rrdppriority">priority</a>": 50,
+               "retry": {
+                       "<a href="#--rrdpretrycount">count</a>": 1,
+                       "<a href="#--rrdpretryinterval">interval</a>": 3
+               }
        },
 
        "rsync": {
                "<a href="#--rsyncenabled">enabled</a>": true,
                "<a href="#--rsyncpriority">priority</a>": 50,
                "<a href="#--rsyncstrategy">strategy</a>": "root",
+               "retry": {
+                       "<a href="#--rsyncretrycount">count</a>": 1,
+                       "<a href="#--rsyncretryinterval">interval</a>": 3
+               },
                "<a href="#rsyncprogram">program</a>": "rsync",
                "<a href="#rsyncarguments-recursive">arguments-recursive</a>": [
                        "--recursive",
@@ -695,6 +711,26 @@ Whenever a certificate has both RSYNC and RRDP repositories, the following crite
 - [`--rsync.priority`](#--rsyncpriority) **greater than** [`--rrdp.priority`](#--rrdppriority): use RSYNC repository URI first; if there's an error fetching data, fallback to use RRDP repository data.
 - [`--rsync.priority`](#--rsyncpriority) **less than** [`--rrdp.priority`](#--rrdppriority): use RRDP repository URI first; if there's an error fetching data, fallback to use RSYNC repository data.
 
+### `--rrdp.retry.count`
+
+- **Type:** Integer
+- **Availability:** `argv` and JSON
+- **Default:** 1
+- **Range:** 0--[`UINT_MAX`](http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/limits.h.html)
+
+Maximum number of retries whenever there's an error fetching RRDP files.
+
+A value of **0** means **no retries**.
+
+### `--rrdp.retry.interval`
+
+- **Type:** Integer
+- **Availability:** `argv` and JSON
+- **Default:** 3
+- **Range:** 0--[`UINT_MAX`](http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/limits.h.html)
+
+Period of time (in seconds) to wait between each retry to fetch an RRDP file.
+
 ### `--rsync.enabled`
 
 - **Type:** Boolean (`true`, `false`)
@@ -767,6 +803,26 @@ Synchronizes the root certificate (the one pointed by the TAL) in `strict` mode,
 
 Useful if you want `root`, but the root certificate is separated from the rest of the repository. Also useful if you don't want the validator to download the entire repository without first confirming the integrity and legitimacy of the root certificate.
 
+### `--rsync.retry.count`
+
+- **Type:** Integer
+- **Availability:** `argv` and JSON
+- **Default:** 1
+- **Range:** 0--[`UINT_MAX`](http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/limits.h.html)
+
+Maximum number of retries whenever there's an error executing an RSYNC.
+
+A value of **0** means **no retries**.
+
+### `--rsync.retry.interval`
+
+- **Type:** Integer
+- **Availability:** `argv` and JSON
+- **Default:** 3
+- **Range:** 0--[`UINT_MAX`](http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/limits.h.html)
+
+Period of time (in seconds) to wait between each retry to execute an RSYNC.
+
 ### rsync.program
 
 - **Type:** String

diff --git a/examples/config.json b/examples/config.json
index 16091b09187e27d3a79b23b22e4b5612414d1cee..ceaaaf6099722227255c2e29fa94dfbf83434b06 100644 (file)
--- a/examples/config.json
+++ b/examples/config.json
@@ -31,12 +31,20 @@
   },
   "rrdp": {
     "enabled": true,
-    "priority": 50
+    "priority": 50,
+    "retry": {
+      "count": 1,
+      "interval": 3
+    }
   },
   "rsync": {
     "enabled": true,
     "priority": 50,
     "strategy": "root",
+    "retry": {
+      "count": 1,
+      "interval": 3
+    },
     "program": "rsync",
     "arguments-recursive": [
       "--recursive",

diff --git a/man/fort.8 b/man/fort.8
index 5414674387c805004ab82dcc76a6d64a6e67683b..1f7f176ec8fd2c9cd63aefdac7cade1ab4ff963c 100644 (file)
--- a/man/fort.8
+++ b/man/fort.8
@@ -1,4 +1,4 @@
-.TH fort 8 "2019-12-18" "v1.2.0" "FORT validator"
+.TH fort 8 "2020-01-14" "v1.2.0" "FORT validator"
 
 .SH NAME
 fort \- RPKI certificate path validator and RTR server
@@ -588,6 +588,25 @@ By default, the value is \fI50\fR.
 .RE
 .P
 
+.B \-\-rrdp.retry.count=\fIUNSIGNED_INTEGER\fR
+.RS 4
+Maximum number of retries whenever there's an error fetching RRDP files.
+.P
+A value of \fI0\fR means no retries.
+.P
+By default, the value is \fI1\fR.
+.RE
+.P
+
+.B \-\-rrdp.retry.interval=\fIUNSIGNED_INTEGER\fR
+.RS 4
+Period (in seconds) to wait between retries after an error ocurred fetching
+RRDP files.
+.P
+By default, the value is \fI3\fR.
+.RE
+.P
+
 .B \-\-rsync.enabled=\fItrue\fR|\fIfalse\fR
 .RS 4
 Enables RSYNC requests.
@@ -700,6 +719,24 @@ root certificate.
 .RE
 .P
 
+.B \-\-rsync.retry.count=\fIUNSIGNED_INTEGER\fR
+.RS 4
+Maximum number of retries whenever there's an error executing RSYNC.
+.P
+A value of \fI0\fR means no retries.
+.P
+By default, the value is \fI1\fR.
+.RE
+.P
+
+.B \-\-rsync.retry.interval=\fIUNSIGNED_INTEGER\fR
+.RS 4
+Period (in seconds) to wait between retries after an RSYNC error ocurred.
+.P
+By default, the value is \fI3\fR.
+.RE
+.P
+
 .B \-\-output.roa=\fIFILE\fR
 .RS 4
 File where the ROAs will be printed in CSV format.