-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: improve timerange documentation (#482)
* docs: improve timerange documentation * add a documentation section to the downloader docs for the timerange-option. * point aggregator and checker docs to the downloader section for timerange. * docs: use a better example for timerange minutes
- Loading branch information
1 parent
666913e
commit abc8b10
Showing
3 changed files
with
34 additions
and
52 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -69,35 +69,10 @@ type 2: error | |
|
||
The checker result is a success if no checks resulted in type 2, and a failure otherwise. | ||
|
||
The option `timerange` allows to only check advisories from a given time interval. | ||
It is only allowed to specify one off them. | ||
There are following variants: | ||
|
||
1. Relative. If the given string follows the rules of being a [Go duration](https://pkg.go.dev/[email protected]#ParseDuration) | ||
the time interval from now minus that duration till now is used. | ||
E.g. `"3h"` means checking the advisories that have changed in the last three hours. | ||
|
||
2. Absolute. If the given string is an RFC 3339 date timestamp the time interval between | ||
this date and now is used. | ||
E.g. `"2006-01-02"` means that all files between 2006 January 2nd and now going to be | ||
checked. | ||
Accepted patterns are: | ||
- `"2006-01-02T15:04:05Z"` | ||
- `"2006-01-02T15:04:05+07:00"` | ||
- `"2006-01-02T15:04:05-07:00"` | ||
- `"2006-01-02T15:04:05"` | ||
- `"2006-01-02T15:04"` | ||
- `"2006-01-02T15"` | ||
- `"2006-01-02"` | ||
- `"2006-01"` | ||
- `"2006"` | ||
|
||
Missing parts are set to the smallest value possible in that field. | ||
|
||
3. Range. Same as 2 but separated by a `,` to span an interval. e.g `2019,2024` | ||
spans an interval from 1st January 2019 to the 1st January of 2024. | ||
|
||
All interval boundaries are inclusive. | ||
The option `timerange` allows to only check advisories from a given time | ||
interval. It can only be given once. See the | ||
[downloader documentation](csaf_downloader.md#timerange-option) for details. | ||
|
||
|
||
You can ignore certain advisories while checking by specifying a list | ||
of regular expressions[^1] to match their URLs by using the `ignorepattern` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -79,17 +79,39 @@ forward_queue = 5 | |
forward_insecure = false | ||
``` | ||
|
||
If the `folder` option is given all the advisories are stored in a subfolder | ||
of this name. Otherwise the advisories are each stored in a folder named | ||
by the year they are from. | ||
|
||
You can ignore certain advisories while downloading by specifying a list | ||
of regular expressions[^1] to match their URLs by using the `ignorepattern` | ||
option. | ||
|
||
E.g. `-i='.*white.*' -i='*.red.*'` will ignore files which URLs contain | ||
the sub strings **white** or **red**. | ||
In the config file this has to be noted as: | ||
``` | ||
ignorepattern = [".*white.*", ".*red.*"] | ||
``` | ||
|
||
#### Timerange option | ||
|
||
The `timerange` parameter enables downloading advisories which last changes falls | ||
into a given intervall. There are three possible notations: | ||
|
||
1. Relative. If the given string follows the rules of being a [Go duration](https://pkg.go.dev/[email protected]#ParseDuration) | ||
the time interval from now minus that duration till now is used. | ||
E.g. `"3h"` means downloading the advisories that have changed in the last three hours. | ||
|
||
2. Absolute. If the given string is an RFC 3339 date timestamp the time interval between | ||
this date and now is used. | ||
1. Relative. If the given string follows the rules of a | ||
[Go duration](https://pkg.go.dev/[email protected]#ParseDuration), | ||
the time interval from now going back that duration is used. | ||
Some examples: | ||
- `"3h"` means downloading the advisories that have changed in the last three hours. | ||
- `"30m"` .. changed within the last thirty minutes. | ||
- `"72h"` .. changed within the last three days. | ||
- `"8760h"` .. changed within the last 365 days. | ||
|
||
2. Absolute. If the given string is an RFC 3339 date timestamp | ||
the time interval between this date and now is used. | ||
E.g. `"2006-01-02"` means that all files between 2006 January 2nd and now going to being | ||
downloaded. | ||
downloaded. | ||
Accepted patterns are: | ||
- `"2006-01-02T15:04:05Z"` | ||
- `"2006-01-02T15:04:05+07:00"` | ||
|
@@ -108,21 +130,6 @@ into a given intervall. There are three possible notations: | |
|
||
All interval boundaries are inclusive. | ||
|
||
If the `folder` option is given all the advisories are stored in a subfolder | ||
of this name. Otherwise the advisories are each stored in a folder named | ||
by the year they are from. | ||
|
||
You can ignore certain advisories while downloading by specifying a list | ||
of regular expressions[^1] to match their URLs by using the `ignorepattern` | ||
option. | ||
|
||
E.g. `-i='.*white.*' -i='*.red.*'` will ignore files which URLs contain | ||
the sub strings **white** or **red**. | ||
In the config file this has to be noted as: | ||
``` | ||
ignorepattern = [".*white.*", ".*red.*"] | ||
``` | ||
|
||
#### Forwarding | ||
The downloader is able to forward downloaded advisories and their checksums, | ||
OpenPGP signatures and validation results to an HTTP endpoint. | ||
|