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

Clean up resource labels, names, and namespaces #119

Merged
merged 4 commits into from
Apr 3, 2025
Merged

Clean up resource labels, names, and namespaces #119

merged 4 commits into from
Apr 3, 2025

Conversation

carbonin
Copy link
Contributor

@carbonin carbonin commented Apr 1, 2025 •
edited by coderabbitai bot
Loading

  • Remove unnecessary labels on resources
  • Rename namePrefix and namespace to match the repo rename
  • Ensure labels and selectors are unique to the provider (for when they run in the same namespace)

Summary by CodeRabbit

  • Chores

    • Updated naming standards and namespaces to align resource labels with the new convention.
    • Removed obsolete configuration files and metadata labels for a cleaner deployment setup.

  • Refactor

    • Streamlined configuration details by eliminating redundant comments and labels.
    • Adjusted selectors and metadata for improved consistency across deployment components.

@openshift-ci openshift-ci bot requested review from eranco74 and rccrdpccl April 1, 2025 20:57
@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 1, 2025
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Apr 1, 2025 •
edited
Loading

Walkthrough

The pull request updates Kubernetes resource configurations by renaming resources and standardizing naming conventions. Namespace, service accounts, roles, bindings, services, and deployments are renamed from the "capi-agent" prefix to "capoa". Additionally, extraneous metadata labels and commented sections were removed, and two obsolete manager configuration patch files were deleted. Both bootstrap and controlplane components were updated consistently without modifying core functionality.

Changes

File(s) Change Summary
bootstrap-components.yaml Renamed namespace and resources from capi-agent-* to capoa-*, updated selectors, and removed metadata labels.
bootstrap/config/default/kustomization.yaml Removed namespace and namePrefix fields.
bootstrap/config/default/manager_config_patch.yaml File removed.
bootstrap/config/manager/manager.yaml Removed metadata labels, updated control-plane labels to capoa-bootstrap-controller-manager, and removed commented sections.
bootstrap/config/prometheus/monitor.yaml Removed extraneous labels and updated matchLabels for control-plane to the new naming.
bootstrap/config/rbac/* Removed metadata labels across various RBAC YAMLs; updated selectors (e.g., in auth_proxy_service.yaml).
controlplane-components.yaml Renamed resources from capi-agent-controlplane-* to capoa-controlplane-* and removed associated labels.
controlplane/config/default/kustomization.yaml Removed namespace and namePrefix fields.
controlplane/config/default/manager_config_patch.yaml File removed.
controlplane/config/manager/manager.yaml Removed metadata labels and commented sections; updated control-plane labels to capoa-controlplane-controller-manager.
controlplane/config/prometheus/monitor.yaml Removed extraneous labels and updated matchLabels for control-plane to the new naming.
controlplane/config/rbac/* Removed metadata labels across multiple RBAC YAML files; updated selectors where applicable (e.g., in auth_proxy_service.yaml).
Makefile Updated role names for manager-role to capoa-bootstrap-manager-role and capoa-controlplane-manager-role.
bootstrap/config/default/manager_auth_proxy_patch.yaml Updated deployment name and namespace to capoa-bootstrap-controller-manager and capoa-system.
bootstrap/config/rbac/role.yaml Updated ClusterRole name from manager-role to capoa-bootstrap-manager-role.
controlplane/config/default/manager_auth_proxy_patch.yaml Updated deployment name and namespace to capoa-controlplane-controller-manager and capoa-system.
controlplane/config/rbac/role.yaml Updated ClusterRole name from manager-role to capoa-controlplane-manager-role.

Suggested labels

lgtm, size/L

Suggested reviewers

  • rccrdpccl
  • gamli75

Poem

I'm a rabbit in the YAML field, hopping light and free,
Seeing names reborn from old to capoa with glee.
Labels vanish, clean and neat, like fresh dewy morn,
A digital garden now well-tended, newly reborn.
With every hop amid these changes, I cheer—sniff, twirl, and adorn!

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e30768c and 37b4864.

📒 Files selected for processing (37)
  • Makefile (1 hunks)
  • bootstrap-components.yaml (7 hunks)
  • bootstrap/config/default/kustomization.yaml (0 hunks)
  • bootstrap/config/default/manager_auth_proxy_patch.yaml (1 hunks)
  • bootstrap/config/default/manager_config_patch.yaml (0 hunks)
  • bootstrap/config/manager/manager.yaml (2 hunks)
  • bootstrap/config/prometheus/monitor.yaml (2 hunks)
  • bootstrap/config/rbac/auth_proxy_client_clusterrole.yaml (1 hunks)
  • bootstrap/config/rbac/auth_proxy_role.yaml (1 hunks)
  • bootstrap/config/rbac/auth_proxy_role_binding.yaml (1 hunks)
  • bootstrap/config/rbac/auth_proxy_service.yaml (1 hunks)
  • bootstrap/config/rbac/leader_election_role.yaml (1 hunks)
  • bootstrap/config/rbac/leader_election_role_binding.yaml (1 hunks)
  • bootstrap/config/rbac/openshiftassistedconfig_editor_role.yaml (1 hunks)
  • bootstrap/config/rbac/openshiftassistedconfig_viewer_role.yaml (1 hunks)
  • bootstrap/config/rbac/openshiftassistedconfigtemplate_editor_role.yaml (1 hunks)
  • bootstrap/config/rbac/openshiftassistedconfigtemplate_viewer_role.yaml (1 hunks)
  • bootstrap/config/rbac/role.yaml (1 hunks)
  • bootstrap/config/rbac/role_binding.yaml (1 hunks)
  • bootstrap/config/rbac/service_account.yaml (1 hunks)
  • controlplane-components.yaml (7 hunks)
  • controlplane/config/default/kustomization.yaml (0 hunks)
  • controlplane/config/default/manager_auth_proxy_patch.yaml (1 hunks)
  • controlplane/config/default/manager_config_patch.yaml (0 hunks)
  • controlplane/config/manager/manager.yaml (2 hunks)
  • controlplane/config/prometheus/monitor.yaml (2 hunks)
  • controlplane/config/rbac/auth_proxy_client_clusterrole.yaml (1 hunks)
  • controlplane/config/rbac/auth_proxy_role.yaml (1 hunks)
  • controlplane/config/rbac/auth_proxy_role_binding.yaml (1 hunks)
  • controlplane/config/rbac/auth_proxy_service.yaml (1 hunks)
  • controlplane/config/rbac/controlplane_openshiftassistedcontrolplane_editor_role.yaml (1 hunks)
  • controlplane/config/rbac/controlplane_openshiftassistedcontrolplane_viewer_role.yaml (1 hunks)
  • controlplane/config/rbac/leader_election_role.yaml (1 hunks)
  • controlplane/config/rbac/leader_election_role_binding.yaml (1 hunks)
  • controlplane/config/rbac/role.yaml (1 hunks)
  • controlplane/config/rbac/role_binding.yaml (1 hunks)
  • controlplane/config/rbac/service_account.yaml (1 hunks)
💤 Files with no reviewable changes (4)
  • controlplane/config/default/manager_config_patch.yaml
  • bootstrap/config/default/manager_config_patch.yaml
  • bootstrap/config/default/kustomization.yaml
  • controlplane/config/default/kustomization.yaml
🚧 Files skipped from review as they are similar to previous changes (30)
  • bootstrap/config/rbac/role.yaml
  • controlplane/config/rbac/role.yaml
  • bootstrap/config/rbac/auth_proxy_role.yaml
  • controlplane/config/rbac/auth_proxy_client_clusterrole.yaml
  • bootstrap/config/default/manager_auth_proxy_patch.yaml
  • bootstrap/config/rbac/openshiftassistedconfig_viewer_role.yaml
  • controlplane/config/default/manager_auth_proxy_patch.yaml
  • bootstrap/config/rbac/auth_proxy_client_clusterrole.yaml
  • bootstrap/config/rbac/openshiftassistedconfigtemplate_editor_role.yaml
  • controlplane/config/rbac/auth_proxy_role.yaml
  • bootstrap/config/rbac/openshiftassistedconfigtemplate_viewer_role.yaml
  • bootstrap/config/rbac/auth_proxy_role_binding.yaml
  • controlplane/config/rbac/auth_proxy_service.yaml
  • Makefile
  • bootstrap/config/rbac/service_account.yaml
  • controlplane/config/rbac/leader_election_role.yaml
  • controlplane/config/prometheus/monitor.yaml
  • bootstrap/config/rbac/auth_proxy_service.yaml
  • bootstrap/config/rbac/role_binding.yaml
  • controlplane/config/rbac/controlplane_openshiftassistedcontrolplane_viewer_role.yaml
  • bootstrap/config/rbac/leader_election_role_binding.yaml
  • controlplane/config/rbac/service_account.yaml
  • controlplane-components.yaml
  • controlplane/config/rbac/role_binding.yaml
  • controlplane/config/rbac/auth_proxy_role_binding.yaml
  • bootstrap-components.yaml
  • controlplane/config/rbac/leader_election_role_binding.yaml
  • bootstrap/config/prometheus/monitor.yaml
  • controlplane/config/rbac/controlplane_openshiftassistedcontrolplane_editor_role.yaml
  • bootstrap/config/rbac/openshiftassistedconfig_editor_role.yaml
🔇 Additional comments (12)
bootstrap/config/rbac/leader_election_role.yaml (2)

5-6: Consistent Renaming and Namespace Addition
The role name has been updated to capoa-bootstrap-leader-election-role and a namespace: capoa-system has been added. These changes align perfectly with the PR objectives to standardize resource names and namespaces, ensuring clarity and consistency across the project.

4-4: Streamlined Metadata
The removal of unnecessary labels in the metadata is intentional and helps reduce extraneous configuration. This cleanup contributes to clearer resource definitions without affecting functionality.

bootstrap/config/manager/manager.yaml (5)

3-4: Namespace Update:
The Namespace metadata now sets the name to capoa-system, which aligns with the new naming convention and streamlines resource grouping.

8-10: Deployment Metadata Updates:
The Deployment’s metadata has been updated with a new name (capoa-bootstrap-controller-manager) and its namespace is now explicitly set to capoa-system. This ensures the Deployment is correctly scoped and clearly identified within the new naming scheme.

12-14: Selector Label Update:
The selector’s matchLabels have been revised to use control-plane: capoa-bootstrap-controller-manager, ensuring that the Deployment’s label selectors match the new naming convention. This is crucial for proper pod selection and controller functioning.

16-19: Template Metadata Label Update:
The labels under the Deployment template metadata now reflect control-plane: capoa-bootstrap-controller-manager, which maintains consistency between the Deployment’s selector and its pod labels.

60-60: Service Account Naming:
The serviceAccountName is updated to capoa-bootstrap-controller-manager, which matches the naming changes in the Deployment. This change aids in clarity and proper role binding.

controlplane/config/manager/manager.yaml (5)

3-4: Namespace Update:
The Namespace name has been updated to capoa-system, ensuring consistency across all resource definitions in the refactored environment.

8-10: Deployment Metadata Updates:
The Deployment metadata now sets the name to capoa-controlplane-controller-manager and assigns it to the capoa-system namespace. This update distinguishes the control plane component from the bootstrap component and aligns with the overall rebranding effort.

12-14: Selector Label Update:
The Deployment selector’s matchLabels have been changed to control-plane: capoa-controlplane-controller-manager. This ensures that the pod selector correctly targets the pods associated with the control plane manager, in line with the new naming convention.

16-19: Template Metadata Label Update:
The labels under the Deployment’s template metadata now use control-plane: capoa-controlplane-controller-manager, which maintains coherence between the pod labels and the Deployment’s selector.

55-55: Service Account Name Verification:
The serviceAccountName here is updated to capoa-controlplane-controller-manager. This differs from the bootstrap configuration (capoa-bootstrap-controller-manager), which may be intentional to clearly differentiate control plane components from bootstrap components. Please verify that this naming difference is by design and aligns with overall project conventions.

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@openshift-ci openshift-ci bot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Apr 1, 2025
@carbonin carbonin changed the title Clean up resource labels, names, and namespaces [WIP] Clean up resource labels, names, and namespaces Apr 1, 2025
@openshift-ci openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Apr 1, 2025
carbonin added 4 commits April 2, 2025 14:34
@carbonin
remove manager_config_patch.yaml, it's not used anywhere
a62350b
@carbonin
Fix up resources
33fbdfb 
- Remove unnecessary labels on resources
- Rename namePrefix and namespace to match the repo rename
- Ensure labels and selectors are unique to the provider
  (for when they run in the same namespace)
@carbonin
Regenerate published manifests
038bf91
@carbonin
Deploy providers in the same namespace
37b4864 
To do this it is required to remove the namespace and object prefix
fields from the default kustomization.yaml. Without these changes the
namespace objects in the manager manifest would get prefixed and thus
would change between the providers.

Now it will be required to directly name and namespace resources
when creating them.
@carbonin carbonin force-pushed the clean-up-resources branch from e30768c to a2d62a5 Compare April 2, 2025 19:09
@carbonin carbonin changed the title [WIP] Clean up resource labels, names, and namespaces Clean up resource labels, names, and namespaces Apr 2, 2025
@openshift-ci openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Apr 2, 2025
@carbonin carbonin force-pushed the clean-up-resources branch from a2d62a5 to 37b4864 Compare April 2, 2025 19:10
@rccrdpccl
Copy link
Contributor

/lgtm
/approve

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Apr 3, 2025
@openshift-ci OpenShift CI
Copy link

openshift-ci bot commented Apr 3, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: carbonin, rccrdpccl

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

@openshift-merge-bot openshift-merge-bot bot merged commit c574c08 into openshift-assisted:master Apr 3, 2025
8 checks passed
@carbonin carbonin deleted the clean-up-resources branch April 3, 2025 12:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eranco74 eranco74 Awaiting requested review from eranco74

@rccrdpccl rccrdpccl Awaiting requested review from rccrdpccl

Assignees

@rccrdpccl rccrdpccl

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@carbonin @rccrdpccl