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

Feed sync #456

Draft
wants to merge 111 commits into
base: main
Choose a base branch
from
Draft

Feed sync #456

wants to merge 111 commits into from

Conversation

syspect-sec
Copy link
Contributor

@syspect-sec syspect-sec commented Mar 7, 2024

What

The comprehensive guide to new and legacy feed sync tools is now available.

Why

Provide users with a comprehensive guide to Greenbone feed sync tooling

Checklist

  • entry added to changelog.md
  • most recent changes to greenbone/docs main branch have been merged

@syspect-sec syspect-sec requested a review from a team as a code owner March 7, 2024 05:13
@greenbonebot greenbonebot enabled auto-merge (rebase) March 7, 2024 05:13
@syspect-sec
Copy link
Contributor Author

syspect-sec commented Mar 8, 2024

Although the auto merge fails (Build the Greenbone Documentation / Build Documentation (pull_request) ) due to during the auto build, myst reports an error: /home/runner/work/docs/docs/src/feed-sync.md:37: WARNING: 'myst' cross-reference target not found: 'available-feed-types' [myst.xref_missing], the upon second compile, the docs build fine and even after the first, build, (and second) the link is active and works to redirect to the correct location.

Interestingly, although the Greenbone docs use the same syntax for inline, same page links in other places, I cannot find any reference for using the [link-text](#header-title) method on either the commonmark.org markdown tutorial, or the recommended syntax guide. Although, the [link-text](#header-title) method seems to use the standard HTML internal linking syntax to headers by name, so I guess that's why it works even though it's not officially supported?

Also, I have tracked down the issue to seems to be all fourth level header links, and I've opened an issue on the MySTParser GitHub page.

syspect-sec and others added 2 commits March 19, 2024 14:34
The greenbone-feed-sync application must be run within a
greenbone-feed-sync container. Otherwise it wont be available.
@cfi-gb
Copy link
Member

cfi-gb commented Mar 27, 2024

Note that the deprecated / old greenbone-nvt-sync has been now removed completely in the scanner with / since greenbone/openvas-scanner#1589 so some adjustments to this PR might be required.

dependabot bot and others added 12 commits April 2, 2024 06:57
Bumps the python-packages group with 3 updates: [importlib-metadata](https://github.com/python/importlib_metadata), [packaging](https://github.com/pypa/packaging) and [zipp](https://github.com/jaraco/zipp).


Updates `importlib-metadata` from 7.0.1 to 7.1.0
- [Release notes](https://github.com/python/importlib_metadata/releases)
- [Changelog](https://github.com/python/importlib_metadata/blob/main/NEWS.rst)
- [Commits](python/importlib_metadata@v7.0.1...v7.1.0)

Updates `packaging` from 23.2 to 24.0
- [Release notes](https://github.com/pypa/packaging/releases)
- [Changelog](https://github.com/pypa/packaging/blob/main/CHANGELOG.rst)
- [Commits](pypa/packaging@23.2...24.0)

Updates `zipp` from 3.17.0 to 3.18.1
- [Release notes](https://github.com/jaraco/zipp/releases)
- [Changelog](https://github.com/jaraco/zipp/blob/main/NEWS.rst)
- [Commits](jaraco/zipp@v3.17.0...v3.18.1)

---
updated-dependencies:
- dependency-name: importlib-metadata
  dependency-type: indirect
  update-type: version-update:semver-minor
  dependency-group: python-packages
- dependency-name: packaging
  dependency-type: indirect
  update-type: version-update:semver-major
  dependency-group: python-packages
- dependency-name: zipp
  dependency-type: indirect
  update-type: version-update:semver-minor
  dependency-group: python-packages
...

Signed-off-by: dependabot[bot] <[email protected]>
Bumps [idna](https://github.com/kjd/idna) from 3.6 to 3.7.
- [Release notes](https://github.com/kjd/idna/releases)
- [Changelog](https://github.com/kjd/idna/blob/master/HISTORY.rst)
- [Commits](kjd/idna@v3.6...v3.7)

---
updated-dependencies:
- dependency-name: idna
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <[email protected]>
To be able to see openvas logs more easily a new service `openvas` is
added. This service tails over `/var/log/openvas/openvas.log`.

Additionally an configuration step `configure-openvas` is added. This
sets the openvas log level to 128 and changes to log output to
`/var/log/openvas/openvas.log` instead of `/var/log/gvm/openvas.log`.

To change the log level you can replace the `128` to the desired log
level.
With greenbone/openvas-scanner#1519
notus is deprecated in favour of openvasd/notus endpoint.

For more details see: https://greenbone.github.io/scanner-api/
for a general overview of the API implemented by openvasd.

This removes the dependencies of a mqtt broker as well as notus service.
When executing docker-compose on some systems:
```
Can not open or create log file or directory. Please check permissions of log files listed in /etc/openvas/openvas_log.conf
```

occurs. To fix that we create a openvas.log upfront with the
persmissions `666`.
Fixed export variable for the path name for OpenVasd.
Bumps the python-packages group with 2 updates: [sphinx](https://github.com/sphinx-doc/sphinx) and [sphinx-autobuild](https://github.com/sphinx-doc/sphinx-autobuild).


Updates `sphinx` from 7.2.6 to 7.3.7
- [Release notes](https://github.com/sphinx-doc/sphinx/releases)
- [Changelog](https://github.com/sphinx-doc/sphinx/blob/master/CHANGES.rst)
- [Commits](sphinx-doc/sphinx@v7.2.6...v7.3.7)

Updates `sphinx-autobuild` from 2024.2.4 to 2024.4.16
- [Release notes](https://github.com/sphinx-doc/sphinx-autobuild/releases)
- [Changelog](https://github.com/sphinx-doc/sphinx-autobuild/blob/main/NEWS.rst)
- [Commits](sphinx-doc/sphinx-autobuild@2024.02.04...2024.04.16)

---
updated-dependencies:
- dependency-name: sphinx
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: python-packages
- dependency-name: sphinx-autobuild
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: python-packages
...

Signed-off-by: dependabot[bot] <[email protected]>
syspect-sec and others added 20 commits August 16, 2024 18:49
Co-authored-by: Kristin Schlosser <[email protected]>
Batch commit for changes

Co-authored-by: Kristin Schlosser <[email protected]>
The first version of a comprehensive feed synchronization documentation.
The first draft of a comprehensive Greenbone feed sync instruction manual
@syspect-sec syspect-sec requested a review from a team as a code owner August 19, 2024 06:23
@y0urself y0urself marked this pull request as draft August 26, 2024 11:00
auto-merge was automatically disabled August 26, 2024 11:00

Pull request was converted to draft

Copy link
Member

@y0urself y0urself left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I need more time for review ... but I am not fine with some formulations.

Especially the "Greenbone version" stuff is a no-go. We need to communicate our products and their versions explicitly. We do not have a "Greenbone" in version x.y ...

Will do some more suggestions, when I have time.

greenbone-feed-sync-docs.md Outdated Show resolved Hide resolved
greenbone-feed-sync-docs.md Outdated Show resolved Hide resolved
greenbone-feed-sync-docs.md Outdated Show resolved Hide resolved
greenbone-feed-sync-docs.md Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.