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.

Sign up for GitHub

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

Jump to bottom

feat: audit scanner docs. #199

Merged
merged 7 commits into from
Sep 11, 2023
Merged

feat: audit scanner docs. #199

merged 7 commits into from
Sep 11, 2023

Conversation

jvanz
Copy link
Member

@jvanz jvanz commented Jul 11, 2023

Description

Adds documentation about the new Kubewarden component, the Audit Scanner. The docs explain what is it, how to use it and why it is useful.

Fix #198

@jvanz jvanz added area/documentation Improvements or additions to documentation kind/enhancement labels Jul 11, 2023
@jvanz jvanz requested a review from a team July 11, 2023 13:13
@jvanz jvanz requested a review from a team as a code owner July 11, 2023 13:13
@jvanz jvanz self-assigned this Jul 11, 2023
@netlify
Copy link

netlify bot commented Jul 11, 2023 •
edited
Loading

❌ Deploy Preview for silly-bunny-8cedd0 failed.

Name Link
🔨 Latest commit 7596757
🔍 Latest deploy log https://app.netlify.com/sites/silly-bunny-8cedd0/deploys/64ff11241c9d9b0008004605

@viccuad viccuad marked this pull request as draft July 11, 2023 13:46
@viccuad
Copy link
Member

viccuad commented Jul 11, 2023 •
edited
Loading

Converted into draft, hope it's ok. Could we re-open this PR against a feat-audit feature branch? it may be a bit until we merge this, and we may have big changes to the docs structure in the meantime from reviews or new colleagues.

@jvanz jvanz requested a review from viccuad July 11, 2023 17:24
@flavio
Copy link
Member

flavio commented Jul 20, 2023

@jordojordo I'm going crazy trying to understand why netlify cannot build the preview website anymore. Looking at the logs there's an error while executing yarn build. However, everything works fine locally.

Can you please take a look, maybe we are not pushing some special yarn/packages.json file... it looks like there's a dependency missing

@jordojordo
Copy link
Member

@flavio It looks to me like there is are some conflicting packages - I believe you can remove @mdx-js/react from the dependencies list as this comes from @docusaurus/core -> @docusaurus/mdx-loader -> @mdx-js/js as a Dev Dependency.
I tested locally with removing that package and updating the lockfile and everything runs, builds, and serves correctly.
If that doesn't work you can try to add @babel/helper-get-function-arity directly, but that may lead to other package issues.

jhkrug
jhkrug reviewed Jul 20, 2023
View reviewed changes
docs/writing-policies/metadata.md Outdated Show resolved Hide resolved
docs/explanations/audit-scanner.md Outdated Show resolved Hide resolved
@jvanz jvanz requested a review from jhkrug July 20, 2023 15:53
viccuad
viccuad approved these changes Jul 21, 2023
View reviewed changes
Copy link
Member

@viccuad viccuad left a comment

Choose a reason for hiding this comment

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

LGTM, but CI is not building it again :/.

I would be ok with pushing this branch to a feature branch as it is.

jhkrug
jhkrug reviewed Jul 24, 2023
View reviewed changes
Copy link
Contributor

@jhkrug jhkrug left a comment

Choose a reason for hiding this comment

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

Some very minor suggestions while reading through.

docs/quick-start.md Outdated Show resolved Hide resolved
docs/writing-policies/metadata.md Outdated Show resolved Hide resolved
@viccuad
Copy link
Member

viccuad commented Jul 25, 2023 •
edited
Loading

The PR is ready, but shouldn't be merged directly to main (and the changes made public) as the feature has not been released yet.
Moving to blocked.

@jvanz jvanz mentioned this pull request Aug 22, 2023
Merged
@viccuad viccuad mentioned this pull request Sep 5, 2023
Closed
jvanz and others added 4 commits September 6, 2023 10:34
@jvanz
feat: audit scanner docs.
c06554a 
Adds documentation about the new Kubewarden component, the Audit
Scanner. The docs explain what is it, how to use it and why it is
useful.

Signed-off-by: José Guilherme Vanz <[email protected]>
@jvanz
Policy metadata documentation.
a4309a1 
This commit adds documentation explaining the purpose and
usage of the Kubewarden metadata file. It covers the enablement of
background audit checks, defining Kubernetes resources for policies,
specifying policy types (mutating or non-mutating), and the rules for
targeting resource types.

Signed-off-by: José Guilherme Vanz <[email protected]>
@viccuad @jhkrug @jvanz
Update docs/writing-policies/metadata.md
d4de928 
Co-authored-by: John Krug <[email protected]>
Signed-off-by: Víctor Cuadrado Juan <[email protected]>
@viccuad @jhkrug @jvanz
Update docs/quick-start.md
c5db02a 
Co-authored-by: John Krug <[email protected]>
Signed-off-by: Víctor Cuadrado Juan <[email protected]>
@jvanz
Copy link
Member Author

jvanz commented Sep 6, 2023

@kubewarden/kubewarden-documentation @kubewarden/kubewarden-developers I've added another paragraph in the explanation docs describing the endpoint the audit scanner will send the fake request and mentioning that tracing information is collected and the usual validation endpoint.

@viccuad
Copy link
Member

viccuad commented Sep 8, 2023

Flavio requested splitting this into subsections, as the current page is quite long.

@viccuad
Copy link
Member

viccuad commented Sep 8, 2023

@kubewarden/kubewarden-documentation @kubewarden/kubewarden-developers I've added another paragraph in the explanation docs describing the endpoint the audit scanner will send the fake request and mentioning that tracing information is collected and the usual validation endpoint.

I couldn't find any tracing mentions, but maybe I'm using the compare feature of GH incorrectly.
Just in case, can you point me to the changed paragraph?

@jvanz
Copy link
Member Author

jvanz commented Sep 8, 2023

@kubewarden/kubewarden-documentation @kubewarden/kubewarden-developers I've added another paragraph in the explanation docs describing the endpoint the audit scanner will send the fake request and mentioning that tracing information is collected and the usual validation endpoint.

I couldn't find any tracing mentions, but maybe I'm using the compare feature of GH incorrectly. Just in case, can you point me to the changed paragraph?

It's the last paragraph of the # Audit Scanner section (the first section)

@jvanz
Split audit scanner explanation docs.
9bd944f 
Splits the audit scanner docs into smaller pages and organize them
inside the subtopic of the explanation docs.

Signed-off-by: José Guilherme Vanz <[email protected]>
@jvanz jvanz requested a review from jhkrug September 8, 2023 14:30
@jvanz
Copy link
Member Author

jvanz commented Sep 8, 2023

@kubewarden/kubewarden-documentation @flavio I've broken the explanation docs into smaller pages. Please, review it. Thanks!

@jvanz jvanz requested a review from kravciak September 11, 2023 12:13
@flavio
Minor fixes to the audit-scanner docs
7596757 
* sidebar: open immediately the intro page when clicking on
  "explanations/audit scanner"
* minor grammar fixes

Signed-off-by: Flavio Castelli <[email protected]>
@flavio
Copy link
Member

flavio commented Sep 11, 2023

@jvanz I did some small changes via 7596757 . I think we can merge this doc, even right now. We already have some 1.7.0 documentation already published

@flavio flavio merged commit f870434 into kubewarden:main Sep 11, 2023
1 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@viccuad viccuad viccuad approved these changes

@flavio flavio flavio approved these changes

@jhkrug jhkrug Awaiting requested review from jhkrug

@kravciak kravciak Awaiting requested review from kravciak

Assignees

@jvanz jvanz

Labels
area/documentation Improvements or additions to documentation kind/enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Write docs on audit feature
6 participants
@jvanz @viccuad @flavio @jordojordo @kravciak @jhkrug