whentimeslows/website
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

NetworkPolicy updates for v1 (#3721)

Browse Source 
* NetworkPolicy clarifications

- For clarity, only use the word "policy" in reference to
  NetworkPolicies, not in reference to the isolation annotation.

- Drop a bunch of text related to the isolation annotation since
  there's only one interesting value so there's no reason to
  complicate things.

- Fix bad YAML indentation

- Misc rewording

* Update NetworkPolicy docs for v1
This commit is contained in:
Dan Winship
2017-05-11 16:26:32 -04:00
committed by Andrew Chen
parent d0b6757e6f
commit a32d30c107
2 changed files with 67 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/concepts/services-networking/networkpolicies.md
+32 -35
View File
@@ -2,6 +2,7 @@
assignees: assignees:
- thockin - thockin
- caseydavenport - caseydavenport
- danwinship
title: Network Policies title: Network Policies
redirect_from: redirect_from:
- "/docs/user-guide/networkpolicies/" - "/docs/user-guide/networkpolicies/"
@@ -11,41 +12,37 @@ redirect_from:
* TOC * TOC
{:toc} {:toc}
A network policy is a specification of how selections of pods are allowed to communicate with each other and other network endpoints. A network policy is a specification of how groups of pods are allowed to communicate with each other and other network endpoints.
`NetworkPolicy` resources use labels to select pods and define whitelist rules which allow traffic to the selected pods in addition to what is allowed by the isolation policy for a given namespace. `NetworkPolicy` resources use labels to select pods and define whitelist rules which allow traffic to the selected pods in addition to what is allowed by the isolation policy for a given namespace.
## Prerequisites ## Prerequisites
You must enable the `extensions/v1beta1/networkpolicies` runtime config in your apiserver to enable this resource. Network policies are implemented by the network plugin, so you must be using a networking solution which supports `NetworkPolicy` - simply creating the resource without a controller to implement it will have no effect.
You must also be using a networking solution which supports `NetworkPolicy` - simply creating the ## Configuring Namespace Isolation
resource without a controller to implement it will have no effect.
## Configuring Namespace Isolation Policy By default, all traffic is allowed between all pods (and `NetworkPolicy` resources have no effect).
Isolation can be configured on a per-namespace basis. Once isolation is configured on a namespace it will be applied to all pods in that namespace. Currently, only isolation policy on inbound traffic (ingress) can be defined. Isolation can be configured on a per-namespace basis. Currently, only isolation on inbound traffic (ingress) can be defined. When a namespace has been configured to isolate inbound traffic, all traffic to pods in that namespace (even from other pods in the same namespace) will be blocked. `NetworkPolicy` objects can then be added to the isolated namespace to specify what traffic should be allowed.
The following ingress isolation types being supported: Isolation is enabled via the `NetworkPolicy` field of the `Namespace` object. To enable isolation via `kubectl`:
- `DefaultDeny`: Pods in the namespace will be inaccessible from any source except the pod's local node. ```shell
{% raw %}
Ingress isolation can be enabled using an annotation on the Namespace. kubectl patch ns <namespace> -p '{"spec": {"networkPolicy": {"ingress": {"isolation": "DefaultDeny"}}}}'
{% endraw %}
```yaml
kind: Namespace
apiVersion: v1
metadata:
annotations:
net.beta.kubernetes.io/network-policy: |
{
"ingress": {
"isolation": "DefaultDeny"
}
}
``` ```
To configure the annotation via `kubectl`: To disable it:
```shell
{% raw %}
kubectl patch ns <namespace> -p '{"spec": {"networkPolicy": null}}'
{% endraw %}
```
NOTE: older network plugins may instead require the v1beta1 syntax, using an annotation:
```shell ```shell
{% raw %} {% raw %}
@@ -53,16 +50,14 @@ kubectl annotate ns <namespace> "net.beta.kubernetes.io/network-policy={\"ingres
{% endraw %} {% endraw %}
``` ```
See the [NetworkPolicy getting started guide](/docs/getting-started-guides/network-policy/walkthrough) for an example.
## The `NetworkPolicy` Resource ## The `NetworkPolicy` Resource
See the [api-reference](/docs/api-reference/extensions/v1beta1/definitions/#_v1beta1_networkpolicy) for a full definition of the resource. See the [api-reference](/docs/api-reference/networking/v1/definitions/#_v1_networkpolicy) for a full definition of the resource.
A minimal `NetworkPolicy` might look like this: An example `NetworkPolicy` might look like this:
```yaml ```yaml
apiVersion: extensions/v1beta1 apiVersion: networking/v1
kind: NetworkPolicy kind: NetworkPolicy
metadata: metadata:
name: test-network-policy name: test-network-policy
@@ -88,14 +83,16 @@ spec:
__Mandatory Fields__: As with all other Kubernetes config, a `NetworkPolicy` needs `apiVersion`, `kind`, and `metadata` fields. For general information about working with config files, see [here](/docs/user-guide/simple-yaml), [here](/docs/user-guide/configuring-containers), and [here](/docs/user-guide/working-with-resources). __Mandatory Fields__: As with all other Kubernetes config, a `NetworkPolicy` needs `apiVersion`, `kind`, and `metadata` fields. For general information about working with config files, see [here](/docs/user-guide/simple-yaml), [here](/docs/user-guide/configuring-containers), and [here](/docs/user-guide/working-with-resources).
__spec__: `NetworkPolicy` [spec](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/docs/devel/api-conventions.md#spec-and-status) has all the information needed to define a network isolation policy in the deployed controller. __spec__: `NetworkPolicy` [spec](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/docs/devel/api-conventions.md#spec-and-status) has all the information needed to define a particular network policy in the given namespace.
__podSelector__: Each `NetworkPolicy` includes a `podSelector` which selects the grouping of pods to which the `ingress` rules in the policy apply. __podSelector__: Each `NetworkPolicy` includes a `podSelector` which selects the grouping of pods to which the `ingress` rules in the policy apply. The example policy selects pods with the label "role=db".
__ingress__: Each `NetworkPolicy` includes a list of whitelist `ingress` rules. Each rule allows traffic which matches both the `from` and `ports` sections. __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`.
This example NetworkPolicy has the following characteristics: So, the example NetworkPolicy:
1. allows connections to tcp port 6379 of "role=db" pods in the "default" namespace from any pod in the "default" namespace with the label "role=frontend"
2. allows connections to tcp port 6379 of "role=db" pods in the "default" namespace from any pod in a namespace with the label "project=myproject"
See the [NetworkPolicy getting started guide](/docs/getting-started-guides/network-policy/walkthrough) for further examples.
1. applies to all pods in the default namespace with the label "role=db"
2. allows tcp/6379 ingress traffic to the "role=db" pods from any pod in the current namespace with the label "role=frontend" (due to the podSelector list element)
3. allows tcp/6379 ingress traffic to the "role=db" pods from any pod in the namespace "myproject" (due to the namespaceSelector list element)
docs/tasks/administer-cluster/declare-network-policy.md
+19 -6
View File
@@ -1,6 +1,7 @@
--- ---
assignees: assignees:
- caseydavenport - caseydavenport
- danwinship
title: Declaring Network Policy title: Declaring Network Policy
redirect_from: redirect_from:
- "/docs/getting-started-guides/network-policy/walkthrough/" - "/docs/getting-started-guides/network-policy/walkthrough/"
@@ -46,7 +47,7 @@ po/nginx-701339712-o00ef 1/1 Running 0 35s
``` ```
We should be able to access our new nginx Service from other Pods. Let's try to access it from another Pod We should be able to access our new nginx Service from other Pods. Let's try to access it from another Pod
in the default namespace. We haven't put any network policy in place, so this should just work. Start a in the default namespace. We haven't enabled isolation on the namespace, so this should just work. Start a
busybox container, and use `wget` to hit the nginx Service: busybox container, and use `wget` to hit the nginx Service:
```console ```console
@@ -64,16 +65,28 @@ Let's say we want to limit access to our nginx Service so that only pods with th
enable ingress isolation on the `default` Namespace. This will prevent _any_ pods from accessing the nginx Service. enable ingress isolation on the `default` Namespace. This will prevent _any_ pods from accessing the nginx Service.
```console ```console
$ kubectl annotate ns default "net.beta.kubernetes.io/network-policy={\"ingress\": {\"isolation\": \"DefaultDeny\"}}" $ kubectl patch ns default -p '{"spec": {"networkPolicy": {"ingress": {"isolation": "DefaultDeny"}}}}'
``` ```
With ingress isolation in place, we should no longer be able to access the nginx Service like we were able to before. With ingress isolation in place, we should no longer be able to access the nginx Service like we were able to before:
```console
$ kubectl run busybox --rm -ti --image=busybox /bin/sh
Waiting for pod default/busybox-472357175-y0m47 to be running, status is Pending, pod ready: false
Hit enter for command prompt
/ # wget --spider --timeout=1 nginx
Connecting to nginx (10.100.0.16:80)
wget: download timed out
/ #
```
Let's now create a `NetworkPolicy` which allows connections from pods with the label `access: true`. Let's now create a `NetworkPolicy` which allows connections from pods with the label `access: true`.
```yaml ```yaml
kind: NetworkPolicy kind: NetworkPolicy
apiVersion: extensions/v1beta1 apiVersion: networking/v1
metadata: metadata:
name: access-nginx name: access-nginx
spec: spec:
@@ -87,13 +100,13 @@ spec:
access: "true" access: "true"
``` ```
Use kubectl to create the above nginx-policy.yaml file: Use kubectl to create a NetworkPolicy from the above nginx-policy.yaml file:
```console ```console
$ kubectl create -f nginx-policy.yaml $ kubectl create -f nginx-policy.yaml
networkpolicy "access-nginx" created networkpolicy "access-nginx" created
``` ```
If we attempt to access the nginx Service from a pod without the correct labels, the request will timeout: If we attempt to access the nginx Service from a pod without the correct labels, the request will still time out:
```console ```console
$ kubectl run busybox --rm -ti --image=busybox /bin/sh $ kubectl run busybox --rm -ti --image=busybox /bin/sh