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

Migrating the Reports API from Kubernetes working group #2

Merged
merged 2 commits into from
Mar 19, 2025

Conversation

jvanz
Copy link
Member

@jvanz jvanz commented Mar 14, 2025

This PR is the first step in migrating the API definition from the Kubernetes Policy Working Group repository to this organization.

After copying the original files, I renamed ClusterPolicyReport to ClusterReport and PolicyReport to Report. I made these changes in the apis/reports.x-k8s.io/v1beta2 version. However, I’m wondering if we should instead implement this renaming in a new API version and take this opportunity to also change the name to apis/reports.openreports.io/v1beta2. What are your thoughts on this?

In this PR, I have not copied some directories, such as falco-adapter, kube-bench-adapter, kubearmor-adapter, oscal-transformer, and trivy-adapter. I decided to exclude them because the PR is already quite large, and I would like to review the documentation more carefully to ensure they are right (I have to familiarize with the projects use of the reports 😉 ) . For this reason, I’ll add new subtasks in issue #1 to address these components.

Important

I'll be on vacations for several days. Therefore, I'll not be able to respond in that period. Therefore, feel free to take over the PR. Maintainers should be able to change it if necessary.

jvanz added 2 commits March 14, 2025 14:36
Copy the PolicyReport API definition from the Kubernetes working group
repository to this one.

Signed-off-by: José Guilherme Vanz <[email protected]>
In order to allow a more broard usage of the Reports CRDs rename from
from (Cluster)PolicyReport to (Cluster)Report.

Signed-off-by: José Guilherme Vanz <[email protected]>
@jvanz jvanz self-assigned this Mar 14, 2025
@JimBugwadia
Copy link
Member

Thanks @jvanz! Enjoy your vacation.

@JimBugwadia
Copy link
Member

After copying the original files, I renamed ClusterPolicyReport to ClusterReport and PolicyReport to Report. I made these changes in the apis/reports.x-k8s.io/v1beta2 version. However, I’m wondering if we should instead implement this renaming in a new API version and take this opportunity to also change the name to apis/reports.openreports.io/v1beta2. What are your thoughts on this?

Yes, we should create a new openreports.io group.

In this PR, I have not copied some directories, such as falco-adapter, kube-bench-adapter, kubearmor-adapter, oscal-transformer, and trivy-adapter. I decided to exclude them because the PR is already quite large, and I would like to review the documentation more carefully to ensure they are right (I have to familiarize with the projects use of the reports 😉 ) . For this reason, I’ll add new subtasks in issue #1 to address these components.

yes, we can exclude these for now.

@JimBugwadia
Copy link
Member

I will merge this PR and then create a new one for the API group change.

@JimBugwadia JimBugwadia merged commit 88b55bc into openreports:main Mar 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants