Skip to content

Conversation

ivelichkovich
Copy link
Contributor

What this PR does / why we need it:
Adds a flag to envtest input to enable apiserver audit logs to log to a file. This can be enabled per package to help debug test flake. Enabling it with this PR for machine package. Audit logs will log to ARTIFACTS dir.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes # #12785

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Oct 10, 2025
@k8s-ci-robot k8s-ci-robot added do-not-merge/needs-area PR is missing an area label needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Oct 10, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @ivelichkovich. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

}

func writeAuditPolicy() string {
policyFile := filepath.Join(os.Getenv("ARTIFACTS"), "audit-policy.yaml")
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Maybe another dir is preferred for the policy?

Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Member

Choose a reason for hiding this comment

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

May be for the policy we can avoid storing a copy for every test folder and just store one in ARTIFACTS

Copy link
Member

@sbueringer sbueringer Oct 14, 2025

Choose a reason for hiding this comment

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

If we ensure we don't overwrite if it already exists. Not sure what happens if one test overwrites it while an apiserver of another test reads it. I would simply use separate files. They are also pretty small.

If we just use one file and if we implement cleanup on test success I think we have to keep the file around to avoid races.

Overall I would prefer to just use separate files

Copy link
Contributor Author

Choose a reason for hiding this comment

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

set it up with separate files

policyFile := filepath.Join(os.Getenv("ARTIFACTS"), "audit-policy.yaml")

policyYAML := []byte(`
apiVersion: audit.k8s.io/v1
Copy link
Contributor Author

Choose a reason for hiding this comment

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

For machine package audit log file as is ends up at about 1.2MB so it isn't too bad so probably not a concern but if data storage is a concern a couple things:

We could restrict this further if we want, could do create/patch/update/delete only perhaps just to reduce data.

We could enable this when dealing with flake on specific packages also to reduce artifact data?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I can go ahead and enable it for the other suites too in this PR if that's wanted

Copy link
Member

Choose a reason for hiding this comment

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

See my comments below. I think they come down to that we have it automatically everywhere and that seems fine to me.

Our e2e test artifacts are much bigger, so I think it's okay

Copy link
Member

@sbueringer sbueringer Oct 13, 2025

Choose a reason for hiding this comment

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

We could also cleanup the logs after l.227 if the tests and stop succeed

@ivelichkovich ivelichkovich changed the title add ability to enable audit logs for envtest 🌱 add ability to enable audit logs for envtest Oct 10, 2025
@fabriziopandini
Copy link
Member

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Oct 10, 2025
@sbueringer sbueringer added the area/testing Issues or PRs related to testing label Oct 11, 2025
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/needs-area PR is missing an area label label Oct 11, 2025
@sbueringer sbueringer added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Oct 13, 2025
@sbueringer sbueringer changed the title 🌱 add ability to enable audit logs for envtest 🌱 Enable audit logs for envtest-based unit tests if ARTIFACTS env var is set Oct 16, 2025
@sbueringer
Copy link
Member

Thx, very nice!

/lgtm

/assign @fabriziopandini

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 16, 2025
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 9e0547f8233f56d2f3d73c16665798935a2421c4

@fabriziopandini
Copy link
Member

Nice!
/lgtm
/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: fabriziopandini

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 16, 2025
@k8s-ci-robot k8s-ci-robot merged commit a86a82a into kubernetes-sigs:main Oct 16, 2025
23 checks passed
@k8s-ci-robot k8s-ci-robot added this to the v1.12 milestone Oct 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. area/testing Issues or PRs related to testing cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants