Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: Adjust container workflow for manual feed sync #412

Merged
merged 2 commits into from
Oct 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 44 additions & 11 deletions src/22.4/container/manual-feed-sync.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,36 @@
## Performing a Manual Feed Sync

It is possible to do a manual feed sync using {command}`rsync`.
It is possible to do a manual feed sync using {command}`rsync` instead of
pulling the current feed content via the newest container images.

```{warning}
Please be aware that the manually synced data will be overridden if the data
containers are (re-)started.
```

For the manual feed sync, the [`greenbone-feed-sync`](https://github.com/greenbone/greenbone-feed-sync/)
script will be used. The `greenbone-feed-sync` script is also provided via a
container image. Using the container image requires extending the docker compose
file as follows:

```{code-block} yaml
---
caption: Extending the docker compose file for performing a manual feed sync using
the greenbone-feed-sync script
---
...
greenbone-feed-sync:
image: greenbone/greenbone-feed-sync
volumes:
- vt_data_vol:/var/lib/openvas/plugins
- notus_data_vol:/var/lib/notus
- gvmd_data_vol:/var/lib/gvm
- scap_data_vol:/var/lib/gvm/scap-data
- cert_data_vol:/var/lib/gvm/cert-data
- data_objects_vol:/var/lib/gvm/data-objects/gvmd
...
```

### Syncing Vulnerability Tests

VT data contains {file}`.nasl` and {file}`.notus` files for creating results
Expand All @@ -20,42 +44,51 @@ available for 22.4.

```{code-block} shell
---
caption: Syncing {term}`VTs<VT>` processed by the scanner, this will take a while.
caption: Downloading {term}`NASL<NASL>` {term}`VTs<VT>` processed by the
ospd-openvas scanner, this will take a while.
---
docker compose -f $DOWNLOAD_DIR/docker-compose.yml -p greenbone-community-edition \
run --rm ospd-openvas greenbone-nvt-sync
run --rm greenbone-feed-sync greenbone-feed-sync --type nasl
```

```{code-block} shell
---
caption: Downloading {term}`notus<notus-scanner>` {term}`VTs<VT>` processed by
the Notus Scanner, this will take a while.
---
docker compose -f $DOWNLOAD_DIR/docker-compose.yml -p greenbone-community-edition \
run --rm greenbone-feed-sync greenbone-feed-sync --type notus
```
### Syncing SCAP, CERT and GVMD Data

{term}`SCAP` data contains {term}`CPE` and {term}`CVE` information.

```{code-block} shell
---
caption: Syncing SCAP data processed by gvmd, this will take a while
caption: Downloading SCAP data processed by gvmd, this will take a while
---
docker compose -f $DOWNLOAD_DIR/docker-compose.yml -p greenbone-community-edition \
run --rm gvmd greenbone-feed-sync --type SCAP
run --rm greenbone-feed-sync greenbone-feed-sync --type scap
```

CERT data contains vulnerability information from the German [DFN-CERT](https://www.dfn-cert.de/)
and [CERT-Bund](https://cert-bund.de/) agencies.

```{code-block} shell
---
caption: Syncing CERT data processed by gvmd
caption: Downloading CERT data processed by gvmd
---
docker compose -f $DOWNLOAD_DIR/docker-compose.yml -p greenbone-community-edition \
run --rm gvmd greenbone-feed-sync --type CERT
run --rm greenbone-feed-sync greenbone-feed-sync --type cert
```

gvmd data (or also called data-objects) are scan configurations, compliance policies, port lists
and report formats.
gvmd data (or also called data-objects) are scan configurations, compliance
policies, port lists and report formats.

```{code-block} shell
---
caption: Syncing data objects processed by gvmd
caption: Downloading data objects processed by gvmd
---
docker compose -f $DOWNLOAD_DIR/docker-compose.yml -p greenbone-community-edition \
run --rm gvmd greenbone-feed-sync --type GVMD_DATA
run --rm gvmd greenbone-feed-sync --type gvmd-data
```
2 changes: 1 addition & 1 deletion src/22.4/container/workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ done automatically when the daemons are running.
The data of the {term}`Greenbone Community Feed` is provided via several
container images. When these images are started, they copy the data into the used
docker volumes automatically. Afterwards, the data is picked up from the
volumes by the running daemons .
volumes by the running daemons.

To download the latest feed data container images run

Expand Down
1 change: 1 addition & 0 deletions src/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ and this project adheres to [Calendar Versioning](https://calver.org).
* Only run gsad on 127.0.0.1 for the community containers setup
* Add workflow for container setup on howto access GSA/gsad remotely
* Fix log warning from tini init server in the ospd-openvas container
* Fix manual feed sync workflow for the container setup

## 23.9.0 - 23-09-23
* Update pg-gvm to 22.6.1
Expand Down