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: Update proposal 2 with design changes #143

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

rossf7
Copy link
Contributor

@rossf7 rossf7 commented Dec 4, 2024

What type of PR is this?

kind/documentation

What this PR does / why we need it:

Updates proposal 2 with design changes implemented in #127

Which issue(s) this PR fixes:

Fixes #117

Special notes for your reviewer (optional):

Changes are quite big so sorry the diff is hard to follow.
I also changed the diagram to mermaid based on the diagram @dipankardas011 added to proposal 1.

@rossf7 rossf7 requested a review from a team as a code owner December 4, 2024 12:39
In the example above, the Kubernetes manifest that is applied to the cluster is located in a different repository: this is the case of an externally defined benchmark

Each workflow should ensure that any artefacts that were deployed as part of the benchmark job should be deleted at the end of the test run.
Manifests in `project.json` are pinned to a Git commit SHA rather than a branch such as `main`. This mitigates the risk that a malicious workload could be included in the benchmark manifest and ensures that any changes to the manifests are reviewed by one of the Green Reviews maintainers.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@leonardpahlke @nikimanoledaki @dipankardas011 FYI I added this note on pinning manifests to SHAs following our discussion in last weeks meeting.

LMK if more detail is needed

Copy link
Contributor

Choose a reason for hiding this comment

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

I think we should add some seccomp profiles, quota limits on the namespace we are dealing with so that we don't have impact on other monitoring workloads, also we should perform some sort of image scaning before begining to start benchmarking to safeguard from any potential problems

anyways let me know your thoughts :)
I was just checking out CIS benchmark for any k8s cluster

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@dipankardas011 Those are good recommendations for securing the cluster but I think we should keep this focused on the pipeline.

The future of the cluster is uncertain. If we only provision on-demand the design is likely to be different to a permanent cluster even a single node one. So I would not invest time until the design is clear.

However your approach of being guided by the CIS benchmark is sound. It's also a good point that by running both the project components and the benchmarks in the benchmark namespace we can restrict its access.

@rossf7 rossf7 enabled auto-merge (rebase) December 4, 2024 12:55
@rossf7 rossf7 disabled auto-merge December 4, 2024 12:56
Copy link
Contributor

@dipankardas011 dipankardas011 left a comment

Choose a reason for hiding this comment

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

apart from the above comment LGTM

@rossf7 rossf7 closed this Dec 8, 2024
@rossf7 rossf7 deleted the docs/prop-3-updates branch December 8, 2024 13:56
@rossf7 rossf7 restored the docs/prop-3-updates branch December 9, 2024 09:02
@rossf7
Copy link
Contributor Author

rossf7 commented Dec 9, 2024

Sorry I closed the wrong PR 🤦‍♂️

@rossf7 rossf7 reopened this Dec 9, 2024
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.

[TRACKING] Implement Proposal 2: Run
2 participants