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.

Sign up for GitHub

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

Jump to bottom

Add netpol endport documentation #26714

Merged
merged 3 commits into from Mar 4, 2021
Merged

Add netpol endport documentation #26714

merged 3 commits into from Mar 4, 2021

Conversation

rikatz
Copy link
Contributor

@rikatz rikatz commented Feb 25, 2021

endPort field is going to be part of release v1.21 as per https://github.com/kubernetes/enhancements/tree/master/keps/sig-network/2079-network-policy-port-range

While this still need to be supported by the CNIs and it's an alpha feature, it's worth to document it and remove from non supported features.

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. language/en Issues or PRs related to English language labels Feb 25, 2021
@k8s-ci-robot k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Feb 25, 2021
@netlify
Copy link

netlify bot commented Feb 25, 2021 •
edited

Deploy preview for kubernetes-io-master-staging ready!

Built with commit c0bb986

https://deploy-preview-26714--kubernetes-io-master-staging.netlify.app

knabben
knabben reviewed Feb 25, 2021
View reviewed changes
content/en/docs/concepts/services-networking/network-policies.md Outdated
* As an alpha feature, this is disabled by default. To enable endPort field at a cluster level, you (or your cluster administrator) will need to enable the `NetworkPolicyEndPort` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/) for the API server with `--feature-gates=NetworkPolicyEndPort=true,…`.
* The `endPort` field must be equal than or greater to `port` field.
* `endPort` can only be defined if `port` is also defined.
* When using `endPort` field, the `port` field must be numeric.
Copy link
Member

Choose a reason for hiding this comment

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

maybe bringing a more global statement like namedPorts are not supported or both ports must be numeric.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

makes sense, will improve this statement during the weekend

sftim
sftim previously requested changes Feb 25, 2021
View reviewed changes
Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

Thanks for proposing this @rikatz

Two problems I think:

  1. This PR should target the dev-1.21 branch; master represents the live (v1.20) documentation.
  2. We need to make sure that the NetworkPolicyEndPort feature gate is documented in the list of feature gates.

/milestone 1.21

content/en/docs/concepts/services-networking/network-policies.md Outdated Show resolved Hide resolved
content/en/docs/concepts/services-networking/network-policies.md Outdated Show resolved Hide resolved
@k8s-ci-robot k8s-ci-robot added this to the 1.21 milestone Feb 25, 2021
@sftim
Copy link
Contributor

sftim commented Feb 25, 2021

KEP issue: kubernetes/enhancements#2079

@sftim
Copy link
Contributor

sftim commented Feb 25, 2021

/retitle Add netpol endport documentation

“before release” is implicit, not documenting features ahead of release is a bug.

@k8s-ci-robot k8s-ci-robot changed the title Add netpol endport documentation before release Add netpol endport documentation Feb 25, 2021
@rikatz @sftim
Add review suggestions
c0bb986 
Co-authored-by: Tim Bannister <tim@scalefactory.com>
@rikatz
Copy link
Contributor Author

rikatz commented Feb 26, 2021

Thanks for proposing this @rikatz

Two problems I think:

1. This PR should target the _dev-1.21_ branch; _master_ represents the live (v1.20) documentation.

2. We need to make sure that the `NetworkPolicyEndPort` feature gate is documented in the list of feature gates.

/milestone 1.21

OK! Will work on this during the weekend. Is there a deadline for docs proposals targeting v1.21?

@annajung
Copy link
Contributor

annajung commented Mar 1, 2021

/cc @reylejano @ChandaniM123

@reylejano
Copy link
Member

/sig network
/assign @ChandaniM123

@k8s-ci-robot k8s-ci-robot added the sig/network Categorizes an issue or PR as relevant to SIG Network. label Mar 1, 2021
@rikatz rikatz changed the base branch from master to dev-1.21 March 1, 2021 20:35
@k8sio-netlify-preview-bot
Copy link
Collaborator

Deploy preview for kubernetes-io-vnext-staging processing.

Building with commit 77f868e

https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/603d520263efcb000749b600

@rikatz
Copy link
Contributor Author

rikatz commented Mar 1, 2021

@sftim thanks for the review. Changed the base branch to dev-1.21, added the feature gate documentation and also the suggestion by @knabben

@knabben
Copy link
Member

knabben commented Mar 1, 2021

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 1, 2021
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 6e879663f73001ccc7bc1e660841c2e8a0c5e8ac

@rikatz rikatz mentioned this pull request Mar 2, 2021
Closed
@sftim sftim dismissed their stale review March 4, 2021 22:49

Review was stale

@sftim
Copy link
Contributor

sftim commented Mar 4, 2021

If the k/kubernetes and any other related changes are merged, this is good to go into dev-1.21

@rikatz
Copy link
Contributor Author

rikatz commented Mar 4, 2021 •
edited

Yes, it's already implemented in k/k repo :)

kubernetes/kubernetes#97058

@sftim
Copy link
Contributor

sftim commented Mar 4, 2021

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sftim

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

The pull request process is described 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 the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 4, 2021
@k8s-ci-robot k8s-ci-robot merged commit 60935ce into kubernetes:dev-1.21 Mar 4, 2021
@sftim sftim mentioned this pull request Mar 4, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@knabben knabben knabben left review comments

@sftim sftim sftim left review comments

@danwinship danwinship Awaiting requested review from danwinship

@thockin thockin Awaiting requested review from thockin

@ChandaniM123 ChandaniM123 Awaiting requested review from ChandaniM123

@reylejano reylejano Awaiting requested review from reylejano

Assignees

@knabben knabben

@ChandaniM123 ChandaniM123

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. sig/network Categorizes an issue or PR as relevant to SIG Network. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
1.21
Development

Successfully merging this pull request may close these issues.

None yet
8 participants
@rikatz @sftim @annajung @reylejano @k8sio-netlify-preview-bot @knabben @k8s-ci-robot @ChandaniM123