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

[feature request]use one repo to manage all api in OpenYurt #953

Closed
rambohe-ch opened this issue Aug 16, 2022 · 6 comments · Fixed by openyurtio/api#1
Closed

[feature request]use one repo to manage all api in OpenYurt #953

rambohe-ch opened this issue Aug 16, 2022 · 6 comments · Fixed by openyurtio/api#1
Assignees
Labels
kind/feature kind/feature

Comments

@rambohe-ch
Copy link
Member

What would you like to be added:
I want to create a repo named openyurtio/api to manage all of the external API types of OpenYurt. and the api structure as following:

openyurtio/api
   - apps
       - v1alpha1
       - v1beta1
   - device
       - v1alpha1
   - network
       - v1alpha1
    - coordinator (TBD)
        - v1alpha1

and the relationship between directory and repo is:

apps  <-->  yurt-app-manager
device <--> yurt-device-controller
network <--> raven-controller-manager
coordinator <--> pool-coordinator

Why is this needed:
as you known, there are several api repos in OpenYurt community, it's not convenient to import by other clients, and it's very hard to manage so many repos. the current api repos as following:

  1. https://github.com/openyurtio/yurt-app-manager-api
  2. https://github.com/openyurtio/yurt-device-controller-api

moreover, we have some other API definition in other repos, like raven-controller-manager and pool-coordinator.

others
by the way, in order to sync charts and api files from scattered repos, we will create the following two github secrets for each repo.

SYNC_CHARTS_SECRET:  for syncing helm charts to openyurtio/openyurt-helm
SYNC_API_SECRET: for syncing api files to openyurtio/api

/kind feature

@rambohe-ch rambohe-ch added the kind/feature kind/feature label Aug 16, 2022
@rambohe-ch
Copy link
Member Author

/assign @rambohe-ch @huiwq1990

@openyurt-bot
Copy link
Collaborator

@rambohe-ch: GitHub didn't allow me to assign the following users: huiwq1990.

Note that only openyurtio members, repo collaborators and people who have commented on this issue/PR can be assigned. Additionally, issues/PRs can only have 10 assignees at the same time.
For more information please see the contributor guide

In response to this:

/assign @rambohe-ch @huiwq1990

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/test-infra repository.

@gnunu
Copy link
Member

gnunu commented Aug 16, 2022

Great move!

@rambohe-ch
Copy link
Member Author

@huiwq1990 I have created two new repos for managing OpenYurt api and OpenYurt client.

and i have added the following organization secrets for the corresponding repos:

please the above secrets in your pipeline.

@huiwq1990
Copy link
Member

@rambohe-ch DO you mean:
https://github.com/openyurtio/yurt-app-manager/tree/master/pkg/yurtappmanager/apis sync to openyurtio/api

https://github.com/openyurtio/yurt-app-manager/tree/master/pkg/yurtappmanager/client sync to openyurt/client_golang

I think it's better put all of them in one repo, as they are generated by same crd definition and used together.

@rambohe-ch
Copy link
Member Author

@rambohe-ch DO you mean: https://github.com/openyurtio/yurt-app-manager/tree/master/pkg/yurtappmanager/apis sync to openyurtio/api

https://github.com/openyurtio/yurt-app-manager/tree/master/pkg/yurtappmanager/client sync to openyurt/client_golang

I think it's better put all of them in one repo, as they are generated by same crd definition and used together.

@huiwq1990 Yes, it's more convenient to put all of them in one repo, and we can optimize api and client in the future.
so i will delete the openyurtio/client_golang repo temporarily.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature kind/feature
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants