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

Revise advice about network plugin compatibility #47026

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

orsenthil
Copy link

Add a clarification that CNI has been supported from earliest version, not just the current version.

Add a clarification that CNI has been supported from earliest version, not just the current version.
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign reylejano for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jun 28, 2024
Copy link

netlify bot commented Jun 28, 2024

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 0e78a85
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/667f45ddd1dc70000860941a
😎 Deploy Preview https://deploy-preview-47026--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@@ -11,7 +11,7 @@ weight: 10

<!-- overview -->

Kubernetes {{< skew currentVersion >}} supports [Container Network Interface](https://github.com/containernetworking/cni)
Kubernetes since earliest releases, including {{< skew currentVersion >}} supports [Container Network Interface](https://github.com/containernetworking/cni)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm unsure that this is a meaningful improvement to the documentation in terms of usefulness to the reader. If we are going to clarify here, we should include the specific version in which CNI plugin support was first introduced.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could do a related change:

-You must use a CNI plugin that is compatible with the 
-[v0.4.0](https://github.com/containernetworking/cni/blob/spec-v0.4.0/SPEC.md) or later
-releases of the CNI specification. The Kubernetes project recommends using a plugin that is
+For Kubernetes {{< skew currentVersion >}} specifically, you must use a CNI plugin
+that is compatible with the
+[v0.4.0](https://github.com/containernetworking/cni/blob/spec-v0.4.0/SPEC.md) or later
+releases of the CNI specification.
+The Kubernetes project further recommends using a plugin that is
 compatible with the [v1.0.0](https://github.com/containernetworking/cni/blob/spec-v1.0.0/SPEC.md)
 CNI specification (plugins can be compatible with multiple spec versions).
+If you are running a version of Kubernetes other than v{{< skew currentVersion >}}, check the
+documentation for the release you're running.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@katcosgrove , my motivation with this change was to indicate that it is not just the latest, but CNI has been standard since kubernetes 1.3.0. Prior to that it was kube-net. So, want to indicate that.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am open to rewording it to indicate this information.

@sftim
Copy link
Contributor

sftim commented Jul 1, 2024

/retitle Revise advice about network plugin compatibility

@k8s-ci-robot k8s-ci-robot changed the title Update network-plugins.md Revise advice about network plugin compatibility Jul 1, 2024
@sftim
Copy link
Contributor

sftim commented Jul 1, 2024

/sig network

@k8s-ci-robot k8s-ci-robot added the sig/network Categorizes an issue or PR as relevant to SIG Network. label Jul 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language sig/network Categorizes an issue or PR as relevant to SIG Network. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants