kubernetes
/
website
mirror of https://github.com/kubernetes/website.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Reformat paragraphs in the namespaces task page 

This page can use more tweaks in addition to the ones proposed in this
PR. This PR focuses on line wrappings, empty lines, inappropriate lists,
and inappropriate indentations.
pull/41256/head
Qiming Teng 2023-05-22 10:19:31 +08:00
parent 24444592a2
commit c65feed910
1 changed files with 156 additions and 148 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

304
content/en/docs/tasks/administer-cluster/namespaces.md
View File

@ -8,25 +8,26 @@ weight: 340
--- ---
<!-- overview --> <!-- overview -->
This page shows how to view, work in, and delete {{< glossary_tooltip text="namespaces" term_id="namespace" >}}. The page also shows how to use Kubernetes namespaces to subdivide your cluster. This page shows how to view, work in, and delete {{< glossary_tooltip text="namespaces" term_id="namespace" >}}.
The page also shows how to use Kubernetes namespaces to subdivide your cluster.
## {{% heading "prerequisites" %}} ## {{% heading "prerequisites" %}}
* Have an [existing Kubernetes cluster](/docs/setup/). * Have an [existing Kubernetes cluster](/docs/setup/).
* You have a basic understanding of Kubernetes {{< glossary_tooltip text="Pods" term_id="pod" >}}, {{< glossary_tooltip term_id="service" text="Services" >}}, and {{< glossary_tooltip text="Deployments" term_id="deployment" >}}. * You have a basic understanding of Kubernetes {{< glossary_tooltip text="Pods" term_id="pod" >}},
{{< glossary_tooltip term_id="service" text="Services" >}}, and
{{< glossary_tooltip text="Deployments" term_id="deployment" >}}.
<!-- steps --> <!-- steps -->
## Viewing namespaces ## Viewing namespaces
1. List the current namespaces in a cluster using: List the current namespaces in a cluster using:
```shell ```shell
kubectl get namespaces kubectl get namespaces
``` ```
``` ```console
NAME STATUS AGE NAME STATUS AGE
default Active 11d default Active 11d
kube-system Active 11d kube-system Active 11d
@ -35,9 +36,12 @@ kube-public Active 11d
Kubernetes starts with three initial namespaces: Kubernetes starts with three initial namespaces:
* `default` The default namespace for objects with no other namespace * `default` The default namespace for objects with no other namespace
* `kube-system` The namespace for objects created by the Kubernetes system * `kube-system` The namespace for objects created by the Kubernetes system
* `kube-public` This namespace is created automatically and is readable by all users (including those not authenticated). This namespace is mostly reserved for cluster usage, in case that some resources should be visible and readable publicly throughout the whole cluster. The public aspect of this namespace is only a convention, not a requirement. * `kube-public` This namespace is created automatically and is readable by all users
(including those not authenticated). This namespace is mostly reserved for cluster usage,
in case that some resources should be visible and readable publicly throughout the whole cluster.
The public aspect of this namespace is only a convention, not a requirement.
You can also get the summary of a specific namespace using: You can also get the summary of a specific namespace using:
@ -50,7 +54,7 @@ Or you can get detailed information with:
```shell ```shell
kubectl describe namespaces <name> kubectl describe namespaces <name>
``` ```
``` ```console
Name: default Name: default
Labels: <none> Labels: <none>
Annotations: <none> Annotations: <none>
@ -66,18 +70,18 @@ Resource Limits
Note that these details show both resource quota (if present) as well as resource limit ranges. Note that these details show both resource quota (if present) as well as resource limit ranges.
Resource quota tracks aggregate usage of resources in the *Namespace* and allows cluster operators Resource quota tracks aggregate usage of resources in the Namespace and allows cluster operators
to define *Hard* resource usage limits that a *Namespace* may consume. to define *Hard* resource usage limits that a Namespace may consume.
A limit range defines min/max constraints on the amount of resources a single entity can consume in A limit range defines min/max constraints on the amount of resources a single entity can consume in
a *Namespace*. a Namespace.
See [Admission control: Limit Range](https://git.k8s.io/design-proposals-archive/resource-management/admission_control_limit_range.md) See [Admission control: Limit Range](https://git.k8s.io/design-proposals-archive/resource-management/admission_control_limit_range.md)
A namespace can be in one of two phases: A namespace can be in one of two phases:
* `Active` the namespace is in use * `Active` the namespace is in use
* `Terminating` the namespace is being deleted, and can not be used for new objects * `Terminating` the namespace is being deleted, and can not be used for new objects
For more details, see [Namespace](/docs/reference/kubernetes-api/cluster-resources/namespace-v1/) For more details, see [Namespace](/docs/reference/kubernetes-api/cluster-resources/namespace-v1/)
in the API reference. in the API reference.
@ -85,35 +89,38 @@ in the API reference.
## Creating a new namespace ## Creating a new namespace
{{< note >}} {{< note >}}
Avoid creating namespace with prefix `kube-`, since it is reserved for Kubernetes system namespaces. Avoid creating namespace with prefix `kube-`, since it is reserved for Kubernetes system namespaces.
{{< /note >}} {{< /note >}}
1. Create a new YAML file called `my-namespace.yaml` with the contents: Create a new YAML file called `my-namespace.yaml` with the contents:
```yaml ```yaml
apiVersion: v1 apiVersion: v1
kind: Namespace kind: Namespace
metadata: metadata:
name: <insert-namespace-name-here> name: <insert-namespace-name-here>
``` ```
Then run: Then run:
```
kubectl create -f ./my-namespace.yaml
```
2. Alternatively, you can create namespace using below command: ```shell
kubectl create -f ./my-namespace.yaml
```
``` Alternatively, you can create namespace using below command:
kubectl create namespace <insert-namespace-name-here>
``` ```shell
kubectl create namespace <insert-namespace-name-here>
```
The name of your namespace must be a valid The name of your namespace must be a valid
[DNS label](/docs/concepts/overview/working-with-objects/names#dns-label-names). [DNS label](/docs/concepts/overview/working-with-objects/names#dns-label-names).
There's an optional field `finalizers`, which allows observables to purge resources whenever the namespace is deleted. Keep in mind that if you specify a nonexistent finalizer, the namespace will be created but will get stuck in the `Terminating` state if the user tries to delete it. There's an optional field `finalizers`, which allows observables to purge resources whenever the
namespace is deleted. Keep in mind that if you specify a nonexistent finalizer, the namespace will
be created but will get stuck in the `Terminating` state if the user tries to delete it.
More information on `finalizers` can be found in the namespace [design doc](https://git.k8s.io/design-proposals-archive/architecture/namespaces.md#finalizers). More information on `finalizers` can be found in the namespace
[design doc](https://git.k8s.io/design-proposals-archive/architecture/namespaces.md#finalizers).
## Deleting a namespace ## Deleting a namespace
@ -131,191 +138,192 @@ This delete is asynchronous, so for a time you will see the namespace in the `Te
## Subdividing your cluster using Kubernetes namespaces ## Subdividing your cluster using Kubernetes namespaces
1. 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 Deployments used by the cluster.
By default, a Kubernetes cluster will instantiate a default namespace when provisioning the cluster to hold the default set of Pods, Assuming you have a fresh cluster, you can introspect the available namespaces by doing the following:
Services, and Deployments used by the cluster.
Assuming you have a fresh cluster, you can introspect the available namespaces by doing the following: ```shell
kubectl get namespaces
```
```console
NAME STATUS AGE
default Active 13m
```
```shell ### Create new namespaces
kubectl get namespaces
```
```
NAME STATUS AGE
default Active 13m
```
2. Create new namespaces For this exercise, we will create two additional Kubernetes namespaces to hold our content.
For this exercise, we will create two additional Kubernetes namespaces to hold our content. In a scenario where an organization is using a shared Kubernetes cluster for development and
production use cases:
In a scenario where an organization is using a shared Kubernetes cluster for development and production use cases: - 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 Deployments 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 development team would like to maintain a space in the cluster where they can get a view on the list of Pods, Services, and Deployments - The operations team would like to maintain a space in the cluster where they can enforce strict
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 procedures on who can or cannot manipulate the set of Pods, Services, and Deployments that run
are relaxed to enable agile development. the production site.
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 One pattern this organization could follow is to partition the Kubernetes cluster into two
Pods, Services, and Deployments that run the production site. namespaces: `development` and `production`. Let's create two new namespaces to hold our work.
One pattern this organization could follow is to partition the Kubernetes cluster into two namespaces: `development` and `production`. Create the `development` namespace using kubectl:
Let's create two new namespaces to hold our work. ```shell
kubectl create -f https://k8s.io/examples/admin/namespace-dev.json
```
Create the `development` namespace using kubectl: And then let's create the `production` namespace using kubectl:
```shell ```shell
kubectl create -f https://k8s.io/examples/admin/namespace-dev.json kubectl create -f https://k8s.io/examples/admin/namespace-prod.json
``` ```
And then let's create the `production` namespace using kubectl: To be sure things are right, list all of the namespaces in our cluster.
```shell ```shell
kubectl create -f https://k8s.io/examples/admin/namespace-prod.json kubectl get namespaces --show-labels
``` ```
To be sure things are right, list all of the namespaces in our cluster. ```console
NAME STATUS AGE LABELS
default Active 32m <none>
development Active 29s name=development
production Active 23s name=production
```
```shell ### Create pods in each namespace
kubectl get namespaces --show-labels
```
```
NAME STATUS AGE LABELS
default Active 32m <none>
development Active 29s name=development
production Active 23s name=production
```
3. Create pods in each namespace A Kubernetes namespace provides the scope for Pods, Services, and Deployments 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 Deployment and Pods in the `development` namespace.
A Kubernetes namespace provides the scope for Pods, Services, and Deployments in the cluster. ```shell
kubectl create deployment snowflake \
--image=registry.k8s.io/serve_hostname \
-n=development --replicas=2
```
Users interacting with one namespace do not see the content in another namespace. We have created a deployment whose replica size is 2 that is running the pod called `snowflake`
with a basic container that serves the hostname.
To demonstrate this, let's spin up a simple Deployment and Pods in the `development` namespace. ```shell
kubectl get deployment -n=development
```
```console
NAME READY UP-TO-DATE AVAILABLE AGE
snowflake 2/2 2 2 2m
```
```shell ```shell
kubectl create deployment snowflake --image=registry.k8s.io/serve_hostname -n=development --replicas=2 kubectl get pods -l app=snowflake -n=development
``` ```
We have created a deployment whose replica size is 2 that is running the pod called `snowflake` with a basic container that serves the hostname. ```console
NAME READY STATUS RESTARTS AGE
snowflake-3968820950-9dgr8 1/1 Running 0 2m
snowflake-3968820950-vgc4n 1/1 Running 0 2m
```
```shell And this is great, developers are able to do what they want, and they do not have to worry about
kubectl get deployment -n=development affecting content in the `production` namespace.
```
```
NAME READY UP-TO-DATE AVAILABLE AGE
snowflake 2/2 2 2 2m
```
```shell
kubectl get pods -l app=snowflake -n=development
```
```
NAME READY STATUS RESTARTS AGE
snowflake-3968820950-9dgr8 1/1 Running 0 2m
snowflake-3968820950-vgc4n 1/1 Running 0 2m
```
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. The `production` namespace should be empty, and the following commands should return nothing.
Let's switch to the `production` namespace and show how resources in one namespace are hidden from the other. ```shell
kubectl get deployment -n=production
kubectl get pods -n=production
```
The `production` namespace should be empty, and the following commands should return nothing. Production likes to run cattle, so let's create some cattle pods.
```shell ```shell
kubectl get deployment -n=production kubectl create deployment cattle --image=registry.k8s.io/serve_hostname -n=production
kubectl get pods -n=production kubectl scale deployment cattle --replicas=5 -n=production
```
Production likes to run cattle, so let's create some cattle pods. kubectl get deployment -n=production
```
```shell ```console
kubectl create deployment cattle --image=registry.k8s.io/serve_hostname -n=production NAME READY UP-TO-DATE AVAILABLE AGE
kubectl scale deployment cattle --replicas=5 -n=production cattle 5/5 5 5 10s
```
kubectl get deployment -n=production ```shell
``` kubectl get pods -l app=cattle -n=production
``` ```
NAME READY UP-TO-DATE AVAILABLE AGE ```console
cattle 5/5 5 5 10s NAME READY STATUS RESTARTS AGE
``` cattle-2263376956-41xy6 1/1 Running 0 34s
cattle-2263376956-kw466 1/1 Running 0 34s
cattle-2263376956-n4v97 1/1 Running 0 34s
cattle-2263376956-p5p3i 1/1 Running 0 34s
cattle-2263376956-sxpth 1/1 Running 0 34s
```
```shell At this point, it should be clear that the resources users create in one namespace are hidden from
kubectl get pods -l app=cattle -n=production the other namespace.
```
```
NAME READY STATUS RESTARTS AGE
cattle-2263376956-41xy6 1/1 Running 0 34s
cattle-2263376956-kw466 1/1 Running 0 34s
cattle-2263376956-n4v97 1/1 Running 0 34s
cattle-2263376956-p5p3i 1/1 Running 0 34s
cattle-2263376956-sxpth 1/1 Running 0 34s
```
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 As the policy support in Kubernetes evolves, we will extend this scenario to show how you can provide different
authorization rules for each namespace. authorization rules for each namespace.
<!-- discussion --> <!-- discussion -->
## Understanding the motivation for using namespaces ## Understanding the motivation for using namespaces
A single cluster should be able to satisfy the needs of multiple users or groups of users (henceforth a 'user community'). A single cluster should be able to satisfy the needs of multiple users or groups of users
(henceforth in this document a _user community_).
Kubernetes _namespaces_ help different projects, teams, or customers to share a Kubernetes cluster. Kubernetes _namespaces_ help different projects, teams, or customers to share a Kubernetes cluster.
It does this by providing the following: It does this by providing the following:
1. A scope for [Names](/docs/concepts/overview/working-with-objects/names/). 1. A scope for [names](/docs/concepts/overview/working-with-objects/names/).
2. A mechanism to attach authorization and policy to a subsection of the cluster. 1. A mechanism to attach authorization and policy to a subsection of the cluster.
Use of multiple namespaces is optional. Use of multiple namespaces is optional.
Each user community wants to be able to work in isolation from other communities. Each user community wants to be able to work in isolation from other communities.
Each user community has its own: Each user community has its own:
1. resources (pods, services, replication controllers, etc.) 1. resources (pods, services, replication controllers, etc.)
2. policies (who can or cannot perform actions in their community) 1. policies (who can or cannot perform actions in their community)
3. constraints (this community is allowed this much quota, etc.) 1. constraints (this community is allowed this much quota, etc.)
A cluster operator may create a Namespace for each unique user community. A cluster operator may create a Namespace for each unique user community.
The Namespace provides a unique scope for: The Namespace provides a unique scope for:
1. named resources (to avoid basic naming collisions) 1. named resources (to avoid basic naming collisions)
2. delegated management authority to trusted users 1. delegated management authority to trusted users
3. ability to limit community resource consumption 1. ability to limit community resource consumption
Use cases include: Use cases include:
1. As a cluster operator, I want to support multiple user communities on a single cluster. 1. As a cluster operator, I want to support multiple user communities on a single cluster.
2. As a cluster operator, I want to delegate authority to partitions of the cluster to trusted users 1. As a cluster operator, I want to delegate authority to partitions of the cluster to trusted
in those communities. users in those communities.
3. As a cluster operator, I want to limit the amount of resources each community can consume in order 1. As a cluster operator, I want to limit the amount of resources each community can consume in
to limit the impact to other communities using the cluster. order to limit the impact to other communities using the cluster.
4. As a cluster user, I want to interact with resources that are pertinent to my user community in 1. As a cluster user, I want to interact with resources that are pertinent to my user community in
isolation of what other user communities are doing on the cluster. isolation of what other user communities are doing on the cluster.
## Understanding namespaces and DNS ## Understanding namespaces and DNS
When you create a [Service](/docs/concepts/services-networking/service/), it creates a corresponding [DNS entry](/docs/concepts/services-networking/dns-pod-service/). When you create a [Service](/docs/concepts/services-networking/service/), it creates a corresponding
[DNS entry](/docs/concepts/services-networking/dns-pod-service/).
This entry is of the form `<service-name>.<namespace-name>.svc.cluster.local`, which means This entry is of the form `<service-name>.<namespace-name>.svc.cluster.local`, which means
that if a container uses `<service-name>` it will resolve to the service which that if a container uses `<service-name>` it will resolve to the service which
is local to a namespace. This is useful for using the same configuration across is local to a namespace. This is useful for using the same configuration across
multiple namespaces such as Development, Staging and Production. If you want to reach multiple namespaces such as Development, Staging and Production. If you want to reach
across namespaces, you need to use the fully qualified domain name (FQDN). across namespaces, you need to use the fully qualified domain name (FQDN).
## {{% heading "whatsnext" %}} ## {{% heading "whatsnext" %}}
* Learn more about [setting the namespace preference](/docs/concepts/overview/working-with-objects/namespaces/#setting-the-namespace-preference). * Learn more about [setting the namespace preference](/docs/concepts/overview/working-with-objects/namespaces/#setting-the-namespace-preference).
* Learn more about [setting the namespace for a request](/docs/concepts/overview/working-with-objects/namespaces/#setting-the-namespace-for-a-request) * Learn more about [setting the namespace for a request](/docs/concepts/overview/working-with-objects/namespaces/#setting-the-namespace-for-a-request)
* See [namespaces design](https://git.k8s.io/design-proposals-archive/architecture/namespaces.md). * See [namespaces design](https://git.k8s.io/design-proposals-archive/architecture/namespaces.md).