feat and bugfixes: update kb and add edit command to support multigroups #4156
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
camilamacedo86
commented
Nov 1, 2020
| @@ -17,7 +17,6 @@ limitations under the License. | |||
| package v1alpha1 | |||
|
|
|||
| import ("errors" | |||
| "k8s.io/apimachinery/pkg/runtime" | |||
| ctrl "sigs.k8s.io/controller-runtime" | |||
There was a problem hiding this comment.
This change in the scaffold is because of the bugfix create webhook subcommand for the defaulting webhooks by removing import that is not used. More info: kubernetes-sigs/kubebuilder#1718
camilamacedo86
commented
Nov 1, 2020
camilamacedo86
force-pushed
the
add-edit-plugin
branch
3 times, most recently
from
f93153f
to
292baf6
Compare
estroz
reviewed
Nov 8, 2020
|
Just double checking: Is this |
camilamacedo86
force-pushed
the
add-edit-plugin
branch
from
292baf6
to
2a65f2a
Compare
openshift-ci-robot
added
the
needs-rebase
camilamacedo86
force-pushed
the
add-edit-plugin
branch
from
2a65f2a
to
23b8f2e
Compare
openshift-ci-robot
removed
the
needs-rebase
This comment has been minimized.
This comment has been minimized.
camilamacedo86
force-pushed
the
add-edit-plugin
branch
from
23b8f2e
to
d50d944
Compare
camilamacedo86
force-pushed
the
add-edit-plugin
branch
from
d50d944
to
b9809e4
Compare
estroz
reviewed
Nov 10, 2020
estroz
reviewed
Nov 10, 2020
changelog/fragments/update-kb-from-36124ae2e027-to-9c02d557f01b.yaml
Outdated
Show resolved
Hide resolved
camilamacedo86
force-pushed
the
add-edit-plugin
branch
from
b9809e4
to
7af343d
Compare
jmrodri
approved these changes
Nov 11, 2020
| version: 2 | ||
| ... | ||
| ``` | ||
| Before we start to create the APIs, check if your project has more than one group such as : `foo.example.com/v1` and `crew.example.com/v1`. If you intend to still working on with multiple groups in your project, then to change the layout of your project to support Multi-Group run the command `operator-sdk edit --multigroup=true` |
There was a problem hiding this comment.
Nit: I know it was already like this but I think it should read:
"If you intend to work with multiple groups in your project, then to change the project's layout to support Multi-Group, run the command operator-sdk edit --multigroup=true.
|
|
||
| ```YAML | ||
| domain: example.com | ||
| layout: go.kubebuilder.io/v2 | ||
| multigroup: true | ||
| ... | ||
| ``` | ||
| For multi-group projects, the API Go type files are created under `apis/<group>/<version>/` and the controllers under `controllers/<group>/`. | ||
| For multi-group projects, the API Go type files are created under `apis/<group>/<version>/` and the controllers under `controllers/<group>/` and then, the Dockerfile will be also updated accordingly. For further information see the [Single Group to Multi-Group][multigroup-kubebuilder-doc] |
There was a problem hiding this comment.
nit: the Dockerfile will be updated accordingly.
|
/lgtm |
estroz
suggested changes
Nov 11, 2020
Comment on lines
5
to
6
| (go/v2) Added the command `òperator-sdk edit` which allows users edit the project layout to support Multi-Group. | ||
| More info: https://book.kubebuilder.io/migration/multi-group.html |
There was a problem hiding this comment.
Suggested change
| (go/v2) Added the command `òperator-sdk edit` which allows users edit the project layout to support Multi-Group. | |
| More info: https://book.kubebuilder.io/migration/multi-group.html | |
| (go/v2) Added the command `òperator-sdk edit` which allows users edit the project layout to support [multi-group](https://book.kubebuilder.io/migration/multi-group.html). |
There was a problem hiding this comment.
Also Mulit-Group really should be lower-cased, as it is not a proper noun in this context.
Comment on lines
10
to
11
| (go/v2) Fix `create webhook` subcommand for the defaulting webhooks by removing import that is not used. | ||
| More info: https://github.com/kubernetes-sigs/kubebuilder/pull/1718 |
There was a problem hiding this comment.
Suggested change
| (go/v2) Fix `create webhook` subcommand for the defaulting webhooks by removing import that is not used. | |
| More info: https://github.com/kubernetes-sigs/kubebuilder/pull/1718 | |
| (go/v2) Removed unused import for defaulting webhooks scaffolded by `create webhook` ([kubebuilder#1718](https://github.com/kubernetes-sigs/kubebuilder/pull/1718)). |
Comment on lines
15
to
16
| (go/v2) Fix `copyright` info on the license of the generated files when the owner is not informed. | ||
| More info: https://github.com/kubernetes-sigs/kubebuilder/pull/1749 |
There was a problem hiding this comment.
Suggested change
| (go/v2) Fix `copyright` info on the license of the generated files when the owner is not informed. | |
| More info: https://github.com/kubernetes-sigs/kubebuilder/pull/1749 | |
| (go/v2) Allow owner to not be specified in generated licenses ([kubebuilder#1749](https://github.com/kubernetes-sigs/kubebuilder/pull/1749)). |
| @@ -61,16 +61,15 @@ Read the [operator scope][operator_scope] documentation on how to run your opera | |||
|
|
|||
| ### Multi-Group APIs | |||
|
|
|||
| Before creating an API and controller, consider if your operator's API requires multiple [groups][API-groups]. | |||
| If yes then add the line `multigroup: true` in the `PROJECT` file which should look like the following: | |||
| Before creating an API and controller, consider if your operator's API requires multiple [groups][API-groups]. Then to change the layout of your project to support Multi-Group run the command `operator-sdk edit --multigroup=true`. It will update the `PROJECT` file which should look like the following: | |||
There was a problem hiding this comment.
Suggested change
| Before creating an API and controller, consider if your operator's API requires multiple [groups][API-groups]. Then to change the layout of your project to support Multi-Group run the command `operator-sdk edit --multigroup=true`. It will update the `PROJECT` file which should look like the following: | |
| Before creating an API and controller, consider if your operator requires multiple API [groups][api-groups]. Then to change the layout of your project to support multi-group run the command `operator-sdk edit --multigroup=true`. It will update the `PROJECT` file which should look like the following: |
|
|
||
| ```YAML | ||
| domain: example.com | ||
| layout: go.kubebuilder.io/v2 | ||
| multigroup: true | ||
| ... | ||
| ``` | ||
| For multi-group projects, the API Go type files are created under `apis/<group>/<version>/` and the controllers under `controllers/<group>/`. | ||
| For multi-group projects, the API Go type files are created under `apis/<group>/<version>/` and the controllers under `controllers/<group>/` and then, the Dockerfile will be also updated accordingly. For further information see the [Single Group to Multi-Group][multigroup-kubebuilder-doc] |
There was a problem hiding this comment.
Suggested change
| For multi-group projects, the API Go type files are created under `apis/<group>/<version>/` and the controllers under `controllers/<group>/` and then, the Dockerfile will be also updated accordingly. For further information see the [Single Group to Multi-Group][multigroup-kubebuilder-doc] | |
| For multi-group projects, the API Go type files are created under `apis/<group>/<version>/` and the controllers under `controllers/<group>/` and then, the Dockerfile will be also updated accordingly. For further information see the [multi-group migration doc][multigroup-kubebuilder-doc] |
camilamacedo86
force-pushed
the
add-edit-plugin
branch
from
7af343d
to
70c9621
Compare
camilamacedo86
force-pushed
the
add-edit-plugin
branch
from
70c9621
to
905de4e
Compare
|
New changes are detected. LGTM label has been removed. |
reinvantveer
pushed a commit
to reinvantveer/operator-sdk
that referenced
this pull request
Feb 5, 2021
…ups (operator-framework#4156) **Description of the change:** - Update kubebuilder dependency (See: kubernetes-sigs/kubebuilder@36124ae...9c02d55) - Add edit command which allows multigroup support - Align SDK with Kubebuilder and address bug fixes **Motivation for the change:** - Solve tech-debt and keep both projects aligned - Close the issue: operator-framework#3678 and provide the same facility that has in upstream to change the layout to support multigroup - Close the issue: operator-framework#4157 Signed-off-by: reinvantveer <rein.van.t.veer@geodan.nl>
rearl-scwx
pushed a commit
to rearl-scwx/operator-sdk
that referenced
this pull request
Feb 5, 2021
…ups (operator-framework#4156) **Description of the change:** - Update kubebuilder dependency (See: kubernetes-sigs/kubebuilder@36124ae...9c02d55) - Add edit command which allows multigroup support - Align SDK with Kubebuilder and address bug fixes **Motivation for the change:** - Solve tech-debt and keep both projects aligned - Close the issue: operator-framework#3678 and provide the same facility that has in upstream to change the layout to support multigroup - Close the issue: operator-framework#4157 Signed-off-by: rearl <rearl@secureworks.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of the change:
Motivation for the change:
Checklist
If the pull request includes user-facing changes, extra documentation is required:
changelog/fragments(seechangelog/fragments/00-template.yaml)website/content/en/docs