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

[WIP]KEP-4958: CSI Sidecars All in one #5153

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

mowangdk
Copy link

@mowangdk mowangdk commented Feb 7, 2025

  • One-line PR description: To combine the source code of the CSI sidecars in a monorepo.
  • Other comments:

@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Feb 7, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: mowangdk
Once this PR has been reviewed and has the lgtm label, please assign xing-yang for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found 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 kind/kep Categorizes KEP tracking issues and PRs modifying the KEP directory sig/storage Categorizes an issue or PR as relevant to SIG Storage. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Feb 7, 2025

We designed the AIO repo's RBAC policy to mirror that of individual repos, where each controller maintains its own policy. Driver maintainers should apply proper RBAC when enabling specific controllers in AIO

> We plan to combine informer caches of different controllers in the future, which will involve updating some RBAC policies, to be addressed in a subsequent KEP
Copy link
Member

Choose a reason for hiding this comment

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

We could have a pointer to the milestone that talks about the future milestone.


#### Monorepo component

poc version: https://github.com/mauriciopoppe/csi-sidecars
Copy link
Member

Choose a reason for hiding this comment

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

This should be a link to the nested locations in the monorepo source code e.g. https://github.com/mauriciopoppe/csi-sidecars/tree/main/pkg/attacher

poc version: https://github.com/mauriciopoppe/csi-sidecars


#### Deployment Workflow Definition
Copy link
Member

Choose a reason for hiding this comment

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

Development workflow

proposal will be implemented, this is the place to discuss them.
-->

![overview](./aio6.png "overview of design details")
Copy link
Member

Choose a reason for hiding this comment

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

This diagram complements the graph that shows the monorepo and individual repo's timelines so it's good to have both.

Please move this diagram to its own section below "Development Workflow Definition" that shows how development is going to look like in terms of workstreams.

##### AIO MonoRepo state definition

- inner-verified: Current state of AIO MonoRepo
- production-verified: Available for production environments, a Cloud vendor that's using it in its production environment.
Copy link
Member

Choose a reason for hiding this comment

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

There can be a cross reference to the milestones listed below e.g.

  • by the start of the production verified we'll have Y number of sidecars in the monorepo.
  • by the end of production verified we'll reach milestone X and have Y number of sidecars working through CSI hostpath

##### AIO MonoRepo state definition

- inner-verified: Current state of AIO MonoRepo
- production-verified: Available for production environments, a Cloud vendor that's using it in its production environment.
Copy link
Member

Choose a reason for hiding this comment

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

During this state we expect CSI Driver authors to start integrating their CSI Drivers with the monorepo artifacts. We also mentioned that this state could be "beta"

- (future) archive it but not at the same time as the deprecation time, this is a terminal state so we can't undo it


![state change](./aio11.png "overview of workflow definition")
Copy link
Member

Choose a reason for hiding this comment

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

Feature freeze on the individual repos should start after the monorepo reaches GA.

@k8s-ci-robot
Copy link
Contributor

@mowangdk: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
pull-enhancements-test 860f112 link true /test pull-enhancements-test
pull-enhancements-verify 860f112 link true /test pull-enhancements-verify

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

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. I understand the commands that are listed here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. kind/kep Categorizes KEP tracking issues and PRs modifying the KEP directory sig/storage Categorizes an issue or PR as relevant to SIG Storage. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants