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

falco-exporter update docs #623

Merged
merged 2 commits into from Feb 13, 2024

Conversation

alacuku
Copy link
Member

@alacuku alacuku commented Feb 13, 2024

What type of PR is this?

Uncomment one (or more) /kind <> lines:

/kind bug

/kind cleanup

/kind design

/kind documentation

/kind failing-test

/kind feature

If this PR will release a new chart version please make sure to also uncomment the following line:

/kind chart-release

Any specific area of the project related to this PR?

Uncomment one (or more) /area <> lines:

/area falco-chart

/area falco-exporter-chart

/area falcosidekick-chart

/area event-generator-chart

/area k8s-metacollector

What this PR does / why we need it:

This PR updates the docs for falco-exporter and adds the helm docs for it. Configuration values are now generated started from the values.yaml file.

Which issue(s) this PR fixes:

The falco-exporter chart was the last chart that needed to be updated to use helm-docs.

Fixes #

Special notes for your reviewer:

Checklist

  • Chart Version bumped
  • Variables are documented in the README.md
  • CHANGELOG.md updated

Furthermore, it adds the autogeneration of the configuration from the values.yaml file.

Signed-off-by: Aldo Lacuku <aldo@lacuku.eu>
Signed-off-by: Aldo Lacuku <aldo@lacuku.eu>
@poiana poiana added kind/documentation Improvements or additions to documentation dco-signoff: yes kind/chart-release Add this label when the chart version has been bumped area/falco-exporter-chart labels Feb 13, 2024
@poiana poiana added the size/XL label Feb 13, 2024
@Issif
Copy link
Member

Issif commented Feb 13, 2024

/lgtm

@poiana
Copy link
Contributor

poiana commented Feb 13, 2024

LGTM label has been added.

Git tree hash: 68d1722d0aff507f98155e7e41fc10d434c3d7d4

@Issif
Copy link
Member

Issif commented Feb 13, 2024

I don't see falcosidekick in the list of charts in the docs.yaml, is it normal?

@alacuku
Copy link
Member Author

alacuku commented Feb 13, 2024

I don't see falcosidekick in the list of charts in the docs.yaml, is it normal?

Haven't ported it yet. Gonna add it, in a subsequent PR.

@Issif
Copy link
Member

Issif commented Feb 13, 2024

I don't see falcosidekick in the list of charts in the docs.yaml, is it normal?

Haven't ported it yet. Gonna add it, in a subsequent PR.

Thanks, I just noticed because of this sentence in the desc:

The falco-exporter chart was the last chart that needed to be updated to use helm-docs.

@alacuku
Copy link
Member Author

alacuku commented Feb 13, 2024

The helm-docs PR for falcosidekick was contributed by an external contributor. It should be already in place. I just need to run some tests and see if i can add it to the CI.

@poiana
Copy link
Contributor

poiana commented Feb 13, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: alacuku, Issif

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@poiana poiana merged commit c96fdb0 into falcosecurity:master Feb 13, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved area/falco-exporter-chart dco-signoff: yes kind/chart-release Add this label when the chart version has been bumped kind/documentation Improvements or additions to documentation lgtm size/XL
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants