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

docs: improve databases documentation #7732

Merged
merged 44 commits into from
Nov 27, 2024
Merged

Conversation

itaysk
Copy link
Contributor

@itaysk itaysk commented Oct 14, 2024

Description

  • document the recently added db fallback options
  • added checks db to db documentation
  • removed unnecessary and and confusing section from air-gapped document

@itaysk itaysk requested a review from knqyf263 as a code owner October 14, 2024 17:54
@itaysk
Copy link
Contributor Author

itaysk commented Oct 14, 2024

the release note says: "Databases are downloaded in priority order until one is successful". does this mean that trivy will keep cycling through list "until one is successful"? or if it reaches the end it will error out

@itaysk itaysk marked this pull request as draft October 20, 2024 08:56
@itaysk
Copy link
Contributor Author

itaysk commented Oct 20, 2024

I wanted to incorporate the rate limiting mitigation steps post into the documentation, but after re-reading the docs I see that there's a growing overlap between the "advanced netwrok scenatios" (aka air-gap) doc, and the "Database cofiguration" doc. The way I thought about it is that the configuration document only describes the flags avaialble and technical usage, and the air gap doc talks more about the scenario and provides recommendations. Does this make sense to you? if so, I'll need to refactor both documents accordingly

@itaysk itaysk marked this pull request as ready for review October 29, 2024 16:23
@itaysk
Copy link
Contributor Author

itaysk commented Oct 29, 2024

I ended up reorganizing the configuration/db doc and the air-gapped doc, such that the db doc now documents everything related to trivy's databases, including purpose, requirements, and configuration options, and the air-gapped explains how to setup trivy in a network constraint environment. I also incorporated parts from the yet-to-be-published db throttling announcement into the relevant documents.

@itaysk itaysk requested a review from simar7 October 29, 2024 16:27
docs/docs/configuration/db.md Outdated Show resolved Hide resolved
docs/docs/configuration/db.md Outdated Show resolved Hide resolved
docs/docs/configuration/db.md Outdated Show resolved Hide resolved
docs/docs/configuration/db.md Outdated Show resolved Hide resolved
docs/docs/configuration/db.md Outdated Show resolved Hide resolved
docs/docs/advanced/air-gap.md Show resolved Hide resolved
docs/docs/advanced/air-gap.md Outdated Show resolved Hide resolved
docs/docs/advanced/air-gap.md Outdated Show resolved Hide resolved
docs/docs/advanced/air-gap.md Outdated Show resolved Hide resolved
docs/docs/advanced/air-gap.md Show resolved Hide resolved
@simar7 simar7 self-requested a review November 20, 2024 00:33
Copy link
Member

@simar7 simar7 left a comment

Choose a reason for hiding this comment

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

@itaysk it lgtm for this iteration. I think we can merge this for now and update in subsequent PRs if more changes are still needed. WDYT @knqyf263?

@itaysk
Copy link
Contributor Author

itaysk commented Nov 20, 2024

thanks for your review @wkoot !

docs/docs/advanced/air-gap.md Outdated Show resolved Hide resolved
docs/docs/advanced/air-gap.md Outdated Show resolved Hide resolved
docs/docs/advanced/self-hosting.md Show resolved Hide resolved
@knqyf263 knqyf263 mentioned this pull request Nov 26, 2024
6 tasks
@simar7 simar7 self-requested a review November 27, 2024 01:03
@knqyf263 knqyf263 added this pull request to the merge queue Nov 27, 2024
Merged via the queue into aquasecurity:main with commit 745be1a Nov 27, 2024
7 checks passed
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.

5 participants