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

Explain context of "group" when initializing a project #5738

Closed
asmacdo opened this issue May 9, 2022 · 1 comment · Fixed by #5842
Closed

Explain context of "group" when initializing a project #5738

asmacdo opened this issue May 9, 2022 · 1 comment · Fixed by #5842
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation.
Milestone

Comments

@asmacdo
Copy link
Member

asmacdo commented May 9, 2022

In the Go docs this is all they have:

# we'll use a domain of example.com
# so all API groups will be <group>.example.com 

Lets Add a link to API groups and maybe an example of what the author should set it to.

@asmacdo asmacdo added the kind/documentation Categorizes issue or PR as related to documentation. label May 9, 2022
@rashmigottipati rashmigottipati added this to the v1.21.0 milestone May 9, 2022
@asmacdo asmacdo modified the milestones: v1.21.0, v1.22.0 May 24, 2022
@varshaprasad96 varshaprasad96 modified the milestones: v1.22.0, v1.23.0 Jun 8, 2022
@varshaprasad96 varshaprasad96 added the help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. label Jun 8, 2022
@varshaprasad96 varshaprasad96 modified the milestones: v1.23.0, v1.22.0 Jun 8, 2022
@varshaprasad96 varshaprasad96 added the good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. label Jun 8, 2022
@everettraven everettraven modified the milestones: v1.22.0, v1.23.0 Jun 15, 2022
@asmacdo asmacdo modified the milestones: v1.23.0, v1.24.0, Backlog Jul 20, 2022
@asmacdo asmacdo modified the milestones: Backlog, v1.24.0 Jul 20, 2022
@camilamacedo86
Copy link
Contributor

camilamacedo86 commented Jul 27, 2022

@asmacdo,

we'll use a domain of example.com
so all API groups will be .example.com

Following my suggestion. See that it is more a tool limitation and that we acctually could/should be able to work with APIs from another domain mainly when we are trying to do scaffold to create controllers that will reconcile external types and core types. Also, has no conceptual reason to say that a project could not own APIs under different domains.

How and where is the domain informed used?

Currently, the tool does not support work with multi-domains to create the APIs by default. For more info check the issue kubebuilder/issues/2394 raised to add this support Therefore, you will check below that when you use the subCommand create api you will not need to inform the domain anymore. You will only inform the group, the Kind and the Version to create the APIs(s) and/or Controllers with the purpose to reconcile them and then, all will be scaffolded using this domain which is stored in the PROJECT file.

Be aware that you can work with external and core types which would have another domain, but the tool is not fully helping out with. For further info see the issue kubebuilder/issues/1999.

c/c @jberkhahn @laxmikantbpandhare

@jmrodri jmrodri removed this from the v1.24.0 milestone Sep 19, 2022
@theishshah theishshah added this to the v1.24.0 milestone Sep 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

8 participants