Update NetworkPolicy concept guide with egress and CIDR changes #5529

caseydavenport · 2017-09-19T01:07:37Z

Documentation updates for two new NetworkPolicy features in Kubernetes 1.8.

CIDRs: ipBlock for Network Policies enhancements#367
Egress: Egress support for Network Policy enhancements#366

Both of these features are marked as "beta" - advice on how to indicate that in the documentation would be much appreciated.

CC @cmluciano

This change is

k8sio-netlify-preview-bot · 2017-09-19T01:09:12Z

Deploy preview ready!

Built with commit aec8264

https://deploy-preview-5529--kubernetes-io-vnext-staging.netlify.com

zacharysarah

@caseydavenport 👋 Thanks for opening this PR. Just some small changes, then LGTM.

You can either make the changes yourself or I can make them, if you de-select and re-select the "allow edits from maintainers" checkbox. (The GitHub UI has a bug.)

Thanks!

zacharysarah · 2017-09-19T04:16:22Z

docs/concepts/services-networking/network-policies.md


 See the [NetworkPolicy getting started guide](/docs/getting-started-guides/network-policy/walkthrough) for further examples.

 ## Default policies

-You can create a "default" isolation policy for a Namespace by creating a NetworkPolicy that selects all pods but does not allow any traffic:
+By default, if no policies exist in a namespace, then all ingress and egress traffic is allowed to and from pods in that Namespace. The following examples let you change the default behavior


...in that namespace.

zacharysarah · 2017-09-19T04:18:12Z

docs/concepts/services-networking/network-policies.md

-Alternatively, if you want to allow all traffic for all pods in a Namespace (even if policies are added that cause some pods to be treated as "isolated"), you can create a policy that explicitly allows all traffic:
+### Default allow all ingress traffic
+
+If you want to allow all traffic for all pods in a Namespace (even if policies are added that cause some pods to be treated as "isolated"), you can create a policy that explicitly allows all traffic:


...in a namespace...

zacharysarah · 2017-09-19T04:18:32Z

docs/concepts/services-networking/network-policies.md

@@ -98,6 +123,42 @@ spec:
  - {}
 ```

+### Default deny all egress traffic.
+
+You can create a "default" egress isolation policy for a Namespace by creating a NetworkPolicy that selects all pods but does not allow any egress traffic:


...for a namespace...

zacharysarah · 2017-09-19T04:18:44Z

docs/concepts/services-networking/network-policies.md

+
+### Default deny all ingress and all egress traffic
+
+You can create a "default" policy for a Namespace which prevents all ingress AND egress traffic by creating the following NetworkPolicy:


...for a namespace...

caseydavenport · 2017-09-19T19:48:31Z

@zacharysarah I've pushed the changes you suggested, and I've also enabled edits from maintainers.

Thanks!

zacharysarah · 2017-09-19T22:05:53Z

Docs LGTM, just need tech review. @cmluciano 👋 Would you please review these docs for accuracy? Thanks in advance!

caseydavenport · 2017-09-20T16:53:13Z

@danwinship or @thockin are also review candidates.

cmluciano

Few nits

cmluciano · 2017-09-21T14:42:25Z

docs/concepts/services-networking/network-policies.md

 ```

-This ensures that even pods that aren't selected by any other NetworkPolicy will still be isolated.
+This ensures that even pods that aren't selected by any other NetworkPolicy will still be isolated. This policy does not change
+the default egress isolation behavior.


extra newline here?

cmluciano · 2017-09-21T14:44:08Z

docs/concepts/services-networking/network-policies.md

@@ -81,11 +101,16 @@ metadata:
  name: default-deny
 spec:
  podSelector:
+  policyTypes:
+  - Ingress


+1 thanks for updating this

cmluciano · 2017-09-21T14:45:18Z

docs/concepts/services-networking/network-policies.md

-Alternatively, if you want to allow all traffic for all pods in a Namespace (even if policies are added that cause some pods to be treated as "isolated"), you can create a policy that explicitly allows all traffic:
+### Default allow all ingress traffic
+
+If you want to allow all traffic for all pods in a namespace (even if policies are added that cause some pods to be treated as "isolated"), you can create a policy that explicitly allows all traffic in that namespace.


Should we have an example for default egress allow all?

thockin

@ahmetb Since you have been writing on this topic

thockin · 2017-09-22T23:27:16Z

docs/concepts/services-networking/network-policies.md

@@ -60,19 +70,29 @@ __spec__: `NetworkPolicy` [spec](https://git.k8s.io/community/contributors/devel

 __podSelector__: Each `NetworkPolicy` includes a `podSelector` which selects the grouping of pods to which the policy applies. Since `NetworkPolicy` currently only supports defining `ingress` rules, this `podSelector` essentially defines the "destination pods" for the policy. The example policy selects pods with the label "role=db". An empty `podSelector` selects all pods in the namespace.

-__ingress__: Each `NetworkPolicy` includes a list of whitelist `ingress` rules.  Each rule allows traffic which matches both the `from` and `ports` sections. The example policy contains a single rule, which matches traffic on a single port, from either of two sources, the first specified via a `namespaceSelector` and the second specified via a `podSelector`.
+__policyTypes__: Each `NetworkPolicy` includes a `policyTypes` list which may include either `Ingress`, `Egress`, or both. The `policyTypes` field indicates whether or not the given policy applies to ingress traffic to selected pod, egress traffic from selected pods, or both.


Describe the default-value semantics?

zacharysarah · 2017-09-25T03:08:50Z

@thockin Do you think we can merge this PR now and open an issue for follow-up changes?

caseydavenport · 2017-09-25T19:30:09Z

Sorry for the delay, just pushed an updated commit with review feedback included. PTAL!

steveperry-53 · 2017-09-25T20:13:30Z

@thockin @cmluciano @ahmetb Can we merge this now?

cmluciano · 2017-09-25T21:13:50Z

/lgtm

@chenopis

* GC now supports non-core resources * Add two examples about how to analysis audits of kube-apiserver (#4264) * Deprecate system:nodes binding * [1.8] StatefulSet `initialized` annotation is now ignored. * inits the kubeadm upgrade docs addresses /issues/4689 * adds kubeadm upgrade cmd to ToC addresses /issues/4689 * add workload placement docs * ScaleIO - document udpate for 1.8 * Add documentation on storageClass.mountOptions and PV.mountOptions (#5254) * Add documentation on storageClass.mountOptions and PV.mountOptions * convert notes into callouts * Add docs for CustomResource validation add info about supported fields * advanced audit beta features (#5300) * Update job workload doc with backoff failure policy (#5319) Add to the Jobs documentation how to use the new backoffLimit field that limit the number of Pod failure before considering the Job as failed. * Documented additional AWS Service annotations (#4864) * Add device plugin doc under concepts/cluster-administration. (#5261) * Add device plugin doc under concepts/cluster-administration. * Update device-plugins.md * Update device-plugins.md Add meta description. Fix typo. Change bare metal deployment to manual deployment. * Update device-plugins.md Fix typo again. * Update page.version. (#5341) * Add documentation on storageClass.reclaimPolicy (#5171) * [Advanced audit] use new herf for audit-api (#5349) This tag contains all the changes in v1beta1 version. Update it now. * Added documentation around creating the InitializerConfiguration for the persistent volume label controller in the cloud-controller-manager (#5255) * Documentation for kubectl plugins (#5294) * Documentation for kubectl plugins * Update kubectl-plugins.md * Update kubectl-plugins.md * Updated CPU manager docs to match implementation. (#5332) * Noted limitation of alpha static cpumanager. * Updated CPU manager docs to match implementation. - Removed references to CPU pressure node condition and evictions. - Added note about new --cpu-manager-reconcile-period flag. - Added note about node allocatable requirements for static policy. - Noted limitation of alpha static cpumanager. * Move cpu-manager task link to rsc mgmt section. * init containers annotation removed in 1.8 (#5390) * Add documentation for TaintNodesByCondition (#5352) * Add documentation for TaintNodesByCondition * Update nodes.md * Update taint-and-toleration.md * Update daemonset.md * Update nodes.md * Update taint-and-toleration.md * Update daemonset.md * Fix deployments (#5421) * Document extended resources and OIR deprecation. (#5399) * Document extended resources and OIR deprecation. * Updated extended resources doc per reviews. * reverts extra spacing in _data/tasks.yml * addresses `kubeadm upgrade` review comments Feedback from @chenopis, @luxas, and @steveperry-53 addressed with this commit * HugePages documentation (#5419) * Update cpu-management-policies.md (#5407) Fixed the bad link. Modified "cpu" to "CPU". Added more 'yaml' as supplement. * Update RBAC docs for v1 (#5445) * Add user docs for pod priority and preemption (#5328) * Add user docs for pod priority and preemption * Update pod-priority-preemption.md * More updates * Update docs/admin/kubeadm.md for 1.8 (#5440) - Made a couple of minor wording changes (not strictly 1.8 related). - Did some reformatting (not strictly 1.8 related). - Updated references to the default token TTL (was infinite, now 24 hours). - Documented the new `--discovery-token-ca-cert-hash` and `--discovery-token-unsafe-skip-ca-verification` flags for `kubeadm join`. - Added references to the new `--discovery-token-ca-cert-hash` flag in all the default examples. - Added a new _Security model_ section that describes the security tradeoffs of the various discovery modes. - Documented the new `--groups` flag for `kubeadm token create`. - Added a note of caution under _Automating kubeadm_ that references the _Security model_ section. - Updated the component version table to drop 1.6 and add 1.8. - Update `_data/reference.yml` to try to get the sidebar fixed up and more consistent with `kubefed`. * Update StatefulSet Basics for 1.8 release (#5398) * addresses `kubeadm upgrade` review comments 2nd iteration review comments by @luxas * adds kubelet upgrade section to kubeadm upgrade * Fix a bulleted list on docs/admin/kubeadm.md. (#5458) I updated this doc yesterday and I was absolutely sure I fixed this, but I just saw that this commit got lost somehow. This was introduced recently in #5440. * Clarify the API to check for device plugins * Moving Flexvolume to separate out-of-tree section * addresses `kubeadm upgrade` review comments CC: @luxas * fixes kubeadm upgrade index * Update Stackdriver Logging documentation (#5495) * Re-update WordPress and MySQL PV doc to use apps/v1beta2 APIs (#5526) * Update statefulset concepts doc to use apps/v1beta2 APIs (#5420) * add document on kubectl's behavior regarding initializers (#5505) * Update docs/admin/kubeadm.md to cover self-hosting in 1.8. (#5497) This is a new beta feature in 1.8. * Update kubectl patch doc to use apps/v1beta2 APIs (#5422) * [1.8] Update "Run Applications" tasks to apps/v1beta2. (#5525) * Update replicated stateful application task for 1.8. * Update single instance stateful app task for 1.8. * Update stateless app task for 1.8. * Update kubectl patch task for 1.8. * fix the link of persistent storage (#5515) * update the admission-controllers.md index.md what-is-kubernetes.md link * fix the link of persistent storage * Add quota support for local ephemeral storage (#5493) * Add quota support for local ephemeral storage update the doc to this alpha feature * Update resource-quotas.md * Updated Deployments concepts doc (#5491) * Updated Deployments concepts doc * Addressed comments * Addressed more comments * Modify allocatable storage to ephemeral-storage (#5490) Update the doc to use ephemeral-storage instead of storage * Revamped concepts doc for ReplicaSet (#5463) * Revamped concepts doc for ReplicaSet * Minor changes to call out specific versions for selector defaulting and immutability * Addressed doc review comments * Remove petset documentations (#5395) * Update docs to use batch/v1beta1 cronjobs (#5475) * add federation job doc (#5485) * add federation job doc * Update job.md Edits for clarity and consistency * Update job.md Fixed a typo * update DaemonSet concept for 1.8 release (#5397) * update DaemonSet concept for 1.8 release * Update daemonset.md Fix typo. than -> then * Update bootstrap tokens doc for 1.8. (#5479) * Update bootstrap tokens doc for 1.8. This has some changes I missed when I was updating the main kubeadm documention: - Bootstrap tokens are now beta, not alpha (kubernetes/enhancements#130) - The apiserver flag to enable the authenticator changedin 1.8 (kubernetes/kubernetes#51198) - Added `auth-extra-groups` documentaion (kubernetes/kubernetes#50933) - Updated the _Token Management with `kubeadm`_ section to link to the main kubeadm docs, since it was just duplicated information. * Update bootstrap-tokens.md * Updated the Cassandra tutorial to use apps/v1beta2 (#5548) * add docs for AllowPrivilegeEscalation (#5448) Signed-off-by: Jess Frazelle <[email protected]> * Add local ephemeral storage alpha feature in managing compute resource (#5522) * Add local ephemeral storage alpha feature in managing compute resource Since 1.8, we add the local ephemeral storage alpha feature as one resource type to manage. Add this feature into the doc. * Update manage-compute-resources-container.md * Update manage-compute-resources-container.md * Update manage-compute-resources-container.md * Update manage-compute-resources-container.md * Update manage-compute-resources-container.md * Update manage-compute-resources-container.md * Added documentation for Metrics Server (#5560) * authorization: improve authorization debugging docs (#5549) * Document mount propagation (#5544) * Update /docs/setup/independent/create-cluster-kubeadm.md for 1.8. (#5524) This introduction needed a couple of small tweaks to cover the `--discovery-token-ca-cert-hash` flag added in kubernetes/kubernetes#49520 and some version bumps. * Add task doc for alpha dynamic kubelet configuration (#5523) * Fix input/output of selfsubjectaccess review (#5593) * Add docs for implementing resize (#5528) * Add docs for implementing resize * Update admission-controllers.md * Added link to PVC section * minor typo fixes * Update NetworkPolicy concept guide with egress and CIDR changes (#5529) * update zookeeper tutorial for 1.8 release * add doc for hostpath type (#5503) * Federated Hpa feature doc (#5487) * Federated Hpa feature doc * Federated Hpa feature doc review fixes * Update hpa.md * Update hpa.md * update cloud controller manager docs for v1.8 * Update cronjob with defaults information (#5556) * Kubernetes 1.8 reference docs (#5632) * Kubernetes 1.8 reference docs * Kubectl reference docs for 1.8 * Update side bar with 1.8 kubectl and api ref docs links * remove petset.md * update on state of HostAlias in 1.8 with hostNetwork Pod support (#5644) * Fix cron job deletion section (#5655) * update imported docs (#5656) * Add documentation for certificate rotation. (#5639) * Link to using kubeadm page * fix the command output fix the command output * fix typo in api/resources reference: "Worloads" * Add documentation for certificate rotation. * Create TOC entry for cloud controller manager. (#5662) * Updates for new versions of API types * Followup 5655: fix link to garbage collection (#5666) * Temporarily redirect resources-reference to api-reference. (#5668) * Update config for 1.8 release. (#5661) * Update config for 1.8 release. * Address reviewer comments. * Switch references in HPA docs from alpha to beta (#5671) The HPA docs still referenced the alpha version. This switches them to talk about v2beta1, which is the appropriate version for Kubernetes 1.8 * Deprecate openstack heat (#5670) * Fix typo in pod preset conflict example Move container port definition to the correct line. * Highlight openstack-heat provider deprecation The openstack-heat provider for kube-up is being deprecated and will be removed in a future release. * Temporarily fix broken links by redirecting. (#5672) * Fix broken links. (#5675) * Fix render of code block (#5674) * Fix broken links. (#5677) * Add a small note about auto-bootstrapped CSR ClusterRoles (#5660) * Update kubeadm install doc for v1.8 (#5676) * add draft workloads api content for 1.8 (#5650) * add draft workloads api content for 1.8 * edits per review, add tables, for 1.8 workloads api doc * fix typo * Minor fixes to kubeadm 1.8 upgrade guide. (#5678) - The kubelet upgrade instructions should be done on every host, not just worker nodes. - We should just upgrade all packages, instead of calling out kubelet specifically. This will also upgrade kubectl, kubeadm, and kubernetes-cni, if installed. - Draining nodes should also ignore daemonsets, and master errors can be ignored. - Make sure that the new kubeadm download is chmoded correctly. - Add a step to run `kubeadm version` to verify after downloading. - Manually approve new kubelet CSRs if rotation is enabled (known issue). * Release 1.8 (#5680) * Fix versions for 1.8 API ref docs * Updates for 1.8 kubectl reference docs * Kubeadm /docs/admin/kubeadm.md cleanup, editing. (#5681) * Update docs/admin/kubeadm.md (mostly 1.8 related). This is Fabrizio's work, which I'm committing along with my edits (in a commit on top of this). * A few of my own edits to clarify and clean up some Markdown.

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Sep 19, 2017

k8s-github-robot assigned zacharysarah Sep 19, 2017

caseydavenport force-pushed the network-policy-1.8 branch from 0936272 to bab39ba Compare September 19, 2017 01:12

This was referenced Sep 19, 2017

ipBlock for Network Policies kubernetes/enhancements#367

Closed

Egress support for Network Policy kubernetes/enhancements#366

Closed

zacharysarah suggested changes Sep 19, 2017

View reviewed changes

steveperry-53 added this to the 1.8 milestone Sep 19, 2017

steveperry-53 added Docs Review: Open Issues labels Sep 19, 2017

caseydavenport force-pushed the network-policy-1.8 branch from bab39ba to 0b29c95 Compare September 19, 2017 19:47

zacharysarah approved these changes Sep 19, 2017

View reviewed changes

zacharysarah requested a review from cmluciano September 19, 2017 22:04

zacharysarah added Docs LGTM and removed Docs Review: Open Issues labels Sep 19, 2017

zacharysarah requested review from danwinship and thockin September 20, 2017 18:48

cmluciano reviewed Sep 21, 2017

View reviewed changes

cmluciano mentioned this pull request Sep 21, 2017

update network-policy by adding egress and ipBlock usage #5473

Merged

steveperry-53 added Tech Review: Open Issues and removed Needs Tech Review labels Sep 21, 2017

thockin reviewed Sep 22, 2017

View reviewed changes

caseydavenport force-pushed the network-policy-1.8 branch from 0b29c95 to 089d34f Compare September 25, 2017 19:29

Update NetworkPolicy concept guide with egress and CIDR changes

aec8264

caseydavenport force-pushed the network-policy-1.8 branch from 089d34f to aec8264 Compare September 25, 2017 19:32

k8s-ci-robot assigned cmluciano Sep 25, 2017

k8s-ci-robot added the lgtm label Sep 25, 2017

zacharysarah added Tech Review LGTM and removed Tech Review: Open Issues labels Sep 25, 2017

zacharysarah merged commit daac519 into kubernetes:release-1.8 Sep 25, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update NetworkPolicy concept guide with egress and CIDR changes #5529

Update NetworkPolicy concept guide with egress and CIDR changes #5529

caseydavenport commented Sep 19, 2017 •

edited by k8s-reviewable

Loading

k8sio-netlify-preview-bot commented Sep 19, 2017 •

edited

Loading

zacharysarah left a comment

zacharysarah Sep 19, 2017

zacharysarah Sep 19, 2017

zacharysarah Sep 19, 2017

zacharysarah Sep 19, 2017

caseydavenport commented Sep 19, 2017

zacharysarah commented Sep 19, 2017

caseydavenport commented Sep 20, 2017

cmluciano left a comment

cmluciano Sep 21, 2017

cmluciano Sep 21, 2017

cmluciano Sep 21, 2017

thockin left a comment

thockin Sep 22, 2017

zacharysarah commented Sep 25, 2017

caseydavenport commented Sep 25, 2017

steveperry-53 commented Sep 25, 2017

cmluciano commented Sep 25, 2017


		### Default deny all ingress and all egress traffic

		You can create a "default" policy for a Namespace which prevents all ingress AND egress traffic by creating the following NetworkPolicy:

Update NetworkPolicy concept guide with egress and CIDR changes #5529

Update NetworkPolicy concept guide with egress and CIDR changes #5529

Conversation

caseydavenport commented Sep 19, 2017 • edited by k8s-reviewable Loading

k8sio-netlify-preview-bot commented Sep 19, 2017 • edited Loading

zacharysarah 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

caseydavenport commented Sep 19, 2017

zacharysarah commented Sep 19, 2017

caseydavenport commented Sep 20, 2017

cmluciano 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

thockin left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zacharysarah commented Sep 25, 2017

caseydavenport commented Sep 25, 2017

steveperry-53 commented Sep 25, 2017

cmluciano commented Sep 25, 2017

caseydavenport commented Sep 19, 2017 •

edited by k8s-reviewable

Loading

k8sio-netlify-preview-bot commented Sep 19, 2017 •

edited

Loading