595 lines
12 KiB
Markdown
595 lines
12 KiB
Markdown
---
|
|
api_metadata:
|
|
apiVersion: "v1"
|
|
import: "k8s.io/api/core/v1"
|
|
kind: "Namespace"
|
|
content_type: "api_reference"
|
|
description: "Namespace provides a scope for Names."
|
|
title: "Namespace"
|
|
weight: 2
|
|
auto_generated: true
|
|
---
|
|
|
|
<!--
|
|
The file is auto-generated from the Go source code of the component using a generic
|
|
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
|
|
to generate the reference documentation, please read
|
|
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
|
|
To update the reference content, please follow the
|
|
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
|
|
guide. You can file document formatting bugs against the
|
|
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
|
|
-->
|
|
|
|
`apiVersion: v1`
|
|
|
|
`import "k8s.io/api/core/v1"`
|
|
|
|
|
|
## Namespace {#Namespace}
|
|
|
|
Namespace provides a scope for Names. Use of multiple namespaces is optional.
|
|
|
|
<hr>
|
|
|
|
- **apiVersion**: v1
|
|
|
|
|
|
- **kind**: Namespace
|
|
|
|
|
|
- **metadata** (<a href="{{< ref "../common-definitions/object-meta#ObjectMeta" >}}">ObjectMeta</a>)
|
|
|
|
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
|
|
|
|
- **spec** (<a href="{{< ref "../cluster-resources/namespace-v1#NamespaceSpec" >}}">NamespaceSpec</a>)
|
|
|
|
Spec defines the behavior of the Namespace. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
|
|
|
|
- **status** (<a href="{{< ref "../cluster-resources/namespace-v1#NamespaceStatus" >}}">NamespaceStatus</a>)
|
|
|
|
Status describes the current status of a Namespace. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
|
|
|
|
|
|
|
|
|
|
|
|
## NamespaceSpec {#NamespaceSpec}
|
|
|
|
NamespaceSpec describes the attributes on a Namespace.
|
|
|
|
<hr>
|
|
|
|
- **finalizers** ([]string)
|
|
|
|
Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/
|
|
|
|
|
|
|
|
|
|
|
|
## NamespaceStatus {#NamespaceStatus}
|
|
|
|
NamespaceStatus is information about the current status of a Namespace.
|
|
|
|
<hr>
|
|
|
|
- **conditions** ([]NamespaceCondition)
|
|
|
|
*Patch strategy: merge on key `type`*
|
|
|
|
Represents the latest available observations of a namespace's current state.
|
|
|
|
<a name="NamespaceCondition"></a>
|
|
*NamespaceCondition contains details about state of namespace.*
|
|
|
|
- **conditions.status** (string), required
|
|
|
|
Status of the condition, one of True, False, Unknown.
|
|
|
|
- **conditions.type** (string), required
|
|
|
|
Type of namespace controller condition.
|
|
|
|
- **conditions.lastTransitionTime** (Time)
|
|
|
|
|
|
<a name="Time"></a>
|
|
*Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.*
|
|
|
|
- **conditions.message** (string)
|
|
|
|
|
|
- **conditions.reason** (string)
|
|
|
|
|
|
- **phase** (string)
|
|
|
|
Phase is the current lifecycle phase of the namespace. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/
|
|
|
|
|
|
|
|
|
|
|
|
## NamespaceList {#NamespaceList}
|
|
|
|
NamespaceList is a list of Namespaces.
|
|
|
|
<hr>
|
|
|
|
- **apiVersion**: v1
|
|
|
|
|
|
- **kind**: NamespaceList
|
|
|
|
|
|
- **metadata** (<a href="{{< ref "../common-definitions/list-meta#ListMeta" >}}">ListMeta</a>)
|
|
|
|
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
|
|
|
|
- **items** ([]<a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace</a>), required
|
|
|
|
Items is the list of Namespace objects in the list. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
|
|
|
|
|
|
|
|
|
|
|
|
## Operations {#Operations}
|
|
|
|
|
|
|
|
<hr>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### `get` read the specified Namespace
|
|
|
|
#### HTTP Request
|
|
|
|
GET /api/v1/namespaces/{name}
|
|
|
|
#### Parameters
|
|
|
|
|
|
- **name** (*in path*): string, required
|
|
|
|
name of the Namespace
|
|
|
|
|
|
- **pretty** (*in query*): string
|
|
|
|
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
|
|
|
|
|
|
|
|
#### Response
|
|
|
|
|
|
200 (<a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace</a>): OK
|
|
|
|
401: Unauthorized
|
|
|
|
|
|
### `get` read status of the specified Namespace
|
|
|
|
#### HTTP Request
|
|
|
|
GET /api/v1/namespaces/{name}/status
|
|
|
|
#### Parameters
|
|
|
|
|
|
- **name** (*in path*): string, required
|
|
|
|
name of the Namespace
|
|
|
|
|
|
- **pretty** (*in query*): string
|
|
|
|
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
|
|
|
|
|
|
|
|
#### Response
|
|
|
|
|
|
200 (<a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace</a>): OK
|
|
|
|
401: Unauthorized
|
|
|
|
|
|
### `list` list or watch objects of kind Namespace
|
|
|
|
#### HTTP Request
|
|
|
|
GET /api/v1/namespaces
|
|
|
|
#### Parameters
|
|
|
|
|
|
- **allowWatchBookmarks** (*in query*): boolean
|
|
|
|
<a href="{{< ref "../common-parameters/common-parameters#allowWatchBookmarks" >}}">allowWatchBookmarks</a>
|
|
|
|
|
|
- **continue** (*in query*): string
|
|
|
|
<a href="{{< ref "../common-parameters/common-parameters#continue" >}}">continue</a>
|
|
|
|
|
|
- **fieldSelector** (*in query*): string
|
|
|
|
<a href="{{< ref "../common-parameters/common-parameters#fieldSelector" >}}">fieldSelector</a>
|
|
|
|
|
|
- **labelSelector** (*in query*): string
|
|
|
|
<a href="{{< ref "../common-parameters/common-parameters#labelSelector" >}}">labelSelector</a>
|
|
|
|
|
|
- **limit** (*in query*): integer
|
|
|
|
<a href="{{< ref "../common-parameters/common-parameters#limit" >}}">limit</a>
|
|
|
|
|
|
- **pretty** (*in query*): string
|
|
|
|
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
|
|
|
|
|
|
- **resourceVersion** (*in query*): string
|
|
|
|
<a href="{{< ref "../common-parameters/common-parameters#resourceVersion" >}}">resourceVersion</a>
|
|
|
|
|
|
- **resourceVersionMatch** (*in query*): string
|
|
|
|
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
|
|
|
|
|
|
- **timeoutSeconds** (*in query*): integer
|
|
|
|
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
|
|
|
|
|
|
- **watch** (*in query*): boolean
|
|
|
|
<a href="{{< ref "../common-parameters/common-parameters#watch" >}}">watch</a>
|
|
|
|
|
|
|
|
#### Response
|
|
|
|
|
|
200 (<a href="{{< ref "../cluster-resources/namespace-v1#NamespaceList" >}}">NamespaceList</a>): OK
|
|
|
|
401: Unauthorized
|
|
|
|
|
|
### `create` create a Namespace
|
|
|
|
#### HTTP Request
|
|
|
|
POST /api/v1/namespaces
|
|
|
|
#### Parameters
|
|
|
|
|
|
- **body**: <a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace</a>, required
|
|
|
|
|
|
|
|
|
|
- **dryRun** (*in query*): string
|
|
|
|
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a>
|
|
|
|
|
|
- **fieldManager** (*in query*): string
|
|
|
|
<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>
|
|
|
|
|
|
- **pretty** (*in query*): string
|
|
|
|
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
|
|
|
|
|
|
|
|
#### Response
|
|
|
|
|
|
200 (<a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace</a>): OK
|
|
|
|
201 (<a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace</a>): Created
|
|
|
|
202 (<a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace</a>): Accepted
|
|
|
|
401: Unauthorized
|
|
|
|
|
|
### `update` replace the specified Namespace
|
|
|
|
#### HTTP Request
|
|
|
|
PUT /api/v1/namespaces/{name}
|
|
|
|
#### Parameters
|
|
|
|
|
|
- **name** (*in path*): string, required
|
|
|
|
name of the Namespace
|
|
|
|
|
|
- **body**: <a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace</a>, required
|
|
|
|
|
|
|
|
|
|
- **dryRun** (*in query*): string
|
|
|
|
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a>
|
|
|
|
|
|
- **fieldManager** (*in query*): string
|
|
|
|
<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>
|
|
|
|
|
|
- **pretty** (*in query*): string
|
|
|
|
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
|
|
|
|
|
|
|
|
#### Response
|
|
|
|
|
|
200 (<a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace</a>): OK
|
|
|
|
201 (<a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace</a>): Created
|
|
|
|
401: Unauthorized
|
|
|
|
|
|
### `update` replace finalize of the specified Namespace
|
|
|
|
#### HTTP Request
|
|
|
|
PUT /api/v1/namespaces/{name}/finalize
|
|
|
|
#### Parameters
|
|
|
|
|
|
- **name** (*in path*): string, required
|
|
|
|
name of the Namespace
|
|
|
|
|
|
- **body**: <a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace</a>, required
|
|
|
|
|
|
|
|
|
|
- **dryRun** (*in query*): string
|
|
|
|
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a>
|
|
|
|
|
|
- **fieldManager** (*in query*): string
|
|
|
|
<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>
|
|
|
|
|
|
- **pretty** (*in query*): string
|
|
|
|
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
|
|
|
|
|
|
|
|
#### Response
|
|
|
|
|
|
200 (<a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace</a>): OK
|
|
|
|
201 (<a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace</a>): Created
|
|
|
|
401: Unauthorized
|
|
|
|
|
|
### `update` replace status of the specified Namespace
|
|
|
|
#### HTTP Request
|
|
|
|
PUT /api/v1/namespaces/{name}/status
|
|
|
|
#### Parameters
|
|
|
|
|
|
- **name** (*in path*): string, required
|
|
|
|
name of the Namespace
|
|
|
|
|
|
- **body**: <a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace</a>, required
|
|
|
|
|
|
|
|
|
|
- **dryRun** (*in query*): string
|
|
|
|
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a>
|
|
|
|
|
|
- **fieldManager** (*in query*): string
|
|
|
|
<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>
|
|
|
|
|
|
- **pretty** (*in query*): string
|
|
|
|
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
|
|
|
|
|
|
|
|
#### Response
|
|
|
|
|
|
200 (<a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace</a>): OK
|
|
|
|
201 (<a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace</a>): Created
|
|
|
|
401: Unauthorized
|
|
|
|
|
|
### `patch` partially update the specified Namespace
|
|
|
|
#### HTTP Request
|
|
|
|
PATCH /api/v1/namespaces/{name}
|
|
|
|
#### Parameters
|
|
|
|
|
|
- **name** (*in path*): string, required
|
|
|
|
name of the Namespace
|
|
|
|
|
|
- **body**: <a href="{{< ref "../common-definitions/patch#Patch" >}}">Patch</a>, required
|
|
|
|
|
|
|
|
|
|
- **dryRun** (*in query*): string
|
|
|
|
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a>
|
|
|
|
|
|
- **fieldManager** (*in query*): string
|
|
|
|
<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>
|
|
|
|
|
|
- **force** (*in query*): boolean
|
|
|
|
<a href="{{< ref "../common-parameters/common-parameters#force" >}}">force</a>
|
|
|
|
|
|
- **pretty** (*in query*): string
|
|
|
|
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
|
|
|
|
|
|
|
|
#### Response
|
|
|
|
|
|
200 (<a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace</a>): OK
|
|
|
|
401: Unauthorized
|
|
|
|
|
|
### `patch` partially update status of the specified Namespace
|
|
|
|
#### HTTP Request
|
|
|
|
PATCH /api/v1/namespaces/{name}/status
|
|
|
|
#### Parameters
|
|
|
|
|
|
- **name** (*in path*): string, required
|
|
|
|
name of the Namespace
|
|
|
|
|
|
- **body**: <a href="{{< ref "../common-definitions/patch#Patch" >}}">Patch</a>, required
|
|
|
|
|
|
|
|
|
|
- **dryRun** (*in query*): string
|
|
|
|
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a>
|
|
|
|
|
|
- **fieldManager** (*in query*): string
|
|
|
|
<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager</a>
|
|
|
|
|
|
- **force** (*in query*): boolean
|
|
|
|
<a href="{{< ref "../common-parameters/common-parameters#force" >}}">force</a>
|
|
|
|
|
|
- **pretty** (*in query*): string
|
|
|
|
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
|
|
|
|
|
|
|
|
#### Response
|
|
|
|
|
|
200 (<a href="{{< ref "../cluster-resources/namespace-v1#Namespace" >}}">Namespace</a>): OK
|
|
|
|
401: Unauthorized
|
|
|
|
|
|
### `delete` delete a Namespace
|
|
|
|
#### HTTP Request
|
|
|
|
DELETE /api/v1/namespaces/{name}
|
|
|
|
#### Parameters
|
|
|
|
|
|
- **name** (*in path*): string, required
|
|
|
|
name of the Namespace
|
|
|
|
|
|
- **body**: <a href="{{< ref "../common-definitions/delete-options#DeleteOptions" >}}">DeleteOptions</a>
|
|
|
|
|
|
|
|
|
|
- **dryRun** (*in query*): string
|
|
|
|
<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun</a>
|
|
|
|
|
|
- **gracePeriodSeconds** (*in query*): integer
|
|
|
|
<a href="{{< ref "../common-parameters/common-parameters#gracePeriodSeconds" >}}">gracePeriodSeconds</a>
|
|
|
|
|
|
- **pretty** (*in query*): string
|
|
|
|
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
|
|
|
|
|
|
- **propagationPolicy** (*in query*): string
|
|
|
|
<a href="{{< ref "../common-parameters/common-parameters#propagationPolicy" >}}">propagationPolicy</a>
|
|
|
|
|
|
|
|
#### Response
|
|
|
|
|
|
200 (<a href="{{< ref "../common-definitions/status#Status" >}}">Status</a>): OK
|
|
|
|
202 (<a href="{{< ref "../common-definitions/status#Status" >}}">Status</a>): Accepted
|
|
|
|
401: Unauthorized
|
|
|