Document Antrea versioning #1352

antoninbas · 2020-10-08T00:20:22Z

antrea-bot · 2020-10-08T00:20:38Z

Thanks for your PR.
Unit tests and code linters are run automatically every time the PR is updated.
E2e, conformance and network policy tests can only be triggered by a member of the vmware-tanzu organization. Regular contributors to the project should join the org.

The following commands are available:

/test-e2e: to trigger e2e tests.
/skip-e2e: to skip e2e tests.
/test-conformance: to trigger conformance tests.
/skip-conformance: to skip conformance tests.
/test-whole-conformance: to trigger all conformance tests on linux.
/skip-whole-conformance: to skip all conformance tests on linux.
/test-networkpolicy: to trigger networkpolicy tests.
/skip-networkpolicy: to skip networkpolicy tests.
/test-windows-conformance: to trigger windows conformance tests.
/skip-windows-conformance: to skip windows conformance tests.
/test-windows-networkpolicy: to trigger windows networkpolicy tests.
/skip-windows-networkpolicy: to skip windows networkpolicy tests.
/test-hw-offload: to trigger ovs hardware offload test.
/skip-hw-offload: to skip ovs hardware offload test.
/test-all: to trigger all tests (except whole conformance).
/skip-all: to skip all tests (except whole conformance).

codecov-io · 2020-10-08T00:24:23Z

Codecov Report

Merging #1352 into master will decrease coverage by 10.02%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##           master    #1352       +/-   ##
===========================================
- Coverage   64.32%   54.30%   -10.03%     
===========================================
  Files         159      120       -39     
  Lines       12674    11266     -1408     
===========================================
- Hits         8153     6118     -2035     
- Misses       3668     4554      +886     
+ Partials      853      594      -259

Flag	Coverage Δ
#integration-tests	`44.82% <ø> (-0.04%)`	⬇️
#kind-e2e-tests	`?`
#unit-tests	`42.05% <ø> (ø)`

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

Impacted Files	Coverage Δ
pkg/agent/agent_linux.go	`0.00% <0.00%> (-100.00%)`	⬇️
pkg/agent/proxy/types/groupcounter.go	`0.00% <0.00%> (-95.00%)`	⬇️
pkg/controller/networkpolicy/tier.go	`0.00% <0.00%> (-90.00%)`	⬇️
pkg/apis/controlplane/register.go	`0.00% <0.00%> (-85.72%)`	⬇️
pkg/agent/proxy/types/types.go	`0.00% <0.00%> (-84.62%)`	⬇️
pkg/apis/stats/register.go	`0.00% <0.00%> (-81.82%)`	⬇️
pkg/agent/client.go	`0.00% <0.00%> (-77.42%)`	⬇️
pkg/agent/util/ethtool/ethtool_linux.go	`0.00% <0.00%> (-70.00%)`	⬇️
pkg/apis/controlplane/v1beta1/helper.go	`0.00% <0.00%> (-69.24%)`	⬇️
pkg/k8s/name.go	`33.33% <0.00%> (-66.67%)`	⬇️
... and 98 more

abhiraut · 2020-10-08T00:49:24Z

docs/versioning.md

+
+## Table of Contents
+
+<!-- toc -->


docs/versioning.md

abhiraut · 2020-10-08T01:07:27Z

docs/versioning.md

+releases](https://kubernetes.io/docs/setup/release/version-skew-policy/#supported-versions)
+at the time of release (3 up to K8s 1.19, 4 after that). For example, at the
+time that Antrea 0.10 was released, the latest K8s version was 1.19; as a result
+we guarantee that 0.10 supports at least 1.19, 1.18 and 1.17 (in practice is


Suggested change

we guarantee that 0.10 supports at least 1.19, 1.18 and 1.17 (in practice is

we guarantee that 0.10 supports at least 1.19, 1.18 and 1.17 (in practice it

abhiraut · 2020-10-08T01:08:35Z

docs/versioning.md

+
+Eventually, even a stable metric can be deleted. In this case, the metric must
+be marked as deprecated first and the metric must stay deprecated for at least
+one minor release. The [CHANGELOG] must announced both metric deprecations and


Suggested change

one minor release. The [CHANGELOG] must announced both metric deprecations and

one minor release. The [CHANGELOG] must announce both metric deprecations and

abhiraut · 2020-10-08T01:09:48Z

docs/versioning.md

+guarantee](#antrea-upgrade-and-supported-version-skew). The `controlplane` API
+(which is exposed using the aggregation layer) is often referred to as an
+"internal" API as it is used by the Antrea components to communicate with each
+other, and is usually noit consummed by end users, e.g. cluster admins. However,


Suggested change

other, and is usually noit consummed by end users, e.g. cluster admins. However,

other, and is usually not consumed by end users, e.g. cluster admins. However,

tnqn

Thanks for the summary, looks very clear. Some typos.

tnqn · 2020-10-13T13:44:44Z

docs/versioning.md

+
+Unlike minor releases, patch releases should not contain miscellaneous feature
+additions or improvements. No incompatibilities should ever be introduced
+between patch version of the same minor version. API groups / versions must not


Suggested change

between patch version of the same minor version. API groups / versions must not

between patch versions of the same minor version. API groups / versions must not

?

tnqn · 2020-10-13T13:47:26Z

docs/versioning.md

+updated (from `Alpha` to `Beta` or from `Beta` to `GA`). Refer to the the
+[CHANGELOG] for information about feature stability level for each release. For
+features controlled by a feature gate, this information is also present in a
+more structured way in [features-gates.md](features-gate.md).


Suggested change

more structured way in [features-gates.md](features-gate.md).

more structured way in [features-gates.md](feature-gates.md).

tnqn · 2020-10-13T13:54:06Z

docs/versioning.md

+patch support. This may seem short, but was done on purpose to encourage users
+to upgrade Antrea often and avoid potential incompatibility issues. In the
+future, we may reduce our release cadence for minor releases and simultaneously
+increase the support windows for each release.


Suggested change

increase the support windows for each release.

increase the support window for each release.

?

tnqn · 2020-10-13T13:57:39Z

docs/versioning.md

+When directly applying a newer Antrea YAML manifest, as provided for each
+[release](https://github.com/vmware-tanzu/antrea/releases), there is no
+guarantee that the Antrea Controller will be upgraded first. In practice, the
+Controller would be upgraded simultaneously with the first Agents to be upgraded


Suggested change

Controller would be upgraded simultaneously with the first Agents to be upgraded

Controller would be upgraded simultaneously with the first Agent to be upgraded

tnqn · 2020-10-13T14:31:07Z

docs/versioning.md

+also supports K8s 1.16).
+
+In addition, we strive to support the K8s versions used by default in
+cloud-managed K8s services ([EKS], [AKS] and [GKE (regular channel)]). 


[GKE (regular channel)] doesn't appear as link

tnqn · 2020-10-13T14:51:07Z

docs/versioning.md

+
+K8s has a [moratorium](https://github.com/kubernetes/kubernetes/issues/52185) on
+the removal of API object versions that have been persisted to storage. At the
+moment, node of Antrea APIServices (which use the aggregation layer) persist


Do you mean "none of Antrea APIServices"?

tnqn

LGTM

srikartati

Just one comment on Prometheus deprecation policy link.

srikartati · 2020-10-15T17:07:24Z

docs/versioning.md

+### Prometheus metrics deprecation policy
+
+Antrea follows a similar policy as
+[Kubernetes](https://cloud.google.com/kubernetes-engine/docs/release-notes) for


I could not find any Prometheus deprecation policy for K8s in the link https://cloud.google.com/kubernetes-engine/docs/release-notes. Wondering if that is the intended link.

Thanks. Looks like I got my links confused, will fix

Fixes antrea-io#1273

antoninbas · 2020-10-22T22:10:04Z

/skip-all

vmwclabot added the cla-not-required label Oct 8, 2020

antoninbas requested review from tnqn, salv-orlando, srikartati, abhiraut, jianjuns and McCodeman October 8, 2020 00:20

abhiraut reviewed Oct 8, 2020

View reviewed changes

abhiraut previously approved these changes Oct 10, 2020

View reviewed changes

tnqn reviewed Oct 13, 2020

View reviewed changes

antoninbas dismissed abhiraut’s stale review via 39c7cd0 October 14, 2020 21:17

antoninbas force-pushed the document-antrea-versioning branch from 09c776d to 39c7cd0 Compare October 14, 2020 21:17

antoninbas mentioned this pull request Oct 14, 2020

Upgrade ExternalEntity to v1alpha2 and controlplane API to v1beta2 #1335

Closed

tnqn previously approved these changes Oct 15, 2020

View reviewed changes

srikartati reviewed Oct 15, 2020

View reviewed changes

antoninbas added 5 commits October 15, 2020 11:48

Document Antrea versioning

092ad58

Fixes antrea-io#1273

Fix typos

5476270

Fix more typos

29723cc

Fix more typos

4e3a70e

Fix incorrect link

b970d94

antoninbas dismissed tnqn’s stale review via b970d94 October 15, 2020 18:48

antoninbas force-pushed the document-antrea-versioning branch from b8a193c to b970d94 Compare October 15, 2020 18:48

tnqn approved these changes Oct 16, 2020

View reviewed changes

abhiraut approved these changes Oct 16, 2020

View reviewed changes

antoninbas merged commit 51d6487 into antrea-io:master Oct 22, 2020

antoninbas deleted the document-antrea-versioning branch October 22, 2020 22:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document Antrea versioning #1352

Document Antrea versioning #1352

antoninbas commented Oct 8, 2020

antrea-bot commented Oct 8, 2020

codecov-io commented Oct 8, 2020 •

edited

Loading

abhiraut Oct 8, 2020

abhiraut Oct 8, 2020

abhiraut Oct 8, 2020

abhiraut Oct 8, 2020

tnqn left a comment

tnqn Oct 13, 2020

tnqn Oct 13, 2020

tnqn Oct 13, 2020

tnqn Oct 13, 2020

tnqn Oct 13, 2020

tnqn Oct 13, 2020

tnqn left a comment

srikartati left a comment

srikartati Oct 15, 2020

antoninbas Oct 15, 2020

antoninbas commented Oct 22, 2020

	we guarantee that 0.10 supports at least 1.19, 1.18 and 1.17 (in practice is
	we guarantee that 0.10 supports at least 1.19, 1.18 and 1.17 (in practice it

	one minor release. The [CHANGELOG] must announced both metric deprecations and
	one minor release. The [CHANGELOG] must announce both metric deprecations and

	other, and is usually noit consummed by end users, e.g. cluster admins. However,
	other, and is usually not consumed by end users, e.g. cluster admins. However,

	between patch version of the same minor version. API groups / versions must not
	between patch versions of the same minor version. API groups / versions must not

	more structured way in [features-gates.md](features-gate.md).
	more structured way in [features-gates.md](feature-gates.md).

	increase the support windows for each release.
	increase the support window for each release.

	Controller would be upgraded simultaneously with the first Agents to be upgraded
	Controller would be upgraded simultaneously with the first Agent to be upgraded

Document Antrea versioning #1352

Document Antrea versioning #1352

Conversation

antoninbas commented Oct 8, 2020

antrea-bot commented Oct 8, 2020

codecov-io commented Oct 8, 2020 • edited Loading

Codecov Report

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

tnqn left a 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

Choose a reason for hiding this comment

tnqn left a comment

Choose a reason for hiding this comment

srikartati 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 commented Oct 22, 2020

codecov-io commented Oct 8, 2020 •

edited

Loading