GET /api/v1
×
Kubernetes v1 REST api
Paths
create a Binding
POST /api/v1/bindings
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
list objects of kind ComponentStatus
GET /api/v1/componentstatuses
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
read the specified ComponentStatus
GET /api/v1/componentstatuses/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
PathParameter |
name |
name of the ComponentStatus |
true |
string |
list or watch objects of kind ConfigMap
GET /api/v1/configmaps
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
create a ConfigMap
POST /api/v1/configmaps
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
list or watch objects of kind Endpoints
GET /api/v1/endpoints
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
create Endpoints
POST /api/v1/endpoints
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
list or watch objects of kind Event
GET /api/v1/events
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
create an Event
POST /api/v1/events
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
list or watch objects of kind LimitRange
GET /api/v1/limitranges
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
create a LimitRange
POST /api/v1/limitranges
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
list or watch objects of kind Namespace
GET /api/v1/namespaces
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
create a Namespace
POST /api/v1/namespaces
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
delete collection of Namespace
DELETE /api/v1/namespaces
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
create a Binding
POST /api/v1/namespaces/{namespace}/bindings
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
list or watch objects of kind ConfigMap
GET /api/v1/namespaces/{namespace}/configmaps
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
create a ConfigMap
POST /api/v1/namespaces/{namespace}/configmaps
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
delete collection of ConfigMap
DELETE /api/v1/namespaces/{namespace}/configmaps
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
read the specified ConfigMap
GET /api/v1/namespaces/{namespace}/configmaps/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
export |
Should this value be exported. Export strips fields that a user can not specify. |
false |
boolean |
|
QueryParameter |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
false |
boolean |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ConfigMap |
true |
string |
partially update the specified ConfigMap
PATCH /api/v1/namespaces/{namespace}/configmaps/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ConfigMap |
true |
string |
replace the specified ConfigMap
PUT /api/v1/namespaces/{namespace}/configmaps/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ConfigMap |
true |
string |
delete a ConfigMap
DELETE /api/v1/namespaces/{namespace}/configmaps/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
QueryParameter |
gracePeriodSeconds |
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
false |
integer |
|
QueryParameter |
orphanDependents |
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both. |
false |
boolean |
|
QueryParameter |
propagationPolicy |
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ConfigMap |
true |
string |
list or watch objects of kind Endpoints
GET /api/v1/namespaces/{namespace}/endpoints
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
create Endpoints
POST /api/v1/namespaces/{namespace}/endpoints
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
delete collection of Endpoints
DELETE /api/v1/namespaces/{namespace}/endpoints
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
read the specified Endpoints
GET /api/v1/namespaces/{namespace}/endpoints/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
export |
Should this value be exported. Export strips fields that a user can not specify. |
false |
boolean |
|
QueryParameter |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
false |
boolean |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Endpoints |
true |
string |
partially update the specified Endpoints
PATCH /api/v1/namespaces/{namespace}/endpoints/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Endpoints |
true |
string |
replace the specified Endpoints
PUT /api/v1/namespaces/{namespace}/endpoints/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Endpoints |
true |
string |
delete Endpoints
DELETE /api/v1/namespaces/{namespace}/endpoints/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
QueryParameter |
gracePeriodSeconds |
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
false |
integer |
|
QueryParameter |
orphanDependents |
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both. |
false |
boolean |
|
QueryParameter |
propagationPolicy |
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Endpoints |
true |
string |
list or watch objects of kind Event
GET /api/v1/namespaces/{namespace}/events
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
create an Event
POST /api/v1/namespaces/{namespace}/events
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
delete collection of Event
DELETE /api/v1/namespaces/{namespace}/events
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
read the specified Event
GET /api/v1/namespaces/{namespace}/events/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
export |
Should this value be exported. Export strips fields that a user can not specify. |
false |
boolean |
|
QueryParameter |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
false |
boolean |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Event |
true |
string |
partially update the specified Event
PATCH /api/v1/namespaces/{namespace}/events/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Event |
true |
string |
replace the specified Event
PUT /api/v1/namespaces/{namespace}/events/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Event |
true |
string |
delete an Event
DELETE /api/v1/namespaces/{namespace}/events/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
QueryParameter |
gracePeriodSeconds |
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
false |
integer |
|
QueryParameter |
orphanDependents |
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both. |
false |
boolean |
|
QueryParameter |
propagationPolicy |
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Event |
true |
string |
list or watch objects of kind LimitRange
GET /api/v1/namespaces/{namespace}/limitranges
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
create a LimitRange
POST /api/v1/namespaces/{namespace}/limitranges
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
delete collection of LimitRange
DELETE /api/v1/namespaces/{namespace}/limitranges
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
read the specified LimitRange
GET /api/v1/namespaces/{namespace}/limitranges/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
export |
Should this value be exported. Export strips fields that a user can not specify. |
false |
boolean |
|
QueryParameter |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
false |
boolean |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the LimitRange |
true |
string |
partially update the specified LimitRange
PATCH /api/v1/namespaces/{namespace}/limitranges/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the LimitRange |
true |
string |
replace the specified LimitRange
PUT /api/v1/namespaces/{namespace}/limitranges/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the LimitRange |
true |
string |
delete a LimitRange
DELETE /api/v1/namespaces/{namespace}/limitranges/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
QueryParameter |
gracePeriodSeconds |
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
false |
integer |
|
QueryParameter |
orphanDependents |
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both. |
false |
boolean |
|
QueryParameter |
propagationPolicy |
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the LimitRange |
true |
string |
list or watch objects of kind PersistentVolumeClaim
GET /api/v1/namespaces/{namespace}/persistentvolumeclaims
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
create a PersistentVolumeClaim
POST /api/v1/namespaces/{namespace}/persistentvolumeclaims
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
delete collection of PersistentVolumeClaim
DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
read the specified PersistentVolumeClaim
GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
export |
Should this value be exported. Export strips fields that a user can not specify. |
false |
boolean |
|
QueryParameter |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
false |
boolean |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the PersistentVolumeClaim |
true |
string |
partially update the specified PersistentVolumeClaim
PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the PersistentVolumeClaim |
true |
string |
replace the specified PersistentVolumeClaim
PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the PersistentVolumeClaim |
true |
string |
delete a PersistentVolumeClaim
DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
QueryParameter |
gracePeriodSeconds |
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
false |
integer |
|
QueryParameter |
orphanDependents |
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both. |
false |
boolean |
|
QueryParameter |
propagationPolicy |
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the PersistentVolumeClaim |
true |
string |
read status of the specified PersistentVolumeClaim
GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the PersistentVolumeClaim |
true |
string |
partially update status of the specified PersistentVolumeClaim
PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the PersistentVolumeClaim |
true |
string |
replace status of the specified PersistentVolumeClaim
PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the PersistentVolumeClaim |
true |
string |
list or watch objects of kind Pod
GET /api/v1/namespaces/{namespace}/pods
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
create a Pod
POST /api/v1/namespaces/{namespace}/pods
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
delete collection of Pod
DELETE /api/v1/namespaces/{namespace}/pods
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
read the specified Pod
GET /api/v1/namespaces/{namespace}/pods/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
export |
Should this value be exported. Export strips fields that a user can not specify. |
false |
boolean |
|
QueryParameter |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
false |
boolean |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Pod |
true |
string |
partially update the specified Pod
PATCH /api/v1/namespaces/{namespace}/pods/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Pod |
true |
string |
replace the specified Pod
PUT /api/v1/namespaces/{namespace}/pods/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Pod |
true |
string |
delete a Pod
DELETE /api/v1/namespaces/{namespace}/pods/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
QueryParameter |
gracePeriodSeconds |
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
false |
integer |
|
QueryParameter |
orphanDependents |
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both. |
false |
boolean |
|
QueryParameter |
propagationPolicy |
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Pod |
true |
string |
connect GET requests to attach of Pod
GET /api/v1/namespaces/{namespace}/pods/{name}/attach
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
stdin |
Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false. |
false |
boolean |
|
QueryParameter |
stdout |
Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true. |
false |
boolean |
|
QueryParameter |
stderr |
Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true. |
false |
boolean |
|
QueryParameter |
tty |
TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false. |
false |
boolean |
|
QueryParameter |
container |
The container in which to execute the command. Defaults to only container if there is only one container in the pod. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Pod |
true |
string |
connect POST requests to attach of Pod
POST /api/v1/namespaces/{namespace}/pods/{name}/attach
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
stdin |
Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false. |
false |
boolean |
|
QueryParameter |
stdout |
Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true. |
false |
boolean |
|
QueryParameter |
stderr |
Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true. |
false |
boolean |
|
QueryParameter |
tty |
TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false. |
false |
boolean |
|
QueryParameter |
container |
The container in which to execute the command. Defaults to only container if there is only one container in the pod. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Pod |
true |
string |
create binding of a Binding
POST /api/v1/namespaces/{namespace}/pods/{name}/binding
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Binding |
true |
string |
create eviction of an Eviction
POST /api/v1/namespaces/{namespace}/pods/{name}/eviction
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Eviction |
true |
string |
connect GET requests to exec of Pod
GET /api/v1/namespaces/{namespace}/pods/{name}/exec
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
stdin |
Redirect the standard input stream of the pod for this call. Defaults to false. |
false |
boolean |
|
QueryParameter |
stdout |
Redirect the standard output stream of the pod for this call. Defaults to true. |
false |
boolean |
|
QueryParameter |
stderr |
Redirect the standard error stream of the pod for this call. Defaults to true. |
false |
boolean |
|
QueryParameter |
tty |
TTY if true indicates that a tty will be allocated for the exec call. Defaults to false. |
false |
boolean |
|
QueryParameter |
container |
Container in which to execute the command. Defaults to only container if there is only one container in the pod. |
false |
string |
|
QueryParameter |
command |
Command is the remote command to execute. argv array. Not executed within a shell. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Pod |
true |
string |
connect POST requests to exec of Pod
POST /api/v1/namespaces/{namespace}/pods/{name}/exec
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
stdin |
Redirect the standard input stream of the pod for this call. Defaults to false. |
false |
boolean |
|
QueryParameter |
stdout |
Redirect the standard output stream of the pod for this call. Defaults to true. |
false |
boolean |
|
QueryParameter |
stderr |
Redirect the standard error stream of the pod for this call. Defaults to true. |
false |
boolean |
|
QueryParameter |
tty |
TTY if true indicates that a tty will be allocated for the exec call. Defaults to false. |
false |
boolean |
|
QueryParameter |
container |
Container in which to execute the command. Defaults to only container if there is only one container in the pod. |
false |
string |
|
QueryParameter |
command |
Command is the remote command to execute. argv array. Not executed within a shell. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Pod |
true |
string |
read log of the specified Pod
GET /api/v1/namespaces/{namespace}/pods/{name}/log
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
container |
The container for which to stream logs. Defaults to only container if there is one container in the pod. |
false |
string |
|
QueryParameter |
follow |
Follow the log stream of the pod. Defaults to false. |
false |
boolean |
|
QueryParameter |
previous |
Return previous terminated container logs. Defaults to false. |
false |
boolean |
|
QueryParameter |
sinceSeconds |
A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified. |
false |
integer |
|
QueryParameter |
timestamps |
If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false. |
false |
boolean |
|
QueryParameter |
tailLines |
If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime |
false |
integer |
|
QueryParameter |
limitBytes |
If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Pod |
true |
string |
connect GET requests to portforward of Pod
GET /api/v1/namespaces/{namespace}/pods/{name}/portforward
connect POST requests to portforward of Pod
POST /api/v1/namespaces/{namespace}/pods/{name}/portforward
connect GET requests to proxy of Pod
GET /api/v1/namespaces/{namespace}/pods/{name}/proxy
connect OPTIONS requests to proxy of Pod
OPTIONS /api/v1/namespaces/{namespace}/pods/{name}/proxy
connect POST requests to proxy of Pod
POST /api/v1/namespaces/{namespace}/pods/{name}/proxy
connect HEAD requests to proxy of Pod
HEAD /api/v1/namespaces/{namespace}/pods/{name}/proxy
connect PUT requests to proxy of Pod
PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy
connect DELETE requests to proxy of Pod
DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy
connect GET requests to proxy of Pod
GET /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
path |
Path is the URL path to use for the current proxy request to pod. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Pod |
true |
string |
|
PathParameter |
path |
path to the resource |
true |
string |
connect OPTIONS requests to proxy of Pod
OPTIONS /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
path |
Path is the URL path to use for the current proxy request to pod. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Pod |
true |
string |
|
PathParameter |
path |
path to the resource |
true |
string |
connect POST requests to proxy of Pod
POST /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
path |
Path is the URL path to use for the current proxy request to pod. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Pod |
true |
string |
|
PathParameter |
path |
path to the resource |
true |
string |
connect HEAD requests to proxy of Pod
HEAD /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
path |
Path is the URL path to use for the current proxy request to pod. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Pod |
true |
string |
|
PathParameter |
path |
path to the resource |
true |
string |
connect PUT requests to proxy of Pod
PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
path |
Path is the URL path to use for the current proxy request to pod. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Pod |
true |
string |
|
PathParameter |
path |
path to the resource |
true |
string |
connect DELETE requests to proxy of Pod
DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
path |
Path is the URL path to use for the current proxy request to pod. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Pod |
true |
string |
|
PathParameter |
path |
path to the resource |
true |
string |
read status of the specified Pod
GET /api/v1/namespaces/{namespace}/pods/{name}/status
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Pod |
true |
string |
partially update status of the specified Pod
PATCH /api/v1/namespaces/{namespace}/pods/{name}/status
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Pod |
true |
string |
replace status of the specified Pod
PUT /api/v1/namespaces/{namespace}/pods/{name}/status
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Pod |
true |
string |
list or watch objects of kind PodTemplate
GET /api/v1/namespaces/{namespace}/podtemplates
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
create a PodTemplate
POST /api/v1/namespaces/{namespace}/podtemplates
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
delete collection of PodTemplate
DELETE /api/v1/namespaces/{namespace}/podtemplates
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
read the specified PodTemplate
GET /api/v1/namespaces/{namespace}/podtemplates/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
export |
Should this value be exported. Export strips fields that a user can not specify. |
false |
boolean |
|
QueryParameter |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
false |
boolean |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the PodTemplate |
true |
string |
partially update the specified PodTemplate
PATCH /api/v1/namespaces/{namespace}/podtemplates/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the PodTemplate |
true |
string |
replace the specified PodTemplate
PUT /api/v1/namespaces/{namespace}/podtemplates/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the PodTemplate |
true |
string |
delete a PodTemplate
DELETE /api/v1/namespaces/{namespace}/podtemplates/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
QueryParameter |
gracePeriodSeconds |
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
false |
integer |
|
QueryParameter |
orphanDependents |
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both. |
false |
boolean |
|
QueryParameter |
propagationPolicy |
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the PodTemplate |
true |
string |
list or watch objects of kind ReplicationController
GET /api/v1/namespaces/{namespace}/replicationcontrollers
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
create a ReplicationController
POST /api/v1/namespaces/{namespace}/replicationcontrollers
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
delete collection of ReplicationController
DELETE /api/v1/namespaces/{namespace}/replicationcontrollers
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
read the specified ReplicationController
GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
export |
Should this value be exported. Export strips fields that a user can not specify. |
false |
boolean |
|
QueryParameter |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
false |
boolean |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ReplicationController |
true |
string |
partially update the specified ReplicationController
PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ReplicationController |
true |
string |
replace the specified ReplicationController
PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ReplicationController |
true |
string |
delete a ReplicationController
DELETE /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
QueryParameter |
gracePeriodSeconds |
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
false |
integer |
|
QueryParameter |
orphanDependents |
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both. |
false |
boolean |
|
QueryParameter |
propagationPolicy |
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ReplicationController |
true |
string |
read scale of the specified Scale
GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Scale |
true |
string |
partially update scale of the specified Scale
PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Scale |
true |
string |
replace scale of the specified Scale
PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Scale |
true |
string |
read status of the specified ReplicationController
GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ReplicationController |
true |
string |
partially update status of the specified ReplicationController
PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ReplicationController |
true |
string |
replace status of the specified ReplicationController
PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ReplicationController |
true |
string |
list or watch objects of kind ResourceQuota
GET /api/v1/namespaces/{namespace}/resourcequotas
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
create a ResourceQuota
POST /api/v1/namespaces/{namespace}/resourcequotas
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
delete collection of ResourceQuota
DELETE /api/v1/namespaces/{namespace}/resourcequotas
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
read the specified ResourceQuota
GET /api/v1/namespaces/{namespace}/resourcequotas/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
export |
Should this value be exported. Export strips fields that a user can not specify. |
false |
boolean |
|
QueryParameter |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
false |
boolean |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ResourceQuota |
true |
string |
partially update the specified ResourceQuota
PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ResourceQuota |
true |
string |
replace the specified ResourceQuota
PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ResourceQuota |
true |
string |
delete a ResourceQuota
DELETE /api/v1/namespaces/{namespace}/resourcequotas/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
QueryParameter |
gracePeriodSeconds |
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
false |
integer |
|
QueryParameter |
orphanDependents |
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both. |
false |
boolean |
|
QueryParameter |
propagationPolicy |
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ResourceQuota |
true |
string |
read status of the specified ResourceQuota
GET /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ResourceQuota |
true |
string |
partially update status of the specified ResourceQuota
PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ResourceQuota |
true |
string |
replace status of the specified ResourceQuota
PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ResourceQuota |
true |
string |
list or watch objects of kind Secret
GET /api/v1/namespaces/{namespace}/secrets
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
create a Secret
POST /api/v1/namespaces/{namespace}/secrets
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
delete collection of Secret
DELETE /api/v1/namespaces/{namespace}/secrets
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
read the specified Secret
GET /api/v1/namespaces/{namespace}/secrets/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
export |
Should this value be exported. Export strips fields that a user can not specify. |
false |
boolean |
|
QueryParameter |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
false |
boolean |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Secret |
true |
string |
partially update the specified Secret
PATCH /api/v1/namespaces/{namespace}/secrets/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Secret |
true |
string |
replace the specified Secret
PUT /api/v1/namespaces/{namespace}/secrets/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Secret |
true |
string |
delete a Secret
DELETE /api/v1/namespaces/{namespace}/secrets/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
QueryParameter |
gracePeriodSeconds |
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
false |
integer |
|
QueryParameter |
orphanDependents |
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both. |
false |
boolean |
|
QueryParameter |
propagationPolicy |
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Secret |
true |
string |
list or watch objects of kind ServiceAccount
GET /api/v1/namespaces/{namespace}/serviceaccounts
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
create a ServiceAccount
POST /api/v1/namespaces/{namespace}/serviceaccounts
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
delete collection of ServiceAccount
DELETE /api/v1/namespaces/{namespace}/serviceaccounts
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
read the specified ServiceAccount
GET /api/v1/namespaces/{namespace}/serviceaccounts/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
export |
Should this value be exported. Export strips fields that a user can not specify. |
false |
boolean |
|
QueryParameter |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
false |
boolean |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ServiceAccount |
true |
string |
partially update the specified ServiceAccount
PATCH /api/v1/namespaces/{namespace}/serviceaccounts/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ServiceAccount |
true |
string |
replace the specified ServiceAccount
PUT /api/v1/namespaces/{namespace}/serviceaccounts/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ServiceAccount |
true |
string |
delete a ServiceAccount
DELETE /api/v1/namespaces/{namespace}/serviceaccounts/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
QueryParameter |
gracePeriodSeconds |
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
false |
integer |
|
QueryParameter |
orphanDependents |
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both. |
false |
boolean |
|
QueryParameter |
propagationPolicy |
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ServiceAccount |
true |
string |
list or watch objects of kind Service
GET /api/v1/namespaces/{namespace}/services
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
create a Service
POST /api/v1/namespaces/{namespace}/services
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
read the specified Service
GET /api/v1/namespaces/{namespace}/services/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
export |
Should this value be exported. Export strips fields that a user can not specify. |
false |
boolean |
|
QueryParameter |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
false |
boolean |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Service |
true |
string |
partially update the specified Service
PATCH /api/v1/namespaces/{namespace}/services/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Service |
true |
string |
replace the specified Service
PUT /api/v1/namespaces/{namespace}/services/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Service |
true |
string |
delete a Service
DELETE /api/v1/namespaces/{namespace}/services/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Service |
true |
string |
connect GET requests to proxy of Service
GET /api/v1/namespaces/{namespace}/services/{name}/proxy
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
path |
Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Service |
true |
string |
connect OPTIONS requests to proxy of Service
OPTIONS /api/v1/namespaces/{namespace}/services/{name}/proxy
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
path |
Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Service |
true |
string |
connect POST requests to proxy of Service
POST /api/v1/namespaces/{namespace}/services/{name}/proxy
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
path |
Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Service |
true |
string |
connect HEAD requests to proxy of Service
HEAD /api/v1/namespaces/{namespace}/services/{name}/proxy
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
path |
Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Service |
true |
string |
connect PUT requests to proxy of Service
PUT /api/v1/namespaces/{namespace}/services/{name}/proxy
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
path |
Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Service |
true |
string |
connect DELETE requests to proxy of Service
DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
path |
Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Service |
true |
string |
connect GET requests to proxy of Service
GET /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
path |
Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Service |
true |
string |
|
PathParameter |
path |
path to the resource |
true |
string |
connect OPTIONS requests to proxy of Service
OPTIONS /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
path |
Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Service |
true |
string |
|
PathParameter |
path |
path to the resource |
true |
string |
connect POST requests to proxy of Service
POST /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
path |
Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Service |
true |
string |
|
PathParameter |
path |
path to the resource |
true |
string |
connect HEAD requests to proxy of Service
HEAD /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
path |
Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Service |
true |
string |
|
PathParameter |
path |
path to the resource |
true |
string |
connect PUT requests to proxy of Service
PUT /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
path |
Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Service |
true |
string |
|
PathParameter |
path |
path to the resource |
true |
string |
connect DELETE requests to proxy of Service
DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
path |
Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Service |
true |
string |
|
PathParameter |
path |
path to the resource |
true |
string |
read status of the specified Service
GET /api/v1/namespaces/{namespace}/services/{name}/status
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Service |
true |
string |
partially update status of the specified Service
PATCH /api/v1/namespaces/{namespace}/services/{name}/status
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Service |
true |
string |
replace status of the specified Service
PUT /api/v1/namespaces/{namespace}/services/{name}/status
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Service |
true |
string |
read the specified Namespace
GET /api/v1/namespaces/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
export |
Should this value be exported. Export strips fields that a user can not specify. |
false |
boolean |
|
QueryParameter |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
false |
boolean |
|
PathParameter |
name |
name of the Namespace |
true |
string |
partially update the specified Namespace
PATCH /api/v1/namespaces/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
name |
name of the Namespace |
true |
string |
replace the specified Namespace
PUT /api/v1/namespaces/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
name |
name of the Namespace |
true |
string |
delete a Namespace
DELETE /api/v1/namespaces/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
QueryParameter |
gracePeriodSeconds |
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
false |
integer |
|
QueryParameter |
orphanDependents |
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both. |
false |
boolean |
|
QueryParameter |
propagationPolicy |
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. |
false |
string |
|
PathParameter |
name |
name of the Namespace |
true |
string |
replace finalize of the specified Namespace
PUT /api/v1/namespaces/{name}/finalize
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
name |
name of the Namespace |
true |
string |
read status of the specified Namespace
GET /api/v1/namespaces/{name}/status
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
PathParameter |
name |
name of the Namespace |
true |
string |
partially update status of the specified Namespace
PATCH /api/v1/namespaces/{name}/status
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
name |
name of the Namespace |
true |
string |
replace status of the specified Namespace
PUT /api/v1/namespaces/{name}/status
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
name |
name of the Namespace |
true |
string |
list or watch objects of kind Node
GET /api/v1/nodes
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
create a Node
POST /api/v1/nodes
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
delete collection of Node
DELETE /api/v1/nodes
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
read the specified Node
GET /api/v1/nodes/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
export |
Should this value be exported. Export strips fields that a user can not specify. |
false |
boolean |
|
QueryParameter |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
false |
boolean |
|
PathParameter |
name |
name of the Node |
true |
string |
partially update the specified Node
PATCH /api/v1/nodes/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
name |
name of the Node |
true |
string |
replace the specified Node
PUT /api/v1/nodes/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
name |
name of the Node |
true |
string |
delete a Node
DELETE /api/v1/nodes/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
QueryParameter |
gracePeriodSeconds |
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
false |
integer |
|
QueryParameter |
orphanDependents |
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both. |
false |
boolean |
|
QueryParameter |
propagationPolicy |
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. |
false |
string |
|
PathParameter |
name |
name of the Node |
true |
string |
connect GET requests to proxy of Node
GET /api/v1/nodes/{name}/proxy
connect OPTIONS requests to proxy of Node
OPTIONS /api/v1/nodes/{name}/proxy
connect POST requests to proxy of Node
POST /api/v1/nodes/{name}/proxy
connect HEAD requests to proxy of Node
HEAD /api/v1/nodes/{name}/proxy
connect PUT requests to proxy of Node
PUT /api/v1/nodes/{name}/proxy
connect DELETE requests to proxy of Node
DELETE /api/v1/nodes/{name}/proxy
connect GET requests to proxy of Node
GET /api/v1/nodes/{name}/proxy/{path}
connect OPTIONS requests to proxy of Node
OPTIONS /api/v1/nodes/{name}/proxy/{path}
connect POST requests to proxy of Node
POST /api/v1/nodes/{name}/proxy/{path}
connect HEAD requests to proxy of Node
HEAD /api/v1/nodes/{name}/proxy/{path}
connect PUT requests to proxy of Node
PUT /api/v1/nodes/{name}/proxy/{path}
connect DELETE requests to proxy of Node
DELETE /api/v1/nodes/{name}/proxy/{path}
read status of the specified Node
GET /api/v1/nodes/{name}/status
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
PathParameter |
name |
name of the Node |
true |
string |
partially update status of the specified Node
PATCH /api/v1/nodes/{name}/status
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
name |
name of the Node |
true |
string |
replace status of the specified Node
PUT /api/v1/nodes/{name}/status
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
name |
name of the Node |
true |
string |
list or watch objects of kind PersistentVolumeClaim
GET /api/v1/persistentvolumeclaims
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
create a PersistentVolumeClaim
POST /api/v1/persistentvolumeclaims
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
list or watch objects of kind PersistentVolume
GET /api/v1/persistentvolumes
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
create a PersistentVolume
POST /api/v1/persistentvolumes
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
delete collection of PersistentVolume
DELETE /api/v1/persistentvolumes
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
read the specified PersistentVolume
GET /api/v1/persistentvolumes/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
export |
Should this value be exported. Export strips fields that a user can not specify. |
false |
boolean |
|
QueryParameter |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
false |
boolean |
|
PathParameter |
name |
name of the PersistentVolume |
true |
string |
partially update the specified PersistentVolume
PATCH /api/v1/persistentvolumes/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
name |
name of the PersistentVolume |
true |
string |
replace the specified PersistentVolume
PUT /api/v1/persistentvolumes/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
name |
name of the PersistentVolume |
true |
string |
delete a PersistentVolume
DELETE /api/v1/persistentvolumes/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
QueryParameter |
gracePeriodSeconds |
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
false |
integer |
|
QueryParameter |
orphanDependents |
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both. |
false |
boolean |
|
QueryParameter |
propagationPolicy |
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. |
false |
string |
|
PathParameter |
name |
name of the PersistentVolume |
true |
string |
read status of the specified PersistentVolume
GET /api/v1/persistentvolumes/{name}/status
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
PathParameter |
name |
name of the PersistentVolume |
true |
string |
partially update status of the specified PersistentVolume
PATCH /api/v1/persistentvolumes/{name}/status
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
name |
name of the PersistentVolume |
true |
string |
replace status of the specified PersistentVolume
PUT /api/v1/persistentvolumes/{name}/status
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
name |
name of the PersistentVolume |
true |
string |
list or watch objects of kind Pod
GET /api/v1/pods
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
create a Pod
POST /api/v1/pods
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
list or watch objects of kind PodTemplate
GET /api/v1/podtemplates
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
create a PodTemplate
POST /api/v1/podtemplates
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
proxy GET requests to Pod
GET /api/v1/proxy/namespaces/{namespace}/pods/{name}
proxy OPTIONS requests to Pod
OPTIONS /api/v1/proxy/namespaces/{namespace}/pods/{name}
proxy POST requests to Pod
POST /api/v1/proxy/namespaces/{namespace}/pods/{name}
proxy PATCH requests to Pod
PATCH /api/v1/proxy/namespaces/{namespace}/pods/{name}
proxy HEAD requests to Pod
HEAD /api/v1/proxy/namespaces/{namespace}/pods/{name}
proxy PUT requests to Pod
PUT /api/v1/proxy/namespaces/{namespace}/pods/{name}
proxy DELETE requests to Pod
DELETE /api/v1/proxy/namespaces/{namespace}/pods/{name}
proxy GET requests to Pod
GET /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
proxy OPTIONS requests to Pod
OPTIONS /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
proxy POST requests to Pod
POST /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
proxy PATCH requests to Pod
PATCH /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
proxy HEAD requests to Pod
HEAD /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
proxy PUT requests to Pod
PUT /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
proxy DELETE requests to Pod
DELETE /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
proxy GET requests to Service
GET /api/v1/proxy/namespaces/{namespace}/services/{name}
proxy OPTIONS requests to Service
OPTIONS /api/v1/proxy/namespaces/{namespace}/services/{name}
proxy POST requests to Service
POST /api/v1/proxy/namespaces/{namespace}/services/{name}
proxy PATCH requests to Service
PATCH /api/v1/proxy/namespaces/{namespace}/services/{name}
proxy HEAD requests to Service
HEAD /api/v1/proxy/namespaces/{namespace}/services/{name}
proxy PUT requests to Service
PUT /api/v1/proxy/namespaces/{namespace}/services/{name}
proxy DELETE requests to Service
DELETE /api/v1/proxy/namespaces/{namespace}/services/{name}
proxy GET requests to Service
GET /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
proxy OPTIONS requests to Service
OPTIONS /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
proxy POST requests to Service
POST /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
proxy PATCH requests to Service
PATCH /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
proxy HEAD requests to Service
HEAD /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
proxy PUT requests to Service
PUT /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
proxy DELETE requests to Service
DELETE /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
proxy GET requests to Node
GET /api/v1/proxy/nodes/{name}
proxy OPTIONS requests to Node
OPTIONS /api/v1/proxy/nodes/{name}
proxy POST requests to Node
POST /api/v1/proxy/nodes/{name}
proxy PATCH requests to Node
PATCH /api/v1/proxy/nodes/{name}
proxy HEAD requests to Node
HEAD /api/v1/proxy/nodes/{name}
proxy PUT requests to Node
PUT /api/v1/proxy/nodes/{name}
proxy DELETE requests to Node
DELETE /api/v1/proxy/nodes/{name}
proxy GET requests to Node
GET /api/v1/proxy/nodes/{name}/{path}
proxy OPTIONS requests to Node
OPTIONS /api/v1/proxy/nodes/{name}/{path}
proxy POST requests to Node
POST /api/v1/proxy/nodes/{name}/{path}
proxy PATCH requests to Node
PATCH /api/v1/proxy/nodes/{name}/{path}
proxy HEAD requests to Node
HEAD /api/v1/proxy/nodes/{name}/{path}
proxy PUT requests to Node
PUT /api/v1/proxy/nodes/{name}/{path}
proxy DELETE requests to Node
DELETE /api/v1/proxy/nodes/{name}/{path}
list or watch objects of kind ReplicationController
GET /api/v1/replicationcontrollers
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
create a ReplicationController
POST /api/v1/replicationcontrollers
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
list or watch objects of kind ResourceQuota
GET /api/v1/resourcequotas
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
create a ResourceQuota
POST /api/v1/resourcequotas
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
list or watch objects of kind Secret
GET /api/v1/secrets
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
create a Secret
POST /api/v1/secrets
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
list or watch objects of kind SecurityContextConstraints
GET /api/v1/securitycontextconstraints
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
create SecurityContextConstraints
POST /api/v1/securitycontextconstraints
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
delete collection of SecurityContextConstraints
DELETE /api/v1/securitycontextconstraints
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
read the specified SecurityContextConstraints
GET /api/v1/securitycontextconstraints/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
export |
Should this value be exported. Export strips fields that a user can not specify. |
false |
boolean |
|
QueryParameter |
exact |
Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. |
false |
boolean |
|
PathParameter |
name |
name of the SecurityContextConstraints |
true |
string |
partially update the specified SecurityContextConstraints
PATCH /api/v1/securitycontextconstraints/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
name |
name of the SecurityContextConstraints |
true |
string |
replace the specified SecurityContextConstraints
PUT /api/v1/securitycontextconstraints/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
PathParameter |
name |
name of the SecurityContextConstraints |
true |
string |
delete SecurityContextConstraints
DELETE /api/v1/securitycontextconstraints/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
|||
QueryParameter |
gracePeriodSeconds |
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
false |
integer |
|
QueryParameter |
orphanDependents |
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both. |
false |
boolean |
|
QueryParameter |
propagationPolicy |
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. |
false |
string |
|
PathParameter |
name |
name of the SecurityContextConstraints |
true |
string |
list or watch objects of kind ServiceAccount
GET /api/v1/serviceaccounts
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
create a ServiceAccount
POST /api/v1/serviceaccounts
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
list or watch objects of kind Service
GET /api/v1/services
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
create a Service
POST /api/v1/services
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
BodyParameter |
body |
true |
watch individual changes to a list of ConfigMap
GET /api/v1/watch/configmaps
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
watch individual changes to a list of Endpoints
GET /api/v1/watch/endpoints
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
watch individual changes to a list of Event
GET /api/v1/watch/events
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
watch individual changes to a list of LimitRange
GET /api/v1/watch/limitranges
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
watch individual changes to a list of Namespace
GET /api/v1/watch/namespaces
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
watch individual changes to a list of ConfigMap
GET /api/v1/watch/namespaces/{namespace}/configmaps
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
watch changes to an object of kind ConfigMap
GET /api/v1/watch/namespaces/{namespace}/configmaps/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ConfigMap |
true |
string |
watch individual changes to a list of Endpoints
GET /api/v1/watch/namespaces/{namespace}/endpoints
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
watch changes to an object of kind Endpoints
GET /api/v1/watch/namespaces/{namespace}/endpoints/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Endpoints |
true |
string |
watch individual changes to a list of Event
GET /api/v1/watch/namespaces/{namespace}/events
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
watch changes to an object of kind Event
GET /api/v1/watch/namespaces/{namespace}/events/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Event |
true |
string |
watch individual changes to a list of LimitRange
GET /api/v1/watch/namespaces/{namespace}/limitranges
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
watch changes to an object of kind LimitRange
GET /api/v1/watch/namespaces/{namespace}/limitranges/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the LimitRange |
true |
string |
watch individual changes to a list of PersistentVolumeClaim
GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
watch changes to an object of kind PersistentVolumeClaim
GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the PersistentVolumeClaim |
true |
string |
watch individual changes to a list of Pod
GET /api/v1/watch/namespaces/{namespace}/pods
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
watch changes to an object of kind Pod
GET /api/v1/watch/namespaces/{namespace}/pods/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Pod |
true |
string |
watch individual changes to a list of PodTemplate
GET /api/v1/watch/namespaces/{namespace}/podtemplates
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
watch changes to an object of kind PodTemplate
GET /api/v1/watch/namespaces/{namespace}/podtemplates/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the PodTemplate |
true |
string |
watch individual changes to a list of ReplicationController
GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
watch changes to an object of kind ReplicationController
GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ReplicationController |
true |
string |
watch individual changes to a list of ResourceQuota
GET /api/v1/watch/namespaces/{namespace}/resourcequotas
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
watch changes to an object of kind ResourceQuota
GET /api/v1/watch/namespaces/{namespace}/resourcequotas/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ResourceQuota |
true |
string |
watch individual changes to a list of Secret
GET /api/v1/watch/namespaces/{namespace}/secrets
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
watch changes to an object of kind Secret
GET /api/v1/watch/namespaces/{namespace}/secrets/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Secret |
true |
string |
watch individual changes to a list of ServiceAccount
GET /api/v1/watch/namespaces/{namespace}/serviceaccounts
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
watch changes to an object of kind ServiceAccount
GET /api/v1/watch/namespaces/{namespace}/serviceaccounts/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the ServiceAccount |
true |
string |
watch individual changes to a list of Service
GET /api/v1/watch/namespaces/{namespace}/services
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
watch changes to an object of kind Service
GET /api/v1/watch/namespaces/{namespace}/services/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
namespace |
object name and auth scope, such as for teams and projects |
true |
string |
|
PathParameter |
name |
name of the Service |
true |
string |
watch changes to an object of kind Namespace
GET /api/v1/watch/namespaces/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
name |
name of the Namespace |
true |
string |
watch individual changes to a list of Node
GET /api/v1/watch/nodes
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
watch changes to an object of kind Node
GET /api/v1/watch/nodes/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
name |
name of the Node |
true |
string |
watch individual changes to a list of PersistentVolumeClaim
GET /api/v1/watch/persistentvolumeclaims
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
watch individual changes to a list of PersistentVolume
GET /api/v1/watch/persistentvolumes
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
watch changes to an object of kind PersistentVolume
GET /api/v1/watch/persistentvolumes/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
name |
name of the PersistentVolume |
true |
string |
watch individual changes to a list of Pod
GET /api/v1/watch/pods
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
watch individual changes to a list of PodTemplate
GET /api/v1/watch/podtemplates
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
watch individual changes to a list of ReplicationController
GET /api/v1/watch/replicationcontrollers
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
watch individual changes to a list of ResourceQuota
GET /api/v1/watch/resourcequotas
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
watch individual changes to a list of Secret
GET /api/v1/watch/secrets
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
watch individual changes to a list of SecurityContextConstraints
GET /api/v1/watch/securitycontextconstraints
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
watch changes to an object of kind SecurityContextConstraints
GET /api/v1/watch/securitycontextconstraints/{name}
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
|
PathParameter |
name |
name of the SecurityContextConstraints |
true |
string |
watch individual changes to a list of ServiceAccount
GET /api/v1/watch/serviceaccounts
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
watch individual changes to a list of Service
GET /api/v1/watch/services
Parameters
| Type | Name | Description | Required | Schema | Default |
|---|---|---|---|---|---|
QueryParameter |
pretty |
If 'true', then the output is pretty printed. |
false |
string |
|
QueryParameter |
labelSelector |
A selector to restrict the list of returned objects by their labels. Defaults to everything. |
false |
string |
|
QueryParameter |
fieldSelector |
A selector to restrict the list of returned objects by their fields. Defaults to everything. |
false |
string |
|
QueryParameter |
watch |
Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
false |
boolean |
|
QueryParameter |
resourceVersion |
When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. |
false |
string |
|
QueryParameter |
timeoutSeconds |
Timeout for the list/watch call. |
false |
integer |
Definitions
v1.apiResource
apiResource specifies the name of a resource and whether it is namespaced.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
name |
name is the name of the resource. |
true |
string |
|
namespaced |
namespaced indicates if a resource is namespaced or not. |
true |
boolean |
|
kind |
kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo') |
true |
string |
|
verbs |
verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy) |
true |
string array |
|
shortNames |
shortNames is a list of suggested short names of the resource. |
false |
string array |
v1.apiResourceList
apiResourceList is a list of apiResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
groupVersion |
groupVersion is the group and version this apiResourceList is for. |
true |
string |
|
resources |
resources contains the name of the resources and if they are namespaced. |
true |
v1.apiResource array |
v1.AWSElasticBlockStoreVolumeSource
Represents a Persistent Disk resource in AWS.
An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
volumeID |
Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore |
true |
string |
|
fsType |
Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore |
false |
string |
|
partition |
The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). |
false |
integer (int32) |
|
readOnly |
Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore |
false |
boolean |
v1.Affinity
Affinity is a group of affinity scheduling rules.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
nodeAffinity |
Describes node affinity scheduling rules for the pod. |
false |
||
podAffinity |
Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). |
false |
||
podAntiAffinity |
Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). |
false |
v1.AttachedVolume
AttachedVolume describes a volume attached to a node
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
name |
Name of the attached volume |
true |
string |
|
devicePath |
DevicePath represents the device path where the volume should be available |
true |
string |
v1.AzureDiskVolumeSource
AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
diskName |
The Name of the data disk in the blob storage |
true |
string |
|
diskURI |
The URI the data disk in the blob storage |
true |
string |
|
cachingMode |
Host Caching mode: None, Read Only, Read Write. |
false |
||
fsType |
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. |
false |
string |
|
readOnly |
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
false |
boolean |
v1.AzureFileVolumeSource
AzureFile represents an Azure File Service mount on the host and bind mount to the pod.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
secretName |
the name of secret that contains Azure Storage Account Name and Key |
true |
string |
|
shareName |
Share Name |
true |
string |
|
readOnly |
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
false |
boolean |
v1.Binding
Binding ties one object to another. For example, a pod is bound to a node by a scheduler.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
target |
The target object that you want to bind to the standard object. |
true |
v1.Capabilities
Adds and removes POSIX capabilities from running containers.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
add |
Added capabilities |
false |
v1.Capability array |
|
drop |
Removed capabilities |
false |
v1.Capability array |
v1.CephFSVolumeSource
Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
monitors |
Required: Monitors is a collection of Ceph monitors More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it |
true |
string array |
|
path |
Optional: Used as the mounted root, rather than the full Ceph tree, default is / |
false |
string |
|
user |
Optional: User is the rados user name, default is admin More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it |
false |
string |
|
secretFile |
Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it |
false |
string |
|
secretRef |
Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it |
false |
||
readOnly |
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it |
false |
boolean |
v1.CinderVolumeSource
Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
volumeID |
volume id used to identify the volume in cinder More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md |
true |
string |
|
fsType |
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md |
false |
string |
|
readOnly |
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md |
false |
boolean |
v1.ComponentCondition
Information about the condition of a component.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
type |
Type of condition for a component. Valid value: "Healthy" |
true |
string |
|
status |
Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown". |
true |
string |
|
message |
Message about the condition for a component. For example, information about a health check. |
false |
string |
|
error |
Condition error code for a component. For example, a health check error code. |
false |
string |
v1.ComponentStatus
ComponentStatus (and ComponentStatusList) holds the cluster validation info.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
conditions |
List of component conditions observed |
false |
v1.ComponentCondition array |
v1.ComponentStatusList
Status of all the conditions for the component as a list of ComponentStatus objects.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
||
items |
List of ComponentStatus objects. |
true |
v1.ComponentStatus array |
v1.ConfigMap
ConfigMap holds configuration data for pods to consume.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
data |
Data contains the configuration data. Each key must be a valid DNS_SUBDOMAIN with an optional leading dot. |
false |
object |
v1.ConfigMapEnvSource
ConfigMapEnvSource selects a ConfigMap to populate the environment variables with.
The contents of the target ConfigMap’s Data field will represent the key-value pairs as environment variables.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
name |
Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names |
false |
string |
|
optional |
Specify whether the ConfigMap must be defined |
false |
boolean |
v1.ConfigMapKeySelector
Selects a key from a ConfigMap.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
name |
Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names |
false |
string |
|
key |
The key to select. |
true |
string |
|
optional |
Specify whether the ConfigMap or it’s key must be defined |
false |
boolean |
v1.ConfigMapList
ConfigMapList is a resource containing a list of ConfigMap objects.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
items |
Items is the list of ConfigMaps. |
true |
v1.ConfigMap array |
v1.ConfigMapProjection
Adapts a ConfigMap into a projected volume.
The contents of the target ConfigMap’s Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
name |
Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names |
false |
string |
|
items |
If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. |
false |
v1.KeyToPath array |
|
optional |
Specify whether the ConfigMap or it’s keys must be defined |
false |
boolean |
v1.ConfigMapVolumeSource
Adapts a ConfigMap into a volume.
The contents of the target ConfigMap’s Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
name |
Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names |
false |
string |
|
items |
If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. |
false |
v1.KeyToPath array |
|
defaultMode |
Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
false |
integer (int32) |
|
optional |
Specify whether the ConfigMap or it’s keys must be defined |
false |
boolean |
v1.Container
A single application container that you want to run within a pod.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
name |
Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. |
true |
string |
|
image |
Docker image name. More info: http://kubernetes.io/docs/user-guide/images |
false |
string |
|
command |
Entrypoint array. Not executed within a shell. The docker image’s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double , ie: (VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands |
false |
string array |
|
args |
Arguments to the entrypoint. The docker image’s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double , ie: (VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands |
false |
string array |
|
workingDir |
Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image. Cannot be updated. |
false |
string |
|
ports |
List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. |
false |
v1.ContainerPort array |
|
envFrom |
List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. |
false |
v1.EnvFromSource array |
|
env |
List of environment variables to set in the container. Cannot be updated. |
false |
v1.EnvVar array |
|
resources |
Compute Resources required by this container. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#resources |
false |
||
volumeMounts |
Pod volumes to mount into the container’s filesystem. Cannot be updated. |
false |
v1.VolumeMount array |
|
livenessProbe |
Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes |
false |
||
readinessProbe |
Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes |
false |
||
lifecycle |
Actions that the management system should take in response to container lifecycle events. Cannot be updated. |
false |
||
terminationMessagePath |
Optional: Path at which the file to which the container’s termination message will be written is mounted into the container’s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. |
false |
string |
|
terminationMessagePolicy |
Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. |
false |
string |
|
imagePullPolicy |
Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/images#updating-images |
false |
string |
|
securityContext |
Security options the pod should run with. More info: http://releases.k8s.io/HEAD/docs/design/security_context.md |
false |
||
stdin |
Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. |
false |
boolean |
|
stdinOnce |
Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false |
false |
boolean |
|
tty |
Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. |
false |
boolean |
v1.ContainerImage
Describe a container image
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
names |
Names by which this image is known. e.g. ["gcr.io/google_containers/hyperkube:v1.0.7", "dockerhub.io/google_containers/hyperkube:v1.0.7"] |
true |
string array |
|
sizeBytes |
The size of the image in bytes. |
false |
integer (int64) |
v1.ContainerPort
ContainerPort represents a network port in a single container.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
name |
If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. |
false |
string |
|
hostPort |
Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. |
false |
integer (int32) |
|
containerPort |
Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536. |
true |
integer (int32) |
|
protocol |
Protocol for port. Must be UDP or TCP. Defaults to "TCP". |
false |
string |
|
hostIP |
What host IP to bind the external port to. |
false |
string |
v1.ContainerState
ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
waiting |
Details about a waiting container |
false |
||
running |
Details about a running container |
false |
||
terminated |
Details about a terminated container |
false |
v1.ContainerStateRunning
ContainerStateRunning is a running state of a container.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
startedAt |
Time at which the container was last (re-)started |
false |
string |
v1.ContainerStateTerminated
ContainerStateTerminated is a terminated state of a container.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
exitCode |
Exit status from the last termination of the container |
true |
integer (int32) |
|
signal |
Signal from the last termination of the container |
false |
integer (int32) |
|
reason |
(brief) reason from the last termination of the container |
false |
string |
|
message |
Message regarding the last termination of the container |
false |
string |
|
startedAt |
Time at which previous execution of the container started |
false |
string |
|
finishedAt |
Time at which the container last terminated |
false |
string |
|
containerID |
Container’s ID in the format 'docker://<container_id>' |
false |
string |
v1.ContainerStateWaiting
ContainerStateWaiting is a waiting state of a container.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
reason |
(brief) reason the container is not yet running. |
false |
string |
|
message |
Message regarding why the container is not yet running. |
false |
string |
v1.ContainerStatus
ContainerStatus contains details for the current status of this container.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
name |
This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated. |
true |
string |
|
state |
Details about the container’s current condition. |
false |
||
lastState |
Details about the container’s last termination condition. |
false |
||
ready |
Specifies whether the container has passed its readiness probe. |
true |
boolean |
|
restartCount |
The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. Note that this is calculated from dead containers. But those containers are subject to garbage collection. This value will get capped at 5 by GC. |
true |
integer (int32) |
|
image |
The image the container is running. More info: http://kubernetes.io/docs/user-guide/images |
true |
string |
|
imageID |
ImageID of the container’s image. |
true |
string |
|
containerID |
Container’s ID in the format 'docker://<container_id>'. More info: http://kubernetes.io/docs/user-guide/container-environment#container-information |
false |
string |
v1.DaemonEndpoint
DaemonEndpoint contains information about a single Daemon endpoint.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
Port |
Port number of the given endpoint. |
true |
integer (int32) |
v1.DeleteOptions
DeleteOptions may be provided when deleting an api object.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
gracePeriodSeconds |
The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
false |
integer (int64) |
|
preconditions |
Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned. |
false |
||
orphanDependents |
Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list. Either this field or PropagationPolicy may be set, but not both. |
false |
boolean |
|
propagationPolicy |
Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. |
false |
v1.DeprecatedDownwardapiVolumeFile
DeprecatedDownwardapiVolumeFile represents information to create the file containing the pod field This type is deprecated and should be replaced by use of the downwardapi volume source.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
name |
Required: Name is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' |
true |
string |
|
fieldRef |
Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. |
false |
||
resourceFieldRef |
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. |
false |
||
mode |
Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
false |
integer (int32) |
v1.DeprecatedDownwardapiVolumeSource
DeprecatedDownwardapiVolumeSource represents a volume containing downward api info. This type is deprecated and should be replaced by use of the downwardapi volume source.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
items |
Items is a list of downward api volume file |
false |
||
defaultMode |
Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
false |
integer (int32) |
v1.DownwardapiProjection
Represents downward api info for projecting into a projected volume. Note that this is identical to a downwardapi volume source without the default mode.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
items |
Items is a list of DownwardapiVolume file |
false |
v1.DownwardapiVolumeFile array |
v1.DownwardapiVolumeFile
DownwardapiVolumeFile represents information to create the file containing the pod field
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
path |
Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' |
true |
string |
|
fieldRef |
Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. |
false |
||
resourceFieldRef |
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. |
false |
||
mode |
Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
false |
integer (int32) |
v1.DownwardapiVolumeSource
DownwardapiVolumeSource represents a volume containing downward api info. Downward api volumes support ownership management and SELinux relabeling.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
items |
Items is a list of downward api volume file |
false |
v1.DownwardapiVolumeFile array |
|
defaultMode |
Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
false |
integer (int32) |
v1.EmptyDirVolumeSource
Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
medium |
What type of storage medium should back this directory. The default is "" which means to use the node’s default medium. Must be an empty string (default) or Memory. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir |
false |
string |
v1.EndpointAddress
EndpointAddress is a tuple that describes single IP address.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
ip |
The IP of this endpoint. May not be loopback (127.0.0.0/8), link-local (169.254.0.0/16), or link-local multicast ((224.0.0.0/24). IPv6 is also accepted but not fully supported on all platforms. Also, certain kubernetes components, like kube-proxy, are not IPv6 ready. |
true |
string |
|
hostname |
The Hostname of this endpoint |
false |
string |
|
nodeName |
Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node. |
false |
string |
|
targetRef |
Reference to object providing the endpoint. |
false |
v1.EndpointPort
EndpointPort is a tuple that describes a single port.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
name |
The name of this port (corresponds to ServicePort.Name). Must be a DNS_LABEL. Optional only if one port is defined. |
false |
string |
|
port |
The port number of the endpoint. |
true |
integer (int32) |
|
protocol |
The IP protocol for this port. Must be UDP or TCP. Default is TCP. |
false |
string |
v1.EndpointSubset
EndpointSubset is a group of addresses with a common set of ports. The expanded set of endpoints is the Cartesian product of Addresses x Ports. For example, given:
{
Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}],
Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}]
}
The resulting set of endpoints can be viewed as:
a: [ 10.10.1.1:8675, 10.10.2.2:8675 ],
b: [ 10.10.1.1:309, 10.10.2.2:309 ]
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
addresses |
IP addresses which offer the related ports that are marked as ready. These endpoints should be considered safe for load balancers and clients to utilize. |
false |
v1.EndpointAddress array |
|
notReadyAddresses |
IP addresses which offer the related ports but are not currently marked as ready because they have not yet finished starting, have recently failed a readiness check, or have recently failed a liveness check. |
false |
v1.EndpointAddress array |
|
ports |
Port numbers available on the related IP addresses. |
false |
v1.EndpointPort array |
v1.Endpoints
Endpoints is a collection of endpoints that implement the actual service. Example:
Name: "mysvc",
Subsets: [
{
Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}],
Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}]
},
{
Addresses: [{"ip": "10.10.3.3"}],
Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}]
},
]
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
subsets |
The set of all endpoints is the union of all subsets. Addresses are placed into subsets according to the IPs they share. A single address with multiple ports, some of which are ready and some of which are not (because they come from different containers) will result in the address being displayed in different subsets for the different ports. No address will appear in both Addresses and NotReadyAddresses in the same subset. Sets of addresses and ports that comprise a service. |
true |
v1.EndpointSubset array |
v1.EndpointsList
EndpointsList is a list of endpoints.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
||
items |
List of endpoints. |
true |
v1.Endpoints array |
v1.EnvFromSource
EnvFromSource represents the source of a set of ConfigMaps
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
prefix |
An optional identifer to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. |
false |
string |
|
configMapRef |
The ConfigMap to select from |
false |
||
secretRef |
The Secret to select from |
false |
v1.EnvVar
EnvVar represents an environment variable present in a Container.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
name |
Name of the environment variable. Must be a C_IDENTIFIER. |
true |
string |
|
value |
Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double , ie: (VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". |
false |
string |
|
valueFrom |
Source for the environment variable’s value. Cannot be used if value is not empty. |
false |
v1.EnvVarSource
EnvVarSource represents a source for the value of an EnvVar.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
fieldRef |
Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.podIP. |
false |
||
resourceFieldRef |
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. |
false |
||
configMapKeyRef |
Selects a key of a ConfigMap. |
false |
||
secretKeyRef |
Selects a key of a secret in the pod’s namespace |
false |
v1.Event
Event is a report of an event somewhere in the cluster.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
true |
||
involvedObject |
The object that this event is about. |
true |
||
reason |
This should be a short, machine understandable string that gives the reason for the transition into the object’s current status. |
false |
string |
|
message |
A human-readable description of the status of this operation. |
false |
string |
|
source |
The component reporting this event. Should be a short machine understandable string. |
false |
||
firstTimestamp |
The time at which the event was first recorded. (Time of server receipt is in TypeMeta.) |
false |
string |
|
lastTimestamp |
The time at which the most recent occurrence of this event was recorded. |
false |
string |
|
count |
The number of times this event has occurred. |
false |
integer (int32) |
|
type |
Type of this event (Normal, Warning), new types could be added in the future |
false |
string |
v1.EventList
EventList is a list of events.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
||
items |
List of events |
true |
v1.Event array |
v1.EventSource
EventSource contains information for an event.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
component |
Component from which the event is generated. |
false |
string |
|
host |
Node name on which the event is generated. |
false |
string |
v1.ExecAction
ExecAction describes a "run in container" action.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
command |
Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('|', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. |
false |
string array |
v1.FCVolumeSource
Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
targetWWNs |
Required: FC target worldwide names (WWNs) |
true |
string array |
|
lun |
Required: FC target lun number |
true |
integer (int32) |
|
fsType |
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. |
false |
string |
|
readOnly |
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
false |
boolean |
v1.FSGroupStrategyOptions
FSGroupStrategyOptions defines the strategy type and options used to create the strategy.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
type |
Type is the strategy that will dictate what FSGroup is used in the SecurityContext. |
false |
string |
|
ranges |
Ranges are the allowed ranges of fs groups. If you would like to force a single fs group then supply a single range with the same start and end. |
false |
v1.IDRange array |
v1.FlexVolumeSource
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
driver |
Driver is the name of the driver to use for this volume. |
true |
string |
|
fsType |
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. |
false |
string |
|
secretRef |
Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts. |
false |
||
readOnly |
Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
false |
boolean |
|
options |
Optional: Extra command options if any. |
false |
object |
v1.FlockerVolumeSource
Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
datasetName |
Name of the dataset stored as metadata → name on the dataset for Flocker should be considered as deprecated |
false |
string |
|
datasetUUID |
UUID of the dataset. This is unique identifier of a Flocker dataset |
false |
string |
v1.GCEPersistentDiskVolumeSource
Represents a Persistent Disk resource in Google Compute Engine.
A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
pdName |
Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk |
true |
string |
|
fsType |
Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk |
false |
string |
|
partition |
The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk |
false |
integer (int32) |
|
readOnly |
ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk |
false |
boolean |
v1.GitRepoVolumeSource
Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
repository |
Repository URL |
true |
string |
|
revision |
Commit hash for the specified revision. |
false |
string |
|
directory |
Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. |
false |
string |
v1.GlusterfsVolumeSource
Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
endpoints |
EndpointsName is the endpoint name that details Glusterfs topology. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod |
true |
string |
|
path |
Path is the Glusterfs volume path. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod |
true |
string |
|
readOnly |
ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod |
false |
boolean |
v1.HTTPGetAction
HTTPGetAction describes an action based on HTTP Get requests.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
path |
Path to access on the HTTP server. |
false |
string |
|
port |
Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
string |
|
host |
Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. |
false |
string |
|
scheme |
Scheme to use for connecting to the host. Defaults to HTTP. |
false |
string |
|
httpHeaders |
Custom headers to set in the request. HTTP allows repeated headers. |
false |
v1.HTTPHeader array |
v1.HTTPHeader
HTTPHeader describes a custom header to be used in HTTP probes
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
name |
The header field name |
true |
string |
|
value |
The header field value |
true |
string |
v1.Handler
Handler defines a specific action that should be taken
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
exec |
One and only one of the following should be specified. Exec specifies the action to take. |
false |
||
httpGet |
HTTPGet specifies the http request to perform. |
false |
||
tcpSocket |
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported |
false |
v1.HostPathVolumeSource
Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
path |
Path of the directory on the host. More info: http://kubernetes.io/docs/user-guide/volumes#hostpath |
true |
string |
v1.IDRange
IDRange provides a min/max of an allowed range of IDs.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
min |
Min is the start of the range, inclusive. |
false |
integer (int64) |
|
max |
Max is the end of the range, inclusive. |
false |
integer (int64) |
v1.ISCSIVolumeSource
Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
targetPortal |
iSCSI target portal. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). |
true |
string |
|
iqn |
Target iSCSI Qualified Name. |
true |
string |
|
lun |
iSCSI target lun number. |
true |
integer (int32) |
|
iscsiInterface |
Optional: Defaults to 'default' (tcp). iSCSI interface name that uses an iSCSI transport. |
false |
string |
|
fsType |
Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://kubernetes.io/docs/user-guide/volumes#iscsi |
false |
string |
|
readOnly |
ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. |
false |
boolean |
|
portals |
iSCSI target portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). |
false |
string array |
|
chapAuthDiscovery |
whether support iSCSI Discovery CHAP authentication |
false |
boolean |
|
chapAuthSession |
whether support iSCSI Session CHAP authentication |
false |
boolean |
|
secretRef |
CHAP secret for iSCSI target and initiator authentication |
false |
v1.KeyToPath
Maps a string key to a path within a volume.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
key |
The key to project. |
true |
string |
|
path |
The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. |
true |
string |
|
mode |
Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
false |
integer (int32) |
v1.LabelSelector
A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
matchLabels |
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. |
false |
object |
|
matchExpressions |
matchExpressions is a list of label selector requirements. The requirements are ANDed. |
false |
v1.LabelSelectorRequirement
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
key |
key is the label key that the selector applies to. |
true |
string |
|
operator |
operator represents a key’s relationship to a set of values. Valid operators ard In, NotIn, Exists and DoesNotExist. |
true |
string |
|
values |
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. |
false |
string array |
v1.Lifecycle
Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
postStart |
PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: http://kubernetes.io/docs/user-guide/container-environment#hook-details |
false |
||
preStop |
PreStop is called immediately before a container is terminated. The container is terminated after the handler completes. The reason for termination is passed to the handler. Regardless of the outcome of the handler, the container is eventually terminated. Other management of the container blocks until the hook completes. More info: http://kubernetes.io/docs/user-guide/container-environment#hook-details |
false |
v1.LimitRange
LimitRange sets resource usage limits for each kind of resource in a Namespace.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
spec |
Spec defines the limits enforced. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
v1.LimitRangeItem
LimitRangeItem defines a min/max usage limit for any resource that matches on kind.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
type |
Type of resource that this limit applies to. |
false |
string |
|
max |
Max usage constraints on this kind by resource name. |
false |
object |
|
min |
Min usage constraints on this kind by resource name. |
false |
object |
|
default |
Default resource requirement limit value by resource name if resource limit is omitted. |
false |
object |
|
defaultRequest |
DefaultRequest is the default resource requirement request value by resource name if resource request is omitted. |
false |
object |
|
maxLimitRequestRatio |
MaxLimitRequestRatio if specified, the named resource must have a request and limit that are both non-zero where limit divided by request is less than or equal to the enumerated value; this represents the max burst for the named resource. |
false |
object |
v1.LimitRangeList
LimitRangeList is a list of LimitRange items.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
||
items |
Items is a list of LimitRange objects. More info: http://releases.k8s.io/HEAD/docs/design/admission_control_limit_range.md |
true |
v1.LimitRange array |
v1.LimitRangeSpec
LimitRangeSpec defines a min/max usage limit for resources that match on kind.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
limits |
Limits is the list of LimitRangeItem objects that are enforced. |
true |
v1.LimitRangeItem array |
v1.ListMeta
ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
selfLink |
SelfLink is a URL representing this object. Populated by the system. Read-only. |
false |
string |
|
resourceVersion |
String that identifies the server’s internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency |
false |
string |
v1.LoadBalancerIngress
LoadBalancerIngress represents the status of a load-balancer ingress point: traffic intended for the service should be sent to an ingress point.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
ip |
IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers) |
false |
string |
|
hostname |
Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers) |
false |
string |
v1.LoadBalancerStatus
LoadBalancerStatus represents the status of a load-balancer.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
ingress |
Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points. |
false |
v1.LoadBalancerIngress array |
v1.LocalObjectReference
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
name |
Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names |
false |
string |
v1.NFSVolumeSource
Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
server |
Server is the hostname or IP address of the NFS server. More info: http://kubernetes.io/docs/user-guide/volumes#nfs |
true |
string |
|
path |
Path that is exported by the NFS server. More info: http://kubernetes.io/docs/user-guide/volumes#nfs |
true |
string |
|
readOnly |
ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: http://kubernetes.io/docs/user-guide/volumes#nfs |
false |
boolean |
v1.Namespace
Namespace provides a scope for Names. Use of multiple namespaces is optional.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
spec |
Spec defines the behavior of the Namespace. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
||
status |
Status describes the current status of a Namespace. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
v1.NamespaceList
NamespaceList is a list of Namespaces.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
||
items |
Items is the list of Namespace objects in the list. More info: http://kubernetes.io/docs/user-guide/namespaces |
true |
v1.Namespace array |
v1.NamespaceSpec
NamespaceSpec describes the attributes on a Namespace.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
finalizers |
Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: http://releases.k8s.io/HEAD/docs/design/namespaces.md#finalizers |
false |
v1.FinalizerName array |
v1.NamespaceStatus
NamespaceStatus is information about the current status of a Namespace.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
phase |
Phase is the current lifecycle phase of the namespace. More info: http://releases.k8s.io/HEAD/docs/design/namespaces.md#phases |
false |
string |
v1.Node
Node is a worker node in Kubernetes. Each node will have a unique identifier in the cache (i.e. in etcd).
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
spec |
Spec defines the behavior of a node. http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
||
status |
Most recently observed status of the node. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
v1.NodeAddress
NodeAddress contains information for the node’s address.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
type |
Node address type, one of Hostname, ExternalIP or InternalIP. |
true |
string |
|
address |
The node address. |
true |
string |
v1.NodeAffinity
Node affinity is a group of node affinity scheduling rules.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
requiredDuringSchedulingIgnoredDuringExecution |
If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node. |
false |
||
preferredDuringSchedulingIgnoredDuringExecution |
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. |
false |
v1.NodeCondition
NodeCondition contains condition information for a node.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
type |
Type of node condition. |
true |
string |
|
status |
Status of the condition, one of True, False, Unknown. |
true |
string |
|
lastHeartbeatTime |
Last time we got an update on a given condition. |
false |
string |
|
lastTransitionTime |
Last time the condition transit from one status to another. |
false |
string |
|
reason |
(brief) reason for the condition’s last transition. |
false |
string |
|
message |
Human readable message indicating details about last transition. |
false |
string |
v1.NodeDaemonEndpoints
NodeDaemonEndpoints lists ports opened by daemons running on the Node.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kubeletEndpoint |
Endpoint on which Kubelet is listening. |
false |
v1.NodeList
NodeList is the whole list of all Nodes which have been registered with master.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
||
items |
List of nodes |
true |
v1.Node array |
v1.NodeSelector
A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
nodeSelectorTerms |
Required. A list of node selector terms. The terms are ORed. |
true |
v1.NodeSelectorTerm array |
v1.NodeSelectorRequirement
A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
key |
The label key that the selector applies to. |
true |
string |
|
operator |
Represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. |
true |
string |
|
values |
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. |
false |
string array |
v1.NodeSelectorTerm
A null or empty node selector term matches no objects.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
matchExpressions |
Required. A list of node selector requirements. The requirements are ANDed. |
true |
v1.NodeSpec
NodeSpec describes the attributes that a node is created with.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
podCIDR |
PodCIDR represents the pod IP range assigned to the node. |
false |
string |
|
externalID |
External ID of the node assigned by some machine database (e.g. a cloud provider). Deprecated. |
false |
string |
|
providerID |
ID of the node assigned by the cloud provider in the format: <ProviderName>://<ProviderSpecificNodeID> |
false |
string |
|
unschedulable |
Unschedulable controls node schedulability of new pods. By default, node is schedulable. More info: http://releases.k8s.io/HEAD/docs/admin/node.md#manual-node-administration |
false |
boolean |
|
taints |
If specified, the node’s taints. |
false |
v1.Taint array |
v1.NodeStatus
NodeStatus is information about the current status of a node.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
capacity |
Capacity represents the total resources of a node. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#capacity for more details. |
false |
object |
|
allocatable |
Allocatable represents the resources of a node that are available for scheduling. Defaults to Capacity. |
false |
object |
|
phase |
NodePhase is the recently observed lifecycle phase of the node. More info: http://releases.k8s.io/HEAD/docs/admin/node.md#node-phase The field is never populated, and now is deprecated. |
false |
string |
|
conditions |
Conditions is an array of current observed node conditions. More info: http://releases.k8s.io/HEAD/docs/admin/node.md#node-condition |
false |
v1.NodeCondition array |
|
addresses |
List of addresses reachable to the node. Queried from cloud provider, if available. More info: http://releases.k8s.io/HEAD/docs/admin/node.md#node-addresses |
false |
v1.NodeAddress array |
|
daemonEndpoints |
Endpoints of daemons running on the Node. |
false |
||
nodeInfo |
Set of ids/uuids to uniquely identify the node. More info: http://releases.k8s.io/HEAD/docs/admin/node.md#node-info |
false |
||
images |
List of container images on this node |
false |
v1.ContainerImage array |
|
volumesInUse |
List of attachable volumes in use (mounted) by the node. |
false |
v1.UniqueVolumeName array |
|
volumesAttached |
List of volumes that are attached to the node. |
false |
v1.AttachedVolume array |
v1.NodeSystemInfo
NodeSystemInfo is a set of ids/uuids to uniquely identify the node.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
machineID |
MachineID reported by the node. For unique machine identification in the cluster this field is prefered. Learn more from man(5) machine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html |
true |
string |
|
systemUUID |
SystemUUID reported by the node. For unique machine identification MachineID is prefered. This field is specific to Red Hat hosts https://access.redhat.com/documentation/en-US/Red_Hat_Subscription_Management/1/html/RHSM/getting-system-uuid.html |
true |
string |
|
bootID |
Boot ID reported by the node. |
true |
string |
|
kernelVersion |
Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64). |
true |
string |
|
osImage |
OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)). |
true |
string |
|
containerRuntimeVersion |
ContainerRuntime Version reported by the node through runtime remote api (e.g. docker://1.5.0). |
true |
string |
|
kubeletVersion |
Kubelet Version reported by the node. |
true |
string |
|
kubeProxyVersion |
KubeProxy Version reported by the node. |
true |
string |
|
operatingSystem |
The Operating System reported by the node |
true |
string |
|
architecture |
The Architecture reported by the node |
true |
string |
v1.ObjectFieldSelector
ObjectFieldSelector selects an apiVersioned field of an object.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
apiVersion |
Version of the schema the FieldPath is written in terms of, defaults to "v1". |
false |
string |
|
fieldPath |
Path of the field to select in the specified api version. |
true |
string |
v1.ObjectMeta
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
name |
Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names |
false |
string |
|
generateName |
GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. |
false |
string |
|
namespace |
Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. |
false |
string |
|
selfLink |
SelfLink is a URL representing this object. Populated by the system. Read-only. |
false |
string |
|
uid |
UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. |
false |
string |
|
resourceVersion |
An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. |
false |
string |
|
generation |
A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. |
false |
integer (int64) |
|
creationTimestamp |
CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. |
false |
string |
|
deletionTimestamp |
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the api. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. |
false |
string |
|
deletionGracePeriodSeconds |
Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. |
false |
integer (int64) |
|
labels |
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels |
false |
object |
|
annotations |
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations |
false |
object |
|
ownerReferences |
List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. |
false |
v1.OwnerReference array |
|
finalizers |
Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. |
false |
string array |
|
clusterName |
The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request. |
false |
string |
v1.ObjectReference
ObjectReference contains enough information to let you inspect or modify the referred object.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind of the referent. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
namespace |
Namespace of the referent. More info: http://kubernetes.io/docs/user-guide/namespaces |
false |
string |
|
name |
Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names |
false |
string |
|
uid |
UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
false |
string |
|
apiVersion |
api version of the referent. |
false |
string |
|
resourceVersion |
Specific resourceVersion to which this reference is made, if any. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency |
false |
string |
|
fieldPath |
If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. |
false |
string |
v1.OwnerReference
OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
apiVersion |
api version of the referent. |
true |
string |
|
kind |
Kind of the referent. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
true |
string |
|
name |
Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names |
true |
string |
|
uid |
UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids |
true |
string |
|
controller |
If true, this reference points to the managing controller. |
false |
boolean |
|
blockOwnerDeletion |
If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. |
false |
boolean |
v1.PersistentVolume
PersistentVolume (PV) is a storage resource provisioned by an administrator. It is analogous to a node. More info: http://kubernetes.io/docs/user-guide/persistent-volumes
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
spec |
Spec defines a specification of a persistent volume owned by the cluster. Provisioned by an administrator. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistent-volumes |
false |
||
status |
Status represents the current information/status for the persistent volume. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistent-volumes |
false |
v1.PersistentVolumeClaim
PersistentVolumeClaim is a user’s request for and claim to a persistent volume
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
spec |
Spec defines the desired characteristics of a volume requested by a pod author. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistentvolumeclaims |
false |
||
status |
Status represents the current information/status of a persistent volume claim. Read-only. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistentvolumeclaims |
false |
v1.PersistentVolumeClaimList
PersistentVolumeClaimList is a list of PersistentVolumeClaim items.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
||
items |
A list of persistent volume claims. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistentvolumeclaims |
true |
v1.PersistentVolumeClaim array |
v1.PersistentVolumeClaimSpec
PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
accessModes |
AccessModes contains the desired access modes the volume should have. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#access-modes-1 |
false |
||
selector |
A label query over volumes to consider for binding. |
false |
||
resources |
Resources represents the minimum resources the volume should have. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#resources |
false |
||
volumeName |
VolumeName is the binding reference to the PersistentVolume backing this claim. |
false |
string |
|
storageClassName |
Name of the StorageClass required by the claim. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#class-1 |
false |
string |
v1.PersistentVolumeClaimStatus
PersistentVolumeClaimStatus is the current status of a persistent volume claim.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
phase |
Phase represents the current phase of PersistentVolumeClaim. |
false |
string |
|
accessModes |
AccessModes contains the actual access modes the volume backing the PVC has. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#access-modes-1 |
false |
||
capacity |
Represents the actual resources of the underlying volume. |
false |
object |
v1.PersistentVolumeClaimVolumeSource
PersistentVolumeClaimVolumeSource references the user’s PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
claimName |
ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistentvolumeclaims |
true |
string |
|
readOnly |
Will force the ReadOnly setting in VolumeMounts. Default false. |
false |
boolean |
v1.PersistentVolumeList
PersistentVolumeList is a list of PersistentVolume items.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
||
items |
List of persistent volumes. More info: http://kubernetes.io/docs/user-guide/persistent-volumes |
true |
v1.PersistentVolume array |
v1.PersistentVolumeSpec
PersistentVolumeSpec is the specification of a persistent volume.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
capacity |
A description of the persistent volume’s resources and capacity. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#capacity |
false |
object |
|
gcePersistentDisk |
GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. Provisioned by an admin. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk |
false |
||
awsElasticBlockStore |
AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore |
false |
||
hostPath |
HostPath represents a directory on the host. Provisioned by a developer or tester. This is useful for single-node development and testing only! On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. More info: http://kubernetes.io/docs/user-guide/volumes#hostpath |
false |
||
glusterfs |
Glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md |
false |
||
nfs |
NFS represents an NFS mount on the host. Provisioned by an admin. More info: http://kubernetes.io/docs/user-guide/volumes#nfs |
false |
||
rbd |
RBD represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md |
false |
||
iscsi |
ISCSI represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. Provisioned by an admin. |
false |
||
cinder |
Cinder represents a cinder volume attached and mounted on kubelets host machine More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md |
false |
||
cephfs |
CephFS represents a Ceph FS mount on the host that shares a pod’s lifetime |
false |
||
fc |
FC represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod. |
false |
||
flocker |
Flocker represents a Flocker volume attached to a kubelet’s host machine and exposed to the pod for its usage. This depends on the Flocker control service being running |
false |
||
flexVolume |
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future. |
false |
||
azureFile |
AzureFile represents an Azure File Service mount on the host and bind mount to the pod. |
false |
||
vsphereVolume |
VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine |
false |
||
quobyte |
Quobyte represents a Quobyte mount on the host that shares a pod’s lifetime |
false |
||
azureDisk |
AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. |
false |
||
photonPersistentDisk |
PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine |
false |
||
portworxVolume |
PortworxVolume represents a portworx volume attached and mounted on kubelets host machine |
false |
||
scaleIO |
ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. |
false |
||
accessModes |
AccessModes contains all ways the volume can be mounted. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#access-modes |
false |
||
claimRef |
ClaimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. Expected to be non-nil when bound. claim.VolumeName is the authoritative bind between PV and PVC. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#binding |
false |
||
persistentVolumeReclaimPolicy |
What happens to a persistent volume when released from its claim. Valid options are Retain (default) and Recycle. Recycling must be supported by the volume plugin underlying this persistent volume. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#recycling-policy |
false |
string |
|
storageClassName |
Name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass. |
false |
string |
v1.PersistentVolumeStatus
PersistentVolumeStatus is the current status of a persistent volume.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
phase |
Phase indicates if a volume is available, bound to a claim, or released by a claim. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#phase |
false |
string |
|
message |
A human-readable message indicating details about why the volume is in this state. |
false |
string |
|
reason |
Reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI. |
false |
string |
v1.PhotonPersistentDiskVolumeSource
Represents a Photon Controller persistent disk resource.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
pdID |
ID that identifies Photon Controller persistent disk |
true |
string |
|
fsType |
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. |
false |
string |
v1.Pod
Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
spec |
Specification of the desired behavior of the pod. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
||
status |
Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
v1.PodAffinity
Pod affinity is a group of inter pod affinity scheduling rules.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
requiredDuringSchedulingIgnoredDuringExecution |
NOT YET IMPLEMENTED. TODO: Uncomment field once it is implemented. If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system will try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. RequiredDuringSchedulingRequiredDuringExecution []PodAffinityTerm |
false |
v1.PodAffinityTerm array |
|
preferredDuringSchedulingIgnoredDuringExecution |
The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. |
false |
v1.PodAffinityTerm
Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> tches that of any node on which a pod of the set of pods is running
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
labelSelector |
A label query over a set of resources, in this case pods. |
false |
||
namespaces |
namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod’s namespace" |
false |
string array |
|
topologyKey |
This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. For PreferredDuringScheduling pod anti-affinity, empty topologyKey is interpreted as "all topologies" ("all topologies" here means all the topologyKeys indicated by scheduler command-line argument --failure-domains); for affinity and for RequiredDuringScheduling pod anti-affinity, empty topologyKey is not allowed. |
false |
string |
v1.PodAntiAffinity
Pod anti affinity is a group of inter pod anti affinity scheduling rules.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
requiredDuringSchedulingIgnoredDuringExecution |
NOT YET IMPLEMENTED. TODO: Uncomment field once it is implemented. If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system will try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. RequiredDuringSchedulingRequiredDuringExecution []PodAffinityTerm |
false |
v1.PodAffinityTerm array |
|
preferredDuringSchedulingIgnoredDuringExecution |
The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. |
false |
v1.PodCondition
PodCondition contains details for the current condition of this pod.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
type |
Type is the type of the condition. Currently only Ready. More info: http://kubernetes.io/docs/user-guide/pod-states#pod-conditions |
true |
string |
|
status |
Status is the status of the condition. Can be True, False, Unknown. More info: http://kubernetes.io/docs/user-guide/pod-states#pod-conditions |
true |
string |
|
lastProbeTime |
Last time we probed the condition. |
false |
string |
|
lastTransitionTime |
Last time the condition transitioned from one status to another. |
false |
string |
|
reason |
Unique, one-word, CamelCase reason for the condition’s last transition. |
false |
string |
|
message |
Human-readable message indicating details about last transition. |
false |
string |
v1.PodList
PodList is a list of Pods.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
||
items |
List of pods. More info: http://kubernetes.io/docs/user-guide/pods |
true |
v1.Pod array |
v1.PodSecurityContext
PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
seLinuxOptions |
The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. |
false |
||
runAsUser |
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. |
false |
integer (int64) |
|
runAsNonRoot |
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
boolean |
|
supplementalGroups |
A list of groups applied to the first process run in each container, in addition to the container’s primary GID. If unspecified, no groups will be added to any container. |
false |
integer array |
|
fsGroup |
A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: |
false |
integer (int64) |
v1.PodSpec
PodSpec is a description of a pod.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
volumes |
List of volumes that can be mounted by containers belonging to the pod. More info: http://kubernetes.io/docs/user-guide/volumes |
false |
v1.Volume array |
|
initContainers |
List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, or Liveness probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers |
false |
v1.Container array |
|
containers |
List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers |
true |
v1.Container array |
|
restartPolicy |
Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: http://kubernetes.io/docs/user-guide/pod-states#restartpolicy |
false |
string |
|
terminationGracePeriodSeconds |
Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds. |
false |
integer (int64) |
|
activeDeadlineSeconds |
Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer. |
false |
integer (int64) |
|
dnsPolicy |
Set DNS policy for containers within the pod. One of 'ClusterFirstWithHostNet', 'ClusterFirst' or 'Default'. Defaults to "ClusterFirst". To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'. |
false |
string |
|
nodeSelector |
NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: http://kubernetes.io/docs/user-guide/node-selection/README |
false |
object |
|
serviceAccountName |
ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: http://releases.k8s.io/HEAD/docs/design/service_accounts.md |
false |
string |
|
serviceAccount |
DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead. |
false |
string |
|
automountServiceAccountToken |
AutomountServiceAccountToken indicates whether a service account token should be automatically mounted. |
false |
boolean |
|
nodeName |
NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements. |
false |
string |
|
hostNetwork |
Host networking requested for this pod. Use the host’s network namespace. If this option is set, the ports that will be used must be specified. Default to false. |
false |
boolean |
|
hostPID |
Use the host’s pid namespace. Optional: Default to false. |
false |
boolean |
|
hostIPC |
Use the host’s ipc namespace. Optional: Default to false. |
false |
boolean |
|
securityContext |
SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field. |
false |
||
imagePullSecrets |
ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod |
false |
v1.LocalObjectReference array |
|
hostname |
Specifies the hostname of the Pod If not specified, the pod’s hostname will be set to a system-defined value. |
false |
string |
|
subdomain |
If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". If not specified, the pod will not have a domainname at all. |
false |
string |
|
affinity |
If specified, the pod’s scheduling constraints |
false |
||
schedulerName |
If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler. |
false |
string |
|
tolerations |
If specified, the pod’s tolerations. |
false |
v1.Toleration array |
v1.PodStatus
PodStatus represents information about the status of a pod. Status may trail the actual state of a system.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
phase |
Current condition of the pod. More info: http://kubernetes.io/docs/user-guide/pod-states#pod-phase |
false |
string |
|
conditions |
Current service state of pod. More info: http://kubernetes.io/docs/user-guide/pod-states#pod-conditions |
false |
v1.PodCondition array |
|
message |
A human readable message indicating details about why the pod is in this condition. |
false |
string |
|
reason |
A brief CamelCase message indicating details about why the pod is in this state. e.g. 'OutOfDisk' |
false |
string |
|
hostIP |
IP address of the host to which the pod is assigned. Empty if not yet scheduled. |
false |
string |
|
podIP |
IP address allocated to the pod. Routable at least within the cluster. Empty if not yet allocated. |
false |
string |
|
startTime |
RFC 3339 date and time at which the object was acknowledged by the Kubelet. This is before the Kubelet pulled the container image(s) for the pod. |
false |
string |
|
initContainerStatuses |
The list has one entry per init container in the manifest. The most recent successful init container will have ready = true, the most recently started container will have startTime set. More info: http://kubernetes.io/docs/user-guide/pod-states#container-statuses |
false |
v1.ContainerStatus array |
|
containerStatuses |
The list has one entry per container in the manifest. Each entry is currently the output of |
false |
v1.ContainerStatus array |
|
qosClass |
The Quality of Service (QOS) classification assigned to the pod based on resource requirements See PodQOSClass type for available QOS classes More info: https://github.com/kubernetes/kubernetes/blob/master/docs/design/resource-qos.md |
false |
string |
v1.PodTemplate
PodTemplate describes a template for creating copies of a predefined pod.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
template |
Template defines the pods that will be created from this pod template. http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
v1.PodTemplateList
PodTemplateList is a list of PodTemplates.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
||
items |
List of pod templates |
true |
v1.PodTemplate array |
v1.PodTemplateSpec
PodTemplateSpec describes the data a pod should have when created from a template
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
metadata |
Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
spec |
Specification of the desired behavior of the pod. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
v1.PortworxVolumeSource
PortworxVolumeSource represents a Portworx volume resource.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
volumeID |
VolumeID uniquely identifies a Portworx volume |
true |
string |
|
fsType |
FSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified. |
false |
string |
|
readOnly |
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
false |
boolean |
v1.Preconditions
Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
uid |
Specifies the target UID. |
false |
v1.PreferredSchedulingTerm
An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it’s a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
weight |
Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. |
true |
integer (int32) |
|
preference |
A node selector term, associated with the corresponding weight. |
true |
v1.Probe
Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
exec |
One and only one of the following should be specified. Exec specifies the action to take. |
false |
||
httpGet |
HTTPGet specifies the http request to perform. |
false |
||
tcpSocket |
TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported |
false |
||
initialDelaySeconds |
Number of seconds after the container has started before liveness probes are initiated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes |
false |
integer (int32) |
|
timeoutSeconds |
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes |
false |
integer (int32) |
|
periodSeconds |
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
false |
integer (int32) |
|
successThreshold |
Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1. |
false |
integer (int32) |
|
failureThreshold |
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. |
false |
integer (int32) |
v1.ProjectedVolumeSource
Represents a projected volume source
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
sources |
list of volume projections |
true |
v1.VolumeProjection array |
|
defaultMode |
Mode bits to use on created files by default. Must be a value between 0 and 0777. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
false |
integer (int32) |
v1.QuobyteVolumeSource
Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
registry |
Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes |
true |
string |
|
volume |
Volume is a string that references an already created Quobyte volume by name. |
true |
string |
|
readOnly |
ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false. |
false |
boolean |
|
user |
User to map volume access to Defaults to serivceaccount user |
false |
string |
|
group |
Group to map volume access to Default is no group |
false |
string |
v1.RBDVolumeSource
Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
monitors |
A collection of Ceph monitors. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it |
true |
string array |
|
image |
The rados image name. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it |
true |
string |
|
fsType |
Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://kubernetes.io/docs/user-guide/volumes#rbd |
false |
string |
|
pool |
The rados pool name. Default is rbd. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it. |
false |
string |
|
user |
The rados user name. Default is admin. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it |
false |
string |
|
keyring |
Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it |
false |
string |
|
secretRef |
SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it |
false |
||
readOnly |
ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it |
false |
boolean |
v1.ReplicationController
ReplicationController represents the configuration of a replication controller.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
If the Labels of a ReplicationController are empty, they are defaulted to be the same as the Pod(s) that the replication controller manages. Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
spec |
Spec defines the specification of the desired behavior of the replication controller. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
||
status |
Status is the most recently observed status of the replication controller. This data may be out of date by some window of time. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
v1.ReplicationControllerCondition
ReplicationControllerCondition describes the state of a replication controller at a certain point.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
type |
Type of replication controller condition. |
true |
string |
|
status |
Status of the condition, one of True, False, Unknown. |
true |
string |
|
lastTransitionTime |
The last time the condition transitioned from one status to another. |
false |
string |
|
reason |
The reason for the condition’s last transition. |
false |
string |
|
message |
A human readable message indicating details about the transition. |
false |
string |
v1.ReplicationControllerList
ReplicationControllerList is a collection of replication controllers.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
||
items |
List of replication controllers. More info: http://kubernetes.io/docs/user-guide/replication-controller |
true |
v1.ReplicationController array |
v1.ReplicationControllerSpec
ReplicationControllerSpec is the specification of a replication controller.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
replicas |
Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: http://kubernetes.io/docs/user-guide/replication-controller#what-is-a-replication-controller |
false |
integer (int32) |
|
minReadySeconds |
Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) |
false |
integer (int32) |
|
selector |
Selector is a label query over pods that should match the Replicas count. If Selector is empty, it is defaulted to the labels present on the Pod template. Label keys and values that must match in order to be controlled by this replication controller, if empty defaulted to labels on Pod template. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors |
false |
object |
|
template |
Template is the object that describes the pod that will be created if insufficient replicas are detected. This takes precedence over a TemplateRef. More info: http://kubernetes.io/docs/user-guide/replication-controller#pod-template |
false |
v1.ReplicationControllerStatus
ReplicationControllerStatus represents the current status of a replication controller.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
replicas |
Replicas is the most recently oberved number of replicas. More info: http://kubernetes.io/docs/user-guide/replication-controller#what-is-a-replication-controller |
true |
integer (int32) |
|
fullyLabeledReplicas |
The number of pods that have labels matching the labels of the pod template of the replication controller. |
false |
integer (int32) |
|
readyReplicas |
The number of ready replicas for this replication controller. |
false |
integer (int32) |
|
availableReplicas |
The number of available replicas (ready for at least minReadySeconds) for this replication controller. |
false |
integer (int32) |
|
observedGeneration |
ObservedGeneration reflects the generation of the most recently observed replication controller. |
false |
integer (int64) |
|
conditions |
Represents the latest available observations of a replication controller’s current state. |
false |
v1.ResourceFieldSelector
ResourceFieldSelector represents container resources (cpu, memory) and their output format
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
containerName |
Container name: required for volumes, optional for env vars |
false |
string |
|
resource |
Required: resource to select |
true |
string |
|
divisor |
Specifies the output format of the exposed resources, defaults to "1" |
false |
string |
v1.ResourceQuota
ResourceQuota sets aggregate quota restrictions enforced per namespace
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
spec |
Spec defines the desired quota. http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
||
status |
Status defines the actual enforced quota and its current usage. http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
v1.ResourceQuotaList
ResourceQuotaList is a list of ResourceQuota items.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
||
items |
Items is a list of ResourceQuota objects. More info: http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota |
true |
v1.ResourceQuota array |
v1.ResourceQuotaSpec
ResourceQuotaSpec defines the desired hard limits to enforce for Quota.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
hard |
Hard is the set of desired hard limits for each named resource. More info: http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota |
false |
object |
|
scopes |
A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects. |
false |
v1.ResourceQuotaScope array |
v1.ResourceQuotaStatus
ResourceQuotaStatus defines the enforced hard limits and observed use.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
hard |
Hard is the set of enforced hard limits for each named resource. More info: http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota |
false |
object |
|
used |
Used is the current observed total usage of the resource in the namespace. |
false |
object |
v1.ResourceRequirements
ResourceRequirements describes the compute resource requirements.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
limits |
Limits describes the maximum amount of compute resources allowed. More info: http://kubernetes.io/docs/user-guide/compute-resources/ |
false |
object |
|
requests |
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: http://kubernetes.io/docs/user-guide/compute-resources/ |
false |
object |
v1.RunAsUserStrategyOptions
RunAsUserStrategyOptions defines the strategy type and any options used to create the strategy.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
type |
Type is the strategy that will dictate what RunAsUser is used in the SecurityContext. |
false |
string |
|
uid |
UID is the user id that containers must run as. Required for the MustRunAs strategy if not using namespace/service account allocated uids. |
false |
integer (int64) |
|
uidRangeMin |
UIDRangeMin defines the min value for a strategy that allocates by range. |
false |
integer (int64) |
|
uidRangeMax |
UIDRangeMax defines the max value for a strategy that allocates by range. |
false |
integer (int64) |
v1.SELinuxContextStrategyOptions
SELinuxContextStrategyOptions defines the strategy type and any options used to create the strategy.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
type |
Type is the strategy that will dictate what SELinux context is used in the SecurityContext. |
false |
string |
|
seLinuxOptions |
seLinuxOptions required to run as; required for MustRunAs |
false |
v1.SELinuxOptions
SELinuxOptions are the labels to be applied to the container
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
user |
User is a SELinux user label that applies to the container. |
false |
string |
|
role |
Role is a SELinux role label that applies to the container. |
false |
string |
|
type |
Type is a SELinux type label that applies to the container. |
false |
string |
|
level |
Level is SELinux level label that applies to the container. |
false |
string |
v1.Scale
Scale represents a scaling request for a resource.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard object metadata; More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata. |
false |
||
spec |
defines the behavior of the scale. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status. |
false |
||
status |
current status of the scale. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status. Read-only. |
false |
v1.ScaleIOVolumeSource
ScaleIOVolumeSource represents a persistent ScaleIO volume
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
gateway |
The host address of the ScaleIO api Gateway. |
true |
string |
|
system |
The name of the storage system as configured in ScaleIO. |
true |
string |
|
secretRef |
SecretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail. |
true |
||
sslEnabled |
Flag to enable/disable SSL communication with Gateway, default false |
false |
boolean |
|
protectionDomain |
The name of the Protection Domain for the configured storage (defaults to "default"). |
false |
string |
|
storagePool |
The Storage Pool associated with the protection domain (defaults to "default"). |
false |
string |
|
storageMode |
Indicates whether the storage for a volume should be thick or thin (defaults to "thin"). |
false |
string |
|
volumeName |
The name of a volume already created in the ScaleIO system that is associated with this volume source. |
false |
string |
|
fsType |
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. |
false |
string |
|
readOnly |
Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. |
false |
boolean |
v1.ScaleSpec
ScaleSpec describes the attributes of a scale subresource.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
replicas |
desired number of instances for the scaled object. |
false |
integer (int32) |
v1.ScaleStatus
ScaleStatus represents the current status of a scale subresource.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
replicas |
actual number of observed instances of the scaled object. |
true |
integer (int32) |
|
selector |
label query over pods that should match the replicas count. This is same as the label selector but in the string format to avoid introspection by clients. The string will be in the same format as the query-param syntax. More info about label selectors: http://kubernetes.io/docs/user-guide/labels#label-selectors |
false |
string |
v1.Secret
Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
data |
Data contains the secret data. Each key must be a valid DNS_SUBDOMAIN or leading dot followed by valid DNS_SUBDOMAIN. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4 |
false |
object |
|
stringData |
stringData allows specifying non-binary secret data in string form. It is provided as a write-only convenience method. All keys and values are merged into the data field on write, overwriting any existing values. It is never output when reading from the api. |
false |
object |
|
type |
Used to facilitate programmatic handling of secret data. |
false |
string |
v1.SecretEnvSource
SecretEnvSource selects a Secret to populate the environment variables with.
The contents of the target Secret’s Data field will represent the key-value pairs as environment variables.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
name |
Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names |
false |
string |
|
optional |
Specify whether the Secret must be defined |
false |
boolean |
v1.SecretKeySelector
SecretKeySelector selects a key of a Secret.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
name |
Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names |
false |
string |
|
key |
The key of the secret to select from. Must be a valid secret key. |
true |
string |
|
optional |
Specify whether the Secret or it’s key must be defined |
false |
boolean |
v1.SecretList
SecretList is a list of Secret.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
||
items |
Items is a list of secret objects. More info: http://kubernetes.io/docs/user-guide/secrets |
true |
v1.Secret array |
v1.SecretProjection
Adapts a secret into a projected volume.
The contents of the target Secret’s Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
name |
Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names |
false |
string |
|
items |
If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. |
false |
v1.KeyToPath array |
|
optional |
Specify whether the Secret or its key must be defined |
false |
boolean |
v1.SecretVolumeSource
Adapts a Secret into a volume.
The contents of the target Secret’s Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
secretName |
Name of the secret in the pod’s namespace to use. More info: http://kubernetes.io/docs/user-guide/volumes#secrets |
false |
string |
|
items |
If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. |
false |
v1.KeyToPath array |
|
defaultMode |
Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. |
false |
integer (int32) |
|
optional |
Specify whether the Secret or it’s keys must be defined |
false |
boolean |
v1.SecurityContext
SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
capabilities |
The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. |
false |
||
privileged |
Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. |
false |
boolean |
|
seLinuxOptions |
The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
||
runAsUser |
The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
integer (int64) |
|
runAsNonRoot |
Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. |
false |
boolean |
|
readOnlyRootFilesystem |
Whether this container has a read-only root filesystem. Default is false. |
false |
boolean |
v1.SecurityContextConstraints
SecurityContextConstraints governs the ability to make requests that affect the SecurityContext that will be applied to a container.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
priority |
Priority influences the sort order of SCCs when evaluating which SCCs to try first for a given pod request based on access in the Users and Groups fields. The higher the int, the higher priority. If scores for multiple SCCs are equal they will be sorted by name. |
true |
integer (int32) |
|
allowPrivilegedContainer |
AllowPrivilegedContainer determines if a container can request to be run as privileged. |
true |
boolean |
|
defaultAddCapabilities |
DefaultAddCapabilities is the default set of capabilities that will be added to the container unless the pod spec specifically drops the capability. You may not list a capabiility in both DefaultAddCapabilities and RequiredDropCapabilities. |
true |
v1.Capability array |
|
requiredDropCapabilities |
RequiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added. |
true |
v1.Capability array |
|
allowedCapabilities |
AllowedCapabilities is a list of capabilities that can be requested to add to the container. Capabilities in this field maybe added at the pod author’s discretion. You must not list a capability in both AllowedCapabilities and RequiredDropCapabilities. To allow all capabilities you may use '*'. |
true |
v1.Capability array |
|
allowHostDirVolumePlugin |
AllowHostDirVolumePlugin determines if the policy allow containers to use the HostDir volume plugin |
true |
boolean |
|
volumes |
Volumes is a white list of allowed volume plugins. FSType corresponds directly with the field names of a VolumeSource (azureFile, configMap, emptyDir). To allow all volumes you may use "*". To allow no volumes, set to ["none"]. |
true |
v1.FSType array |
|
allowHostNetwork |
AllowHostNetwork determines if the policy allows the use of HostNetwork in the pod spec. |
true |
boolean |
|
allowHostPorts |
AllowHostPorts determines if the policy allows host ports in the containers. |
true |
boolean |
|
allowHostPID |
AllowHostPID determines if the policy allows host pid in the containers. |
true |
boolean |
|
allowHostIPC |
AllowHostIPC determines if the policy allows host ipc in the containers. |
true |
boolean |
|
seLinuxContext |
SELinuxContext is the strategy that will dictate what labels will be set in the SecurityContext. |
false |
||
runAsUser |
RunAsUser is the strategy that will dictate what RunAsUser is used in the SecurityContext. |
false |
||
supplementalGroups |
SupplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext. |
false |
||
fsGroup |
FSGroup is the strategy that will dictate what fs group is used by the SecurityContext. |
false |
||
readOnlyRootFilesystem |
ReadOnlyRootFilesystem when set to true will force containers to run with a read only root file system. If the container specifically requests to run with a non-read only root file system the SCC should deny the pod. If set to false the container may run with a read only root file system if it wishes but it will not be forced to. |
true |
boolean |
|
users |
The users who have permissions to use this security context constraints |
false |
string array |
|
groups |
The groups that have permission to use this security context constraints |
false |
string array |
|
seccompProfiles |
SeccompProfiles lists the allowed profiles that may be set for the pod or container’s seccomp annotations. An unset (nil) or empty value means that no profiles may be specifid by the pod or container. The wildcard '*' may be used to allow all profiles. When used to generate a value for a pod the first non-wildcard profile will be used as the default. |
false |
string array |
v1.SecurityContextConstraintsList
SecurityContextConstraintsList is a list of SecurityContextConstraints objects
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
items |
List of security context constraints. |
true |
v1.Service
Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
spec |
Spec defines the behavior of a service. http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
||
status |
Most recently observed status of the service. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
v1.ServiceAccount
ServiceAccount binds together: * a name, understood by users, and perhaps by peripheral systems, for an identity * a principal that can be authenticated and authorized * a set of secrets
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
false |
||
secrets |
Secrets is the list of secrets allowed to be used by pods running using this ServiceAccount. More info: http://kubernetes.io/docs/user-guide/secrets |
false |
v1.ObjectReference array |
|
imagePullSecrets |
ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: http://kubernetes.io/docs/user-guide/secrets#manually-specifying-an-imagepullsecret |
false |
v1.LocalObjectReference array |
|
automountServiceAccountToken |
AutomountServiceAccountToken indicates whether pods running as this service account should have an api token automatically mounted. Can be overridden at the pod level. |
false |
boolean |
v1.ServiceAccountList
ServiceAccountList is a list of ServiceAccount objects
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
||
items |
List of ServiceAccounts. More info: http://releases.k8s.io/HEAD/docs/design/service_accounts.md#service-accounts |
true |
v1.ServiceAccount array |
v1.ServiceList
ServiceList holds a list of services.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
||
items |
List of services |
true |
v1.Service array |
v1.ServicePort
ServicePort contains information on service’s port.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
name |
The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. This maps to the 'Name' field in EndpointPort objects. Optional if only one ServicePort is defined on this service. |
false |
string |
|
protocol |
The IP protocol for this port. Supports "TCP" and "UDP". Default is TCP. |
false |
string |
|
port |
The port that will be exposed by this service. |
true |
integer (int32) |
|
targetPort |
Number or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod’s container ports. If this is not specified, the value of the 'port' field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the 'port' field. More info: http://kubernetes.io/docs/user-guide/services#defining-a-service |
false |
string |
|
nodePort |
The port on each node on which this service is exposed when type=NodePort or LoadBalancer. Usually assigned by the system. If specified, it will be allocated to the service if unused or else creation of the service will fail. Default is to auto-allocate a port if the ServiceType of this Service requires one. More info: http://kubernetes.io/docs/user-guide/services#type—nodeport |
false |
integer (int32) |
v1.ServiceSpec
ServiceSpec describes the attributes that a user creates on a service.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
ports |
The list of ports that are exposed by this service. More info: http://kubernetes.io/docs/user-guide/services#virtual-ips-and-service-proxies |
false |
v1.ServicePort array |
|
selector |
Route service traffic to pods with label keys and values matching this selector. If empty or not present, the service is assumed to have an external process managing its endpoints, which Kubernetes will not modify. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: http://kubernetes.io/docs/user-guide/services#overview |
false |
object |
|
clusterIP |
clusterIP is the IP address of the service and is usually assigned randomly by the master. If an address is specified manually and is not in use by others, it will be allocated to the service; otherwise, creation of the service will fail. This field can not be changed through updates. Valid values are "None", empty string (""), or a valid IP address. "None" can be specified for headless services when proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: http://kubernetes.io/docs/user-guide/services#virtual-ips-and-service-proxies |
false |
string |
|
type |
type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ExternalName" maps to the specified externalName. "ClusterIP" allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a stable IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the clusterIP. More info: http://kubernetes.io/docs/user-guide/services#overview |
false |
string |
|
externalIPs |
externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service. These IPs are not managed by Kubernetes. The user is responsible for ensuring that traffic arrives at a node with this IP. A common example is external load-balancers that are not part of the Kubernetes system. A previous form of this functionality exists as the deprecatedPublicIPs field. When using this field, callers should also clear the deprecatedPublicIPs field. |
false |
string array |
|
deprecatedPublicIPs |
deprecatedPublicIPs is deprecated and replaced by the externalIPs field with almost the exact same semantics. This field is retained in the v1 api for compatibility until at least 8/20/2016. It will be removed from any new api revisions. If both deprecatedPublicIPs and externalIPs are set, deprecatedPublicIPs is used. |
false |
string array |
|
sessionAffinity |
Supports "ClientIP" and "None". Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. More info: http://kubernetes.io/docs/user-guide/services#virtual-ips-and-service-proxies |
false |
string |
|
loadBalancerIP |
Only applies to Service Type: LoadBalancer LoadBalancer will get created with the IP specified in this field. This feature depends on whether the underlying cloud-provider supports specifying the loadBalancerIP when a load balancer is created. This field will be ignored if the cloud-provider does not support the feature. |
false |
string |
|
loadBalancerSourceRanges |
If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature." More info: http://kubernetes.io/docs/user-guide/services-firewalls |
false |
string array |
|
externalName |
externalName is the external reference that kubedns or equivalent will return as a CNAME record for this service. No proxying will be involved. Must be a valid DNS name and requires Type to be ExternalName. |
false |
string |
v1.ServiceStatus
ServiceStatus represents the current status of a service.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
loadBalancer |
LoadBalancer contains the current status of the load-balancer, if one is present. |
false |
v1.Status
Status is a return value for calls that don’t return other objects.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
||
status |
Status of the operation. One of: "Success" or "Failure". More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
false |
string |
|
message |
A human-readable description of the status of this operation. |
false |
string |
|
reason |
A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it. |
false |
string |
|
details |
Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type. |
false |
||
code |
Suggested HTTP return code for this status, 0 if not set. |
false |
integer (int32) |
v1.StatusCause
StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
reason |
A machine-readable description of the cause of the error. If this value is empty there is no information available. |
false |
string |
|
message |
A human-readable description of the cause of the error. This field may be presented as-is to a reader. |
false |
string |
|
field |
The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional. |
false |
string |
v1.StatusDetails
StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
name |
The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described). |
false |
string |
|
group |
The group attribute of the resource associated with the status StatusReason. |
false |
string |
|
kind |
The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
causes |
The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes. |
false |
v1.StatusCause array |
|
retryAfterSeconds |
If specified, the time in seconds before the operation should be retried. |
false |
integer (int32) |
v1.SupplementalGroupsStrategyOptions
SupplementalGroupsStrategyOptions defines the strategy type and options used to create the strategy.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
type |
Type is the strategy that will dictate what supplemental groups is used in the SecurityContext. |
false |
string |
|
ranges |
Ranges are the allowed ranges of supplemental groups. If you would like to force a single supplemental group then supply a single range with the same start and end. |
false |
v1.IDRange array |
v1.TCPSocketAction
TCPSocketAction describes an action based on opening a socket
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
port |
Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
true |
string |
v1.Taint
The node this Taint is attached to has the effect "effect" on any pod that that does not tolerate the Taint.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
key |
Required. The taint key to be applied to a node. |
true |
string |
|
value |
Required. The taint value corresponding to the taint key. |
false |
string |
|
effect |
Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute. |
true |
string |
|
timeAdded |
TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints. |
false |
string |
v1.Toleration
The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
key |
Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. |
false |
string |
|
operator |
Operator represents a key’s relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. |
false |
string |
|
value |
Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. |
false |
string |
|
effect |
Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. |
false |
string |
|
tolerationSeconds |
TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. |
false |
integer (int64) |
v1.Volume
Volume represents a named volume in a pod that may be accessed by any container in the pod.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
name |
Volume’s name. Must be a DNS_LABEL and unique within the pod. More info: http://kubernetes.io/docs/user-guide/identifiers#names |
true |
string |
|
hostPath |
HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: http://kubernetes.io/docs/user-guide/volumes#hostpath |
false |
||
emptyDir |
EmptyDir represents a temporary directory that shares a pod’s lifetime. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir |
false |
||
gcePersistentDisk |
GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://kubernetes.io/docs/user-guide/volumes#gcepersistentdisk |
false |
||
awsElasticBlockStore |
AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://kubernetes.io/docs/user-guide/volumes#awselasticblockstore |
false |
||
gitRepo |
GitRepo represents a git repository at a particular revision. |
false |
||
secret |
Secret represents a secret that should populate this volume. More info: http://kubernetes.io/docs/user-guide/volumes#secrets |
false |
||
nfs |
NFS represents an NFS mount on the host that shares a pod’s lifetime More info: http://kubernetes.io/docs/user-guide/volumes#nfs |
false |
||
iscsi |
ISCSI represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://releases.k8s.io/HEAD/examples/volumes/iscsi/README.md |
false |
||
glusterfs |
Glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md |
false |
||
persistentVolumeClaim |
PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#persistentvolumeclaims |
false |
||
rbd |
RBD represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md |
false |
||
flexVolume |
FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future. |
false |
||
cinder |
Cinder represents a cinder volume attached and mounted on kubelets host machine More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md |
false |
||
cephfs |
CephFS represents a Ceph FS mount on the host that shares a pod’s lifetime |
false |
||
flocker |
Flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running |
false |
||
downwardapi |
Downwardapi represents downward api about the pod that should populate this volume |
false |
||
fc |
FC represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod. |
false |
||
azureFile |
AzureFile represents an Azure File Service mount on the host and bind mount to the pod. |
false |
||
configMap |
ConfigMap represents a configMap that should populate this volume |
false |
||
vsphereVolume |
VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine |
false |
||
quobyte |
Quobyte represents a Quobyte mount on the host that shares a pod’s lifetime |
false |
||
azureDisk |
AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. |
false |
||
photonPersistentDisk |
PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine |
false |
||
projected |
Items for all in one resources secrets, configmaps, and downward api |
false |
||
portworxVolume |
PortworxVolume represents a portworx volume attached and mounted on kubelets host machine |
false |
||
scaleIO |
ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. |
false |
||
metadata |
Metadata represents metadata about the pod that should populate this volume Deprecated: Use downwardapi instead. |
false |
v1.VolumeMount
VolumeMount describes a mounting of a Volume within a container.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
name |
This must match the Name of a Volume. |
true |
string |
|
readOnly |
Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. |
false |
boolean |
|
mountPath |
Path within the container at which the volume should be mounted. Must not contain ':'. |
true |
string |
|
subPath |
Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root). |
false |
string |
v1.VolumeProjection
Projection that may be projected along with other supported volume types
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
secret |
information about the secret data to project |
false |
||
downwardapi |
information about the downwardapi data to project |
false |
||
configMap |
information about the configMap data to project |
false |
v1.VsphereVirtualDiskVolumeSource
Represents a vSphere volume resource.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
volumePath |
Path that identifies vSphere volume vmdk |
true |
string |
|
fsType |
Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. |
false |
string |
v1.WeightedPodAffinityTerm
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
weight |
weight associated with matching the corresponding podAffinityTerm, in the range 1-100. |
true |
integer (int32) |
|
podAffinityTerm |
Required. A pod affinity term, associated with the corresponding weight. |
true |
v1beta1.Eviction
Eviction evicts a pod from its node subject to certain policies and safety constraints. This is a subresource of Pod. A request to cause such an eviction is created by POSTing to …/pods/<pod name>/evictions.
| Name | Description | Required | Schema | Default |
|---|---|---|---|---|
kind |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
false |
string |
|
apiVersion |
apiVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
false |
string |
|
metadata |
ObjectMeta describes the pod that is being evicted. |
false |
||
deleteOptions |
DeleteOptions may be provided |
false |