2015-07-13 20:13:09 -04:00
<!-- BEGIN MUNGE: UNVERSIONED_WARNING -->
<!-- BEGIN STRIP_FOR_RELEASE -->
2015-07-16 13:02:26 -04:00
< img src = "http://kubernetes.io/img/warning.png" alt = "WARNING"
width="25" height="25">
< img src = "http://kubernetes.io/img/warning.png" alt = "WARNING"
width="25" height="25">
< img src = "http://kubernetes.io/img/warning.png" alt = "WARNING"
width="25" height="25">
< img src = "http://kubernetes.io/img/warning.png" alt = "WARNING"
width="25" height="25">
< img src = "http://kubernetes.io/img/warning.png" alt = "WARNING"
width="25" height="25">
< h2 > PLEASE NOTE: This document applies to the HEAD of the source tree< / h2 >
If you are using a released version of Kubernetes, you should
refer to the docs that go with that version.
2015-12-14 13:37:38 -05:00
<!-- TAG RELEASE_LINK, added by the munger automatically -->
2015-07-16 13:02:26 -04:00
< strong >
2015-11-03 13:17:57 -05:00
The latest release of this document can be found
[here ](http://releases.k8s.io/release-1.1/docs/admin/namespaces/README.md ).
2015-07-16 13:02:26 -04:00
Documentation for other releases can be found at
[releases.k8s.io ](http://releases.k8s.io ).
< / strong >
--
2015-07-13 18:15:35 -04:00
2015-07-13 20:13:09 -04:00
<!-- END STRIP_FOR_RELEASE -->
<!-- END MUNGE: UNVERSIONED_WARNING -->
2015-07-17 18:35:41 -04:00
2015-01-19 16:50:00 -05:00
## Kubernetes Namespaces
2015-07-20 15:54:28 -04:00
Kubernetes _[namespaces](../../../docs/admin/namespaces.md)_ help different projects, teams, or customers to share a Kubernetes cluster.
2015-01-19 16:50:00 -05:00
It does this by providing the following:
2015-07-20 15:54:28 -04:00
1. A scope for [Names ](../../user-guide/identifiers.md ).
2015-01-19 16:50:00 -05:00
2. A mechanism to attach authorization and policy to a subsection of the cluster.
Use of multiple namespaces is optional.
This example demonstrates how to use Kubernetes namespaces to subdivide your cluster.
### Step Zero: Prerequisites
This example assumes the following:
2015-07-16 18:20:37 -04:00
1. You have an [existing Kubernetes cluster ](../../getting-started-guides/ ).
2015-07-20 15:54:28 -04:00
2. You have a basic understanding of Kubernetes _[pods](../../user-guide/pods.md)_ , _[services](../../user-guide/services.md)_ , and _[replication controllers](../../user-guide/replication-controller.md)_ .
2015-01-19 16:50:00 -05:00
### Step One: Understand the default namespace
By default, a Kubernetes cluster will instantiate a default namespace when provisioning the cluster to hold the default set of pods,
services, and replication controllers used by the cluster.
Assuming you have a fresh cluster, you can introspect the available namespace's by doing the following:
2015-07-18 21:42:04 -04:00
```console
2015-06-05 17:50:11 -04:00
$ kubectl get namespaces
2015-01-19 16:50:00 -05:00
NAME LABELS
default < none >
```
### Step Two: Create new namespaces
For this exercise, we will create two additional Kubernetes namespaces to hold our content.
Let's imagine a scenario where an organization is using a shared Kubernetes cluster for development and production use cases.
2015-09-21 21:48:53 -04:00
The development team would like to maintain a space in the cluster where they can get a view on the list of pods, services, and replication controllers
2015-01-19 16:50:00 -05:00
they use to build and run their application. In this space, Kubernetes resources come and go, and the restrictions on who can or cannot modify resources
are relaxed to enable agile development.
The operations team would like to maintain a space in the cluster where they can enforce strict procedures on who can or cannot manipulate the set of
pods, services, and replication controllers that run the production site.
One pattern this organization could follow is to partition the Kubernetes cluster into two namespaces: development and production.
Let's create two new namespaces to hold our work.
2015-07-16 18:20:37 -04:00
Use the file [`namespace-dev.json` ](namespace-dev.json ) which describes a development namespace:
2015-01-19 16:50:00 -05:00
2015-07-20 18:46:20 -04:00
<!-- BEGIN MUNGE: EXAMPLE namespace - dev.json -->
2015-07-18 21:42:04 -04:00
```json
2015-01-19 16:50:00 -05:00
{
"kind": "Namespace",
2015-06-10 14:38:31 -04:00
"apiVersion": "v1",
2015-05-05 17:46:00 -04:00
"metadata": {
"name": "development",
"labels": {
"name": "development"
}
}
2015-01-19 16:50:00 -05:00
}
```
2015-09-07 20:43:09 -04:00
[Download example ](namespace-dev.json?raw=true )
2015-07-20 13:45:12 -04:00
<!-- END MUNGE: EXAMPLE namespace - dev.json -->
2015-07-20 18:46:20 -04:00
2015-01-19 16:50:00 -05:00
Create the development namespace using kubectl.
2015-07-18 21:42:04 -04:00
```console
2015-07-20 15:54:28 -04:00
$ kubectl create -f docs/admin/namespaces/namespace-dev.json
2015-01-19 16:50:00 -05:00
```
And then lets create the production namespace using kubectl.
2015-07-18 21:42:04 -04:00
```console
2015-07-20 15:54:28 -04:00
$ kubectl create -f docs/admin/namespaces/namespace-prod.json
2015-01-19 16:50:00 -05:00
```
To be sure things are right, let's list all of the namespaces in our cluster.
2015-07-18 21:42:04 -04:00
```console
2015-06-05 17:50:11 -04:00
$ kubectl get namespaces
2015-05-05 17:46:00 -04:00
NAME LABELS STATUS
default < none > Active
development name=development Active
production name=production Active
2015-01-19 16:50:00 -05:00
```
2015-05-05 17:46:00 -04:00
2015-01-19 16:50:00 -05:00
### Step Three: Create pods in each namespace
A Kubernetes namespace provides the scope for pods, services, and replication controllers in the cluster.
Users interacting with one namespace do not see the content in another namespace.
To demonstrate this, let's spin up a simple replication controller and pod in the development namespace.
2015-05-05 17:46:00 -04:00
We first check what is the current context:
2015-07-18 21:42:04 -04:00
```yaml
2015-05-05 17:46:00 -04:00
apiVersion: v1
clusters:
- cluster:
certificate-authority-data: REDACTED
server: https://130.211.122.180
name: lithe-cocoa-92103_kubernetes
contexts:
- context:
cluster: lithe-cocoa-92103_kubernetes
user: lithe-cocoa-92103_kubernetes
name: lithe-cocoa-92103_kubernetes
current-context: lithe-cocoa-92103_kubernetes
kind: Config
preferences: {}
users:
- name: lithe-cocoa-92103_kubernetes
user:
client-certificate-data: REDACTED
client-key-data: REDACTED
token: 65rZW78y8HbwXXtSXuUw9DbP4FLjHi4b
- name: lithe-cocoa-92103_kubernetes-basic-auth
user:
password: h5M0FtUUIflBSdI7
username: admin
```
The next step is to define a context for the kubectl client to work in each namespace. The value of "cluster" and "user" fields are copied from the current context.
2015-01-19 16:50:00 -05:00
2015-07-18 21:42:04 -04:00
```console
2015-06-05 17:50:11 -04:00
$ kubectl config set-context dev --namespace=development --cluster=lithe-cocoa-92103_kubernetes --user=lithe-cocoa-92103_kubernetes
$ kubectl config set-context prod --namespace=production --cluster=lithe-cocoa-92103_kubernetes --user=lithe-cocoa-92103_kubernetes
2015-01-19 16:50:00 -05:00
```
The above commands provided two request contexts you can alternate against depending on what namespace you
wish to work against.
Let's switch to operate in the development namespace.
2015-07-18 21:42:04 -04:00
```console
2015-06-05 17:50:11 -04:00
$ kubectl config use-context dev
2015-01-19 16:50:00 -05:00
```
You can verify your current context by doing the following:
2015-07-18 21:42:04 -04:00
```console
2015-06-05 17:50:11 -04:00
$ kubectl config view
2015-07-18 21:42:04 -04:00
```
```yaml
2015-05-05 17:46:00 -04:00
apiVersion: v1
clusters:
- cluster:
certificate-authority-data: REDACTED
server: https://130.211.122.180
name: lithe-cocoa-92103_kubernetes
2015-01-19 16:50:00 -05:00
contexts:
2015-05-05 17:46:00 -04:00
- context:
cluster: lithe-cocoa-92103_kubernetes
2015-01-19 16:50:00 -05:00
namespace: development
2015-05-05 17:46:00 -04:00
user: lithe-cocoa-92103_kubernetes
name: dev
- context:
cluster: lithe-cocoa-92103_kubernetes
user: lithe-cocoa-92103_kubernetes
name: lithe-cocoa-92103_kubernetes
- context:
cluster: lithe-cocoa-92103_kubernetes
2015-01-19 16:50:00 -05:00
namespace: production
2015-05-05 17:46:00 -04:00
user: lithe-cocoa-92103_kubernetes
name: prod
2015-01-19 16:50:00 -05:00
current-context: dev
2015-05-05 17:46:00 -04:00
kind: Config
2015-01-19 16:50:00 -05:00
preferences: {}
2015-05-05 17:46:00 -04:00
users:
- name: lithe-cocoa-92103_kubernetes
user:
client-certificate-data: REDACTED
client-key-data: REDACTED
token: 65rZW78y8HbwXXtSXuUw9DbP4FLjHi4b
- name: lithe-cocoa-92103_kubernetes-basic-auth
user:
password: h5M0FtUUIflBSdI7
username: admin
2015-01-19 16:50:00 -05:00
```
At this point, all requests we make to the Kubernetes cluster from the command line are scoped to the development namespace.
Let's create some content.
2015-07-18 21:42:04 -04:00
```console
2015-06-05 17:50:11 -04:00
$ kubectl run snowflake --image=kubernetes/serve_hostname --replicas=2
2015-01-19 16:50:00 -05:00
```
We have just created a replication controller whose replica size is 2 that is running the pod called snowflake with a basic container that just serves the hostname.
2015-07-18 21:42:04 -04:00
```console
2015-07-07 17:29:59 -04:00
$ kubectl get rc
CONTROLLER CONTAINER(S) IMAGE(S) SELECTOR REPLICAS
snowflake snowflake kubernetes/serve_hostname run=snowflake 2
2015-01-19 16:50:00 -05:00
2015-06-05 17:50:11 -04:00
$ kubectl get pods
2015-07-07 17:29:59 -04:00
NAME READY STATUS RESTARTS AGE
snowflake-8w0qn 1/1 Running 0 22s
snowflake-jrpzb 1/1 Running 0 22s
2015-01-19 16:50:00 -05:00
```
And this is great, developers are able to do what they want, and they do not have to worry about affecting content in the production namespace.
Let's switch to the production namespace and show how resources in one namespace are hidden from the other.
2015-07-18 21:42:04 -04:00
```console
2015-06-05 17:50:11 -04:00
$ kubectl config use-context prod
2015-01-19 16:50:00 -05:00
```
The production namespace should be empty.
2015-07-18 21:42:04 -04:00
```console
2015-06-05 17:50:11 -04:00
$ kubectl get rc
2015-07-07 17:29:59 -04:00
CONTROLLER CONTAINER(S) IMAGE(S) SELECTOR REPLICAS
2015-01-19 16:50:00 -05:00
2015-06-05 17:50:11 -04:00
$ kubectl get pods
2015-07-07 17:29:59 -04:00
NAME READY STATUS RESTARTS AGE
2015-01-19 16:50:00 -05:00
```
Production likes to run cattle, so let's create some cattle pods.
2015-07-18 21:42:04 -04:00
```console
2015-06-05 17:50:11 -04:00
$ kubectl run cattle --image=kubernetes/serve_hostname --replicas=5
2015-01-19 16:50:00 -05:00
2015-06-05 17:50:11 -04:00
$ kubectl get rc
2015-07-07 17:29:59 -04:00
CONTROLLER CONTAINER(S) IMAGE(S) SELECTOR REPLICAS
cattle cattle kubernetes/serve_hostname run=cattle 5
2015-01-19 16:50:00 -05:00
2015-06-05 17:50:11 -04:00
$ kubectl get pods
2015-07-07 17:29:59 -04:00
NAME READY STATUS RESTARTS AGE
cattle-97rva 1/1 Running 0 12s
cattle-i9ojn 1/1 Running 0 12s
cattle-qj3yv 1/1 Running 0 12s
cattle-yc7vn 1/1 Running 0 12s
cattle-zz7ea 1/1 Running 0 12s
2015-01-19 16:50:00 -05:00
```
At this point, it should be clear that the resources users create in one namespace are hidden from the other namespace.
As the policy support in Kubernetes evolves, we will extend this scenario to show how you can provide different
authorization rules for each namespace.
2015-05-14 18:12:45 -04:00
2015-07-13 20:13:09 -04:00
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
2015-07-20 15:54:28 -04:00
[]()
2015-07-13 20:13:09 -04:00
<!-- END MUNGE: GENERATED_ANALYTICS -->