Rename API groups from .antrea.tanzu.vmware.com to .antrea.io #1799

hongliangl · 2021-01-29T04:07:57Z

Rename API groups from *.antrea.tanzu.vmware.com to *.antrea.io

Extension API groups as well as CRD API groups are renamed from *.antrea.tanzu.vmware.com to *.antrea.io.
Old version of extension API groups is not renamed. Legacy CRD API groups ops.antrea.tanzu.vmware.com, security.antrea.tanzu.vmware.com, core.antrea.tanzu.vmware.com are merged into crd.antrea.io.

New API group	New API version	Legacy API group	Legacy API version
		`controlplane.antrea.tanzu.vmware.com`	`v1beta1`
		`networking.antrea.tanzu.vmware.com`	`v1beta1`
`controlplane.antrea.io`	`v1beta2`	`controlplane.antrea.tanzu.vmware.com`	`v1beta2`
`stats.antrea.io`	`v1alpha1`	`stats.antrea.tanzu.vmware.com`	`v1alpha1`
`system.antrea.io`	`v1beta1`	`system.antrea.tanzu.vmware.com`	`v1beta1`
`crd.antrea.io`	`v1alpha2`	`core.antrea.tanzu.vmware.com`	`v1alpha2`
`crd.antrea.io`	`v1alpha1`	`ops.antrea.tanzu.vmware.com`	`v1alpha1`
`crd.antrea.io`	`v1alpha1`	`security.antrea.tanzu.vmware.com`	`v1alpha1`
`crd.antrea.io`	`v1beta1`	`clusterinformation.antrea.tanzu.vmware.com`	`v1beta1`

Legacy extension and CRD API groups are reservered. Legacy extension API groups can be used directly.

For legacy API groups, option LegacyCRDMirroring should be enabled in feature gates.When the mirroring is enabled,if a legacy CRD is created with legacy API groups, mirroring-controllerwill create a new CRD with the Spec and Labels from the legacy CRD. Afterwards, the modification of Spec and Label in legacy CRD will be synchronized to new CRD automatically. In addition, the modification of Status in new CRD will also be synchronized to legacy CRD automatically. If legacy CRD is deleted, the corresponding new CRD will be deleted.

Note that, a new CRD created by mirroring-controller has an annotation managed-by, and the new CRD cannot be updated or delete with new API groups(If the new CRD is manually forcibly updated or deleted, it will be restored by mirroring-controller) unless the corresponding legacy CRD is annotated with crd.antrea.io/stop-mirror by user. Once the legacy CRD is annotated with crd.antrea.io/stop-mirror, the annotation of managed-by in corresponding new CRD will be removed by mirroring-controller, then the new CRD is decoupled from the legacy CRD.

If Antrea is upgraded from version <= v0.13 and legacy CRDs is used, option LegacyCRDMirroring should be enabled, otherwise the legacy CRDs created with the legacy API groups will not take any effect and work as expected.

codecov-io · 2021-01-29T04:11:34Z

Codecov Report

Merging #1799 (8cbb8f2) into main (25c15ad) will decrease coverage by 3.91%.
The diff coverage is 35.90%.

❗ Current head 8cbb8f2 differs from pull request most recent head bdde2fc. Consider uploading reports for the commit bdde2fc to get more accurate results

@@            Coverage Diff             @@
##             main    #1799      +/-   ##
==========================================
- Coverage   59.64%   55.72%   -3.92%     
==========================================
  Files         197      262      +65     
  Lines       17507    19487    +1980     
==========================================
+ Hits        10442    10860     +418     
- Misses       5955     7472    +1517     
- Partials     1110     1155      +45

Flag	Coverage Δ
kind-e2e-tests	`41.93% <23.39%> (-3.38%)`	⬇️
unit-tests	`41.87% <61.53%> (+0.33%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
pkg/agent/apiserver/handlers/agentinfo/handler.go	`38.23% <ø> (ø)`
pkg/agent/controller/networkpolicy/cache.go	`84.64% <ø> (ø)`
pkg/agent/openflow/network_policy.go	`69.10% <0.00%> (-1.95%)`	⬇️
pkg/agent/querier/querier.go	`87.50% <ø> (ø)`
pkg/agent/types/networkpolicy.go	`37.50% <ø> (ø)`
pkg/antctl/raw/traceflow/command.go	`27.05% <0.00%> (ø)`
pkg/apis/controlplane/register.go	`88.23% <ø> (ø)`
pkg/apis/controlplane/v1beta1/conversion.go	`81.00% <ø> (ø)`
pkg/apis/controlplane/v1beta1/register.go	`92.85% <ø> (ø)`
pkg/apis/controlplane/v1beta2/register.go	`94.11% <ø> (ø)`
... and 142 more

antoninbas

you only need to port the latest version of each supported API, see https://github.com/vmware-tanzu/antrea/blob/main/docs/api.md

so looking at this list:

  - v1alpha1.stats.antrea.io
  - v1beta1.system.antrea.io
  - v1beta2.controlplane.antrea.io
  - v1beta1.controlplane.antrea.io
  - v1beta1.networking.antrea.io

you only need

  - v1alpha1.stats.antrea.io
  - v1beta1.system.antrea.io
  - v1beta2.controlplane.antrea.io

(note that the networking API group was deprecated and replaced with controlplane)

hongliangl · 2021-01-29T05:02:49Z

Got it, thanks for reminding. @antoninbas

jianjuns

Do we plan to merge this one in 0.13, or merge it together with the CRD group change in the next release?

antoninbas · 2021-02-04T01:33:43Z

@jianjuns I suggest we merge them together in the next release cycle

jianjuns · 2021-02-04T01:35:33Z

@jianjuns I suggest we merge them together in the next release cycle

Works for me. Just want to confirm.

hongliangl · 2021-02-04T13:07:41Z

Do we plan to merge this one in 0.13, or merge it together with the CRD group change in the next release?

Sorry for replying late, I don't know why I didn't received a notice email when there are new comments in this PR.

The part of renaming CRD is in progressing.

vicky-liu · 2021-02-05T01:35:45Z

It's the plan to merge the CRD converter and API name change together in 0.14 if we cannt do that in 0.13.

build/yamls/base/controller.yml

build/yamls/base/crds.yml

cmd/antrea-controller/controller.go

pkg/controller/crdmirroring/crdmirroring_controller.go

pkg/controller/crdmirroring/crdmirroring_handlers.go

pkg/controller/crdmirroring/crdmirroring_tracker.go

pkg/k8s/client.go

jianjuns

I think we concluded to put all CRDs under: "crd.antrea.io", and not extra sub-groups like: ops, security, core, etc.
So, for example, traceflow should be: traceflows.crd.antrea.io.

Is that the case: @antoninbas @tnqn ?

pkg/controller/crdmirroring/crdhandler/clustergroup.go

tnqn

LGTM. @jianjuns @antoninbas would you take a look at this PR?

antoninbas

First thanks for the tremendous amount of work @hongliangl and thanks @tnqn for all your detailed rounds of review. The final "scheme" is pretty much what I had in mind, so this works well for me at a high level.

I added a few small comments and questions. The main one being that I think we should not run the legacy tests on Kind, because it takes too much time.

After this is merged we should:

update all the examples in the documentation to use the new APIs
write a short guide on how to upgrade an existing cluster / application from old APIs to the new ones (I can take care of this)

build/yamls/base/conf/antrea-controller.conf

antoninbas · 2021-03-31T21:48:48Z

hack/generate-manifest.sh

@@ -29,6 +29,7 @@ Generate a YAML manifest for Antrea using Kustomize and print it to stdout.
        --ipsec                       Generate a manifest with IPSec encryption of tunnel traffic enabled
        --all-features                Generate a manifest with all alpha features enabled
        --no-proxy                    Generate a manifest with Antrea proxy disabled
+        --no-legacy-crd               Generate a manifest without legacy CRD mirroring support enabled


is this used anywhere so far?

I may not got totally what you mean. But I added this for the reason: for new users of Antrea, they have never used the legacy CRDs, nor they need to use the legacy API groups, and they can use this option to disable the mirroring controllers. I added six mirroring controllers, every controller has 4 workers. For new users, it is redundant to run this controllers.

pkg/agent/controller/traceflow/packetin.go

antoninbas · 2021-03-31T21:53:26Z

docs/api.md

+| `crd.antrea.io` | `v1alpha1` | No | v1.0.0 | N/A | N/A |
+| `crd.antrea.io` | `v1alpha2` | No | v1.0.0 | N/A | N/A |
+| `crd.antrea.io` | `v1beta1` | No | v1.0.0 | N/A | N/A |


I will need to think about this once this PR is merged. Versioning will need to be done independently for each CRD, and not for a given API group.

test/e2e/legacyantreapolicy_test.go

antoninbas · 2021-03-31T22:13:15Z

ci/kind/test-e2e-kind.sh

-      go test -v -timeout=50m github.com/vmware-tanzu/antrea/test/e2e -provider=kind --logs-export-dir=$ANTREA_LOG_DIR --coverage --coverage-dir $ANTREA_COV_DIR
+      go test -v -timeout=70m github.com/vmware-tanzu/antrea/test/e2e -provider=kind --logs-export-dir=$ANTREA_LOG_DIR --coverage --coverage-dir $ANTREA_COV_DIR
  else
-      go test -v -timeout=45m github.com/vmware-tanzu/antrea/test/e2e -provider=kind --logs-export-dir=$ANTREA_LOG_DIR
+      go test -v -timeout=65m github.com/vmware-tanzu/antrea/test/e2e -provider=kind --logs-export-dir=$ANTREA_LOG_DIR


can we run the legacy tests only on jenkins and disable them in Kind?

A new issue, even the legacy tests are skipped in Kind, 50m is not enough for other tests.

pkg/controller/crdmirroring/crdmirroring_controller.go

antoninbas · 2021-03-31T22:44:31Z

build/yamls/base/controller-rbac.yml

      - crdmutator.antrea.tanzu.vmware.com
      - crdvalidator.antrea.tanzu.vmware.com
      - labelsmutator.antrea.io
+      - crdmutator.antrea.io
+      - crdvalidator.antrea.io


@hongliangl @tnqn Just to confirm: we have to keep the old mutator / validator in addition to the new one? So if a legacy CR is created, and is mirrored, it will go through the webhooks twice?

BTW, the validation code / mutation code only use the new API types. I assume it works on the old legacy CRs because the type definitions are the same?

Just to confirm: we have to keep the old mutator / validator in addition to the new one? So if a legacy CR is created, and is mirrored, it will go through the webhooks twice?

If a legacy CR is created, the legacy one goes through the legacy webhook, and the mirrored new goes through the new webhook.

BTW, the validation code / mutation code only use the new API types. I assume it works on the old legacy CRs because the type definitions are the same?

I didn't add anything new in the validation code / mutation code. What I added is MutatingWebhookConfiguration and ValidatingWebhookConfiguration in build/yamls/base/controller.yml. I have tried using crdmutator.antrea.io and crdvalidator.antrea.io to mutate/validate the legacy CRs, but it didn't work.

Dyanngg · 2021-03-31T23:54:01Z

@tnqn @antoninbas I assume this PR has inter-dependency with #1993?

antoninbas · 2021-04-01T00:08:44Z

@tnqn @antoninbas I assume this PR has inter-dependency with #1993?

yes, but only in the sense that there may be merge conflicts, which should be easy to resolve

build/yamls/base/conf/antrea-controller.conf

pkg/agent/controller/traceflow/packetin.go

jianjuns · 2021-04-01T00:44:35Z

pkg/controller/crdmirroring/crdhandler/clustergroup.go

+func (c *ClusterGroupHandler) AddNewObject(obj metav1.Object) error {
+	l := obj.(*legacycore.ClusterGroup)
+	n := c.buildNewObject(l)
+	client := c.client.CrdV1alpha2().ClusterGroups()


Then should we handle Cluster scope CRD separately (esp. most our CRDs are cluster scoped)?

hongliangl · 2021-04-01T03:11:22Z

Then should we handle Cluster scope CRD separately (esp. most our CRDs are cluster scoped)?

Sorry, I didn't get what you mean. I don't understand what is the difference between Cluster scope and Non-Cluster scope in mirroring. @jianjuns

tnqn · 2021-04-01T03:15:15Z

Then should we handle Cluster scope CRD separately (esp. most our CRDs are cluster scoped)?

Sorry, I didn't get what you mean. I don't understand what is the difference between Cluster scope and Non-Cluster scope in mirroring. @jianjuns

Please check the thread in "Files changed" panel to get the context and reply there so the conversation is easy to track.
For this question, cluster scope resource is the the CRD you don't need to set Namespace when updating their CRs.

tnqn

LGTM

hongliangl · 2021-04-01T08:11:52Z

/test-all

jianjuns

I just have a nit. Since this PR has been pending for long and blocks a few others, I would not block the merge any longer. So, just go ahead to merge, if no other comments/changes, and we can address nits with a followup PR.

jianjuns · 2021-04-01T16:26:26Z

cmd/antrea-controller/controller.go

@@ -142,15 +158,79 @@ func run(o *Options) error {
 		networkPolicyStatusController = networkpolicy.NewStatusController(crdClient, networkPolicyStore, cnpInformer, anpInformer)
 	}

+	var anpMirroringController *crdmirroring.Controller


Probably better to move these lines and line 129 to 140 to a separate func.

Thanks for advices. This could be better.

antoninbas

LGTM

vmwclabot added the cla-not-required label Jan 29, 2021

antoninbas reviewed Jan 29, 2021

View reviewed changes

hongliangl force-pushed the api-rename branch 2 times, most recently from 043dc82 to 527038b Compare January 29, 2021 07:47

jianjuns requested a review from tnqn February 1, 2021 23:55

jianjuns reviewed Feb 1, 2021

View reviewed changes

hongliangl changed the title ~~Rename extension API from *.antrea.tanzu.vmware.com to *.antrea.io~~ Rename extension and CRD API from *.antrea.tanzu.vmware.com to *.antrea.io Feb 6, 2021

hongliangl force-pushed the api-rename branch from 3e44ba5 to b2b0605 Compare February 6, 2021 15:18

hongliangl requested review from antoninbas and jianjuns February 7, 2021 01:35

hongliangl marked this pull request as draft February 7, 2021 01:35

hongliangl force-pushed the api-rename branch 5 times, most recently from 0862a9a to d10347f Compare February 7, 2021 08:57

hongliangl marked this pull request as ready for review February 8, 2021 04:20

hongliangl force-pushed the api-rename branch 5 times, most recently from ed4c542 to 2efc5df Compare February 28, 2021 09:02

tnqn reviewed Mar 4, 2021

View reviewed changes

jianjuns reviewed Mar 4, 2021

View reviewed changes

hongliangl force-pushed the api-rename branch from 0861da5 to fd42f9d Compare March 31, 2021 08:56

tnqn reviewed Mar 31, 2021

View reviewed changes

pkg/controller/crdmirroring/crdhandler/clustergroup.go Outdated Show resolved Hide resolved

Modification for review.

94fb668

hongliangl force-pushed the api-rename branch from fd42f9d to 94fb668 Compare March 31, 2021 15:49

tnqn previously approved these changes Mar 31, 2021

View reviewed changes

hongliangl requested a review from tnqn March 31, 2021 16:43

antoninbas reviewed Mar 31, 2021

View reviewed changes

jianjuns reviewed Apr 1, 2021

View reviewed changes

hongliangl dismissed tnqn’s stale review via 8cbb8f2 April 1, 2021 03:28

hongliangl force-pushed the api-rename branch from 8cbb8f2 to 88c798f Compare April 1, 2021 04:13

hongliangl requested review from antoninbas and jianjuns April 1, 2021 04:14

hongliangl force-pushed the api-rename branch 2 times, most recently from bdde2fc to 780959c Compare April 1, 2021 05:32

Modification for review - 2.

4d8c14f

hongliangl force-pushed the api-rename branch from 780959c to 4d8c14f Compare April 1, 2021 05:42

tnqn approved these changes Apr 1, 2021

View reviewed changes

jianjuns approved these changes Apr 1, 2021

View reviewed changes

antoninbas approved these changes Apr 1, 2021

View reviewed changes

hongliangl merged commit a2eacf7 into antrea-io:main Apr 1, 2021

hongliangl mentioned this pull request Apr 1, 2021

Running Antrea-native e2e policy tests more than once (using -count) does not work #2022

Closed

antoninbas mentioned this pull request Apr 6, 2021

Rename Antrea APIs from *.antrea.tanzu.vmware.com to *.antrea.io #1715

Closed

antoninbas mentioned this pull request Aug 20, 2021

Why do we still have "controlplane.antrea.io/v1beta1"? #2620

Closed

hongliangl deleted the api-rename branch April 28, 2022 11:53

bangqipropel mentioned this pull request Mar 14, 2023

Migrate ClusterClaim to ClusterProperty #4686

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rename API groups from .antrea.tanzu.vmware.com to .antrea.io #1799

Rename API groups from .antrea.tanzu.vmware.com to .antrea.io #1799

hongliangl commented Jan 29, 2021 •

edited

codecov-io commented Jan 29, 2021 •

edited

antoninbas left a comment •

edited

hongliangl commented Jan 29, 2021

jianjuns left a comment

antoninbas commented Feb 4, 2021

jianjuns commented Feb 4, 2021

hongliangl commented Feb 4, 2021

vicky-liu commented Feb 5, 2021

jianjuns left a comment

tnqn left a comment

antoninbas left a comment

antoninbas Mar 31, 2021

hongliangl Apr 1, 2021 •

edited

antoninbas Mar 31, 2021

antoninbas Mar 31, 2021

tnqn Apr 1, 2021

hongliangl Apr 1, 2021

hongliangl Apr 1, 2021

antoninbas Mar 31, 2021

hongliangl Apr 1, 2021 •

edited

Dyanngg commented Mar 31, 2021

antoninbas commented Apr 1, 2021

jianjuns Apr 1, 2021

hongliangl commented Apr 1, 2021 •

edited

tnqn commented Apr 1, 2021

tnqn left a comment

hongliangl commented Apr 1, 2021

jianjuns left a comment

jianjuns Apr 1, 2021

hongliangl Apr 1, 2021

antoninbas left a comment

Rename API groups from *.antrea.tanzu.vmware.com to *.antrea.io #1799

Rename API groups from *.antrea.tanzu.vmware.com to *.antrea.io #1799

Conversation

hongliangl commented Jan 29, 2021 • edited

codecov-io commented Jan 29, 2021 • edited

Codecov Report

antoninbas left a comment • edited

Choose a reason for hiding this comment

hongliangl commented Jan 29, 2021

jianjuns left a comment

Choose a reason for hiding this comment

antoninbas commented Feb 4, 2021

jianjuns commented Feb 4, 2021

hongliangl commented Feb 4, 2021

vicky-liu commented Feb 5, 2021

jianjuns left a comment

Choose a reason for hiding this comment

tnqn left a comment

Choose a reason for hiding this comment

antoninbas left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hongliangl Apr 1, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hongliangl Apr 1, 2021 • edited

Choose a reason for hiding this comment

Dyanngg commented Mar 31, 2021

antoninbas commented Apr 1, 2021

Choose a reason for hiding this comment

hongliangl commented Apr 1, 2021 • edited

tnqn commented Apr 1, 2021

tnqn left a comment

Choose a reason for hiding this comment

hongliangl commented Apr 1, 2021

jianjuns left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

antoninbas left a comment

Choose a reason for hiding this comment

Rename API groups from .antrea.tanzu.vmware.com to .antrea.io #1799

Rename API groups from .antrea.tanzu.vmware.com to .antrea.io #1799

hongliangl commented Jan 29, 2021 •

edited

codecov-io commented Jan 29, 2021 •

edited

antoninbas left a comment •

edited

hongliangl Apr 1, 2021 •

edited

hongliangl Apr 1, 2021 •

edited

hongliangl commented Apr 1, 2021 •

edited