openshift enterprise 3.1 rest api reference - red hat 536 536 812 982 982 982 table of contents 1....

Red Hat OpenShift DocumentationTeam

OpenShift Enterprise3.1REST API Reference

OpenShift Enterprise 3.1 REST API for Developers

OpenShift Enterprise 3.1 REST API Reference

OpenShift Enterprise 3.1 REST API for Developers

Legal Notice

Copyright © 2017 Red Hat, Inc.

The text of and illustrations in this document are licensed by Red Hat under a Creative CommonsAttribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA isavailable athttp://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you mustprovide the URL for the original version.

Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert,Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.

Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinitylogo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and othercountries.

Linux ® is the registered trademark of Linus Torvalds in the United States and other countries.

Java ® is a registered trademark of Oracle and/or its affiliates.

XFS ® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United Statesand/or other countries.

MySQL ® is a registered trademark of MySQL AB in the United States, the European Union andother countries.

Node.js ® is an official trademark of Joyent. Red Hat Software Collections is not formally related toor endorsed by the official Joyent Node.js open source or commercial project.

The OpenStack ® Word Mark and OpenStack logo are either registered trademarks/service marksor trademarks/service marks of the OpenStack Foundation, in the United States and other countriesand are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed orsponsored by the OpenStack Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.

AbstractThe OpenShift Enterprise 3.1 distribution of Kubernetes includes the Kubernetes v1 REST API andthe OpenShift v1 REST API. These are RESTful APIs accessible via HTTP(s) on the OpenShiftEnterprise master servers. These REST APIs can be used to manage end-user applications, thecluster, and the users of the cluster.

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Table of Contents

CHAPTER 1. OVERVIEW1.1. AUTHENTICATION1.2. EXAMPLES1.3. WEBSOCKETS AND WATCHING FOR CHANGES

CHAPTER 2. OPENSHIFT ENTERPRISE V1 REST API2.1. OVERVIEW2.2. PATHS2.3. DEFINITIONS

CHAPTER 3. KUBERNETES V1 REST API3.1. OVERVIEW3.2. PATHS3.3. DEFINITIONS

CHAPTER 4. REVISION HISTORY: REST API REFERENCE4.1. TUE OCT 04 20164.2. THU NOV 19 2015

3346

777

339

536536536812

982982982

Table of Contents

1


2

CHAPTER 1. OVERVIEW

The OpenShift Enterprise distribution of Kubernetes includes the Kubernetes v1 REST API and theOpenShift v1 REST API. These are RESTful APIs accessible via HTTP(s) on the OpenShiftEnterprise master servers.

These REST APIs can be used to manage end-user applications, the cluster, and the users of thecluster.

1.1. AUTHENTICATION

API calls must be authenticated with an access token or X.509 certificate. See Authentication in theArchitecture documentation for an overview.

This section highlights the token authentication method. With token authentication, a bearer tokenmust be passed in as an HTTP Authorization header. There are two types of access tokens: sessionand service account.

1.1.1. Session Tokens

A session token is short-lived, expiring within 24 hours by default. It represents a user. After loggingin, the session token may be obtained with the oc whoami command:

$ oc login -u test_userUsing project "test".$ oc whoami -tdIAo76N-W-GXK3S_w_KsC6DmH3MzP79zq7jbMQvCOUo

1.1.2. Service Account Tokens

Service account tokens are long-lived tokens. They are JSON Web Token (JWT) formatted tokensand are much longer strings than session tokens. See Using a Service Account’s CredentialsExternally for steps on using these tokens to authenticate using the CLI.

A service account token may be obtained with these commands:

1. Create a service account in the current project (test) named robot:

$ oc create serviceaccount robotserviceaccount "robot" created

2. Grant a role to the service account. In this example, assign the robot service account in thetest project the admin role:

$ oc policy add-role-to-user admin system:serviceaccounts:test:robot

3. Describe the service account to discover the secret token name:

$ oc describe serviceaccount robotName: robot

CHAPTER 1. OVERVIEW

3

https://access.redhat.com/documentation/en-us/openshift_enterprise/3.1/html-single/architecture/#api-authentication

https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.8

https://access.redhat.com/documentation/en-us/openshift_enterprise/3.1/html-single/architecture/#users-and-groups

https://tools.ietf.org/html/rfc7519

https://access.redhat.com/documentation/en-us/openshift_enterprise/3.1/html-single/developer_guide/#using-a-service-accounts-credentials-externally

Namespace: testLabels: <none>

Image pull secrets: robot-dockercfg-rdrpg

Mountable secrets: robot-token-2dsne robot-dockercfg-rdrpg

Tokens: robot-token-2dsne robot-token-9efwm

4. Describe the secret token to get the token value:

$ oc describe secret robot-token-2dsneName: robot-token-2dsneNamespace: testLabels: <none>Annotations: kubernetes.io/service-account.name=robot,kubernetes.io/service-account.uid=ea70e4c7-0663-11e6-b279-fa163e610e01

Type: kubernetes.io/service-account-token

Data===token: fyJhbGciOiJSUzI1NiIyInR5cCI2IkpXVCJ9...ca.crt: 1070 bytesnamespace: 8 bytes

The token value may be used as an in an authorization header to authenticate API calls, the CLI orin the docker login command. Service accounts may be created and deleted as needed with theappropriate role(s) assigned. See Authorization in the Architecture documentation for a deeperdiscussion on roles.

1.2. EXAMPLES

These examples are provided as a reference to provide quick success making REST API calls. Theyuse insecure methods. In these examples a simple GET call is made to list available resources.

1.2.1. cURL

Example 1.1. Request (Insecure)

$ curl -X GET -H "Authorization: Bearer <token>" https://openshift.redhat.com:8443/oapi/v1 --insecure

Example 1.2. Result (Truncated)

{


4

https://access.redhat.com/documentation/en-us/openshift_enterprise/3.1/html-single/developer_guide/#using-a-service-accounts-credentials-externally

https://access.redhat.com/documentation/en-us/openshift_enterprise/3.1/html-single/architecture/#roles

"kind": "APIResourceList", "groupVersion": "v1", "resources": [ { "name": "buildconfigs", "namespaced": true, "kind": "BuildConfig" }, { "name": "buildconfigs/instantiate", "namespaced": true, "kind": "BuildRequest" }, { "name": "buildconfigs/instantiatebinary", "namespaced": true, "kind": "BinaryBuildRequestOptions" }, { "name": "buildconfigs/webhooks", "namespaced": true, "kind": "Status" }, { "name": "builds", "namespaced": true, "kind": "Build" }, ... { "name": "subjectaccessreviews", "namespaced": true, "kind": "SubjectAccessReview" }, { "name": "templates", "namespaced": true, "kind": "Template" }, { "name": "useridentitymappings", "namespaced": false, "kind": "UserIdentityMapping" }, { "name": "users", "namespaced": false, "kind": "User" } ]}

1.2.2. Python

CHAPTER 1. OVERVIEW

5

Example 1.3. Interactive Python API Call Using "requests" Module (Insecure)

>>> import requests>>> url = 'https://openshift.redhat.com:8443/oapi/v1'>>> headers = {'Authorization': 'Bearer dIAo76N-W-GXK3S_w_KsC6DmH3MzP79zq7jbMQvCOUo'}>>> requests.get(url, headers=headers, verify=False)/usr/lib/python2.7/site-packages/requests/packages/urllib3/connectionpool.py:791: InsecureRequestWarning: Unverified HTTPS request is being made. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.org/en/latest/security.html InsecureRequestWarning)<Response [200]>

1.2.3. Docker Login

The OpenShift Enterprise integrated Docker registry must be authenticated using either a usersession or service account token. The value of the token must be used as the value for the --password argument. The user and email argument values are ignored:

$ docker login -p <token_value> -u unused -e unused <registry>[:<port>]

1.3. WEBSOCKETS AND WATCHING FOR CHANGES

The API is designed to work via the websocket protocol. API requests may take the form of "one-shot" calls to list resources or by passing in query parameter watch=true. When watching anendpoint, changes to the system may be observed through an open endpoint. Using callbacks,dynamic systems may be developed that integrate with the API.

For more information and examples, see the Mozilla Developer Network page on Writing WebSocketclient applications.


6

https://tools.ietf.org/html/rfc6455

https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API/Writing_WebSocket_client_applications

CHAPTER 2. OPENSHIFT ENTERPRISE V1 REST API

2.1. OVERVIEW

The OpenShift Enterprise API exposes operations for managing an enterprise Kubernetes cluster,including security and user management, application deployments, image and source builds,HTTP(s) routing, and project management.

2.1.1. Version information

Version: v1

2.1.2. URI scheme

Host: 127.0.0.1:8443 BasePath: / Schemes: HTTPS

2.2. PATHS

2.2.1. get available resources

GET /oapi/v1

2.2.1.1. Responses

HTTP Code Description Schema

default success string

2.2.1.2. Consumes

application/json

2.2.1.3. Produces

application/json

2.2.1.4. Tags

oapiv1

2.2.2. list or watch objects of kind BuildConfig

GET /oapi/v1/buildconfigs


7

2.2.2.1. Parameters

Type Name Description Required Schema Default

QueryParameter

pretty If 'true', thenthe output ispretty printed.

false string

QueryParameter

labelSelector A selector torestrict the listof returnedobjects bytheir labels.Defaults toeverything.

false string

QueryParameter

fieldSelector A selector torestrict the listof returnedobjects bytheir fields.Defaults toeverything.

false string

QueryParameter

watch Watch forchanges tothe describedresources andreturn them asa stream ofadd, update,and removenotifications.SpecifyresourceVersion.

false boolean


8

QueryParameter

resourceVersion

Whenspecified witha watch call,showschanges thatoccur afterthat particularversion of aresource.Defaults tochanges fromthe beginningof history.

false string


2.2.2.2. Responses


200 success Section 2.3.36,“v1.BuildConfigList”

2.2.2.3. Consumes

/

2.2.2.4. Produces

application/json

2.2.2.5. Tags

oapiv1

2.2.3. create a BuildConfig

POST /oapi/v1/buildconfigs

2.2.3.1. Parameters


9


QueryParameter


false string

BodyParameter

body

true Section 2.3.60,“v1.BuildConfig”

2.2.3.2. Responses


200 success Section 2.3.60, “v1.BuildConfig”

2.2.3.3. Consumes

/

2.2.3.4. Produces

application/json

2.2.3.5. Tags

oapiv1

2.2.4. list or watch objects of kind Build

GET /oapi/v1/builds

2.2.4.1. Parameters


QueryParameter


false string


10

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


2.2.4.2. Responses


11


200 success Section 2.3.102, “v1.BuildList”

2.2.4.3. Consumes

/

2.2.4.4. Produces

application/json

2.2.4.5. Tags

oapiv1

2.2.5. create a Build

POST /oapi/v1/builds

2.2.5.1. Parameters


QueryParameter


false string

BodyParameter

body

true Section 2.3.26, “v1.Build”

2.2.5.2. Responses


200 success Section 2.3.26, “v1.Build”

2.2.5.3. Consumes

/


12

2.2.5.4. Produces

application/json

2.2.5.5. Tags

oapiv1

2.2.6. list or watch objects of kind ClusterNetwork

GET /oapi/v1/clusternetworks

2.2.6.1. Parameters


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string


13

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


2.2.6.2. Responses


200 success Section 2.3.41,“v1.ClusterNetworkList”

2.2.6.3. Consumes

/

2.2.6.4. Produces

application/json

2.2.6.5. Tags

oapiv1


14

2.2.7. create a ClusterNetwork

POST /oapi/v1/clusternetworks

2.2.7.1. Parameters


QueryParameter


false string

BodyParameter

body

true Section 2.3.50,“v1.ClusterNetwork”

2.2.7.2. Responses


200 success Section 2.3.50,“v1.ClusterNetwork”

2.2.7.3. Consumes

/

2.2.7.4. Produces

application/json

2.2.7.5. Tags

oapiv1

2.2.8. read the specified ClusterNetwork

GET /oapi/v1/clusternetworks/{name}

2.2.8.1. Parameters


15


QueryParameter


false string

PathParameter

name name of theClusterNetwork

true string

2.2.8.2. Responses



2.2.8.3. Consumes

/

2.2.8.4. Produces

application/json

2.2.8.5. Tags

oapiv1

2.2.9. replace the specified ClusterNetwork

PUT /oapi/v1/clusternetworks/{name}

2.2.9.1. Parameters


QueryParameter


false string


16

BodyParameter

body

true Section 2.3.50,“v1.ClusterNetwork”

PathParameter


true string


2.2.9.2. Responses



2.2.9.3. Consumes

/

2.2.9.4. Produces

application/json

2.2.9.5. Tags

oapiv1

2.2.10. delete a ClusterNetwork

DELETE /oapi/v1/clusternetworks/{name}

2.2.10.1. Parameters


QueryParameter


false string


17

BodyParameter

body

true Section 2.3.24,“v1.DeleteOptions”

PathParameter


true string


2.2.10.2. Responses


200 success Section 2.3.35,“unversioned.Status”

2.2.10.3. Consumes

/

2.2.10.4. Produces

application/json

2.2.10.5. Tags

oapiv1

2.2.11. partially update the specified ClusterNetwork

PATCH /oapi/v1/clusternetworks/{name}



QueryParameter


false string


18

BodyParameter

body

true Section 2.3.43,“unversioned.Patch”

PathParameter


true string


2.2.11.2. Responses



2.2.11.3. Consumes

application/json-patch+json

application/merge-patch+json

application/strategic-merge-patch+json

2.2.11.4. Produces

application/json

2.2.11.5. Tags

oapiv1

2.2.12. list or watch objects of kind ClusterPolicy

GET /oapi/v1/clusterpolicies



19


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


20


2.2.12.2. Responses


200 success Section 2.3.147,“v1.ClusterPolicyList”

2.2.12.3. Consumes

/

2.2.12.4. Produces

application/json

2.2.12.5. Tags

oapiv1

2.2.13. create a ClusterPolicy

POST /oapi/v1/clusterpolicies



21


QueryParameter


false string

BodyParameter

body

true Section 2.3.82,“v1.ClusterPolicy”

2.2.13.2. Responses


200 success Section 2.3.82,“v1.ClusterPolicy”

2.2.13.3. Consumes

/

2.2.13.4. Produces

application/json

2.2.13.5. Tags

oapiv1

2.2.14. read the specified ClusterPolicy

GET /oapi/v1/clusterpolicies/{name}



QueryParameter


false string


22

PathParameter

name name of theClusterPolicy

true string


2.2.14.2. Responses



2.2.14.3. Consumes

/

2.2.14.4. Produces

application/json

2.2.14.5. Tags

oapiv1

2.2.15. replace the specified ClusterPolicy

PUT /oapi/v1/clusterpolicies/{name}



QueryParameter


false string

BodyParameter

body

true Section 2.3.82,“v1.ClusterPolicy”


23

PathParameter


true string


2.2.15.2. Responses



2.2.15.3. Consumes

/

2.2.15.4. Produces

application/json

2.2.15.5. Tags

oapiv1

2.2.16. delete a ClusterPolicy

DELETE /oapi/v1/clusterpolicies/{name}



QueryParameter


false string

BodyParameter

body



24

PathParameter


true string


2.2.16.2. Responses



2.2.16.3. Consumes

/

2.2.16.4. Produces

application/json

2.2.16.5. Tags

oapiv1

2.2.17. partially update the specified ClusterPolicy

PATCH /oapi/v1/clusterpolicies/{name}



QueryParameter


false string

BodyParameter

body



25

PathParameter


true string


2.2.17.2. Responses



2.2.17.3. Consumes




2.2.17.4. Produces

application/json

2.2.17.5. Tags

oapiv1

2.2.18. list or watch objects of kind ClusterPolicyBinding

GET /oapi/v1/clusterpolicybindings



QueryParameter


false string


26

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


2.2.18.2. Responses


27


200 success Section 2.3.121,“v1.ClusterPolicyBindingList”

2.2.18.3. Consumes

/

2.2.18.4. Produces

application/json

2.2.18.5. Tags

oapiv1

2.2.19. create a ClusterPolicyBinding

POST /oapi/v1/clusterpolicybindings



QueryParameter


false string

BodyParameter

body

true Section 2.3.12,“v1.ClusterPolicyBinding”

2.2.19.2. Responses


200 success Section 2.3.12,“v1.ClusterPolicyBinding”


28

2.2.19.3. Consumes

/

2.2.19.4. Produces

application/json

2.2.19.5. Tags

oapiv1

2.2.20. read the specified ClusterPolicyBinding

GET /oapi/v1/clusterpolicybindings/{name}



QueryParameter


false string

PathParameter

name name of theClusterPolicyBinding

true string

2.2.20.2. Responses



2.2.20.3. Consumes

/

2.2.20.4. Produces

application/json


29

2.2.20.5. Tags

oapiv1

2.2.21. replace the specified ClusterPolicyBinding

PUT /oapi/v1/clusterpolicybindings/{name}



QueryParameter


false string

BodyParameter

body

true Section 2.3.12,“v1.ClusterPolicyBinding”

PathParameter


true string

2.2.21.2. Responses



2.2.21.3. Consumes

/

2.2.21.4. Produces

application/json

2.2.21.5. Tags

oapiv1


30

2.2.22. delete a ClusterPolicyBinding

DELETE /oapi/v1/clusterpolicybindings/{name}



QueryParameter


false string

BodyParameter

body


PathParameter


true string

2.2.22.2. Responses



2.2.22.3. Consumes

/

2.2.22.4. Produces

application/json

2.2.22.5. Tags

oapiv1

2.2.23. partially update the specified ClusterPolicyBinding


31

PATCH /oapi/v1/clusterpolicybindings/{name}



QueryParameter


false string

BodyParameter

body


PathParameter


true string

2.2.23.2. Responses



2.2.23.3. Consumes




2.2.23.4. Produces

application/json

2.2.23.5. Tags

oapiv1

2.2.24. list objects of kind ClusterRoleBinding


32

GET /oapi/v1/clusterrolebindings



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


33

QueryParameter

resourceVersion


false string


2.2.24.2. Responses


200 success Section 2.3.136,“v1.ClusterRoleBindingList”

2.2.24.3. Consumes

/

2.2.24.4. Produces

application/json

2.2.24.5. Tags

oapiv1

2.2.25. create a ClusterRoleBinding

POST /oapi/v1/clusterrolebindings



34


QueryParameter


false string

BodyParameter

body

true Section 2.3.47,“v1.ClusterRoleBinding”

2.2.25.2. Responses


200 success Section 2.3.47,“v1.ClusterRoleBinding”

2.2.25.3. Consumes

/

2.2.25.4. Produces

application/json

2.2.25.5. Tags

oapiv1

2.2.26. read the specified ClusterRoleBinding

GET /oapi/v1/clusterrolebindings/{name}



QueryParameter


false string


35

PathParameter

name name of theClusterRoleBinding

true string


2.2.26.2. Responses



2.2.26.3. Consumes

/

2.2.26.4. Produces

application/json

2.2.26.5. Tags

oapiv1

2.2.27. replace the specified ClusterRoleBinding

PUT /oapi/v1/clusterrolebindings/{name}



QueryParameter


false string

BodyParameter

body



36

PathParameter


true string


2.2.27.2. Responses



2.2.27.3. Consumes

/

2.2.27.4. Produces

application/json

2.2.27.5. Tags

oapiv1

2.2.28. delete a ClusterRoleBinding

DELETE /oapi/v1/clusterrolebindings/{name}



QueryParameter


false string

BodyParameter

body



37

PathParameter


true string


2.2.28.2. Responses



2.2.28.3. Consumes

/

2.2.28.4. Produces

application/json

2.2.28.5. Tags

oapiv1

2.2.29. partially update the specified ClusterRoleBinding

PATCH /oapi/v1/clusterrolebindings/{name}



QueryParameter


false string

BodyParameter

body



38

PathParameter


true string


2.2.29.2. Responses



2.2.29.3. Consumes




2.2.29.4. Produces

application/json

2.2.29.5. Tags

oapiv1

2.2.30. list objects of kind ClusterRole

GET /oapi/v1/clusterroles



QueryParameter


false string


39

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


2.2.30.2. Responses


40


200 success Section 2.3.7,“v1.ClusterRoleList”

2.2.30.3. Consumes

/

2.2.30.4. Produces

application/json

2.2.30.5. Tags

oapiv1

2.2.31. create a ClusterRole

POST /oapi/v1/clusterroles



QueryParameter


false string

BodyParameter

body

true Section 2.3.153,“v1.ClusterRole”

2.2.31.2. Responses


200 success Section 2.3.153,“v1.ClusterRole”


41

2.2.31.3. Consumes

/

2.2.31.4. Produces

application/json

2.2.31.5. Tags

oapiv1

2.2.32. read the specified ClusterRole

GET /oapi/v1/clusterroles/{name}



QueryParameter


false string

PathParameter

name name of theClusterRole

true string

2.2.32.2. Responses



2.2.32.3. Consumes

/

2.2.32.4. Produces

application/json

2.2.32.5. Tags


42

oapiv1

2.2.33. replace the specified ClusterRole

PUT /oapi/v1/clusterroles/{name}



QueryParameter


false string

BodyParameter

body

true Section 2.3.153,“v1.ClusterRole”

PathParameter


true string

2.2.33.2. Responses



2.2.33.3. Consumes

/

2.2.33.4. Produces

application/json

2.2.33.5. Tags

oapiv1

2.2.34. delete a ClusterRole


43

DELETE /oapi/v1/clusterroles/{name}



QueryParameter


false string

BodyParameter

body


PathParameter


true string

2.2.34.2. Responses



2.2.34.3. Consumes

/

2.2.34.4. Produces

application/json

2.2.34.5. Tags

oapiv1

2.2.35. partially update the specified ClusterRole

PATCH /oapi/v1/clusterroles/{name}


44



QueryParameter


false string

BodyParameter

body


PathParameter


true string

2.2.35.2. Responses



2.2.35.3. Consumes




2.2.35.4. Produces

application/json

2.2.35.5. Tags

oapiv1

2.2.36. create a DeploymentConfigRollback

POST /oapi/v1/deploymentconfigrollbacks


45



QueryParameter


false string

BodyParameter

body

true Section 2.3.74,“v1.DeploymentConfigRollback”

2.2.36.2. Responses


200 success Section 2.3.74,“v1.DeploymentConfigRollback”

2.2.36.3. Consumes

/

2.2.36.4. Produces

application/json

2.2.36.5. Tags

oapiv1

2.2.37. list or watch objects of kind DeploymentConfig

GET /oapi/v1/deploymentconfigs



46


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


47

QueryParameter

resourceVersion


false string


2.2.37.2. Responses


200 success Section 2.3.55,“v1.DeploymentConfigList”

2.2.37.3. Consumes

/

2.2.37.4. Produces

application/json

2.2.37.5. Tags

oapiv1

2.2.38. create a DeploymentConfig

POST /oapi/v1/deploymentconfigs



48


QueryParameter


false string

BodyParameter

body

true Section 2.3.31,“v1.DeploymentConfig”

2.2.38.2. Responses


200 success Section 2.3.31,“v1.DeploymentConfig”

2.2.38.3. Consumes

/

2.2.38.4. Produces

application/json

2.2.38.5. Tags

oapiv1

2.2.39. list or watch objects of kind Group

GET /oapi/v1/groups



QueryParameter


false string


49

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


2.2.39.2. Responses


50


200 success Section 2.3.5, “v1.GroupList”

2.2.39.3. Consumes

/

2.2.39.4. Produces

application/json

2.2.39.5. Tags

oapiv1

2.2.40. create a Group

POST /oapi/v1/groups



QueryParameter


false string

BodyParameter

body

true Section 2.3.56, “v1.Group”

2.2.40.2. Responses


200 success Section 2.3.56, “v1.Group”

2.2.40.3. Consumes

/


51

2.2.40.4. Produces

application/json

2.2.40.5. Tags

oapiv1

2.2.41. read the specified Group

GET /oapi/v1/groups/{name}



QueryParameter


false string

PathParameter

name name of theGroup

true string

2.2.41.2. Responses



2.2.41.3. Consumes

/

2.2.41.4. Produces

application/json

2.2.41.5. Tags

oapiv1

2.2.42. replace the specified Group


52

PUT /oapi/v1/groups/{name}



QueryParameter


false string

BodyParameter

body

true Section 2.3.56, “v1.Group”

PathParameter


true string

2.2.42.2. Responses



2.2.42.3. Consumes

/

2.2.42.4. Produces

application/json

2.2.42.5. Tags

oapiv1

2.2.43. delete a Group

DELETE /oapi/v1/groups/{name}



53


QueryParameter


false string

BodyParameter

body


PathParameter


true string

2.2.43.2. Responses



2.2.43.3. Consumes

/

2.2.43.4. Produces

application/json

2.2.43.5. Tags

oapiv1

2.2.44. partially update the specified Group

PATCH /oapi/v1/groups/{name}



54


QueryParameter


false string

BodyParameter

body


PathParameter


true string

2.2.44.2. Responses



2.2.44.3. Consumes




2.2.44.4. Produces

application/json

2.2.44.5. Tags

oapiv1

2.2.45. list or watch objects of kind HostSubnet

GET /oapi/v1/hostsubnets



55


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


56

2.2.45.2. Responses


200 success Section 2.3.4,“v1.HostSubnetList”

2.2.45.3. Consumes

/

2.2.45.4. Produces

application/json

2.2.45.5. Tags

oapiv1

2.2.46. create a HostSubnet

POST /oapi/v1/hostsubnets



QueryParameter


false string

BodyParameter

body

true Section 2.3.11,“v1.HostSubnet”

2.2.46.2. Responses


200 success Section 2.3.11, “v1.HostSubnet”


57


2.2.46.3. Consumes

/

2.2.46.4. Produces

application/json

2.2.46.5. Tags

oapiv1

2.2.47. read the specified HostSubnet

GET /oapi/v1/hostsubnets/{name}



QueryParameter


false string

PathParameter

name name of theHostSubnet

true string

2.2.47.2. Responses



2.2.47.3. Consumes

/


58

2.2.47.4. Produces

application/json

2.2.47.5. Tags

oapiv1

2.2.48. replace the specified HostSubnet

PUT /oapi/v1/hostsubnets/{name}



QueryParameter


false string

BodyParameter

body

true Section 2.3.11,“v1.HostSubnet”

PathParameter


true string

2.2.48.2. Responses



2.2.48.3. Consumes

/

2.2.48.4. Produces

application/json


59

2.2.48.5. Tags

oapiv1

2.2.49. delete a HostSubnet

DELETE /oapi/v1/hostsubnets/{name}



QueryParameter


false string

BodyParameter

body


PathParameter


true string

2.2.49.2. Responses



2.2.49.3. Consumes

/

2.2.49.4. Produces

application/json

2.2.49.5. Tags

oapiv1


60

2.2.50. partially update the specified HostSubnet

PATCH /oapi/v1/hostsubnets/{name}



QueryParameter


false string

BodyParameter

body


PathParameter


true string

2.2.50.2. Responses



2.2.50.3. Consumes




2.2.50.4. Produces

application/json

2.2.50.5. Tags

oapiv1

2.2.51. list or watch objects of kind Identity


61

GET /oapi/v1/identities



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


62

QueryParameter

resourceVersion


false string


2.2.51.2. Responses


200 success Section 2.3.97, “v1.IdentityList”

2.2.51.3. Consumes

/

2.2.51.4. Produces

application/json

2.2.51.5. Tags

oapiv1

2.2.52. create a Identity

POST /oapi/v1/identities



63


QueryParameter


false string

BodyParameter

body

true Section 2.3.77, “v1.Identity”

2.2.52.2. Responses


200 success Section 2.3.77, “v1.Identity”

2.2.52.3. Consumes

/

2.2.52.4. Produces

application/json

2.2.52.5. Tags

oapiv1

2.2.53. read the specified Identity

GET /oapi/v1/identities/{name}



QueryParameter


false string


64

PathParameter

name name of theIdentity

true string


2.2.53.2. Responses



2.2.53.3. Consumes

/

2.2.53.4. Produces

application/json

2.2.53.5. Tags

oapiv1

2.2.54. replace the specified Identity

PUT /oapi/v1/identities/{name}



QueryParameter


false string

BodyParameter

body

true Section 2.3.77, “v1.Identity”

PathParameter


true string


65

2.2.54.2. Responses



2.2.54.3. Consumes

/

2.2.54.4. Produces

application/json

2.2.54.5. Tags

oapiv1

2.2.55. delete a Identity

DELETE /oapi/v1/identities/{name}



QueryParameter


false string

BodyParameter

body


PathParameter


true string

2.2.55.2. Responses


66



2.2.55.3. Consumes

/

2.2.55.4. Produces

application/json

2.2.55.5. Tags

oapiv1

2.2.56. partially update the specified Identity

PATCH /oapi/v1/identities/{name}



QueryParameter


false string

BodyParameter

body


PathParameter


true string

2.2.56.2. Responses


67



2.2.56.3. Consumes




2.2.56.4. Produces

application/json

2.2.56.5. Tags

oapiv1

2.2.57. list or watch objects of kind Image

GET /oapi/v1/images



QueryParameter


false string

QueryParameter


false string


68

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


2.2.57.2. Responses


200 success Section 2.3.42, “v1.ImageList”

2.2.57.3. Consumes

/


69

2.2.57.4. Produces

application/json

2.2.57.5. Tags

oapiv1

2.2.58. create a Image

POST /oapi/v1/images



QueryParameter


false string

BodyParameter

body

true Section 2.3.99, “v1.Image”

2.2.58.2. Responses


200 success Section 2.3.99, “v1.Image”

2.2.58.3. Consumes

/

2.2.58.4. Produces

application/json

2.2.58.5. Tags

oapiv1

2.2.59. read the specified Image


70

GET /oapi/v1/images/{name}



QueryParameter


false string

PathParameter

name name of theImage

true string

2.2.59.2. Responses



2.2.59.3. Consumes

/

2.2.59.4. Produces

application/json

2.2.59.5. Tags

oapiv1

2.2.60. replace the specified Image

PUT /oapi/v1/images/{name}



71


QueryParameter


false string

BodyParameter

body

true Section 2.3.99, “v1.Image”

PathParameter


true string

2.2.60.2. Responses



2.2.60.3. Consumes

/

2.2.60.4. Produces

application/json

2.2.60.5. Tags

oapiv1

2.2.61. delete a Image

DELETE /oapi/v1/images/{name}




72

QueryParameter


false string

BodyParameter

body


PathParameter


true string


2.2.61.2. Responses



2.2.61.3. Consumes

/

2.2.61.4. Produces

application/json

2.2.61.5. Tags

oapiv1

2.2.62. partially update the specified Image

PATCH /oapi/v1/images/{name}



73


QueryParameter


false string

BodyParameter

body


PathParameter


true string

2.2.62.2. Responses



2.2.62.3. Consumes




2.2.62.4. Produces

application/json

2.2.62.5. Tags

oapiv1

2.2.63. create a ImageStreamMapping

POST /oapi/v1/imagestreammappings



74


QueryParameter


false string

BodyParameter

body

true Section 2.3.144,“v1.ImageStreamMapping”

2.2.63.2. Responses


200 success Section 2.3.144,“v1.ImageStreamMapping”

2.2.63.3. Consumes

/

2.2.63.4. Produces

application/json

2.2.63.5. Tags

oapiv1

2.2.64. list or watch objects of kind ImageStream

GET /oapi/v1/imagestreams



QueryParameter


false string


75

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


2.2.64.2. Responses


76


200 success Section 2.3.94,“v1.ImageStreamList”

2.2.64.3. Consumes

/

2.2.64.4. Produces

application/json

2.2.64.5. Tags

oapiv1

2.2.65. create a ImageStream

POST /oapi/v1/imagestreams



QueryParameter


false string

BodyParameter

body

true Section 2.3.155,“v1.ImageStream”

2.2.65.2. Responses


200 success Section 2.3.155,“v1.ImageStream”


77

2.2.65.3. Consumes

/

2.2.65.4. Produces

application/json

2.2.65.5. Tags

oapiv1

2.2.66. list objects of kind ImageStreamTag

GET /oapi/v1/imagestreamtags



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string


78

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


2.2.66.2. Responses


200 success Section 2.3.17,“v1.ImageStreamTagList”

2.2.66.3. Consumes

/

2.2.66.4. Produces

application/json

2.2.66.5. Tags


79

oapiv1

2.2.67. create a LocalResourceAccessReview

POST /oapi/v1/localresourceaccessreviews



QueryParameter


false string

BodyParameter

body

true Section 2.3.148,“v1.LocalResourceAccessReview”

2.2.67.2. Responses


200 success Section 2.3.148,“v1.LocalResourceAccessReview”

2.2.67.3. Consumes

/

2.2.67.4. Produces

application/json

2.2.67.5. Tags

oapiv1

2.2.68. create a LocalSubjectAccessReview

POST /oapi/v1/localsubjectaccessreviews


80



QueryParameter


false string

BodyParameter

body

true Section 2.3.23,“v1.LocalSubjectAccessReview”

2.2.68.2. Responses


200 success Section 2.3.23,“v1.LocalSubjectAccessReview”

2.2.68.3. Consumes

/

2.2.68.4. Produces

application/json

2.2.68.5. Tags

oapiv1

2.2.69. list or watch objects of kind BuildConfig

GET /oapi/v1/namespaces/{namespace}/buildconfigs



81


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


82

QueryParameter

resourceVersion


false string

PathParameter

namespace object nameand authscope, suchas for teamsand projects

true string


2.2.69.2. Responses


200 success Section 2.3.36,“v1.BuildConfigList”

2.2.69.3. Consumes

/

2.2.69.4. Produces

application/json

2.2.69.5. Tags

oapiv1

2.2.70. create a BuildConfig

POST /oapi/v1/namespaces/{namespace}/buildconfigs


83



QueryParameter


false string

BodyParameter

body


PathParameter


true string

2.2.70.2. Responses



2.2.70.3. Consumes

/

2.2.70.4. Produces

application/json

2.2.70.5. Tags

oapiv1

2.2.71. read the specified BuildConfig

GET /oapi/v1/namespaces/{namespace}/buildconfigs/{name}



84


QueryParameter


false string

PathParameter


true string

PathParameter

name name of theBuildConfig

true string

2.2.71.2. Responses



2.2.71.3. Consumes

/

2.2.71.4. Produces

application/json

2.2.71.5. Tags

oapiv1

2.2.72. replace the specified BuildConfig

PUT /oapi/v1/namespaces/{namespace}/buildconfigs/{name}



85


QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string

2.2.72.2. Responses



2.2.72.3. Consumes

/

2.2.72.4. Produces

application/json

2.2.72.5. Tags

oapiv1

2.2.73. delete a BuildConfig

DELETE /oapi/v1/namespaces/{namespace}/buildconfigs/{name}


86



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string

2.2.73.2. Responses



2.2.73.3. Consumes

/

2.2.73.4. Produces

application/json

2.2.73.5. Tags

oapiv1

2.2.74. partially update the specified BuildConfig


87

PATCH /oapi/v1/namespaces/{namespace}/buildconfigs/{name}



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string

2.2.74.2. Responses



2.2.74.3. Consumes




2.2.74.4. Produces

application/json

2.2.74.5. Tags


88

2.2.74.5. Tags

oapiv1

2.2.75. create instantiate of a BuildRequest

POST /oapi/v1/namespaces/{namespace}/buildconfigs/{name}/instantiate



QueryParameter


false string

BodyParameter

body

true Section 2.3.14,“v1.BuildRequest”

PathParameter


true string

PathParameter

name name of theBuildRequest

true string

2.2.75.2. Responses


200 success Section 2.3.14,“v1.BuildRequest”

2.2.75.3. Consumes

/

2.2.75.4. Produces


89

application/json

2.2.75.5. Tags

oapiv1

2.2.76. connect POST requests to instantiatebinary ofBinaryBuildRequestOptions

POST /oapi/v1/namespaces/{namespace}/buildconfigs/{name}/instantiatebinary



QueryParameter

asFile

false string

QueryParameter

revision.commit

false string

QueryParameter

revision.message

false string

QueryParameter

revision.authorName

false string

QueryParameter

revision.authorEmail

false string

QueryParameter

revision.committerName

false string

QueryParameter

revision.committerEmail

false string


90

PathParameter


true string

PathParameter

name name of theBinaryBuildRequestOptions

true string


2.2.76.2. Responses



2.2.76.3. Consumes

/

2.2.76.4. Produces

/

2.2.76.5. Tags

oapiv1

2.2.77. connect POST requests to webhooks of Status

POST /oapi/v1/namespaces/{namespace}/buildconfigs/{name}/webhooks




91

QueryParameter

path Path is theURL path touse for thecurrent proxyrequest topod.

false string

PathParameter


true string

PathParameter

name name of theStatus

true string


2.2.77.2. Responses



2.2.77.3. Consumes

/

2.2.77.4. Produces

/

2.2.77.5. Tags

oapiv1

2.2.78. connect POST requests to webhooks of Status

POST /oapi/v1/namespaces/{namespace}/buildconfigs/{name}/webhooks/{path:*}



92


QueryParameter


false string

PathParameter


true string

PathParameter

name name of theStatus

true string

PathParameter

path path to theresource

true string

2.2.78.2. Responses



2.2.78.3. Consumes

/

2.2.78.4. Produces

/

2.2.78.5. Tags

oapiv1

2.2.79. list or watch objects of kind Build

GET /oapi/v1/namespaces/{namespace}/builds


93



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


94

QueryParameter

resourceVersion


false string

PathParameter


true string


2.2.79.2. Responses


200 success Section 2.3.102, “v1.BuildList”

2.2.79.3. Consumes

/

2.2.79.4. Produces

application/json

2.2.79.5. Tags

oapiv1

2.2.80. create a Build


95

POST /oapi/v1/namespaces/{namespace}/builds



QueryParameter


false string

BodyParameter

body


PathParameter


true string

2.2.80.2. Responses



2.2.80.3. Consumes

/

2.2.80.4. Produces

application/json

2.2.80.5. Tags

oapiv1

2.2.81. read the specified Build

GET /oapi/v1/namespaces/{namespace}/builds/{name}


96



QueryParameter


false string

PathParameter


true string

PathParameter

name name of theBuild

true string

2.2.81.2. Responses



2.2.81.3. Consumes

/

2.2.81.4. Produces

application/json

2.2.81.5. Tags

oapiv1

2.2.82. replace the specified Build

PUT /oapi/v1/namespaces/{namespace}/builds/{name}



97


QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string

2.2.82.2. Responses



2.2.82.3. Consumes

/

2.2.82.4. Produces

application/json

2.2.82.5. Tags

oapiv1

2.2.83. delete a Build

DELETE /oapi/v1/namespaces/{namespace}/builds/{name}



98


QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string

2.2.83.2. Responses



2.2.83.3. Consumes

/

2.2.83.4. Produces

application/json

2.2.83.5. Tags

oapiv1

2.2.84. partially update the specified Build

PATCH /oapi/v1/namespaces/{namespace}/builds/{name}


99



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string

2.2.84.2. Responses



2.2.84.3. Consumes




2.2.84.4. Produces

application/json

2.2.84.5. Tags

oapiv1


100

2.2.85. create clone of a BuildRequest

POST /oapi/v1/namespaces/{namespace}/builds/{name}/clone



QueryParameter


false string

BodyParameter

body

true Section 2.3.14,“v1.BuildRequest”

PathParameter


true string

PathParameter

name name of theBuildRequest

true string

2.2.85.2. Responses


200 success Section 2.3.14,“v1.BuildRequest”

2.2.85.3. Consumes

/

2.2.85.4. Produces

application/json

2.2.85.5. Tags


101

2.2.85.5. Tags

oapiv1

2.2.86. read log of the specified BuildLog

GET /oapi/v1/namespaces/{namespace}/builds/{name}/log



QueryParameter


false string

QueryParameter

container

false string

QueryParameter

follow

false boolean

QueryParameter

previous

false boolean

QueryParameter

sinceSeconds

false ref

QueryParameter

sinceTime

false string

QueryParameter

timestamps

false boolean

QueryParameter

tailLines

false ref

QueryParameter

limitBytes

false ref


102

QueryParameter

nowait

false boolean

PathParameter


true string

PathParameter

name name of theBuildLog

true string


2.2.86.2. Responses


200 success Section 2.3.73, “v1.BuildLog”

2.2.86.3. Consumes

/

2.2.86.4. Produces

application/json

2.2.86.5. Tags

oapiv1

2.2.87. create a DeploymentConfigRollback

POST /oapi/v1/namespaces/{namespace}/deploymentconfigrollbacks



103


QueryParameter


false string

BodyParameter

body

true Section 2.3.74,“v1.DeploymentConfigRollback”

PathParameter


true string

2.2.87.2. Responses


200 success Section 2.3.74,“v1.DeploymentConfigRollback”

2.2.87.3. Consumes

/

2.2.87.4. Produces

application/json

2.2.87.5. Tags

oapiv1

2.2.88. list or watch objects of kind DeploymentConfig

GET /oapi/v1/namespaces/{namespace}/deploymentconfigs



104


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


105

PathParameter


true string


2.2.88.2. Responses


200 success Section 2.3.55,“v1.DeploymentConfigList”

2.2.88.3. Consumes

/

2.2.88.4. Produces

application/json

2.2.88.5. Tags

oapiv1

2.2.89. create a DeploymentConfig

POST /oapi/v1/namespaces/{namespace}/deploymentconfigs


106



QueryParameter


false string

BodyParameter

body


PathParameter


true string

2.2.89.2. Responses



2.2.89.3. Consumes

/

2.2.89.4. Produces

application/json

2.2.89.5. Tags

oapiv1

2.2.90. read the specified DeploymentConfig

GET /oapi/v1/namespaces/{namespace}/deploymentconfigs/{name}


107



QueryParameter


false string

PathParameter


true string

PathParameter

name name of theDeploymentConfig

true string

2.2.90.2. Responses



2.2.90.3. Consumes

/

2.2.90.4. Produces

application/json

2.2.90.5. Tags

oapiv1

2.2.91. replace the specified DeploymentConfig

PUT /oapi/v1/namespaces/{namespace}/deploymentconfigs/{name}



108


QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string

2.2.91.2. Responses



2.2.91.3. Consumes

/

2.2.91.4. Produces

application/json

2.2.91.5. Tags

oapiv1

2.2.92. delete a DeploymentConfig

DELETE /oapi/v1/namespaces/{namespace}/deploymentconfigs/{name}


109



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string

2.2.92.2. Responses



2.2.92.3. Consumes

/

2.2.92.4. Produces

application/json

2.2.92.5. Tags

oapiv1


110

2.2.93. partially update the specified DeploymentConfig

PATCH /oapi/v1/namespaces/{namespace}/deploymentconfigs/{name}



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string

2.2.93.2. Responses



2.2.93.3. Consumes




2.2.93.4. Produces


111

2.2.93.4. Produces

application/json

2.2.93.5. Tags

oapiv1

2.2.94. read log of the specified DeploymentLog

GET /oapi/v1/namespaces/{namespace}/deploymentconfigs/{name}/log



QueryParameter


false string

QueryParameter

container

false string

QueryParameter

follow

false boolean

QueryParameter

previous

false boolean

QueryParameter

sinceSeconds

false ref

QueryParameter

sinceTime

false string

QueryParameter

timestamps

false boolean

QueryParameter

tailLines

false ref


112

QueryParameter

limitBytes

false ref

QueryParameter

nowait

false boolean

QueryParameter

version

false ref

PathParameter


true string

PathParameter

name name of theDeploymentLog

true string


2.2.94.2. Responses


200 success Section 2.3.33,“v1.DeploymentLog”

2.2.94.3. Consumes

/

2.2.94.4. Produces

application/json

2.2.94.5. Tags

oapiv1



113


GET /oapi/v1/namespaces/{namespace}/generatedeploymentconfigs/{name}



QueryParameter


false string

PathParameter


true string

PathParameter


true string

2.2.95.2. Responses



2.2.95.3. Consumes

/

2.2.95.4. Produces

application/json

2.2.95.5. Tags

oapiv1

2.2.96. read the specified ImageStreamImage


114

GET /oapi/v1/namespaces/{namespace}/imagestreamimages/{name}



QueryParameter


false string

PathParameter


true string

PathParameter

name name of theImageStreamImage

true string

2.2.96.2. Responses


200 success Section 2.3.100,“v1.ImageStreamImage”

2.2.96.3. Consumes

/

2.2.96.4. Produces

application/json

2.2.96.5. Tags

oapiv1

2.2.97. create a ImageStreamMapping

POST /oapi/v1/namespaces/{namespace}/imagestreammappings


115



QueryParameter


false string

BodyParameter

body

true Section 2.3.144,“v1.ImageStreamMapping”

PathParameter


true string

2.2.97.2. Responses


200 success Section 2.3.144,“v1.ImageStreamMapping”

2.2.97.3. Consumes

/

2.2.97.4. Produces

application/json

2.2.97.5. Tags

oapiv1

2.2.98. list or watch objects of kind ImageStream

GET /oapi/v1/namespaces/{namespace}/imagestreams


116



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


117

QueryParameter

resourceVersion


false string

PathParameter


true string


2.2.98.2. Responses


200 success Section 2.3.94,“v1.ImageStreamList”

2.2.98.3. Consumes

/

2.2.98.4. Produces

application/json

2.2.98.5. Tags

oapiv1

2.2.99. create a ImageStream

POST /oapi/v1/namespaces/{namespace}/imagestreams


118



QueryParameter


false string

BodyParameter

body


PathParameter


true string

2.2.99.2. Responses



2.2.99.3. Consumes

/

2.2.99.4. Produces

application/json

2.2.99.5. Tags

oapiv1

2.2.100. read the specified ImageStream

GET /oapi/v1/namespaces/{namespace}/imagestreams/{name}


119



QueryParameter


false string

PathParameter


true string

PathParameter

name name of theImageStream

true string

2.2.100.2. Responses



2.2.100.3. Consumes

/

2.2.100.4. Produces

application/json

2.2.100.5. Tags

oapiv1

2.2.101. replace the specified ImageStream

PUT /oapi/v1/namespaces/{namespace}/imagestreams/{name}



120


QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string




2.2.101.3. Consumes

/

2.2.101.4. Produces

application/json

2.2.101.5. Tags

oapiv1

2.2.102. delete a ImageStream

DELETE /oapi/v1/namespaces/{namespace}/imagestreams/{name}


121



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string




2.2.102.3. Consumes

/

2.2.102.4. Produces

application/json

2.2.102.5. Tags

oapiv1

2.2.103. partially update the specified ImageStream


122

PATCH /oapi/v1/namespaces/{namespace}/imagestreams/{name}



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string




2.2.103.3. Consumes




2.2.103.4. Produces

application/json


123

2.2.103.5. Tags

oapiv1

2.2.104. replace status of the specified ImageStream

PUT /oapi/v1/namespaces/{namespace}/imagestreams/{name}/status



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string




2.2.104.3. Consumes

/


124

2.2.104.4. Produces

application/json

2.2.104.5. Tags

oapiv1

2.2.105. list objects of kind ImageStreamTag

GET /oapi/v1/namespaces/{namespace}/imagestreamtags



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string


125

QueryParameter


false boolean

QueryParameter

resourceVersion


false string

PathParameter


true string




200 success Section 2.3.17,“v1.ImageStreamTagList”

2.2.105.3. Consumes

/


126

2.2.105.4. Produces

application/json

2.2.105.5. Tags

oapiv1

2.2.106. read the specified ImageStreamTag

GET /oapi/v1/namespaces/{namespace}/imagestreamtags/{name}



QueryParameter


false string

PathParameter


true string

PathParameter

name name of theImageStreamTag

true string



200 success Section 2.3.52,“v1.ImageStreamTag”

2.2.106.3. Consumes

/

2.2.106.4. Produces


127

application/json

2.2.106.5. Tags

oapiv1

2.2.107. replace the specified ImageStreamTag

PUT /oapi/v1/namespaces/{namespace}/imagestreamtags/{name}



QueryParameter


false string

BodyParameter

body

true Section 2.3.52,“v1.ImageStreamTag”

PathParameter


true string

PathParameter


true string




2.2.107.3. Consumes


128

/

2.2.107.4. Produces

application/json

2.2.107.5. Tags

oapiv1

2.2.108. delete a ImageStreamTag

DELETE /oapi/v1/namespaces/{namespace}/imagestreamtags/{name}



QueryParameter


false string

PathParameter


true string

PathParameter


true string




2.2.108.3. Consumes

/


129

2.2.108.4. Produces

application/json

2.2.108.5. Tags

oapiv1

2.2.109. partially update the specified ImageStreamTag

PATCH /oapi/v1/namespaces/{namespace}/imagestreamtags/{name}



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string





130

2.2.109.3. Consumes




2.2.109.4. Produces

application/json

2.2.109.5. Tags

oapiv1

2.2.110. create a LocalResourceAccessReview

POST /oapi/v1/namespaces/{namespace}/localresourceaccessreviews



QueryParameter


false string

BodyParameter

body

true Section 2.3.148,“v1.LocalResourceAccessReview”

PathParameter


true string



131


200 success Section 2.3.148,“v1.LocalResourceAccessReview”

2.2.110.3. Consumes

/

2.2.110.4. Produces

application/json

2.2.110.5. Tags

oapiv1

2.2.111. create a LocalSubjectAccessReview

POST /oapi/v1/namespaces/{namespace}/localsubjectaccessreviews



QueryParameter


false string

BodyParameter

body

true Section 2.3.23,“v1.LocalSubjectAccessReview”

PathParameter


true string


132



200 success Section 2.3.23,“v1.LocalSubjectAccessReview”

2.2.111.3. Consumes

/

2.2.111.4. Produces

application/json

2.2.111.5. Tags

oapiv1

2.2.112. list or watch objects of kind Policy

GET /oapi/v1/namespaces/{namespace}/policies



QueryParameter


false string

QueryParameter


false string


133

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string

PathParameter


true string




134


200 success Section 2.3.22, “v1.PolicyList”

2.2.112.3. Consumes

/

2.2.112.4. Produces

application/json

2.2.112.5. Tags

oapiv1

2.2.113. create a Policy

POST /oapi/v1/namespaces/{namespace}/policies



QueryParameter


false string

BodyParameter

body

true Section 2.3.160, “v1.Policy”

PathParameter


true string



135


200 success Section 2.3.160, “v1.Policy”

2.2.113.3. Consumes

/

2.2.113.4. Produces

application/json

2.2.113.5. Tags

oapiv1

2.2.114. read the specified Policy

GET /oapi/v1/namespaces/{namespace}/policies/{name}



QueryParameter


false string

PathParameter


true string

PathParameter

name name of thePolicy

true string



136



2.2.114.3. Consumes

/

2.2.114.4. Produces

application/json

2.2.114.5. Tags

oapiv1

2.2.115. replace the specified Policy

PUT /oapi/v1/namespaces/{namespace}/policies/{name}



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string



137



2.2.115.3. Consumes

/

2.2.115.4. Produces

application/json

2.2.115.5. Tags

oapiv1

2.2.116. delete a Policy

DELETE /oapi/v1/namespaces/{namespace}/policies/{name}



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string


138




2.2.116.3. Consumes

/

2.2.116.4. Produces

application/json

2.2.116.5. Tags

oapiv1

2.2.117. partially update the specified Policy

PATCH /oapi/v1/namespaces/{namespace}/policies/{name}



QueryParameter


false string

BodyParameter

body


PathParameter


true string


139

PathParameter


true string





2.2.117.3. Consumes




2.2.117.4. Produces

application/json

2.2.117.5. Tags

oapiv1

2.2.118. list or watch objects of kind PolicyBinding

GET /oapi/v1/namespaces/{namespace}/policybindings



QueryParameter


false string


140

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string



141

PathParameter


true string




200 success Section 2.3.6,“v1.PolicyBindingList”

2.2.118.3. Consumes

/

2.2.118.4. Produces

application/json

2.2.118.5. Tags

oapiv1

2.2.119. create a PolicyBinding

POST /oapi/v1/namespaces/{namespace}/policybindings



QueryParameter


false string


142

BodyParameter

body

true Section 2.3.161,“v1.PolicyBinding”

PathParameter


true string




200 success Section 2.3.161,“v1.PolicyBinding”

2.2.119.3. Consumes

/

2.2.119.4. Produces

application/json

2.2.119.5. Tags

oapiv1

2.2.120. read the specified PolicyBinding

GET /oapi/v1/namespaces/{namespace}/policybindings/{name}



143


QueryParameter


false string

PathParameter


true string

PathParameter

name name of thePolicyBinding

true string




2.2.120.3. Consumes

/

2.2.120.4. Produces

application/json

2.2.120.5. Tags

oapiv1

2.2.121. replace the specified PolicyBinding

PUT /oapi/v1/namespaces/{namespace}/policybindings/{name}



144


QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string




2.2.121.3. Consumes

/

2.2.121.4. Produces

application/json

2.2.121.5. Tags

oapiv1

2.2.122. delete a PolicyBinding

DELETE /oapi/v1/namespaces/{namespace}/policybindings/{name}


145



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string




2.2.122.3. Consumes

/

2.2.122.4. Produces

application/json

2.2.122.5. Tags

oapiv1

2.2.123. partially update the specified PolicyBinding


146

PATCH /oapi/v1/namespaces/{namespace}/policybindings/{name}



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string




2.2.123.3. Consumes




2.2.123.4. Produces

application/json


147

2.2.123.5. Tags

oapiv1

2.2.124. create a Template

POST /oapi/v1/namespaces/{namespace}/processedtemplates



QueryParameter


false string

BodyParameter

body

true Section 2.3.79,“v1.Template”

PathParameter


true string



200 success Section 2.3.79, “v1.Template”

2.2.124.3. Consumes

/

2.2.124.4. Produces

application/json

2.2.124.5. Tags

oapiv1


148

2.2.125. create a ResourceAccessReview

POST /oapi/v1/namespaces/{namespace}/resourceaccessreviews



QueryParameter


false string

BodyParameter

body

true Section 2.3.167,“v1.ResourceAccessReview”

PathParameter


true string



200 success Section 2.3.167,“v1.ResourceAccessReview”

2.2.125.3. Consumes

/

2.2.125.4. Produces

application/json

2.2.125.5. Tags


149

oapiv1

2.2.126. list objects of kind RoleBinding

GET /oapi/v1/namespaces/{namespace}/rolebindings



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


150

QueryParameter

resourceVersion


false string

PathParameter


true string




200 success Section 2.3.163,“v1.RoleBindingList”

2.2.126.3. Consumes

/

2.2.126.4. Produces

application/json

2.2.126.5. Tags

oapiv1

2.2.127. create a RoleBinding

POST /oapi/v1/namespaces/{namespace}/rolebindings


151



QueryParameter


false string

BodyParameter

body

true Section 2.3.142,“v1.RoleBinding”

PathParameter


true string



200 success Section 2.3.142,“v1.RoleBinding”

2.2.127.3. Consumes

/

2.2.127.4. Produces

application/json

2.2.127.5. Tags

oapiv1

2.2.128. read the specified RoleBinding

GET /oapi/v1/namespaces/{namespace}/rolebindings/{name}


152



QueryParameter


false string

PathParameter


true string

PathParameter

name name of theRoleBinding

true string




2.2.128.3. Consumes

/

2.2.128.4. Produces

application/json

2.2.128.5. Tags

oapiv1

2.2.129. replace the specified RoleBinding

PUT /oapi/v1/namespaces/{namespace}/rolebindings/{name}



153


QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string




2.2.129.3. Consumes

/

2.2.129.4. Produces

application/json

2.2.129.5. Tags

oapiv1

2.2.130. delete a RoleBinding

DELETE /oapi/v1/namespaces/{namespace}/rolebindings/{name}


154



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string




2.2.130.3. Consumes

/

2.2.130.4. Produces

application/json

2.2.130.5. Tags

oapiv1

2.2.131. partially update the specified RoleBinding


155

PATCH /oapi/v1/namespaces/{namespace}/rolebindings/{name}



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string




2.2.131.3. Consumes




2.2.131.4. Produces

application/json


156

2.2.131.5. Tags

oapiv1

2.2.132. list objects of kind Role

GET /oapi/v1/namespaces/{namespace}/roles



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


157

QueryParameter

resourceVersion


false string

PathParameter


true string




200 success Section 2.3.140, “v1.RoleList”

2.2.132.3. Consumes

/

2.2.132.4. Produces

application/json

2.2.132.5. Tags

oapiv1

2.2.133. create a Role


158

POST /oapi/v1/namespaces/{namespace}/roles



QueryParameter


false string

BodyParameter

body

true Section 2.3.46, “v1.Role”

PathParameter


true string



200 success Section 2.3.46, “v1.Role”

2.2.133.3. Consumes

/

2.2.133.4. Produces

application/json

2.2.133.5. Tags

oapiv1

2.2.134. read the specified Role

GET /oapi/v1/namespaces/{namespace}/roles/{name}


159



QueryParameter


false string

PathParameter


true string

PathParameter

name name of theRole

true string




2.2.134.3. Consumes

/

2.2.134.4. Produces

application/json

2.2.134.5. Tags

oapiv1

2.2.135. replace the specified Role

PUT /oapi/v1/namespaces/{namespace}/roles/{name}



160


QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string




2.2.135.3. Consumes

/

2.2.135.4. Produces

application/json

2.2.135.5. Tags

oapiv1

2.2.136. delete a Role

DELETE /oapi/v1/namespaces/{namespace}/roles/{name}



161


QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string




2.2.136.3. Consumes

/

2.2.136.4. Produces

application/json

2.2.136.5. Tags

oapiv1

2.2.137. partially update the specified Role

PATCH /oapi/v1/namespaces/{namespace}/roles/{name}


162



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string




2.2.137.3. Consumes




2.2.137.4. Produces

application/json

2.2.137.5. Tags

oapiv1


163

2.2.138. list or watch objects of kind Route

GET /oapi/v1/namespaces/{namespace}/routes



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


164

QueryParameter

resourceVersion


false string

PathParameter


true string




200 success Section 2.3.162, “v1.RouteList”

2.2.138.3. Consumes

/

2.2.138.4. Produces

application/json

2.2.138.5. Tags

oapiv1

2.2.139. create a Route

POST /oapi/v1/namespaces/{namespace}/routes



165


QueryParameter


false string

BodyParameter

body

true Section 2.3.154, “v1.Route”

PathParameter


true string



200 success Section 2.3.154, “v1.Route”

2.2.139.3. Consumes

/

2.2.139.4. Produces

application/json

2.2.139.5. Tags

oapiv1

2.2.140. read the specified Route

GET /oapi/v1/namespaces/{namespace}/routes/{name}



166


QueryParameter


false string

PathParameter


true string

PathParameter

name name of theRoute

true string




2.2.140.3. Consumes

/

2.2.140.4. Produces

application/json

2.2.140.5. Tags

oapiv1

2.2.141. replace the specified Route

PUT /oapi/v1/namespaces/{namespace}/routes/{name}



167


QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string




2.2.141.3. Consumes

/

2.2.141.4. Produces

application/json

2.2.141.5. Tags

oapiv1

2.2.142. delete a Route

DELETE /oapi/v1/namespaces/{namespace}/routes/{name}


168



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string




2.2.142.3. Consumes

/

2.2.142.4. Produces

application/json

2.2.142.5. Tags

oapiv1

2.2.143. partially update the specified Route


169

PATCH /oapi/v1/namespaces/{namespace}/routes/{name}



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string




2.2.143.3. Consumes




2.2.143.4. Produces

application/json

2.2.143.5. Tags


170

2.2.143.5. Tags

oapiv1

2.2.144. replace status of the specified Route

PUT /oapi/v1/namespaces/{namespace}/routes/{name}/status



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string




2.2.144.3. Consumes

/

2.2.144.4. Produces

application/json


171

2.2.144.5. Tags

oapiv1

2.2.145. create a SubjectAccessReview

POST /oapi/v1/namespaces/{namespace}/subjectaccessreviews



QueryParameter


false string

BodyParameter

body

true Section 2.3.53,“v1.SubjectAccessReview”

PathParameter


true string



200 success Section 2.3.53,“v1.SubjectAccessReview”

2.2.145.3. Consumes

/

2.2.145.4. Produces

application/json


172

2.2.145.5. Tags

oapiv1

2.2.146. list or watch objects of kind Template

GET /oapi/v1/namespaces/{namespace}/templates



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


173

QueryParameter

resourceVersion


false string

PathParameter


true string




200 success Section 2.3.58,“v1.TemplateList”

2.2.146.3. Consumes

/

2.2.146.4. Produces

application/json

2.2.146.5. Tags

oapiv1



174

POST /oapi/v1/namespaces/{namespace}/templates



QueryParameter


false string

BodyParameter

body


PathParameter


true string




2.2.147.3. Consumes

/

2.2.147.4. Produces

application/json

2.2.147.5. Tags

oapiv1

2.2.148. read the specified Template

GET /oapi/v1/namespaces/{namespace}/templates/{name}


175



QueryParameter


false string

PathParameter


true string

PathParameter

name name of theTemplate

true string




2.2.148.3. Consumes

/

2.2.148.4. Produces

application/json

2.2.148.5. Tags

oapiv1

2.2.149. replace the specified Template

PUT /oapi/v1/namespaces/{namespace}/templates/{name}



176


QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string




2.2.149.3. Consumes

/

2.2.149.4. Produces

application/json

2.2.149.5. Tags

oapiv1

2.2.150. delete a Template

DELETE /oapi/v1/namespaces/{namespace}/templates/{name}



177


QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string




2.2.150.3. Consumes

/

2.2.150.4. Produces

application/json

2.2.150.5. Tags

oapiv1

2.2.151. partially update the specified Template


178

PATCH /oapi/v1/namespaces/{namespace}/templates/{name}



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string




2.2.151.3. Consumes




2.2.151.4. Produces

application/json


179

2.2.151.5. Tags

oapiv1

2.2.152. list or watch objects of kind NetNamespace

GET /oapi/v1/netnamespaces



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


180

QueryParameter

resourceVersion


false string




200 success Section 2.3.16,“v1.NetNamespaceList”

2.2.152.3. Consumes

/

2.2.152.4. Produces

application/json

2.2.152.5. Tags

oapiv1

2.2.153. create a NetNamespace

POST /oapi/v1/netnamespaces



181


QueryParameter


false string

BodyParameter

body

true Section 2.3.27,“v1.NetNamespace”



200 success Section 2.3.27,“v1.NetNamespace”

2.2.153.3. Consumes

/

2.2.153.4. Produces

application/json

2.2.153.5. Tags

oapiv1

2.2.154. read the specified NetNamespace

GET /oapi/v1/netnamespaces/{name}



QueryParameter


false string


182

PathParameter

name name of theNetNamespace

true string





2.2.154.3. Consumes

/

2.2.154.4. Produces

application/json

2.2.154.5. Tags

oapiv1

2.2.155. replace the specified NetNamespace

PUT /oapi/v1/netnamespaces/{name}



QueryParameter


false string


183

BodyParameter

body

true Section 2.3.27,“v1.NetNamespace”

PathParameter


true string





2.2.155.3. Consumes

/

2.2.155.4. Produces

application/json

2.2.155.5. Tags

oapiv1

2.2.156. delete a NetNamespace

DELETE /oapi/v1/netnamespaces/{name}



QueryParameter


false string


184

BodyParameter

body


PathParameter


true string





2.2.156.3. Consumes

/

2.2.156.4. Produces

application/json

2.2.156.5. Tags

oapiv1

2.2.157. partially update the specified NetNamespace

PATCH /oapi/v1/netnamespaces/{name}




185

QueryParameter


false string

BodyParameter

body


PathParameter


true string





2.2.157.3. Consumes




2.2.157.4. Produces

application/json

2.2.157.5. Tags

oapiv1

2.2.158. list objects of kind OAuthAccessToken

GET /oapi/v1/oauthaccesstokens



186


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


187




200 success Section 2.3.138,“v1.OAuthAccessTokenList”

2.2.158.3. Consumes

/

2.2.158.4. Produces

application/json

2.2.158.5. Tags

oapiv1

2.2.159. create a OAuthAccessToken

POST /oapi/v1/oauthaccesstokens



188


QueryParameter


false string

BodyParameter

body

true Section 2.3.34,“v1.OAuthAccessToken”



200 success Section 2.3.34,“v1.OAuthAccessToken”

2.2.159.3. Consumes

/

2.2.159.4. Produces

application/json

2.2.159.5. Tags

oapiv1

2.2.160. read the specified OAuthAccessToken

GET /oapi/v1/oauthaccesstokens/{name}



QueryParameter


false string


189

PathParameter

name name of theOAuthAccessToken

true string




200 success Section 2.3.34,“v1.OAuthAccessToken”

2.2.160.3. Consumes

/

2.2.160.4. Produces

application/json

2.2.160.5. Tags

oapiv1

2.2.161. delete a OAuthAccessToken

DELETE /oapi/v1/oauthaccesstokens/{name}



QueryParameter


false string

BodyParameter

body



190

PathParameter

name name of theOAuthAccessToken

true string





2.2.161.3. Consumes

/

2.2.161.4. Produces

application/json

2.2.161.5. Tags

oapiv1

2.2.162. list objects of kind OAuthAuthorizeToken

GET /oapi/v1/oauthauthorizetokens



QueryParameter


false string


191

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string




192


200 success Section 2.3.57,“v1.OAuthAuthorizeTokenList”

2.2.162.3. Consumes

/

2.2.162.4. Produces

application/json

2.2.162.5. Tags

oapiv1

2.2.163. create a OAuthAuthorizeToken

POST /oapi/v1/oauthauthorizetokens



QueryParameter


false string

BodyParameter

body

true Section 2.3.118,“v1.OAuthAuthorizeToken”



200 success Section 2.3.118,“v1.OAuthAuthorizeToken”


193

2.2.163.3. Consumes

/

2.2.163.4. Produces

application/json

2.2.163.5. Tags

oapiv1

2.2.164. read the specified OAuthAuthorizeToken

GET /oapi/v1/oauthauthorizetokens/{name}



QueryParameter


false string

PathParameter

name name of theOAuthAuthorizeToken

true string



200 success Section 2.3.118,“v1.OAuthAuthorizeToken”

2.2.164.3. Consumes

/

2.2.164.4. Produces

application/json


194

2.2.164.5. Tags

oapiv1

2.2.165. delete a OAuthAuthorizeToken

DELETE /oapi/v1/oauthauthorizetokens/{name}



QueryParameter


false string

BodyParameter

body


PathParameter

name name of theOAuthAuthorizeToken

true string




2.2.165.3. Consumes

/

2.2.165.4. Produces

application/json

2.2.165.5. Tags

oapiv1


195

2.2.166. list or watch objects of kind OAuthClientAuthorization

GET /oapi/v1/oauthclientauthorizations



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


196

QueryParameter

resourceVersion


false string




200 success Section 2.3.141,“v1.OAuthClientAuthorizationList”

2.2.166.3. Consumes

/

2.2.166.4. Produces

application/json

2.2.166.5. Tags

oapiv1

2.2.167. create a OAuthClientAuthorization

POST /oapi/v1/oauthclientauthorizations



197


QueryParameter


false string

BodyParameter

body

true Section 2.3.69,“v1.OAuthClientAuthorization”



200 success Section 2.3.69,“v1.OAuthClientAuthorization”

2.2.167.3. Consumes

/

2.2.167.4. Produces

application/json

2.2.167.5. Tags

oapiv1

2.2.168. read the specified OAuthClientAuthorization

GET /oapi/v1/oauthclientauthorizations/{name}




198

QueryParameter


false string

PathParameter

name name of theOAuthClientAuthorization

true string





2.2.168.3. Consumes

/

2.2.168.4. Produces

application/json

2.2.168.5. Tags

oapiv1

2.2.169. replace the specified OAuthClientAuthorization

PUT /oapi/v1/oauthclientauthorizations/{name}



QueryParameter


false string


199

BodyParameter

body

true Section 2.3.69,“v1.OAuthClientAuthorization”

PathParameter


true string





2.2.169.3. Consumes

/

2.2.169.4. Produces

application/json

2.2.169.5. Tags

oapiv1

2.2.170. delete a OAuthClientAuthorization

DELETE /oapi/v1/oauthclientauthorizations/{name}




200

QueryParameter


false string

BodyParameter

body


PathParameter


true string





2.2.170.3. Consumes

/

2.2.170.4. Produces

application/json

2.2.170.5. Tags

oapiv1

2.2.171. partially update the specified OAuthClientAuthorization

PATCH /oapi/v1/oauthclientauthorizations/{name}



201


QueryParameter


false string

BodyParameter

body


PathParameter


true string




2.2.171.3. Consumes




2.2.171.4. Produces

application/json

2.2.171.5. Tags

oapiv1

2.2.172. list or watch objects of kind OAuthClient

GET /oapi/v1/oauthclients



202


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


203




200 success Section 2.3.48,“v1.OAuthClientList”

2.2.172.3. Consumes

/

2.2.172.4. Produces

application/json

2.2.172.5. Tags

oapiv1

2.2.173. create a OAuthClient

POST /oapi/v1/oauthclients



204


QueryParameter


false string

BodyParameter

body

true Section 2.3.93,“v1.OAuthClient”



200 success Section 2.3.93, “v1.OAuthClient”

2.2.173.3. Consumes

/

2.2.173.4. Produces

application/json

2.2.173.5. Tags

oapiv1

2.2.174. read the specified OAuthClient

GET /oapi/v1/oauthclients/{name}



QueryParameter


false string


205

PathParameter

name name of theOAuthClient

true string





2.2.174.3. Consumes

/

2.2.174.4. Produces

application/json

2.2.174.5. Tags

oapiv1

2.2.175. replace the specified OAuthClient

PUT /oapi/v1/oauthclients/{name}



QueryParameter


false string

BodyParameter

body

true Section 2.3.93,“v1.OAuthClient”


206

PathParameter


true string





2.2.175.3. Consumes

/

2.2.175.4. Produces

application/json

2.2.175.5. Tags

oapiv1

2.2.176. delete a OAuthClient

DELETE /oapi/v1/oauthclients/{name}



QueryParameter


false string

BodyParameter

body



207

PathParameter


true string





2.2.176.3. Consumes

/

2.2.176.4. Produces

application/json

2.2.176.5. Tags

oapiv1

2.2.177. partially update the specified OAuthClient

PATCH /oapi/v1/oauthclients/{name}



QueryParameter


false string

BodyParameter

body



208

PathParameter


true string





2.2.177.3. Consumes




2.2.177.4. Produces

application/json

2.2.177.5. Tags

oapiv1

2.2.178. list or watch objects of kind Policy

GET /oapi/v1/policies



QueryParameter


false string


209

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string




210


200 success Section 2.3.22, “v1.PolicyList”

2.2.178.3. Consumes

/

2.2.178.4. Produces

application/json

2.2.178.5. Tags

oapiv1

2.2.179. create a Policy

POST /oapi/v1/policies



QueryParameter


false string

BodyParameter

body





2.2.179.3. Consumes

/


211

2.2.179.4. Produces

application/json

2.2.179.5. Tags

oapiv1

2.2.180. list or watch objects of kind PolicyBinding

GET /oapi/v1/policybindings



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string


212

QueryParameter


false boolean

QueryParameter

resourceVersion


false string




200 success Section 2.3.6,“v1.PolicyBindingList”

2.2.180.3. Consumes

/

2.2.180.4. Produces

application/json

2.2.180.5. Tags

oapiv1


213

2.2.181. create a PolicyBinding

POST /oapi/v1/policybindings



QueryParameter


false string

BodyParameter

body





2.2.181.3. Consumes

/

2.2.181.4. Produces

application/json

2.2.181.5. Tags

oapiv1


POST /oapi/v1/processedtemplates



214


QueryParameter


false string

BodyParameter

body





2.2.182.3. Consumes

/

2.2.182.4. Produces

application/json

2.2.182.5. Tags

oapiv1

2.2.183. list objects of kind ProjectRequest

GET /oapi/v1/projectrequests



QueryParameter


false string


215

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string




216



2.2.183.3. Consumes

/

2.2.183.4. Produces

application/json

2.2.183.5. Tags

oapiv1

2.2.184. create a ProjectRequest

POST /oapi/v1/projectrequests



QueryParameter


false string

BodyParameter

body

true Section 2.3.32,“v1.ProjectRequest”



200 success Section 2.3.32,“v1.ProjectRequest”


217

2.2.184.3. Consumes

/

2.2.184.4. Produces

application/json

2.2.184.5. Tags

oapiv1

2.2.185. list objects of kind Project

GET /oapi/v1/projects



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string


218

QueryParameter


false boolean

QueryParameter

resourceVersion


false string




200 success Section 2.3.151, “v1.ProjectList”

2.2.185.3. Consumes

/

2.2.185.4. Produces

application/json

2.2.185.5. Tags

oapiv1


219

2.2.186. create a Project

POST /oapi/v1/projects



QueryParameter


false string

BodyParameter

body

true Section 2.3.114, “v1.Project”



200 success Section 2.3.114, “v1.Project”

2.2.186.3. Consumes

/

2.2.186.4. Produces

application/json

2.2.186.5. Tags

oapiv1

2.2.187. read the specified Project

GET /oapi/v1/projects/{name}



220


QueryParameter


false string

PathParameter

name name of theProject

true string




2.2.187.3. Consumes

/

2.2.187.4. Produces

application/json

2.2.187.5. Tags

oapiv1

2.2.188. replace the specified Project

PUT /oapi/v1/projects/{name}



QueryParameter


false string


221

BodyParameter

body

true Section 2.3.114, “v1.Project”

PathParameter


true string





2.2.188.3. Consumes

/

2.2.188.4. Produces

application/json

2.2.188.5. Tags

oapiv1

2.2.189. delete a Project

DELETE /oapi/v1/projects/{name}



QueryParameter


false string

PathParameter


true string


222




2.2.189.3. Consumes

/

2.2.189.4. Produces

application/json

2.2.189.5. Tags

oapiv1

2.2.190. partially update the specified Project

PATCH /oapi/v1/projects/{name}



QueryParameter


false string

BodyParameter

body


PathParameter


true string



223



2.2.190.3. Consumes




2.2.190.4. Produces

application/json

2.2.190.5. Tags

oapiv1

2.2.191. create a ResourceAccessReview

POST /oapi/v1/resourceaccessreviews



QueryParameter


false string

BodyParameter

body

true Section 2.3.167,“v1.ResourceAccessReview”



224


200 success Section 2.3.167,“v1.ResourceAccessReview”

2.2.191.3. Consumes

/

2.2.191.4. Produces

application/json

2.2.191.5. Tags

oapiv1

2.2.192. list objects of kind RoleBinding

GET /oapi/v1/rolebindings



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string


225

QueryParameter


false boolean

QueryParameter

resourceVersion


false string




200 success Section 2.3.163,“v1.RoleBindingList”

2.2.192.3. Consumes

/

2.2.192.4. Produces

application/json

2.2.192.5. Tags


226

oapiv1

2.2.193. create a RoleBinding

POST /oapi/v1/rolebindings



QueryParameter


false string

BodyParameter

body





2.2.193.3. Consumes

/

2.2.193.4. Produces

application/json

2.2.193.5. Tags

oapiv1

2.2.194. list objects of kind Role

GET /oapi/v1/roles


227



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


228

QueryParameter

resourceVersion


false string




200 success Section 2.3.140, “v1.RoleList”

2.2.194.3. Consumes

/

2.2.194.4. Produces

application/json

2.2.194.5. Tags

oapiv1

2.2.195. create a Role

POST /oapi/v1/roles



229


QueryParameter


false string

BodyParameter

body





2.2.195.3. Consumes

/

2.2.195.4. Produces

application/json

2.2.195.5. Tags

oapiv1

2.2.196. list or watch objects of kind Route

GET /oapi/v1/routes



QueryParameter


false string


230

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string




231


200 success Section 2.3.162, “v1.RouteList”

2.2.196.3. Consumes

/

2.2.196.4. Produces

application/json

2.2.196.5. Tags

oapiv1

2.2.197. create a Route

POST /oapi/v1/routes



QueryParameter


false string

BodyParameter

body





2.2.197.3. Consumes

/


232

2.2.197.4. Produces

application/json

2.2.197.5. Tags

oapiv1

2.2.198. create a SubjectAccessReview

POST /oapi/v1/subjectaccessreviews



QueryParameter


false string

BodyParameter

body

true Section 2.3.53,“v1.SubjectAccessReview”



200 success Section 2.3.53,“v1.SubjectAccessReview”

2.2.198.3. Consumes

/

2.2.198.4. Produces

application/json

2.2.198.5. Tags

oapiv1


233

2.2.199. list or watch objects of kind Template

GET /oapi/v1/templates



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


234

QueryParameter

resourceVersion


false string




200 success Section 2.3.58,“v1.TemplateList”

2.2.199.3. Consumes

/

2.2.199.4. Produces

application/json

2.2.199.5. Tags

oapiv1


POST /oapi/v1/templates



235


QueryParameter


false string

BodyParameter

body





2.2.200.3. Consumes

/

2.2.200.4. Produces

application/json

2.2.200.5. Tags

oapiv1

2.2.201. create a UserIdentityMapping

POST /oapi/v1/useridentitymappings



QueryParameter


false string


236

BodyParameter

body

true Section 2.3.78,“v1.UserIdentityMapping”




200 success Section 2.3.78,“v1.UserIdentityMapping”

2.2.201.3. Consumes

/

2.2.201.4. Produces

application/json

2.2.201.5. Tags

oapiv1

2.2.202. read the specified UserIdentityMapping

GET /oapi/v1/useridentitymappings/{name}



QueryParameter


false string

PathParameter

name name of theUserIdentityMapping

true string


237




2.2.202.3. Consumes

/

2.2.202.4. Produces

application/json

2.2.202.5. Tags

oapiv1

2.2.203. replace the specified UserIdentityMapping

PUT /oapi/v1/useridentitymappings/{name}



QueryParameter


false string

BodyParameter

body

true Section 2.3.78,“v1.UserIdentityMapping”

PathParameter


true string



238



2.2.203.3. Consumes

/

2.2.203.4. Produces

application/json

2.2.203.5. Tags

oapiv1

2.2.204. delete a UserIdentityMapping

DELETE /oapi/v1/useridentitymappings/{name}



QueryParameter


false string

PathParameter


true string




2.2.204.3. Consumes


239

/

2.2.204.4. Produces

application/json

2.2.204.5. Tags

oapiv1

2.2.205. partially update the specified UserIdentityMapping

PATCH /oapi/v1/useridentitymappings/{name}



QueryParameter


false string

BodyParameter

body


PathParameter


true string




2.2.205.3. Consumes



240



2.2.205.4. Produces

application/json

2.2.205.5. Tags

oapiv1

2.2.206. list or watch objects of kind User

GET /oapi/v1/users



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string


241

QueryParameter


false boolean

QueryParameter

resourceVersion


false string




200 success Section 2.3.84, “v1.UserList”

2.2.206.3. Consumes

/

2.2.206.4. Produces

application/json

2.2.206.5. Tags

oapiv1


242

2.2.207. create a User

POST /oapi/v1/users



QueryParameter


false string

BodyParameter

body

true Section 2.3.10, “v1.User”



200 success Section 2.3.10, “v1.User”

2.2.207.3. Consumes

/

2.2.207.4. Produces

application/json

2.2.207.5. Tags

oapiv1

2.2.208. read the specified User

GET /oapi/v1/users/{name}



243


QueryParameter


false string

PathParameter

name name of theUser

true string




2.2.208.3. Consumes

/

2.2.208.4. Produces

application/json

2.2.208.5. Tags

oapiv1

2.2.209. replace the specified User

PUT /oapi/v1/users/{name}



QueryParameter


false string


244

BodyParameter

body

true Section 2.3.10, “v1.User”

PathParameter


true string





2.2.209.3. Consumes

/

2.2.209.4. Produces

application/json

2.2.209.5. Tags

oapiv1

2.2.210. delete a User

DELETE /oapi/v1/users/{name}



QueryParameter


false string


245

BodyParameter

body


PathParameter


true string





2.2.210.3. Consumes

/

2.2.210.4. Produces

application/json

2.2.210.5. Tags

oapiv1

2.2.211. partially update the specified User

PATCH /oapi/v1/users/{name}



QueryParameter


false string


246

BodyParameter

body


PathParameter


true string





2.2.211.3. Consumes




2.2.211.4. Produces

application/json

2.2.211.5. Tags

oapiv1

2.2.212. watch individual changes to a list of BuildConfig

GET /oapi/v1/watch/buildconfigs




247

QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string



248



200 success Section 2.3.145,“json.WatchEvent”

2.2.212.3. Consumes

/

2.2.212.4. Produces

application/json

2.2.212.5. Tags

oapiv1

2.2.213. watch individual changes to a list of Build

GET /oapi/v1/watch/builds



QueryParameter


false string

QueryParameter


false string


249

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string





2.2.213.3. Consumes


250

/

2.2.213.4. Produces

application/json

2.2.213.5. Tags

oapiv1

2.2.214. watch individual changes to a list of ClusterNetwork

GET /oapi/v1/watch/clusternetworks



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string


251

QueryParameter


false boolean

QueryParameter

resourceVersion


false string





2.2.214.3. Consumes

/

2.2.214.4. Produces

application/json

2.2.214.5. Tags


252

2.2.214.5. Tags

oapiv1

2.2.215. watch changes to an object of kind ClusterNetwork

GET /oapi/v1/watch/clusternetworks/{name}



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


253

QueryParameter

resourceVersion


false string

PathParameter


true string





2.2.215.3. Consumes

/

2.2.215.4. Produces

application/json

2.2.215.5. Tags

oapiv1

2.2.216. watch individual changes to a list of ClusterPolicy

GET /oapi/v1/watch/clusterpolicies


254



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


255

QueryParameter

resourceVersion


false string





2.2.216.3. Consumes

/

2.2.216.4. Produces

application/json

2.2.216.5. Tags

oapiv1

2.2.217. watch changes to an object of kind ClusterPolicy

GET /oapi/v1/watch/clusterpolicies/{name}



256


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


257

QueryParameter

resourceVersion


false string

PathParameter


true string





2.2.217.3. Consumes

/

2.2.217.4. Produces

application/json

2.2.217.5. Tags

oapiv1

2.2.218. watch individual changes to a list of ClusterPolicyBinding

GET /oapi/v1/watch/clusterpolicybindings



258


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


259





2.2.218.3. Consumes

/

2.2.218.4. Produces

application/json

2.2.218.5. Tags

oapiv1

2.2.219. watch changes to an object of kind ClusterPolicyBinding

GET /oapi/v1/watch/clusterpolicybindings/{name}



260


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


261

PathParameter


true string





2.2.219.3. Consumes

/

2.2.219.4. Produces

application/json

2.2.219.5. Tags

oapiv1

2.2.220. watch individual changes to a list of DeploymentConfig

GET /oapi/v1/watch/deploymentconfigs



262


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


263





2.2.220.3. Consumes

/

2.2.220.4. Produces

application/json

2.2.220.5. Tags

oapiv1

2.2.221. watch individual changes to a list of Group

GET /oapi/v1/watch/groups



264


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


265





2.2.221.3. Consumes

/

2.2.221.4. Produces

application/json

2.2.221.5. Tags

oapiv1

2.2.222. watch changes to an object of kind Group

GET /oapi/v1/watch/groups/{name}



266


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


267

PathParameter


true string





2.2.222.3. Consumes

/

2.2.222.4. Produces

application/json

2.2.222.5. Tags

oapiv1

2.2.223. watch individual changes to a list of HostSubnet

GET /oapi/v1/watch/hostsubnets



268


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


269





2.2.223.3. Consumes

/

2.2.223.4. Produces

application/json

2.2.223.5. Tags

oapiv1

2.2.224. watch changes to an object of kind HostSubnet

GET /oapi/v1/watch/hostsubnets/{name}



270


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


271

PathParameter


true string





2.2.224.3. Consumes

/

2.2.224.4. Produces

application/json

2.2.224.5. Tags

oapiv1

2.2.225. watch individual changes to a list of Identity

GET /oapi/v1/watch/identities



272


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


273





2.2.225.3. Consumes

/

2.2.225.4. Produces

application/json

2.2.225.5. Tags

oapiv1

2.2.226. watch changes to an object of kind Identity

GET /oapi/v1/watch/identities/{name}



274


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


275

PathParameter


true string





2.2.226.3. Consumes

/

2.2.226.4. Produces

application/json

2.2.226.5. Tags

oapiv1

2.2.227. watch individual changes to a list of Image

GET /oapi/v1/watch/images



276


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


277





2.2.227.3. Consumes

/

2.2.227.4. Produces

application/json

2.2.227.5. Tags

oapiv1

2.2.228. watch changes to an object of kind Image

GET /oapi/v1/watch/images/{name}



278


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


279

PathParameter


true string





2.2.228.3. Consumes

/

2.2.228.4. Produces

application/json

2.2.228.5. Tags

oapiv1

2.2.229. watch individual changes to a list of ImageStream

GET /oapi/v1/watch/imagestreams



280


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


281





2.2.229.3. Consumes

/

2.2.229.4. Produces

application/json

2.2.229.5. Tags

oapiv1

2.2.230. watch individual changes to a list of BuildConfig

GET /oapi/v1/watch/namespaces/{namespace}/buildconfigs



282


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


283

PathParameter


true string





2.2.230.3. Consumes

/

2.2.230.4. Produces

application/json

2.2.230.5. Tags

oapiv1

2.2.231. watch changes to an object of kind BuildConfig

GET /oapi/v1/watch/namespaces/{namespace}/buildconfigs/{name}


284



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


285

QueryParameter

resourceVersion


false string

PathParameter


true string

PathParameter


true string





2.2.231.3. Consumes

/

2.2.231.4. Produces

application/json

2.2.231.5. Tags

oapiv1



286


GET /oapi/v1/watch/namespaces/{namespace}/builds



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


287

QueryParameter

resourceVersion


false string

PathParameter


true string





2.2.232.3. Consumes

/

2.2.232.4. Produces

application/json

2.2.232.5. Tags

oapiv1

2.2.233. watch changes to an object of kind Build

GET /oapi/v1/watch/namespaces/{namespace}/builds/{name}


288



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


289

QueryParameter

resourceVersion


false string

PathParameter


true string

PathParameter


true string





2.2.233.3. Consumes

/

2.2.233.4. Produces

application/json

2.2.233.5. Tags

oapiv1



290


GET /oapi/v1/watch/namespaces/{namespace}/deploymentconfigs



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


291

QueryParameter

resourceVersion


false string

PathParameter


true string





2.2.234.3. Consumes

/

2.2.234.4. Produces

application/json

2.2.234.5. Tags

oapiv1

2.2.235. watch changes to an object of kind DeploymentConfig

GET /oapi/v1/watch/namespaces/{namespace}/deploymentconfigs/{name}


292



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


293

QueryParameter

resourceVersion


false string

PathParameter


true string

PathParameter


true string





2.2.235.3. Consumes

/

2.2.235.4. Produces

application/json

2.2.235.5. Tags

oapiv1


294

2.2.236. watch individual changes to a list of ImageStream

GET /oapi/v1/watch/namespaces/{namespace}/imagestreams



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


295

QueryParameter

resourceVersion


false string

PathParameter


true string





2.2.236.3. Consumes

/

2.2.236.4. Produces

application/json

2.2.236.5. Tags

oapiv1

2.2.237. watch changes to an object of kind ImageStream

GET /oapi/v1/watch/namespaces/{namespace}/imagestreams/{name}


296



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


297

QueryParameter

resourceVersion


false string

PathParameter


true string

PathParameter


true string





2.2.237.3. Consumes

/

2.2.237.4. Produces

application/json

2.2.237.5. Tags


298

oapiv1

2.2.238. watch individual changes to a list of Policy

GET /oapi/v1/watch/namespaces/{namespace}/policies



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


299

QueryParameter

resourceVersion


false string

PathParameter


true string





2.2.238.3. Consumes

/

2.2.238.4. Produces

application/json

2.2.238.5. Tags

oapiv1

2.2.239. watch changes to an object of kind Policy

GET /oapi/v1/watch/namespaces/{namespace}/policies/{name}


300



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


301

QueryParameter

resourceVersion


false string

PathParameter


true string

PathParameter


true string





2.2.239.3. Consumes

/

2.2.239.4. Produces

application/json

2.2.239.5. Tags

oapiv1

2.2.240. watch individual changes to a list of PolicyBinding


302


GET /oapi/v1/watch/namespaces/{namespace}/policybindings



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


303

QueryParameter

resourceVersion


false string

PathParameter


true string





2.2.240.3. Consumes

/

2.2.240.4. Produces

application/json

2.2.240.5. Tags

oapiv1

2.2.241. watch changes to an object of kind PolicyBinding

GET /oapi/v1/watch/namespaces/{namespace}/policybindings/{name}


304



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


305

QueryParameter

resourceVersion


false string

PathParameter


true string

PathParameter


true string





2.2.241.3. Consumes

/

2.2.241.4. Produces

application/json

2.2.241.5. Tags

oapiv1

2.2.242. watch individual changes to a list of Route


306


GET /oapi/v1/watch/namespaces/{namespace}/routes



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


307

QueryParameter

resourceVersion


false string

PathParameter


true string





2.2.242.3. Consumes

/

2.2.242.4. Produces

application/json

2.2.242.5. Tags

oapiv1

2.2.243. watch changes to an object of kind Route

GET /oapi/v1/watch/namespaces/{namespace}/routes/{name}


308



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


309

QueryParameter

resourceVersion


false string

PathParameter


true string

PathParameter


true string





2.2.243.3. Consumes

/

2.2.243.4. Produces

application/json

2.2.243.5. Tags

oapiv1

2.2.244. watch individual changes to a list of Template


310


GET /oapi/v1/watch/namespaces/{namespace}/templates



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


311

QueryParameter

resourceVersion


false string

PathParameter


true string





2.2.244.3. Consumes

/

2.2.244.4. Produces

application/json

2.2.244.5. Tags

oapiv1

2.2.245. watch changes to an object of kind Template

GET /oapi/v1/watch/namespaces/{namespace}/templates/{name}


312



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


313

QueryParameter

resourceVersion


false string

PathParameter


true string

PathParameter


true string





2.2.245.3. Consumes

/

2.2.245.4. Produces

application/json

2.2.245.5. Tags

oapiv1

2.2.246. watch individual changes to a list of NetNamespace


314

2.2.246. watch individual changes to a list of NetNamespace

GET /oapi/v1/watch/netnamespaces



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


315

QueryParameter

resourceVersion


false string





2.2.246.3. Consumes

/

2.2.246.4. Produces

application/json

2.2.246.5. Tags

oapiv1

2.2.247. watch changes to an object of kind NetNamespace

GET /oapi/v1/watch/netnamespaces/{name}



316


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


317

PathParameter


true string





2.2.247.3. Consumes

/

2.2.247.4. Produces

application/json

2.2.247.5. Tags

oapiv1

2.2.248. watch individual changes to a list of OAuthClientAuthorization

GET /oapi/v1/watch/oauthclientauthorizations



318


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


319





2.2.248.3. Consumes

/

2.2.248.4. Produces

application/json

2.2.248.5. Tags

oapiv1

2.2.249. watch changes to an object of kind OAuthClientAuthorization

GET /oapi/v1/watch/oauthclientauthorizations/{name}



320


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


321

PathParameter


true string





2.2.249.3. Consumes

/

2.2.249.4. Produces

application/json

2.2.249.5. Tags

oapiv1

2.2.250. watch individual changes to a list of OAuthClient

GET /oapi/v1/watch/oauthclients



322


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


323





2.2.250.3. Consumes

/

2.2.250.4. Produces

application/json

2.2.250.5. Tags

oapiv1

2.2.251. watch changes to an object of kind OAuthClient

GET /oapi/v1/watch/oauthclients/{name}



324


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


325

PathParameter


true string





2.2.251.3. Consumes

/

2.2.251.4. Produces

application/json

2.2.251.5. Tags

oapiv1

2.2.252. watch individual changes to a list of Policy

GET /oapi/v1/watch/policies



326


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


327





2.2.252.3. Consumes

/

2.2.252.4. Produces

application/json

2.2.252.5. Tags

oapiv1


GET /oapi/v1/watch/policybindings



328


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


329





2.2.253.3. Consumes

/

2.2.253.4. Produces

application/json

2.2.253.5. Tags

oapiv1


GET /oapi/v1/watch/routes



330


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


331





2.2.254.3. Consumes

/

2.2.254.4. Produces

application/json

2.2.254.5. Tags

oapiv1


GET /oapi/v1/watch/templates



332


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


333





2.2.255.3. Consumes

/

2.2.255.4. Produces

application/json

2.2.255.5. Tags

oapiv1

2.2.256. watch individual changes to a list of User

GET /oapi/v1/watch/users



334


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


335





2.2.256.3. Consumes

/

2.2.256.4. Produces

application/json

2.2.256.5. Tags

oapiv1

2.2.257. watch changes to an object of kind User

GET /oapi/v1/watch/users/{name}



336


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


337

PathParameter


true string





2.2.257.3. Consumes

/

2.2.257.4. Produces

application/json

2.2.257.5. Tags

oapiv1

2.3. DEFINITIONS

2.3.1. v1.MetadataVolumeSource


338

Name Description Required Schema Default

items list of metadatafiles

false Section 2.3.66,“v1.MetadataFile”array

2.3.2. v1.TCPSocketAction

TCPSocketAction describes an action based on opening a socket


port Number or nameof the port toaccess on thecontainer.Number must bein the range 1 to65535. Namemust be anIANA_SVC_NAME.

true string

2.3.3. v1.GitBuildSource


uri points to thesource that will bebuilt, structure ofthe source willdepend on thetype of build torun

true string

ref identifies thebranch/tag/ref tobuild

false string


339

httpProxy specifies a httpproxy to be usedduring git cloneoperations

false string

httpsProxy specifies a httpsproxy to be usedduring git cloneoperations

false string


2.3.4. v1.HostSubnetList


kind Kind is a stringvaluerepresenting theREST resourcethis objectrepresents.Servers may inferthis from theendpoint the clientsubmits requeststo. Cannot beupdated. InCamelCase. Moreinfo:http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false string


340

http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

apiVersion APIVersiondefines theversioned schemaof thisrepresentation ofan object. Serversshould convertrecognizedschemas to thelatest internalvalue, and mayrejectunrecognizedvalues. More info:http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

false string

metadata

false Section 2.3.86,“unversioned.ListMeta”

items list of hostsubnets

true Section 2.3.11,“v1.HostSubnet”array


2.3.5. v1.GroupList



341

http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources


false string


false string

metadata


items list of groups true Section 2.3.56,“v1.Group” array



342



2.3.6. v1.PolicyBindingList



false string


false string

metadata



343



items list of policybindings

true Section 2.3.161,“v1.PolicyBinding”array


2.3.7. v1.ClusterRoleList



false string


344



false string

metadata


items list of cluster roles true Section 2.3.153,“v1.ClusterRole”array


2.3.8. v1.Capability

2.3.9. v1.SourceRevision


type type of the buildsource

true string

git information aboutgit-based buildsource

false Section 2.3.87,“v1.GitSourceRevision”


345



2.3.10. v1.User

Upon log in, every user of the system receives a User and Identity resource. Administrators maydirectly manipulate the attributes of the users for their own tracking, or set groups via the API. Theuser name is unique and is chosen based on the value provided by the identity provider - if a useralready exists with the incoming name, the user name may have a number appended to it.



false string


346



false string

metadata

false Section 2.3.113,“v1.ObjectMeta”

fullName full name of user false string

identities list of identities true string array

groups list of groups true string array


2.3.11. v1.HostSubnet



347



false string


false string

metadata




348



host Name of the hostthat is registeredat the master. Alease will besought after thisname.

true string

hostIP IP address to beused as vtep byother hosts in theoverlay network

true string

subnet Actual subnetCIDR leaseassigned to thehost

true string


2.3.12. v1.ClusterPolicyBinding



false string


349



false string

metadata


lastModified last time any partof the object wascreated, updated,or deleted

true string

policyRef reference to thecluster policy thatthis cluster policybinding’s rolebindings mayreference

true Section 2.3.132,“v1.ObjectReference”

roleBindings all the rolebindings held bythis policy,mapped by rolename

true Section 2.3.110,“v1.NamedClusterRoleBinding”array


2.3.13. v1.BuildStatus


350



phase observed point inthe build lifecycle

true string

cancelled describes if acanceling eventwas triggered forthe build

false boolean false

reason brief CamelCasestring describing afailure, meant formachine parsingand tidy display inthe CLI

false string

message human-readablemessageindicating detailsabout why thebuild has thisstatus

false string

startTimestamp server time whenthis build startedrunning in a pod

false string

completionTimestamp

server time whenthe pod runningthis build stoppedrunning

false string

duration amount of timethe build hasbeen running

false time.Duration


351

outputDockerImageReference

reference to theDocker imagebuilt by this build,computed frombuild.spec.output.to, and can beused to push andpull the image

false string

config reference to buildconfig from whichthis build wasderived

false Section 2.3.132,“v1.ObjectReference”


2.3.14. v1.BuildRequest



false string


352



false string

metadata


revision information fromthe source for aspecific reposnapshot

false Section 2.3.9,“v1.SourceRevision”

triggeredByImage image thattriggered this build


from ImageStreamTagthat triggered thisbuild




353


binary the binary will beprovided by thebuilder as anarchive or file tobe placed withinthe inputdirectory; allowsDockerfile to beoptionally set;may not be setwith git sourcetype also set

false Section 2.3.119,“v1.BinaryBuildSource”

lastVersion LastVersion of theBuildConfig thattriggered this build

false integer (int32)


2.3.15. v1.HostPathVolumeSource

HostPathVolumeSource represents bare host directory volume.


path Path of thedirectory on thehost. More info:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#hostpath

true string

2.3.16. v1.NetNamespaceList

NetNamespaceList represents a list of NetNamespace objects. NetNamespace catpures informationabout a segregated network namespace for an entire cluster. When a group of pods, or a project, ora group of projects get a NetNamespace assigned then the openshift-sdn’s multitenant plug-inensures network layer isolation of traffic from other NetNamespaces.



354

http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#hostpath


false string


false string

metadata


items list of netnamespaces

true Section 2.3.27,“v1.NetNamespace” array



355



2.3.17. v1.ImageStreamTagList



false string


false string

metadata



356



items list of imagestream tagobjects

true Section 2.3.52,“v1.ImageStreamTag” array


2.3.18. v1.Parameter


name name of theparameter

true string

displayName optional: provideshuman readablename for theparameter

false string

description optional:describes theparameter

false string

value optional: holdsthe parameterdata. if specified,the generator isignored. the valuereplaces alloccurrences ofthe parameter${Name}expression duringtemplate to configtransformation

false string


357

generate optional: generatespecifies thegenerator to beused to generaterandom stringfrom an inputvalue specified bythe from field. theresult string isstored in thevalue field. if notspecified, thevalue field isuntouched

false string

from input value for thegenerator

false string

required indicates theparameter musthave a non-emptyvalue or begenerated

false boolean false


2.3.19. v1.Volume

Volume represents a named volume in a pod that may be accessed by any container in the pod.


name Volume’s name.Must be aDNS_LABEL andunique within thepod. More info:http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names

true string


358

http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names

hostPath HostPathrepresents a pre-existing file ordirectory on thehost machine thatis directlyexposed to thecontainer. This isgenerally used forsystem agents orother privilegedthings that areallowed to see thehost machine.Most containerswill NOT needthis. More info:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#hostpath

false Section 2.3.15,“v1.HostPathVolumeSource”

emptyDir EmptyDirrepresents atemporarydirectory thatshares a pod’slifetime. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#emptydir

false Section 2.3.104,“v1.EmptyDirVolumeSource”



359


http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#emptydir

gcePersistentDisk GCEPersistentDisk represents aGCE Diskresource that isattached to akubelet’s hostmachine and thenexposed to thepod. More info:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk

false Section 2.3.80,“v1.GCEPersistentDiskVolumeSource”

awsElasticBlockStore

AWSElasticBlockStore representsan AWS Diskresource that isattached to akubelet’s hostmachine and thenexposed to thepod. More info:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore

false Section 2.3.146,“v1.AWSElasticBlockStoreVolumeSource”

gitRepo GitReporepresents a gitrepository at aparticular revision.

false Section 2.3.112,“v1.GitRepoVolumeSource”

secret Secret representsa secret thatshould populatethis volume. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#secrets

false Section 2.3.38,“v1.SecretVolumeSource”



360

http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk

http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore

http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#secrets

nfs NFS representsan NFS mount onthe host thatshares a pod’slifetime More info:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs

false Section 2.3.28,“v1.NFSVolumeSource”

iscsi ISCSI representsan ISCSI Diskresource that isattached to akubelet’s hostmachine and thenexposed to thepod. More info:http://releases.k8s.io/HEAD/examples/iscsi/README.md

false Section 2.3.111,“v1.ISCSIVolumeSource”

glusterfs Glusterfsrepresents aGlusterfs mounton the host thatshares a pod’slifetime. Moreinfo:http://releases.k8s.io/HEAD/examples/glusterfs/README.md

false Section 2.3.168,“v1.GlusterfsVolumeSource”



361

http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs

http://releases.k8s.io/HEAD/examples/iscsi/README.md

http://releases.k8s.io/HEAD/examples/glusterfs/README.md

persistentVolumeClaim

PersistentVolumeClaimVolumeSource represents areference to aPersistentVolumeClaim in the samenamespace. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

false Section 2.3.51,“v1.PersistentVolumeClaimVolumeSource”

rbd RBD represents aRados BlockDevice mount onthe host thatshares a pod’slifetime. Moreinfo:http://releases.k8s.io/HEAD/examples/rbd/README.md

false Section 2.3.70,“v1.RBDVolumeSource”

cinder Cinder representsa cinder volumeattached andmounted onkubelets hostmachine Moreinfo:http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

false Section 2.3.127,“v1.CinderVolumeSource”



362

http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

http://releases.k8s.io/HEAD/examples/rbd/README.md

http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

cephfs CephFSrepresents aCeph FS mounton the host thatshares a pod’slifetime

false Section 2.3.29,“v1.CephFSVolumeSource”

flocker Flockerrepresents aFlocker volumeattached to akubelet’s hostmachine. Thisdepends on theFlocker controlservice beingrunning

false Section 2.3.68,“v1.FlockerVolumeSource”

downwardAPI DownwardAPIrepresentsdownward APIabout the pod thatshould populatethis volume

false Section 2.3.126,“v1.DownwardAPIVolumeSource”

fc FC represents aFibre Channelresource that isattached to akubelet’s hostmachine and thenexposed to thepod.

false Section 2.3.62,“v1.FCVolumeSource”

metadata

false Section 2.3.1,“v1.MetadataVolumeSource”


2.3.20. v1.RouteStatus

2.3.21. v1.BuildTriggerPolicy


363


type type of buildtrigger

true string

github parameters for aGitHub webhooktype of trigger

false Section 2.3.107,“v1.WebHookTrigger”

generic parameters for aGeneric webhooktype of trigger

false Section 2.3.107,“v1.WebHookTrigger”

imageChange parameters for anImageChangetype of trigger

false Section 2.3.157,“v1.ImageChangeTrigger”

2.3.22. v1.PolicyList



false string


364



false string

metadata


items list of policies true Section 2.3.160,“v1.Policy” array


2.3.23. v1.LocalSubjectAccessReview

Local Subject Access Reviews are objects that allow you to determine whether a given user orgroup can perform a particular action in a given namespace. Leaving user and groups emptyallows you determine whether the identity making the request can perform the action.



365



false string


false string

namespace namespace of theaction beingrequested

true string

verb one of get, list,watch, create,update, delete

true string



366



resource one of theexisting resourcetypes

true string

resourceName name of theresource beingrequested for aget or delete

true string

content actual content ofthe request forcreate and update

false string

user optional, if bothuser and groupsare empty, thecurrentauthenticateduser is used

true string

groups optional, list ofgroups to whichthe user belongs

true string array


2.3.24. v1.DeleteOptions

DeleteOptions may be provided when deleting an API object



367


false string


false string



368



gracePeriodSeconds

The duration inseconds beforethe object shouldbe deleted. Valuemust be non-negative integer.The value zeroindicates deleteimmediately. Ifthis value is nil,the default graceperiod for thespecified type willbe used. Defaultsto a per objectvalue if notspecified. zeromeans deleteimmediately.

true integer (int64)


2.3.25. v1.PodTemplateSpec

PodTemplateSpec describes the data a pod should have when created from a template


metadata Standard object’smetadata. Moreinfo:http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata


spec Specification ofthe desiredbehavior of thepod. More info:http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false Section 2.3.67,“v1.PodSpec”

2.3.26. v1.Build


369

http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

2.3.26. v1.Build



false string


false string

metadata



370



spec specification ofthe desiredbehavior for abuild

false Section 2.3.120,“v1.BuildSpec”

status most recentlyobserved status ofa build aspopulated by thesystem

false Section 2.3.13,“v1.BuildStatus”


2.3.27. v1.NetNamespace

NetNamespace represents a segregated network namespace for an entire cluster. When a group ofpods, or a project, or a group of projects get a NetNamespace assigned then the openshift-sdn’smultitenant plug-in ensures network layer isolation of traffic from other NetNamespaces.



false string


371



false string

metadata


netname Name of thenetworknamespace.

true string

netid NetID of thenetworknamespaceassigned to eachoverlay networkpacket.

true unit


2.3.28. v1.NFSVolumeSource

NFSVolumeSource represents an NFS mount that lasts the lifetime of a pod



372


server Server is thehostname or IPaddress of theNFS server. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs

true string

path Path that isexported by theNFS server. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs

true string

readOnly ReadOnly herewill force the NFSexport to bemounted withread-onlypermissions.Defaults to false.More info:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs

false boolean false


2.3.29. v1.CephFSVolumeSource

CephFSVolumeSource represents a Ceph Filesystem Mount that lasts the lifetime of a pod



373




monitors Required:Monitors is acollection of Cephmonitors Moreinfo:http://releases.k8s.io/HEAD/examples/cephfs/README.md#how-to-use-it

true string array

user Optional: User isthe rados username, default isadmin More info:http://releases.k8s.io/HEAD/examples/cephfs/README.md#how-to-use-it

false string

secretFile Optional:SecretFile is thepath to key ring forUser, default is/etc/ceph/user.secret More info:http://releases.k8s.io/HEAD/examples/cephfs/README.md#how-to-use-it

false string

secretRef Optional:SecretRef isreference to theauthenticationsecret for User,default is empty.More info:http://releases.k8s.io/HEAD/examples/cephfs/README.md#how-to-use-it

false Section 2.3.117,“v1.LocalObjectReference”



374

http://releases.k8s.io/HEAD/examples/cephfs/README.md#how-to-use-it




readOnly Optional: Defaultsto false(read/write).ReadOnly herewill force theReadOnly settingin VolumeMounts.More info:http://releases.k8s.io/HEAD/examples/cephfs/README.md#how-to-use-it

false boolean false


2.3.30. v1.Capabilities

Adds and removes POSIX capabilities from running containers.


add Added capabilities false Section 2.3.8,“v1.Capability”array

drop Removedcapabilities

false Section 2.3.8,“v1.Capability”array

2.3.31. v1.DeploymentConfig

Deployment Configs define the template for a pod and manages deploying new images orconfiguration changes. A single deployment configuration is usually analogous to a single micro-service. Can support many different deployment patterns, including full restart, customizable rollingupdates, and fully custom behaviors, as well as pre- and post- deployment hooks. Each individualdeployment is represented as a replication controller.

A deployment is "triggered" when its configuration is changed or a tag in an Image Stream ischanged. Triggers can be disabled to allow manual control over a deployment. The"strategy"determines how the deployment is carried out and may be changed at any time.


375




false string


false string

metadata



376



spec a desireddeployment stateand how to deployit

true Section 2.3.81,“v1.DeploymentConfigSpec”

status the current stateof the latestdeployment

true Section 2.3.115,“v1.DeploymentConfigStatus”


2.3.32. v1.ProjectRequest



false string


377



true string

metadata

subfield name Section 2.3.113,“v1.ObjectMeta”

displayName display name toapply to a project

false string

description description toapply to a project

false string


2.3.33. v1.DeploymentLog

A deployment log is a virtual resource used by the OpenShift client tool for retrieving the logs for adeployment.



378



false string


false string


2.3.34. v1.OAuthAccessToken



379




false string


false string

metadata




380



clientName references theclient that createdthis token

false string

expiresIn is the secondsfrom creation timebefore this tokenexpires


scopes list of requestedscopes

false string array

redirectURI redirection URIassociated withthe token

false string

userName user nameassociated withthis token

false string

userUID unique UIDassociated withthis token

false string

authorizeToken contains the tokenthat authorizedthis token

false string

refreshToken optional value bywhich this tokencan be renewed

false string


2.3.35. unversioned.Status

Status is a return value for calls that don’t return other objects.


381



false string


false string

metadata Standard listmetadata. Moreinfo:http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds



382




status Status of theoperation. One of:"Success" or"Failure". Moreinfo:http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false string

message A human-readabledescription of thestatus of thisoperation.

false string

reason A machine-readabledescription of whythis operation is inthe "Failure"status. If thisvalue is emptythere is noinformationavailable. AReason clarifiesan HTTP statuscode but does notoverride it.

false string



383


details Extended dataassociated withthe reason. Eachreason maydefine its ownextended details.This field isoptional and thedata returned isnot guaranteed toconform to anyschema exceptthat defined bythe reason type.

false Section 2.3.37,“unversioned.StatusDetails”

code Suggested HTTPreturn code forthis status, 0 if notset.



2.3.36. v1.BuildConfigList



false string


384



false string

metadata


items list of build configs true Section 2.3.60,“v1.BuildConfig”array


2.3.37. unversioned.StatusDetails

StatusDetails is a set of additional properties that MAY be set by the server to provide additionalinformation 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 assumethat any attribute may be empty, invalid, or under defined.



385


name The nameattribute of theresourceassociated withthe statusStatusReason(when there is asingle namewhich can bedescribed).

false string

kind The kind attributeof the resourceassociated withthe statusStatusReason. Onsome operationsmay differ fromthe requestedresource Kind.More info:http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false string

causes The Causes arrayincludes moredetails associatedwith theStatusReasonfailure. Not allStatusReasonsmay providedetailed causes.

false Section 2.3.159,“unversioned.StatusCause” array

retryAfterSeconds If specified, thetime in secondsbefore theoperation shouldbe retried.



2.3.38. v1.SecretVolumeSource


386


SecretVolumeSource adapts a Secret into a VolumeSource. More info:http://releases.k8s.io/HEAD/docs/design/secrets.md


secretName SecretName isthe name of asecret in thepod’s namespace.More info:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#secrets

true string

2.3.39. v1.SecretSpec

A SecretSpec specifies a secret and its corresponding mount point for a custom builder. Thespecified secret must be assigned to the service account that will run the build.


secretSource a reference to asecret

true Section 2.3.117,“v1.LocalObjectReference”

mountPath path within thecontainer at whichthe secret shouldbe mounted

true string

2.3.40. v1.ResourceRequirements

ResourceRequirements describes the compute resource requirements.



387

http://releases.k8s.io/HEAD/docs/design/secrets.md


limits Limits describesthe maximumamount ofcomputeresourcesallowed. Moreinfo:http://releases.k8s.io/HEAD/docs/design/resources.md#resource-specifications

false Section 2.3.171,“any”

requests Requestsdescribes theminimum amountof computeresourcesrequired. IfRequests isomitted for acontainer, itdefaults to Limitsif that is explicitlyspecified,otherwise to animplementation-defined value.More info:http://releases.k8s.io/HEAD/docs/design/resources.md#resource-specifications



2.3.41. v1.ClusterNetworkList



388

http://releases.k8s.io/HEAD/docs/design/resources.md#resource-specifications



false string


false string

metadata


items list of clusternetworks

true Section 2.3.50,“v1.ClusterNetwork” array



389




2.3.42. v1.ImageList



false string


390



false string

metadata


items list of imageobjects

true Section 2.3.99,“v1.Image” array


2.3.43. unversioned.Patch

Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.

2.3.44. v1.ImageStreamStatus


dockerImageRepository

represents theeffective locationthis stream maybe accessed at,may be emptyuntil the serverdetermines wherethe repository islocated

true string


391


tags historical record ofimagesassociated witheach tag, the firstentry is thecurrently taggedimage

false Section 2.3.123,“v1.NamedTagEventList” array


2.3.45. v1.TLSConfig


termination indicatestermination type. ifnot set, anytermination configwill be ignored

false string

certificate providescertificatecontents

false string

key provides key filecontents

false string

caCertificate provides the certauthoritycertificatecontents

false string


392

destinationCACertificate

provides thecontents of the cacertificate of thefinal destination.When using re-encrypttermination thisfile should beprovided in orderto have routersuse it for healthchecks on thesecure connection

false string

insecureEdgeTerminationPolicy

indicates desiredbehavior forinsecureconnections to anedge-terminatedroute (None,Allow orRedirect). If notset, insecureconnections willnot be allowed

false string


2.3.46. v1.Role



393


false string


false string

metadata


rules all the rules forthis role

true Section 2.3.88,“v1.PolicyRule”array



394



2.3.47. v1.ClusterRoleBinding



false string


false string

metadata



395



userNames all user namesdirectly bound tothe role

true string array

groupNames all the groupsdirectly bound tothe role

true string array

subjects references tosubjects bound tothe role. OnlyUser, Group,SystemUser,SystemGroup,andServiceAccountare allowed.

true Section 2.3.132,“v1.ObjectReference” array

roleRef reference to thepolicy role



2.3.48. v1.OAuthClientList



396


false string


false string

metadata


items list of oauthclients

true Section 2.3.93,“v1.OAuthClient”array



397



2.3.49. v1.ExecAction

ExecAction describes a "run in container" action.


command Command is thecommand line toexecute inside thecontainer, theworking directoryfor the commandis root ('/') in thecontainer’sfilesystem. Thecommand issimply exec’d, it isnot run inside ashell, sotraditional shellinstructions ('|',etc) won’t work.To use a shell,you need toexplicitly call outto that shell. Exitstatus of 0 istreated aslive/healthy andnon-zero isunhealthy.

false string array

2.3.50. v1.ClusterNetwork



398


false string


false string

metadata


network CIDR string tospecify the globaloverlay network’sL3 space

true string



399



hostsubnetlength number of bits toallocate to eachhost’s subnet e.g.8 would mean a/24 network onthe host


serviceNetwork CIDR string tospecify theservice network

true string


2.3.51. v1.PersistentVolumeClaimVolumeSource

PersistentVolumeClaimVolumeSource references the user’s PVC in the same namespace. Thisvolume finds the bound PV and mounts that volume for the pod. APersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume thatis owned by someone else (the system).


claimName ClaimName is thename of aPersistentVolumeClaim in the samenamespace asthe pod using thisvolume. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

true string

readOnly Will force theReadOnly settingin VolumeMounts.Default false.

false boolean false

2.3.52. v1.ImageStreamTag


400




false string


false string

metadata


image the imageassociated withthe ImageStreamand tag

true Section 2.3.99,“v1.Image”


401



2.3.53. v1.SubjectAccessReview

TypeMeta describes an individual object in an API response or request with strings representing thetype of the object and its API schema version. Structures that are versioned or persisted shouldinline TypeMeta.



false string


false string


402




true string


true string


true string


true string


false string

user optional, if bothuser and groupsare empty, thecurrentauthenticateduser is used

true string

groups optional, list ofgroups to whichthe user belongs

true string array


2.3.54. v1.BuildStrategy


type identifies the typeof build strategy

true string


403

dockerStrategy holds parametersfor the Dockerbuild strategy

false Section 2.3.133,“v1.DockerBuildStrategy”

sourceStrategy holds parametersto the Sourcebuild strategy

false Section 2.3.128,“v1.SourceBuildStrategy”

customStrategy holds parametersto the Custombuild strategy

false Section 2.3.149,“v1.CustomBuildStrategy”


2.3.55. v1.DeploymentConfigList



false string


404



false string

metadata


items a list ofdeploymentconfigs

true Section 2.3.31,“v1.DeploymentConfig” array


2.3.56. v1.Group



405



false string


false string

metadata


users list of users in thisgroup

true string array



406



2.3.57. v1.OAuthAuthorizeTokenList



false string


false string

metadata



407



items list of oauthauthorizationtokens

true Section 2.3.118,“v1.OAuthAuthorizeToken” array


2.3.58. v1.TemplateList



false string


408



false string

metadata


items list of templates true Section 2.3.79,“v1.Template”array


2.3.59. v1.ProjectStatus


phase phase is thecurrent lifecyclephase of theproject

false string

2.3.60. v1.BuildConfig

Build configurations define a build process for new Docker images. There are three types of buildspossible - a Docker build using a Dockerfile, a Source-to-Image build that uses a specially preparedbase image that accepts source code that it can make runnable, and a custom build that can run


409


arbitrary Docker images as a base and accept the build parameters. Builds run on the cluster and oncompletion are pushed to the Docker registry specified in the "output" section. A build can betriggered via a webhook, when the base image changes, or when a user manually requests a newbuild be created.

Each build created by a build configuration is numbered and refers back to its parent configuration.Multiple builds can be triggered at once. Builds that do not have "output" set can be used to testcode or run a verification build.



false string


false string


410



metadata


spec holds all the inputnecessary toproduce a newbuild, and theconditions whento trigger them

true Section 2.3.143,“v1.BuildConfigSpec”

status holds any relevantinformation abouta build configderived by thesystem

true Section 2.3.129,“v1.BuildConfigStatus”


2.3.61. v1.Handler

Handler defines a specific action that should be taken


exec One and only oneof the followingshould bespecified. Execspecifies theaction to take.

false Section 2.3.49,“v1.ExecAction”

httpGet HTTPGetspecifies the httprequest toperform.

false Section 2.3.106,“v1.HTTPGetAction”

tcpSocket TCPSocketspecifies anaction involving aTCP port. TCPhooks not yetsupported

false Section 2.3.2,“v1.TCPSocketAction”


411

2.3.62. v1.FCVolumeSource

A Fibre Channel Disk can only be mounted as read/write once.


targetWWNs Required: FCtarget world widenames (WWNs)

true string array

lun Required: FCtarget lun number


fsType Required:Filesystem type tomount. Must be afilesystem typesupported by thehost operatingsystem. Ex."ext4", "xfs", "ntfs"

true string

readOnly Optional: Defaultsto false(read/write).ReadOnly herewill force theReadOnly settingin VolumeMounts.

false boolean false

2.3.63. v1.DownwardAPIVolumeFile

DownwardAPIVolumeFile represents a single file containing information from the downward API



412

path Required: Path isthe relative pathname of the file tobe created. Mustnot be absolute orcontain the '..'path. Must be utf-8 encoded. Thefirst item of therelative path mustnot start with '..'

true string

fieldRef Required: Selectsa field of the pod:only annotations,labels, name andnamespace aresupported.

true Section 2.3.137,“v1.ObjectFieldSelector”


2.3.64. v1.Container

A single application container that you want to run within a pod.


name Name of thecontainerspecified as aDNS_LABEL.Each container ina pod must have aunique name(DNS_LABEL).Cannot beupdated.

true string

image Docker imagename. More info:http://releases.k8s.io/HEAD/docs/user-guide/images.md

false string


413

http://releases.k8s.io/HEAD/docs/user-guide/images.md

command Entrypoint array.Not executedwithin a shell. Thedocker image’sentrypoint is usedif this is notprovided. Variablereferences$(VAR_NAME)are expandedusing thecontainer’senvironment. If avariable cannotbe resolved, thereference in theinput string will beunchanged. The$(VAR_NAME)syntax can beescaped with adouble , ie:(VAR_NAME).Escapedreferences willnever beexpanded,regardless ofwhether thevariable exists ornot. Cannot beupdated. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/containers.md#containers-and-commands

false string array



414

http://releases.k8s.io/HEAD/docs/user-guide/containers.md#containers-and-commands

args Arguments to theentrypoint. Thedocker image’scmd is used if thisis not provided.Variablereferences$(VAR_NAME)are expandedusing thecontainer’senvironment. If avariable cannotbe resolved, thereference in theinput string will beunchanged. The$(VAR_NAME)syntax can beescaped with adouble , ie:(VAR_NAME).Escapedreferences willnever beexpanded,regardless ofwhether thevariable exists ornot. Cannot beupdated. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/containers.md#containers-and-commands

false string array

workingDir Container’sworking directory.Defaults toDocker’s default.D efaults toimage’s default.Cannot beupdated.

false string



415


ports List of ports toexpose from thecontainer. Cannotbe updated.

false Section 2.3.124,“v1.ContainerPort” array

env List ofenvironmentvariables to set inthe container.Cannot beupdated.

false Section 2.3.158,“v1.EnvVar” array

resources ComputeResourcesrequired by thiscontainer. Cannotbe updated. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#resources

false Section 2.3.40,“v1.ResourceRequirements”

volumeMounts Pod volumes tomount into thecontainer’sfilesyste. Cannotbe updated.

false Section 2.3.90,“v1.VolumeMount” array

livenessProbe Periodic probe ofcontainerliveness.Container will berestarted if theprobe fails.Cannot beupdated. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes

false Section 2.3.109,“v1.Probe”



416

http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#resources

http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes

readinessProbe Periodic probe ofcontainer servicereadiness.Container will beremoved fromservice endpointsif the probe fails.Cannot beupdated. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes


lifecycle Actions that themanagementsystem shouldtake in responseto containerlifecycle events.Cannot beupdated.

false Section 2.3.139,“v1.Lifecycle”

terminationMessagePath

Optional: Path atwhich the file towhich thecontainer’sterminationmessage will bewritten is mountedinto thecontainer’sfilesystem.Message writtenis intended to bebrief final status,such as anassertion failuremessage.Defaults to/dev/termination-log. Cannot beupdated.

false string



417


imagePullPolicy Image pull policy.One of Always,Never,IfNotPresent.Defaults toAlways if :latesttag is specified, orIfNotPresentotherwise. Cannotbe updated. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/images.md#updating-images

false string

securityContext Security optionsthe pod shouldrun with. Moreinfo:http://releases.k8s.io/HEAD/docs/design/security_context.md

false Section 2.3.75,“v1.SecurityContext”

stdin Whether thiscontainer shouldallocate a bufferfor stdin in thecontainer runtime.If this is not set,reads from stdinin the containerwill always resultin EOF. Default isfalse.

false boolean false



418

http://releases.k8s.io/HEAD/docs/user-guide/images.md#updating-images

http://releases.k8s.io/HEAD/docs/design/security_context.md

stdinOnce Whether thecontainer runtimeshould close thestdin channelafter it has beenopened by asingle attach.When stdin is truethe stdin streamwill remain openacross multipleattach sessions. IfstdinOnce is setto true, stdin isopened oncontainer start, isempty until thefirst clientattaches to stdin,and then remainsopen and acceptsdata until theclient disconnects,at which timestdin is closedand remainsclosed until thecontainer isrestarted. If thisflag is false, acontainerprocesses thatreads from stdinwill never receivean EOF. Default isfalse

false boolean false

tty Whether thiscontainer shouldallocate a TTY foritself, alsorequires 'stdin' tobe true. Default isfalse.

false boolean false


2.3.65. v1.SourceControlUser


419


name name of thesource controluser

false string

email e-mail of thesource controluser

false string

2.3.66. v1.MetadataFile


name the name of thefile to be created

true string

fieldRef selects a field ofthe pod.Supported fields:metadata.annotations,metadata.labels,metadata.name,metadata.namespace


2.3.67. v1.PodSpec

PodSpec is a description of a pod.



420

volumes List of volumesthat can bemounted bycontainersbelonging to thepod. More info:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md

false Section 2.3.19,“v1.Volume” array

containers List of containersbelonging to thepod. Containerscannot currentlybe added orremoved. Theremust be at leastone container in aPod. Cannot beupdated. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/containers.md

true Section 2.3.64,“v1.Container”array

restartPolicy Restart policy forall containerswithin the pod.One of Always,OnFailure, Never.Default to Always.More info:http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#restartpolicy

false string



421

http://releases.k8s.io/HEAD/docs/user-guide/volumes.md

http://releases.k8s.io/HEAD/docs/user-guide/containers.md

http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#restartpolicy

terminationGracePeriodSeconds

Optional durationin seconds thepod needs toterminategracefully. May bedecreased indelete request.Value must benon-negativeinteger. The valuezero indicatesdeleteimmediately. Ifthis value is nil,the default graceperiod will beused instead. Thegrace period isthe duration inseconds after theprocessesrunning in the podare sent atermination signaland the timewhen theprocesses areforcibly haltedwith a kill signal.Set this valuelonger than theexpected cleanuptime for yourprocess. Defaultsto 30 seconds.


activeDeadlineSeconds

Optional durationin seconds thepod may beactive on thenode relative toStartTime beforethe system willactively try tomark it failed andkill associatedcontainers. Valuemust be a positiveinteger.




422

dnsPolicy Set DNS policy forcontainers withinthe pod. One of'ClusterFirst' or'Default'. Defaultsto "ClusterFirst".

false string

nodeSelector NodeSelector is aselector whichmust be true forthe pod to fit on anode. Selectorwhich must matcha node’s labels forthe pod to bescheduled on thatnode. More info:http://releases.k8s.io/HEAD/docs/user-guide/node-selection/README.md


host deprecated, usenodeNameinstead

false string

serviceAccountName

ServiceAccountName is the nameof theServiceAccount touse to run thispod. More info:http://releases.k8s.io/HEAD/docs/design/service_accounts.md

false string



423

http://releases.k8s.io/HEAD/docs/user-guide/node-selection/README.md

http://releases.k8s.io/HEAD/docs/design/service_accounts.md

serviceAccount DeprecatedServiceAccount is adepreciated aliasforServiceAccountName. Deprecated:UseserviceAccountName instead.

false string

nodeName NodeName is arequest toschedule this podonto a specificnode. If it is non-empty, thescheduler simplyschedules thispod onto thatnode, assumingthat it fitsresourcerequirements.

false string

hostNetwork Host networkingrequested for thispod. Use thehost’s networknamespace. If thisoption is set, theports that will beused must bespecified. Defaultto false.

false boolean false

hostPID Use the host’s pidnamespace.Optional: Defaultto false.

false boolean false

hostIPC Use the host’s ipcnamespace.Optional: Defaultto false.

false boolean false



424

securityContext SecurityContextholds pod-levelsecurity attributesand commoncontainer settings.Optional: Defaultsto empty. Seetype descriptionfor default valuesof each field.

false Section 2.3.96,“v1.PodSecurityContext”

imagePullSecrets ImagePullSecretsis an optional listof references tosecrets in thesame namespaceto use for pullingany of the imagesused by thisPodSpec. Ifspecified, thesesecrets will bepassed toindividual pullerimplementationsfor them to use.For example, inthe case ofdocker, onlyDockerConfigtype secrets arehonored. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/images.md#specifying-imagepullsecrets-on-a-pod

false Section 2.3.117,“v1.LocalObjectReference” array


2.3.68. v1.FlockerVolumeSource

FlockerVolumeSource represents a Flocker volume mounted by the Flocker agent.


425

http://releases.k8s.io/HEAD/docs/user-guide/images.md#specifying-imagepullsecrets-on-a-pod


datasetName Required: thevolume name.This is going to bestore on metadata→ name on thepayload forFlocker

true string

2.3.69. v1.OAuthClientAuthorization



false string


426



false string

metadata


clientName references theclient that createdthis authorization

false string

userName user name thatauthorized thisclient

false string

userUID unique UIDassociated withthis authorization.userUID anduserName mustboth match for thisauthorization tobe valid

false string

scopes list of grantedscopes

false string array


2.3.70. v1.RBDVolumeSource


427



RBDVolumeSource represents a Rados Block Device Mount that lasts the lifetime of a pod


monitors A collection ofCeph monitors.More info:http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it

true string array

image The rados imagename. More info:http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it

true string

fsType Filesystem type ofthe volume thatyou want tomount. Tip:Ensure that thefilesystem type issupported by thehost operatingsystem.Examples: "ext4","xfs", "ntfs". Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#rbd

false string

pool The rados poolname. Default isrbd. More info:http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it.

true string


428

http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it


http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#rbd


user The rados username. Default isadmin. More info:http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it

true string

keyring Keyring is thepath to key ring forRBDUser. Defaultis/etc/ceph/keyring.More info:http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it

true string

secretRef SecretRef isname of theauthenticationsecret forRBDUser. Ifprovidedoverrides keyring.Default is empty.More info:http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it


readOnly ReadOnly herewill force theReadOnly settingin VolumeMounts.Defaults to false.More info:http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it

false boolean false



429





2.3.71. v1.RollingDeploymentStrategyParams


updatePeriodSeconds

the time to waitbetweenindividual podupdates


intervalSeconds the time to waitbetween pollingdeployment statusafter update


timeoutSeconds the time to waitfor updates beforegiving up


maxUnavailable max number ofpods that can beunavailable duringthe update; valuecan be anabsolute numberor a percentage oftotal pods at startof update

false string

maxSurge max number ofpods that can bescheduled abovethe originalnumber of pods;value can be anabsolute numberor a percentage oftotal pods at startof update

false string


430

updatePercent the percentage ofreplicas to scaleup or down eachinterval (negativevalue switchesscale order todown/up insteadof up/down)


pre a hook executedbefore thestrategy starts thedeployment

false Section 2.3.85,“v1.LifecycleHook”

post a hook executedafter the strategyfinishes thedeployment



2.3.72. v1.ImageStreamSpec


dockerImageRepository

optional field ifspecified thisstream is backedby a Dockerrepository on thisserver

false string

tags map arbitrarystring values tospecific imagelocators

false Section 2.3.92,“v1.NamedTagReference” array

2.3.73. v1.BuildLog



431



false string


false string

2.3.74. v1.DeploymentConfigRollback



432





false string


false string

spec options forrollbackgeneration

true Section 2.3.122,“v1.DeploymentConfigRollbackSpec”

2.3.75. v1.SecurityContext


433



SecurityContext holds security configuration that will be applied to a container. Some fields arepresent in both SecurityContext and PodSecurityContext. When both are set, the values inSecurityContext take precedence.


capabilities The capabilities toadd/drop whenrunningcontainers.Defaults to thedefault set ofcapabilitiesgranted by thecontainer runtime.

false Section 2.3.30,“v1.Capabilities”

privileged Run container inprivileged mode.Processes inprivilegedcontainers areessentiallyequivalent to rooton the host.Defaults to false.

false boolean false

seLinuxOptions The SELinuxcontext to beapplied to thecontainer. Ifunspecified, thecontainer runtimewill allocate arandom SELinuxcontext for eachcontainer. Mayalso be set inPodSecurityContext. If set in bothSecurityContextandPodSecurityContext, the valuespecified inSecurityContexttakesprecedence.

false Section 2.3.131,“v1.SELinuxOptions”


434

runAsUser The UID to runthe entrypoint ofthe containerprocess. Defaultsto user specifiedin imagemetadata ifunspecified. Mayalso be set inPodSecurityContext. If set in bothSecurityContextandPodSecurityContext, the valuespecified inSecurityContexttakesprecedence.


runAsNonRoot Indicates that thecontainer mustrun as a non-rootuser. If true, theKubelet willvalidate the imageat runtime toensure that itdoes not run asUID 0 (root) andfail to start thecontainer if itdoes. If unset orfalse, no suchvalidation will beperformed. Mayalso be set inPodSecurityContext. If set in bothSecurityContextandPodSecurityContext, the valuespecified inSecurityContexttakesprecedence.

false boolean false



435

2.3.76. v1.NamedRole


name name of the role true string

role the role true Section 2.3.46,“v1.Role”

2.3.77. v1.Identity



false string


436



false string

metadata


providerName source of identityinformation

true string

providerUserName

uniquelyrepresents thisidentity in thescope of theprovider

true string

user reference to theuser this identity isassociated with.both name anduid must be set


extra extra informationfor this identity



2.3.78. v1.UserIdentityMapping


437




false string


false string

metadata


identity reference to anidentity



438



user reference to auser



2.3.79. v1.Template



false string


439



false string

metadata


objects list of objects toinclude in thetemplate

true Section 2.3.156,“runtime.RawExtension” array

parameters optional: list ofparameters usedduring template toconfigtransformation

false Section 2.3.18,“v1.Parameter”array

labels optional: list oflables that areapplied to everyobject during thetemplate to configtransformation



2.3.80. v1.GCEPersistentDiskVolumeSource

GCEPersistentDiskVolumeSource represents a Persistent Disk resource in Google ComputeEngine.


440


A GCE PD must exist and be formatted before mounting to a container. The disk must also be in thesame GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once.


pdName Unique name ofthe PD resourcein GCE. Used toidentify the disk inGCE. More info:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk

true string

fsType Filesystem type ofthe volume thatyou want tomount. Tip:Ensure that thefilesystem type issupported by thehost operatingsystem.Examples: "ext4","xfs", "ntfs". Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk

true string


441



partition The partition inthe volume thatyou want tomount. If omitted,the default is tomount by volumename. Examples:For volume/dev/sda1, youspecify thepartition as "1".Similarly, thevolume partitionfor /dev/sda is "0"(or you can leavethe propertyempty). More info:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk


readOnly ReadOnly herewill force theReadOnly settingin VolumeMounts.Defaults to false.More info:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk

false boolean false


2.3.81. v1.DeploymentConfigSpec


strategy how a deploymentis executed

true Section 2.3.166,“v1.DeploymentStrategy”


442



triggers how newdeployments aretriggered

true Section 2.3.134,“v1.DeploymentTriggerPolicy” array

replicas the desirednumber ofreplicas


selector a label query overpods that shouldmatch the replicascount

true Section 2.3.171,“any”

template describes the podthat will becreated ifinsufficientreplicas aredetected; takesprecedence overa templatereference

false Section 2.3.25,“v1.PodTemplateSpec”


2.3.82. v1.ClusterPolicy



443


false string


false string

metadata


lastModified last time any partof the object wascreated, updated,or deleted

true string



444



roles all the roles heldby this policy,mapped by rolename

true Section 2.3.116,“v1.NamedClusterRole” array


2.3.83. v1.EnvVarSource

EnvVarSource represents a source for the value of an EnvVar.


fieldRef Selects a field ofthe pod. Onlyname andnamespace aresupported.


2.3.84. v1.UserList



false string


445



false string

metadata


items list of users true Section 2.3.10,“v1.User” array


2.3.85. v1.LifecycleHook


failurePolicy what action totake if the hookfails

true string

execNewPod options for anExecNewPodHook

false Section 2.3.130,“v1.ExecNewPodHook”

2.3.86. unversioned.ListMeta


446


ListMeta describes metadata that synthetic resources must have, including lists and various statusobjects. A resource may have only one of {ObjectMeta, ListMeta}.


selfLink SelfLink is a URLrepresenting thisobject. Populatedby the system.Read-only.

false string

resourceVersion String thatidentifies theserver’s internalversion of thisobject that can beused by clients todetermine whenobjects havechanged. Valuemust be treatedas opaque byclients andpassedunmodified backto the server.Populated by thesystem. Read-only. More info:http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency

false string

2.3.87. v1.GitSourceRevision


commit hash identifying aspecific commit

false string


447

http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency

author author of aspecific commit

false Section 2.3.65,“v1.SourceControlUser”

committer committer of aspecific commit

false Section 2.3.65,“v1.SourceControlUser”

message description of aspecific commit

false string


2.3.88. v1.PolicyRule


verbs list of verbs thatapply to ALL theresourceKindsandattributeRestrictions contained inthis rule. The verb* represents allkinds.

true string array

attributeRestrictions

vary dependingon what theauthorizersupports. If theauthorizer doesnot recognize howto handle thespecified value, itshould report anerror.

false string

apiGroups list of API groupsthis rule appliesto. * represents allAPI groups.

true string array


448

resources list of resourcesthis rule appliesto. * represents allresources.

true string array

resourceNames optional white listof names that therule applies to. Anempty set meansthat everything isallowed.

false string array

nonResourceURLs

set of partial urlsthat a user shouldhave access to.*s are allowed,but only as thefull, final step inthe path.

false string array


2.3.89. integer

2.3.90. v1.VolumeMount

VolumeMount describes a mounting of a Volume within a container.


name This must matchthe Name of aVolume.

true string

readOnly Mounted read-only if true, read-write otherwise(false orunspecified).Defaults to false.

false boolean false


449

mountPath Path within thecontainer at whichthe volume shouldbe mounted.

true string


2.3.91. v1.DeploymentCause


type the type of triggerthat resulted in anew deployment

true string

imageTrigger image triggerdetails (ifapplicable)

false Section 2.3.95,“v1.DeploymentCauseImageTrigger”

2.3.92. v1.NamedTagReference


name name of tag true string

annotations annotationsassociated withimages using thistag


from a reference to animage stream tagor image streamthis tag shouldtrack



450

reference if true considerthis tag areference onlyand do notattempt to importmetadata aboutthe image

false boolean false


2.3.93. v1.OAuthClient



false string


451



false string

metadata


secret unique secretassociated with aclient

false string

respondWithChallenges

indicates whetherthe client wantsauthenticationneededresponses madein the form ofchallengesinstead ofredirects

false boolean false

redirectURIs valid redirectionURIs associatedwith a client

false string array


2.3.94. v1.ImageStreamList


452




false string


false string

metadata


items list of imagestream objects

true Section 2.3.155,“v1.ImageStream”array


453



2.3.95. v1.DeploymentCauseImageTrigger


from a reference thechanged objectwhich triggered adeployment


2.3.96. v1.PodSecurityContext

PodSecurityContext holds pod-level security attributes and common container settings. Some fieldsare also present in container.securityContext. Field values of container.securityContext takeprecedence over field values of PodSecurityContext.


seLinuxOptions The SELinuxcontext to beapplied to allcontainers. Ifunspecified, thecontainer runtimewill allocate arandom SELinuxcontext for eachcontainer. Mayalso be set inSecurityContext. Ifset in bothSecurityContextandPodSecurityContext, the valuespecified inSecurityContexttakes precedencefor that container.



454

runAsUser The UID to runthe entrypoint ofthe containerprocess. Defaultsto user specifiedin imagemetadata ifunspecified. Mayalso be set inSecurityContext. Ifset in bothSecurityContextandPodSecurityContext, the valuespecified inSecurityContexttakes precedencefor that container.


runAsNonRoot Indicates that thecontainer mustrun as a non-rootuser. If true, theKubelet willvalidate the imageat runtime toensure that itdoes not run asUID 0 (root) andfail to start thecontainer if itdoes. If unset orfalse, no suchvalidation will beperformed. Mayalso be set inSecurityContext. Ifset in bothSecurityContextandPodSecurityContext, the valuespecified inSecurityContexttakesprecedence.

false boolean false



455

supplementalGroups

A list of groupsapplied to the firstprocess run ineach container, inaddition to thecontainer’sprimary GID. Ifunspecified, nogroups will beadded to anycontainer.

false Section 2.3.89,“integer” array

fsGroup A specialsupplementalgroup that appliesto all containers ina pod. Somevolume typesallow the Kubeletto change theownership of thatvolume to beowned by the pod:

1. The owningGID will be theFSGroup 2. Thesetgid bit is set(new files createdin the volume willbe owned byFSGroup) 3. Thepermission bitsare OR’d with rw-rw



2.3.97. v1.IdentityList



456


false string


false string

metadata


items list of identities true Section 2.3.77,“v1.Identity” array



457



2.3.98. patch.Object

represents an object patch, which may be any of: JSON patch (RFC 6902), JSON merge patch(RFC 7396), or the Kubernetes strategic merge patch

2.3.99. v1.Image



false string


false string


458



metadata


dockerImageReference

string that can beused to pull thisimage

false string

dockerImageMetadata

metadata aboutthis image

false string

dockerImageMetadataVersion

conveys versionof the object, ifempty defaults to'1.0'

false string

dockerImageManifest

raw JSON of themanifest

false string


2.3.100. v1.ImageStreamImage



false string


459



false string

metadata


image the imageassociated withthe ImageStreamand image name

true Section 2.3.99,“v1.Image”


2.3.101. v1.RouteSpec


host optional: alias/dnsthat points to theservice, mustfollow DNS 952subdomainconventions

true string


460


path optional: path thatthe routerwatches to routetraffic to theservice

false string

to an object theroute points to.only the servicekind is allowed,and it will bedefaulted to aservice.


port port that shouldbe used by therouter; this is ahint to controlwhich podendpoint port isused; if emptyrouters may useall endpoints andports

false Section 2.3.150,“v1.RoutePort”

tls provides theability to configurecertificates andtermination for theroute

false Section 2.3.45,“v1.TLSConfig”


2.3.102. v1.BuildList



461


false string


false string

metadata


items list of builds true Section 2.3.26,“v1.Build” array



462



2.3.103. v1.RecreateDeploymentStrategyParams


pre a hook executedbefore thestrategy starts thedeployment


post a hook executedafter the strategyfinishes thedeployment


2.3.104. v1.EmptyDirVolumeSource

EmptyDirVolumeSource is temporary directory that shares a pod’s lifetime.


medium What type ofstorage mediumshould back thisdirectory. Thedefault is "" whichmeans to use thenode’s defaultmedium. Must bean empty string(default) orMemory. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#emptydir

false string

2.3.105. v1.BuildSource



463


type type of build inputto accept

true string

binary the binary will beprovided by thebuilder as anarchive or file tobe placed withinthe inputdirectory; allowsDockerfile to beoptionally set;may not be setwith git sourcetype also set

false Section 2.3.119,“v1.BinaryBuildSource”

dockerfile the contents of aDockerfile tobuild; FROM maybe overridden byyour strategysource, andadditional ENVfrom your strategywill be placedbefore the rest ofthe Dockerfilestanzas

false string

git optionalinformation aboutgit build source

false Section 2.3.3,“v1.GitBuildSource”

contextDir specifies sub-directory wherethe source codefor the applicationexists, allows forsources to be builtfrom a directoryother than theroot of arepository

false string



464

sourceSecret supported authmethods are: ssh-privatekey



2.3.106. v1.HTTPGetAction

HTTPGetAction describes an action based on HTTP Get requests.


path Path to access onthe HTTP server.

false string

port Name or numberof the port toaccess on thecontainer.Number must bein the range 1 to65535. Namemust be anIANA_SVC_NAME.

true string

host Host name toconnect to,defaults to thepod IP.

false string

scheme Scheme to use forconnecting to thehost. Defaults toHTTP.

false string

2.3.107. v1.WebHookTrigger



465

secret secret used tovalidate requests

false string


2.3.108. v1.DeploymentDetails


message a user specifiedchange message

false string

causes extended dataassociated withall the causes forcreating a newdeployment

false Section 2.3.91,“v1.DeploymentCause” array

2.3.109. v1.Probe

Probe describes a liveness probe to be examined to the container.







466



initialDelaySeconds

Number ofseconds after thecontainer hasstarted beforeliveness probesare initiated. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes


timeoutSeconds Number ofseconds afterwhich livenessprobes timeout.Defaults to 1second. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes



2.3.110. v1.NamedClusterRoleBinding


name name of thecluster rolebinding

true string


467



roleBinding the cluster rolebinding



2.3.111. v1.ISCSIVolumeSource

ISCSIVolumeSource describes an ISCSI Disk can only be mounted as read/write once.


targetPortal iSCSI targetportal. The portalis either an IP orip_addr:port if theport is other thandefault (typicallyTCP ports 860and 3260).

true string

iqn Target iSCSIQualified Name.

true string

lun iSCSI target lunnumber.


fsType Filesystem type ofthe volume thatyou want tomount. Tip:Ensure that thefilesystem type issupported by thehost operatingsystem.Examples: "ext4","xfs", "ntfs". Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#iscsi

true string


468

http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#iscsi

readOnly ReadOnly herewill force theReadOnly settingin VolumeMounts.Defaults to false.

false boolean false


2.3.112. v1.GitRepoVolumeSource

GitRepoVolumeSource represents a volume that is pulled from git when the pod is created.


repository Repository URL true string

revision Commit hash forthe specifiedrevision.

true string

2.3.113. v1.ObjectMeta

ObjectMeta is metadata that all persisted resources must have, which includes all objects usersmust create.



469

name Name must beunique within anamespace. Isrequired whencreatingresources,although someresources mayallow a client torequest thegeneration of anappropriate nameautomatically.Name is primarilyintended forcreationidempotence andconfigurationdefinition. Cannotbe updated. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names

false string

generateName GenerateName isan optional prefix,used by theserver, togenerate a uniquename ONLY IFthe Name fieldhas not beenprovided. If thisfield is used, thename returned tothe client will bedifferent than thename passed.This value willalso be combinedwith a uniquesuffix. Theprovided valuehas the samevalidation rules asthe Name field,and may betruncated by the

false string



470


length of the suffixrequired to makethe value uniqueon the server.

If this field isspecified and thegenerated nameexists, the serverwill NOT return a409 - instead, itwill either return201 Created or500 with ReasonServerTimeoutindicating aunique namecould not befound in the timeallotted, and theclient should retry(optionally afterthe time indicatedin the Retry-Afterheader).

Applied only ifName is notspecified. Moreinfo:http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#idempotency



471

http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#idempotency

namespace Namespacedefines the spacewithin each namemust be unique.An emptynamespace isequivalent to the"default"namespace, but"default" is thecanonicalrepresentation.Not all objects arerequired to bescoped to anamespace - thevalue of this fieldfor those objectswill be empty.

Must be aDNS_LABEL.Cannot beupdated. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/namespaces.md

false string


false string



472

http://releases.k8s.io/HEAD/docs/user-guide/namespaces.md

uid UID is the uniquein time and spacevalue for thisobject. It istypicallygenerated by theserver onsuccessfulcreation of aresource and isnot allowed tochange on PUToperations.

Populated by thesystem. Read-only. More info:http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#uids

false string



473

http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#uids

resourceVersion An opaque valuethat representsthe internalversion of thisobject that can beused by clients todetermine whenobjects havechanged. May beused for optimisticconcurrency,change detection,and the watchoperation on aresource or set ofresources. Clientsmust treat thesevalues as opaqueand passedunmodified backto the server.They may only bevalid for aparticularresource or set ofresources.

Populated by thesystem. Read-only. Value mustbe treated asopaque by clientsand . More info:http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency

false string



474


generation A sequencenumberrepresenting aspecificgeneration of thedesired state.Currently onlyimplemented byreplicationcontrollers.Populated by thesystem. Read-only.


creationTimestamp

CreationTimestamp is a timestamprepresenting theserver time whenthis object wascreated. It is notguaranteed to beset in happens-before orderacross separateoperations.Clients may notset this value. It isrepresented inRFC3339 formand is in UTC.

Populated by thesystem. Read-only. Null for lists.More info:http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false string

deletionTimestamp

DeletionTimestamp is RFC 3339date and time atwhich thisresource will bedeleted. This fieldis set by theserver when agraceful deletion

false string



475


is requested bythe user, and isnot directlysettable by aclient. Theresource will bedeleted (no longervisible fromresource lists, andnot reachable byname) after thetime in this field.Once set, thisvalue may not beunset or be setfurther into thefuture, although itmay be shortenedor the resourcemay be deletedprior to this time.For example, auser may requestthat a pod isdeleted in 30seconds. TheKubelet will reactby sending agracefultermination signalto the containersin the pod. Oncethe resource isdeleted in theAPI, the Kubeletwill send a hardtermination signalto the container. Ifnot set, gracefuldeletion of theobject has notbeen requested.

Populated by thesystem when agraceful deletionis requested.Read-only. Moreinfo:http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata



476


deletionGracePeriodSeconds

Number ofseconds allowedfor this object togracefullyterminate before itwill be removedfrom the system.Only set whendeletionTimestamp is also set. Mayonly beshortened. Read-only.


labels Map of string keysand values thatcan be used toorganize andcategorize (scopeand select)objects. Maymatch selectors ofreplicationcontrollers andservices. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/labels.md




477

http://releases.k8s.io/HEAD/docs/user-guide/labels.md

annotations Annotations is anunstructured keyvalue map storedwith a resourcethat may be setby external toolsto store andretrieve arbitrarymetadata. Theyare not queryableand should bepreserved whenmodifying objects.More info:http://releases.k8s.io/HEAD/docs/user-guide/annotations.md



2.3.114. v1.Project

Projects are the unit of isolation and collaboration in OpenShift. A project has one or more members,a quota on the resources that the project may consume, and the security controls on the resourcesin the project. Within a project, members may have different roles - project administrators can setmembership, editors can create and manage the resources, and viewers can see but not accessrunning containers. In a normal cluster project administrators are not able to alter their quotas - thatis restricted to cluster administrators.



478

http://releases.k8s.io/HEAD/docs/user-guide/annotations.md


false string


false string

metadata


spec spec defines thebehavior of theProject

false Section 2.3.169,“v1.ProjectSpec”



479



status status describesthe current statusof a Project; read-only

false Section 2.3.59,“v1.ProjectStatus”


2.3.115. v1.DeploymentConfigStatus


latestVersion used to determinewhether thecurrentdeployment is outof sync


details reasons for thelast update to theconfig

false Section 2.3.108,“v1.DeploymentDetails”

2.3.116. v1.NamedClusterRole


name name of thecluster role

true string

role the cluster role true Section 2.3.153,“v1.ClusterRole”

2.3.117. v1.LocalObjectReference

LocalObjectReference contains enough information to let you locate the referenced object inside thesame namespace.


480


name Name of thereferent. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names

false string

2.3.118. v1.OAuthAuthorizeToken



false string


481




false string

metadata


clientName references theclient that createdthis token

false string

expiresIn seconds fromcreation timebefore this tokenexpires


scopes list of requestedscopes

false string array

redirectURI redirection URIassociated withthe token

false string

state state data fromrequest

false string



482


userName user nameassociated withthis token

false string

userUID unique UIDassociated withthis token.userUID anduserName mustboth match for thistoken to be valid

false string


2.3.119. v1.BinaryBuildSource


asFile indicate theprovided binaryshould beconsidered asingle file placedwithin the root ofthe input; must bea valid filenamewith no pathsegments

false string

2.3.120. v1.BuildSpec


serviceAccount the name of theservice account touse to run podscreated by thebuild, pod will beallowed to usesecretsreferenced by theservice account

false string


483

source describes thesource controlmanagementsystem in use

false Section 2.3.105,“v1.BuildSource”

revision specific revision inthe sourcerepository


strategy defines how toperform a build

true Section 2.3.54,“v1.BuildStrategy”

output describes theoutput of a buildthat a strategyshould produce

false Section 2.3.135,“v1.BuildOutput”

resources the desiredcomputeresources thebuild should have


completionDeadlineSeconds

optional durationin seconds thebuild may beactive on a nodebefore the systemwill actively try tomark it failed andkill associatedcontainers; valuemust be a positiveinteger



2.3.121. v1.ClusterPolicyBindingList



484


false string


false string

metadata




485



items list of clusterpolicy bindings

true Section 2.3.12,“v1.ClusterPolicyBinding” array


2.3.122. v1.DeploymentConfigRollbackSpec


from a reference to adeployment,which is aReplicationController


includeTriggers whether to includeold config triggersin the rollback

true boolean false

includeTemplate whether to includethe old podtemplate spec inthe rollback

true boolean false

includeReplicationMeta

whether to includethe replica countand replicaselector in therollback

true boolean false

includeStrategy whether to includethe deploymentstrategy in therollback

true boolean false

2.3.123. v1.NamedTagEventList


486


tag the tag true string

items list of tag eventsrelated to the tag

true Section 2.3.164,“v1.TagEvent”array

2.3.124. v1.ContainerPort

ContainerPort represents a network port in a single container.


name If specified, thismust be anIANA_SVC_NAME and uniquewithin the pod.Each named portin a pod musthave a uniquename. Name forthe port that canbe referred to byservices.

false string

hostPort Number of port toexpose on thehost. If specified,this must be avalid port number,0 < x < 65536. IfHostNetwork isspecified, thismust matchContainerPort.Most containersdo not need this.



487

containerPort Number of port toexpose on thepod’s IP address.This must be avalid port number,0 < x < 65536.


protocol Protocol for port.Must be UDP orTCP. Defaults to"TCP".

false string

hostIP What host IP tobind the externalport to.

false string


2.3.125. v1.NamedRoleBinding


name name of theroleBinding

true string

roleBinding the roleBinding true Section 2.3.142,“v1.RoleBinding”

2.3.126. v1.DownwardAPIVolumeSource

DownwardAPIVolumeSource represents a volume containing downward API info


items Items is a list ofdownward APIvolume file

false Section 2.3.63,“v1.DownwardAPIVolumeFile” array

2.3.127. v1.CinderVolumeSource


488

CinderVolumeSource represents a cinder volume resource in Openstack. A Cinder volume mustexist before mounting to a container. The volume must also be in the same region as the kubelet.


volumeID volume id used toidentify thevolume in cinderMore info:http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

true string

fsType Required:Filesystem type tomount. Must be afilesystem typesupported by thehost operatingsystem. Only ext3and ext4 areallowed Moreinfo:http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

false string

readOnly Optional: Defaultsto false(read/write).ReadOnly herewill force theReadOnly settingin VolumeMounts.More info:http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

false boolean false

2.3.128. v1.SourceBuildStrategy


489





from reference to animage stream,image stream tag,or image streamimage from whichthe Docker imageshould be pulled


pullSecret supported type:dockercfg


env additionalenvironmentvariables youwant to pass intoa buildercontainer


scripts location of thesource scripts

false string

incremental forces the sourcebuild to doincremental buildsif true

false boolean false

forcePull forces the sourcebuild to pull theimage if true

false boolean false

2.3.129. v1.BuildConfigStatus


lastVersion used to informabout number oflast triggeredbuild



490

2.3.130. v1.ExecNewPodHook


command the hookcommand and itsarguments

true string array

env environmentvariables providedto the hookcontainer


containerName the name of acontainer from thepod templatewhose image willbe used for thehook container

true string

volumes the names ofvolumes from thepod templatewhich should beincluded in thehook pod; anempty list meansno volumes willbe copied, andnames not foundin the pod specwill be ignored

false string array

2.3.131. v1.SELinuxOptions

SELinuxOptions are the labels to be applied to the container


user User is a SELinuxuser label thatapplies to thecontainer.

false string


491

role Role is a SELinuxrole label thatapplies to thecontainer.

false string

type Type is a SELinuxtype label thatapplies to thecontainer.

false string

level Level is SELinuxlevel label thatapplies to thecontainer.

false string


2.3.132. v1.ObjectReference

ObjectReference contains enough information to let you inspect or modify the referred object.


kind Kind of thereferent. Moreinfo:http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false string

namespace Namespace of thereferent. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/namespaces.md

false string


492




false string

uid UID of thereferent. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#uids

false string

apiVersion API version of thereferent.

false string

resourceVersion SpecificresourceVersionto which thisreference ismade, if any.More info:http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency

false string



493




fieldPath If referring to apiece of an objectinstead of anentire object, thisstring shouldcontain a validJSON/Go fieldaccess statement,such asdesiredState.manifest.containers[2].For example, ifthe objectreference is to acontainer within apod, this wouldtake on a valuelike:"spec.containers{name}" (where"name" refers tothe name of thecontainer thattriggered theevent) or if nocontainer name isspecified"spec.containers[2]" (container withindex 2 in thispod). This syntaxis chosen only tohave some well-defined way ofreferencing a partof an object.

false string


2.3.133. v1.DockerBuildStrategy



494

from reference toimage stream,image stream tag,or image streamimage from whichdocker imageshould be pulled,resulting imagewill be used in theFROM line for theDockerfile for thisbuild




noCache if true, indicatesthat the Dockerbuild must beexecuted with the--no-cache=trueflag

false boolean false



forcePull forces the sourcebuild to pull theimage if true

false boolean false

dockerfilePath path of theDockerfile to usefor building theDocker image,relative to thecontextDir, if set

false string


2.3.134. v1.DeploymentTriggerPolicy


495


type the type of thetrigger

false string

imageChangeParams

input to theImageChangetrigger

false Section 2.3.170,“v1.DeploymentTriggerImageChangeParams”

2.3.135. v1.BuildOutput


to The optionalimage stream topush the output ofthis build. Thenamespace maybe empty, inwhich case, theimage stream willbe looked upbased on thenamespace of thebuild.


pushSecret supported type:dockercfg


2.3.136. v1.ClusterRoleBindingList



496


false string


false string

metadata


items list of cluster rolebindings

true Section 2.3.47,“v1.ClusterRoleBinding” array



497



2.3.137. v1.ObjectFieldSelector

ObjectFieldSelector selects an APIVersioned field of an object.


apiVersion Version of theschema theFieldPath iswritten in termsof, defaults to"v1".

false string

fieldPath Path of the field toselect in thespecified APIversion.

true string

2.3.138. v1.OAuthAccessTokenList



false string


498



false string

metadata


items list of oauthaccess tokens

true Section 2.3.34,“v1.OAuthAccessToken” array


2.3.139. v1.Lifecycle

Lifecycle describes actions that the management system should take in response to containerlifecycle events. For the PostStart and PreStop lifecycle handlers, management of the containerblocks until the action is complete, unless the container process fails, in which case the handler isaborted.



499


postStart PostStart is calledimmediately aftera container iscreated. If thehandler fails, thecontainer isterminated andrestartedaccording to itsrestart policy.Othermanagement ofthe containerblocks until thehook completes.More info:http://releases.k8s.io/HEAD/docs/user-guide/container-environment.md#hook-details

false Section 2.3.61,“v1.Handler”



500

http://releases.k8s.io/HEAD/docs/user-guide/container-environment.md#hook-details

preStop PreStop is calledimmediatelybefore a containeris terminated. Thecontainer isterminated afterthe handlercompletes. Thereason fortermination ispassed to thehandler.Regardless of theoutcome of thehandler, thecontainer iseventuallyterminated. Othermanagement ofthe containerblocks until thehook completes.More info:http://releases.k8s.io/HEAD/docs/user-guide/container-environment.md#hook-details



2.3.140. v1.RoleList



501



false string


false string

metadata


items list of roles true Section 2.3.46,“v1.Role” array



502



2.3.141. v1.OAuthClientAuthorizationList



false string


false string

metadata



503



items list of oauth clientauthorizations

true Section 2.3.69,“v1.OAuthClientAuthorization” array


2.3.142. v1.RoleBinding



false string


504



false string

metadata


userNames all the usernamesdirectly bound tothe role

true string array

groupNames all the groupsdirectly bound tothe role

true string array

subjects references tosubjects bound tothe role. OnlyUser, Group,SystemUser,SystemGroup,andServiceAccountare allowed.

true Section 2.3.132,“v1.ObjectReference” array

roleRef a reference to arole




505


2.3.143. v1.BuildConfigSpec


triggers determines hownew builds can belaunched from abuild config. if notriggers aredefined, a newbuild can onlyoccur as a resultof an explicit clientbuild creation.

true Section 2.3.21,“v1.BuildTriggerPolicy” array

serviceAccount the name of theservice account touse to run podscreated by thebuild, pod will beallowed to usesecretsreferenced by theservice account

false string

source describes thesource controlmanagementsystem in use

false Section 2.3.105,“v1.BuildSource”

revision specific revision inthe sourcerepository


strategy defines how toperform a build

true Section 2.3.54,“v1.BuildStrategy”

output describes theoutput of a buildthat a strategyshould produce

false Section 2.3.135,“v1.BuildOutput”


506

resources the desiredcomputeresources thebuild should have


completionDeadlineSeconds

optional durationin seconds thebuild may beactive on a nodebefore the systemwill actively try tomark it failed andkill associatedcontainers; valuemust be a positiveinteger



2.3.144. v1.ImageStreamMapping



false string


507



false string

metadata


image a Docker image true Section 2.3.99,“v1.Image”

tag string value thisimage can belocated withinside the stream

true string


2.3.145. json.WatchEvent


type the type of watchevent; may beADDED,MODIFIED,DELETED, orERROR

false string


508


object the object beingwatched; willmatch the type ofthe resourceendpoint or be aStatus object ifthe type isERROR

false string


2.3.146. v1.AWSElasticBlockStoreVolumeSource

Represents a persistent disk resource in AWS.

An Amazon Elastic Block Store (EBS) must already be created, formatted, and reside in the sameAWS zone as the kubelet before it can be mounted. Note: Amazon EBS volumes can be mounted toonly one instance at a time.


volumeID Unique ID of thepersistent diskresource in AWS(Amazon EBSvolume). Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore

true string


509


fsType Filesystem type ofthe volume thatyou want tomount. Tip:Ensure that thefilesystem type issupported by thehost operatingsystem.Examples: "ext4","xfs", "ntfs". Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore

true string

partition The partition inthe volume thatyou want tomount. If omitted,the default is tomount by volumename. Examples:For volume/dev/sda1, youspecify thepartition as "1".Similarly, thevolume partitionfor /dev/sda is "0"(or you can leavethe propertyempty).




510


readOnly Specify "true" toforce and set theReadOnlyproperty inVolumeMounts to"true". If omitted,the default is"false". More info:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore

false boolean false


2.3.147. v1.ClusterPolicyList



false string


511




false string

metadata


items list of clusterpolicies

true Section 2.3.82,“v1.ClusterPolicy”array


2.3.148. v1.LocalResourceAccessReview

Local Resource Access Reviews are objects that allow you to determine which users and groupscan perform a given action in a given namespace.



512



false string


false string


true string


true string



513




true string


true string


false string


2.3.149. v1.CustomBuildStrategy


from reference to animage stream,image stream tag,or image streamimage from whichthe Docker imageshould be pulled





514



exposeDockerSocket

allow runningDockercommands (andbuild Dockerimages) frominside thecontainer

false boolean false

forcePull forces pulling ofbuilder imagefrom remoteregistry if true

false boolean false

secrets a list of secrets toinclude in thebuild pod inaddition to pull,push and sourcesecrets

false Section 2.3.39,“v1.SecretSpec”array


2.3.150. v1.RoutePort


targetPort the target port onthe endpoints forthe service; if thisis a string mustmatch the namedport, if an integer,must match theport number

true string

2.3.151. v1.ProjectList


515



false string


false string

metadata


items list of projects true Section 2.3.114,“v1.Project” array


516



2.3.152. v1.CustomDeploymentStrategyParams


image a Docker imagewhich can carryout a deployment

false string

environment environmentvariables providedto the deploymentprocess container


command optionallyoverrides thecontainercommand (defaultis specified by theimage)

false string array

2.3.153. v1.ClusterRole



false string


517



false string

metadata


rules list of policy rules true Section 2.3.88,“v1.PolicyRule”array


2.3.154. v1.Route

A route allows developers to expose services through an HTTP(S) aware load balancing and proxylayer via a public DNS entry. The route may further specify TLS options and a certificate, or specifya public CNAME that the router should also accept for HTTP and HTTPS traffic. An administratortypically configures their router to be visible outside the cluster firewall, and may also add additionalsecurity, caching, or traffic controls on the service content. Routers usually talk directly to theservice endpoints.



518



false string


false string

metadata


spec desired state ofthe route

true Section 2.3.101,“v1.RouteSpec”



519



status current state ofthe route

true Section 2.3.20,“v1.RouteStatus”


2.3.155. v1.ImageStream



false string


false string


520



metadata


spec desired state ofthe stream

true Section 2.3.72,“v1.ImageStreamSpec”

status current state ofthe stream asobserved by thesystem

false Section 2.3.44,“v1.ImageStreamStatus”


2.3.156. runtime.RawExtension

this may be any JSON object with a 'kind' and 'apiVersion' field; and is preserved unmodified byprocessing

2.3.157. v1.ImageChangeTrigger


lastTriggeredImageID

used internally tosave last usedimage ID for build

false string

from reference to anImageStreamTagthat will triggerthe build


2.3.158. v1.EnvVar

EnvVar represents an environment variable present in a Container.



521

name Name of theenvironmentvariable. Must bea C_IDENTIFIER.

true string

value Variablereferences$(VAR_NAME)are expandedusing theprevious definedenvironmentvariables in thecontainer and anyserviceenvironmentvariables. If avariable cannotbe resolved, thereference in theinput string will beunchanged. The$(VAR_NAME)syntax can beescaped with adouble , ie:(VAR_NAME).Escapedreferences willnever beexpanded,regardless ofwhether thevariable exists ornot. Defaults to "".

false string

valueFrom Source for theenvironmentvariable’s value.Cannot be used ifvalue is notempty.

false Section 2.3.83,“v1.EnvVarSource”


2.3.159. unversioned.StatusCause

StatusCause provides more information about an api.Status failure, including cases when multipleerrors are encountered.


522


reason A machine-readabledescription of thecause of theerror. If this valueis empty there isno informationavailable.

false string

message A human-readabledescription of thecause of theerror. This fieldmay be presentedas-is to a reader.

false string

field The field of theresource that hascaused this error,as named by itsJSONserialization. Mayinclude dot andpostfix notation fornested attributes.Arrays are zero-indexed. Fieldsmay appear morethan once in anarray of causesdue to fieldshaving multipleerrors. Optional.

Examples:"name" - the field"name" on thecurrent resource"items[0].name" -the field "name"on the first arrayentry in "items"

false string

2.3.160. v1.Policy


523



false string


false string

metadata



524



lastModified last time that anypart of the policywas created,updated, ordeleted

true string

roles roles held by thispolicy

true Section 2.3.76,“v1.NamedRole”array


2.3.161. v1.PolicyBinding



false string


525



false string

metadata


lastModified last time that anypart of the objectwas created,updated, ordeleted

true string

policyRef reference to thepolicy thatcontains all theRoles that thisobject’sroleBindings mayreference


roleBindings all roleBindingsheld by thispolicyBinding

true Section 2.3.125,“v1.NamedRoleBinding” array


2.3.162. v1.RouteList


526




false string


false string

metadata


items list of routes true Section 2.3.154,“v1.Route” array


527



2.3.163. v1.RoleBindingList



false string


false string

metadata



528



items list of rolebindings

true Section 2.3.142,“v1.RoleBinding”array


2.3.164. v1.TagEvent


created when the eventwas created

true string

dockerImageReference

the string that canbe used to pullthis image

true string

image the image true string

2.3.165. v1.FinalizerName

2.3.166. v1.DeploymentStrategy


type the name of adeploymentstrategy

false string

customParams input to theCustomdeploymentstrategy

false Section 2.3.152,“v1.CustomDeploymentStrategyParams”


529

recreateParams input to theRecreatedeploymentstrategy

false Section 2.3.103,“v1.RecreateDeploymentStrategyParams”

rollingParams input to theRollingdeploymentstrategy

false Section 2.3.71,“v1.RollingDeploymentStrategyParams”

resources resourcerequirements toexecute thedeployment



2.3.167. v1.ResourceAccessReview




false string


530



false string


true string


true string


true string


true string


false string


2.3.168. v1.GlusterfsVolumeSource


531


GlusterfsVolumeSource represents a Glusterfs Mount that lasts the lifetime of a pod.


endpoints EndpointsName isthe endpointname that detailsGlusterfstopology. Moreinfo:http://releases.k8s.io/HEAD/examples/glusterfs/README.md#create-a-pod

true string

path Path is theGlusterfs volumepath. More info:http://releases.k8s.io/HEAD/examples/glusterfs/README.md#create-a-pod

true string

readOnly ReadOnly herewill force theGlusterfs volumeto be mountedwith read-onlypermissions.Defaults to false.More info:http://releases.k8s.io/HEAD/examples/glusterfs/README.md#create-a-pod

false boolean false

2.3.169. v1.ProjectSpec



532

http://releases.k8s.io/HEAD/examples/glusterfs/README.md#create-a-pod



finalizers an opaque list ofvalues that mustbe empty topermanentlyremove objectfrom storage

false Section 2.3.165,“v1.FinalizerName” array


2.3.170. v1.DeploymentTriggerImageChangeParams


automatic whether detectionof a new tag valueshould trigger adeployment

false boolean false

containerNames restricts tagupdates to a setof containernames in the pod

false string array

from a reference to anImageRepository,ImageStream, orImageStreamTagto watch forchanges


lastTriggeredImage

the last image tobe triggered

false string

2.3.171. any

Represents an untyped JSON map - see the description of the field for more info about the structureof this object.


533

CHAPTER 3. KUBERNETES V1 REST API

3.1. OVERVIEW

The Kubernetes API allows you to run containerized applications, bind persistent storage, link thoseapplications through service discovery, and manage the cluster infrastructure.

3.1.1. Version information

Version: v1

3.1.2. URI scheme

Host: 127.0.0.1:8443BasePath: /Schemes: HTTPS

3.2. PATHS

3.2.1. get available resources

GET /api/v1

3.2.1.1. Responses



3.2.1.2. Consumes

application/json

3.2.1.3. Produces

application/json

3.2.1.4. Tags

apiv1

3.2.2. create a Binding

POST /api/v1/bindings


534

3.2.2.1. Parameters


QueryParameter


false string

BodyParameter

body

true Section 3.3.115, “v1.Binding”

3.2.2.2. Responses


200 success Section 3.3.115, “v1.Binding”

3.2.2.3. Consumes

/

3.2.2.4. Produces

application/json

3.2.2.5. Tags

apiv1

3.2.3. list objects of kind ComponentStatus

GET /api/v1/componentstatuses

3.2.3.1. Parameters


QueryParameter


false string


535

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


3.2.3.2. Responses


536


200 success Section 3.3.108,“v1.ComponentStatusList”

3.2.3.3. Consumes

/

3.2.3.4. Produces

application/json

3.2.3.5. Tags

apiv1

3.2.4. list or watch objects of kind Endpoints

GET /api/v1/endpoints

3.2.4.1. Parameters


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string


537

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


3.2.4.2. Responses


200 success Section 3.3.59,“v1.EndpointsList”

3.2.4.3. Consumes

/

3.2.4.4. Produces

application/json

3.2.4.5. Tags


538

apiv1

3.2.5. create a Endpoints

POST /api/v1/endpoints

3.2.5.1. Parameters


QueryParameter


false string

BodyParameter

body

true Section 3.3.100,“v1.Endpoints”

3.2.5.2. Responses


200 success Section 3.3.100, “v1.Endpoints”

3.2.5.3. Consumes

/

3.2.5.4. Produces

application/json

3.2.5.5. Tags

apiv1

3.2.6. list or watch objects of kind Event

GET /api/v1/events

3.2.6.1. Parameters


539


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


540


3.2.6.2. Responses


200 success Section 3.3.89, “v1.EventList”

3.2.6.3. Consumes

/

3.2.6.4. Produces

application/json

3.2.6.5. Tags

apiv1

3.2.7. create a Event

POST /api/v1/events

3.2.7.1. Parameters


541


QueryParameter


false string

BodyParameter

body

true Section 3.3.9,“v1.Event”

3.2.7.2. Responses


200 success Section 3.3.9, “v1.Event”

3.2.7.3. Consumes

/

3.2.7.4. Produces

application/json

3.2.7.5. Tags

apiv1

3.2.8. list or watch objects of kind LimitRange

GET /api/v1/limitranges

3.2.8.1. Parameters


QueryParameter


false string


542

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


3.2.8.2. Responses


543


200 success Section 3.3.46,“v1.LimitRangeList”

3.2.8.3. Consumes

/

3.2.8.4. Produces

application/json

3.2.8.5. Tags

apiv1

3.2.9. create a LimitRange

POST /api/v1/limitranges

3.2.9.1. Parameters


QueryParameter


false string

BodyParameter

body

true Section 3.3.125,“v1.LimitRange”

3.2.9.2. Responses


200 success Section 3.3.125, “v1.LimitRange”

3.2.9.3. Consumes


544

/

3.2.9.4. Produces

application/json

3.2.9.5. Tags

apiv1

3.2.10. list or watch objects of kind Namespace

GET /api/v1/namespaces



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string


545

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


3.2.10.2. Responses


200 success Section 3.3.67,“v1.NamespaceList”

3.2.10.3. Consumes

/

3.2.10.4. Produces

application/json

3.2.10.5. Tags


546

apiv1

3.2.11. create a Namespace

POST /api/v1/namespaces



QueryParameter


false string

BodyParameter

body

true Section 3.3.57,“v1.Namespace”

3.2.11.2. Responses


200 success Section 3.3.57, “v1.Namespace”

3.2.11.3. Consumes

/

3.2.11.4. Produces

application/json

3.2.11.5. Tags

apiv1

3.2.12. create a Binding

POST /api/v1/namespaces/{namespace}/bindings



547


QueryParameter


false string

BodyParameter

body


PathParameter


true string

3.2.12.2. Responses



3.2.12.3. Consumes

/

3.2.12.4. Produces

application/json

3.2.12.5. Tags

apiv1

3.2.13. list objects of kind ComponentStatus

GET /api/v1/namespaces/{namespace}/componentstatuses



548


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


549

PathParameter


true string


3.2.13.2. Responses


200 success Section 3.3.108,“v1.ComponentStatusList”

3.2.13.3. Consumes

/

3.2.13.4. Produces

application/json

3.2.13.5. Tags

apiv1

3.2.14. read the specified ComponentStatus

GET /api/v1/namespaces/{namespace}/componentstatuses/{name}


550



QueryParameter


false string

PathParameter


true string

PathParameter

name name of theComponentStatus

true string

3.2.14.2. Responses


200 success Section 3.3.92,“v1.ComponentStatus”

3.2.14.3. Consumes

/

3.2.14.4. Produces

application/json

3.2.14.5. Tags

apiv1

3.2.15. list or watch objects of kind Endpoints

GET /api/v1/namespaces/{namespace}/endpoints



551


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


552

PathParameter


true string


3.2.15.2. Responses


200 success Section 3.3.59,“v1.EndpointsList”

3.2.15.3. Consumes

/

3.2.15.4. Produces

application/json

3.2.15.5. Tags

apiv1

3.2.16. create a Endpoints

POST /api/v1/namespaces/{namespace}/endpoints


553



QueryParameter


false string

BodyParameter

body


PathParameter


true string

3.2.16.2. Responses



3.2.16.3. Consumes

/

3.2.16.4. Produces

application/json

3.2.16.5. Tags

apiv1

3.2.17. read the specified Endpoints

GET /api/v1/namespaces/{namespace}/endpoints/{name}



554


QueryParameter


false string

PathParameter


true string

PathParameter

name name of theEndpoints

true string

3.2.17.2. Responses



3.2.17.3. Consumes

/

3.2.17.4. Produces

application/json

3.2.17.5. Tags

apiv1

3.2.18. replace the specified Endpoints

PUT /api/v1/namespaces/{namespace}/endpoints/{name}



555


QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string

3.2.18.2. Responses



3.2.18.3. Consumes

/

3.2.18.4. Produces

application/json

3.2.18.5. Tags

apiv1

3.2.19. delete a Endpoints

DELETE /api/v1/namespaces/{namespace}/endpoints/{name}



556


QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string

3.2.19.2. Responses



3.2.19.3. Consumes

/

3.2.19.4. Produces

application/json

3.2.19.5. Tags

apiv1

3.2.20. partially update the specified Endpoints


557

PATCH /api/v1/namespaces/{namespace}/endpoints/{name}



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string

3.2.20.2. Responses



3.2.20.3. Consumes




3.2.20.4. Produces

application/json


558

3.2.20.5. Tags

apiv1

3.2.21. list or watch objects of kind Event

GET /api/v1/namespaces/{namespace}/events



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


559

QueryParameter

resourceVersion


false string

PathParameter


true string


3.2.21.2. Responses


200 success Section 3.3.89, “v1.EventList”

3.2.21.3. Consumes

/

3.2.21.4. Produces

application/json

3.2.21.5. Tags

apiv1

3.2.22. create a Event


560

POST /api/v1/namespaces/{namespace}/events



QueryParameter


false string

BodyParameter

body


PathParameter


true string

3.2.22.2. Responses



3.2.22.3. Consumes

/

3.2.22.4. Produces

application/json

3.2.22.5. Tags

apiv1

3.2.23. read the specified Event

GET /api/v1/namespaces/{namespace}/events/{name}


561



QueryParameter


false string

PathParameter


true string

PathParameter

name name of theEvent

true string

3.2.23.2. Responses



3.2.23.3. Consumes

/

3.2.23.4. Produces

application/json

3.2.23.5. Tags

apiv1

3.2.24. replace the specified Event

PUT /api/v1/namespaces/{namespace}/events/{name}



562


QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string

3.2.24.2. Responses



3.2.24.3. Consumes

/

3.2.24.4. Produces

application/json

3.2.24.5. Tags

apiv1

3.2.25. delete a Event

DELETE /api/v1/namespaces/{namespace}/events/{name}



563


QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string

3.2.25.2. Responses



3.2.25.3. Consumes

/

3.2.25.4. Produces

application/json

3.2.25.5. Tags

apiv1

3.2.26. partially update the specified Event

PATCH /api/v1/namespaces/{namespace}/events/{name}


564



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string

3.2.26.2. Responses



3.2.26.3. Consumes




3.2.26.4. Produces

application/json

3.2.26.5. Tags

apiv1


565

3.2.27. list or watch objects of kind LimitRange

GET /api/v1/namespaces/{namespace}/limitranges



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


566

QueryParameter

resourceVersion


false string

PathParameter


true string


3.2.27.2. Responses


200 success Section 3.3.46,“v1.LimitRangeList”

3.2.27.3. Consumes

/

3.2.27.4. Produces

application/json

3.2.27.5. Tags

apiv1

3.2.28. create a LimitRange

POST /api/v1/namespaces/{namespace}/limitranges


567



QueryParameter


false string

BodyParameter

body


PathParameter


true string

3.2.28.2. Responses



3.2.28.3. Consumes

/

3.2.28.4. Produces

application/json

3.2.28.5. Tags

apiv1

3.2.29. read the specified LimitRange

GET /api/v1/namespaces/{namespace}/limitranges/{name}



568


QueryParameter


false string

PathParameter


true string

PathParameter

name name of theLimitRange

true string

3.2.29.2. Responses



3.2.29.3. Consumes

/

3.2.29.4. Produces

application/json

3.2.29.5. Tags

apiv1

3.2.30. replace the specified LimitRange

PUT /api/v1/namespaces/{namespace}/limitranges/{name}



569


QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string

3.2.30.2. Responses



3.2.30.3. Consumes

/

3.2.30.4. Produces

application/json

3.2.30.5. Tags

apiv1

3.2.31. delete a LimitRange

DELETE /api/v1/namespaces/{namespace}/limitranges/{name}


570



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string

3.2.31.2. Responses



3.2.31.3. Consumes

/

3.2.31.4. Produces

application/json

3.2.31.5. Tags

apiv1

3.2.32. partially update the specified LimitRange


571

PATCH /api/v1/namespaces/{namespace}/limitranges/{name}



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string

3.2.32.2. Responses



3.2.32.3. Consumes




3.2.32.4. Produces

application/json

3.2.32.5. Tags


572

3.2.32.5. Tags

apiv1

3.2.33. list or watch objects of kind PersistentVolumeClaim

GET /api/v1/namespaces/{namespace}/persistentvolumeclaims

3.2.33.1. Description

Persistent Volume Claims (PVC) represent a request to use a persistent volume (PV) with a pod.When creating a pod definition (or replication controller or deployment config) a developer mayspecify the amount of storage they need via a persistent volume reference. If an administrator hasenabled and configured persistent volumes for use, they will be allocated on demand to pods thathave similar requirements. Since volumes are created lazily, some pods may be scheduled to anode before their volume is assigned. The node will detect this situation and wait to start the pod untilthe volume is bound. Events will be generated (visible by using the describe command on thepod) that indicate the pod is waiting for volumes.



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string


573

QueryParameter


false boolean

QueryParameter

resourceVersion


false string

PathParameter


true string


3.2.33.3. Responses


200 success Section 3.3.91,“v1.PersistentVolumeClaimList”

3.2.33.4. Consumes

/


574

3.2.33.5. Produces

application/json

3.2.33.6. Tags

apiv1

3.2.34. create a PersistentVolumeClaim

POST /api/v1/namespaces/{namespace}/persistentvolumeclaims



QueryParameter


false string

BodyParameter

body

true Section 3.3.26,“v1.PersistentVolumeClaim”

PathParameter


true string

3.2.34.2. Responses


200 success Section 3.3.26,“v1.PersistentVolumeClaim”

3.2.34.3. Consumes

/


575

3.2.34.4. Produces

application/json

3.2.34.5. Tags

apiv1

3.2.35. read the specified PersistentVolumeClaim

GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}



QueryParameter


false string

PathParameter


true string

PathParameter

name name of thePersistentVolumeClaim

true string

3.2.35.2. Responses



3.2.35.3. Consumes

/

3.2.35.4. Produces


576

application/json

3.2.35.5. Tags

apiv1

3.2.36. replace the specified PersistentVolumeClaim

PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string

3.2.36.2. Responses



3.2.36.3. Consumes


577

/

3.2.36.4. Produces

application/json

3.2.36.5. Tags

apiv1

3.2.37. delete a PersistentVolumeClaim

DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string

3.2.37.2. Responses



578



3.2.37.3. Consumes

/

3.2.37.4. Produces

application/json

3.2.37.5. Tags

apiv1

3.2.38. partially update the specified PersistentVolumeClaim

PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}



QueryParameter


false string

BodyParameter

body


PathParameter


true string


579

PathParameter


true string


3.2.38.2. Responses



3.2.38.3. Consumes




3.2.38.4. Produces

application/json

3.2.38.5. Tags

apiv1

3.2.39. replace status of the specified PersistentVolumeClaim

PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status



QueryParameter


false string


580

BodyParameter

body


PathParameter


true string

PathParameter


true string


3.2.39.2. Responses



3.2.39.3. Consumes

/

3.2.39.4. Produces

application/json

3.2.39.5. Tags

apiv1

3.2.40. list or watch objects of kind Pod

GET /api/v1/namespaces/{namespace}/pods



581


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


582

PathParameter


true string


3.2.40.2. Responses


200 success Section 3.3.78, “v1.PodList”

3.2.40.3. Consumes

/

3.2.40.4. Produces

application/json

3.2.40.5. Tags

apiv1

3.2.41. create a Pod

POST /api/v1/namespaces/{namespace}/pods


583



QueryParameter


false string

BodyParameter

body

true Section 3.3.8,“v1.Pod”

PathParameter


true string

3.2.41.2. Responses


200 success Section 3.3.8, “v1.Pod”

3.2.41.3. Consumes

/

3.2.41.4. Produces

application/json

3.2.41.5. Tags

apiv1

3.2.42. read the specified Pod

GET /api/v1/namespaces/{namespace}/pods/{name}



584


QueryParameter


false string

PathParameter


true string

PathParameter

name name of thePod

true string

3.2.42.2. Responses



3.2.42.3. Consumes

/

3.2.42.4. Produces

application/json

3.2.42.5. Tags

apiv1

3.2.43. replace the specified Pod

PUT /api/v1/namespaces/{namespace}/pods/{name}



585


QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter

name name of thePod

true string

3.2.43.2. Responses



3.2.43.3. Consumes

/

3.2.43.4. Produces

application/json

3.2.43.5. Tags

apiv1

3.2.44. delete a Pod

DELETE /api/v1/namespaces/{namespace}/pods/{name}



586


QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter

name name of thePod

true string

3.2.44.2. Responses



3.2.44.3. Consumes

/

3.2.44.4. Produces

application/json

3.2.44.5. Tags

apiv1

3.2.45. partially update the specified Pod

PATCH /api/v1/namespaces/{namespace}/pods/{name}


587



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter

name name of thePod

true string

3.2.45.2. Responses



3.2.45.3. Consumes




3.2.45.4. Produces

application/json

3.2.45.5. Tags

apiv1


588

3.2.46. connect GET requests to attach of Pod

GET /api/v1/namespaces/{namespace}/pods/{name}/attach



QueryParameter

stdin Stdin if true,redirects thestandard inputstream of thepod for thiscall. Defaultsto false.

false boolean

QueryParameter

stdout Stdout if trueindicates thatstdout is to beredirected forthe attach call.Defaults totrue.

false boolean

QueryParameter

stderr Stderr if trueindicates thatstderr is to beredirected forthe attach call.Defaults totrue.

false boolean


589

QueryParameter

tty TTY if trueindicates thata tty will beallocated forthe attach call.This is passedthrough thecontainerruntime so thetty is allocatedon the workernode by thecontainerruntime.Defaults tofalse.

false boolean

QueryParameter

container The containerin which toexecute thecommand.Defaults toonly containerif there is onlyone containerin the pod.

false string

PathParameter


true string

PathParameter

name name of thePod

true string


3.2.46.2. Responses



3.2.46.3. Consumes


590

3.2.46.3. Consumes

/

3.2.46.4. Produces

/

3.2.46.5. Tags

apiv1

3.2.47. connect POST requests to attach of Pod

POST /api/v1/namespaces/{namespace}/pods/{name}/attach



QueryParameter

stdin Stdin if true,redirects thestandard inputstream of thepod for thiscall. Defaultsto false.

false boolean

QueryParameter

stdout Stdout if trueindicates thatstdout is to beredirected forthe attach call.Defaults totrue.

false boolean

QueryParameter

stderr Stderr if trueindicates thatstderr is to beredirected forthe attach call.Defaults totrue.

false boolean


591

QueryParameter

tty TTY if trueindicates thata tty will beallocated forthe attach call.This is passedthrough thecontainerruntime so thetty is allocatedon the workernode by thecontainerruntime.Defaults tofalse.

false boolean

QueryParameter

container The containerin which toexecute thecommand.Defaults toonly containerif there is onlyone containerin the pod.

false string

PathParameter


true string

PathParameter

name name of thePod

true string


3.2.47.2. Responses




592

3.2.47.3. Consumes

/

3.2.47.4. Produces

/

3.2.47.5. Tags

apiv1

3.2.48. create binding of a Binding

POST /api/v1/namespaces/{namespace}/pods/{name}/binding



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter

name name of theBinding

true string

3.2.48.2. Responses




593

3.2.48.3. Consumes

/

3.2.48.4. Produces

application/json

3.2.48.5. Tags

apiv1

3.2.49. connect GET requests to exec of Pod

GET /api/v1/namespaces/{namespace}/pods/{name}/exec



QueryParameter

stdin Redirect thestandard inputstream of thepod for thiscall. Defaultsto false.

false boolean

QueryParameter

stdout Redirect thestandardoutput streamof the pod forthis call.Defaults totrue.

false boolean

QueryParameter

stderr Redirect thestandard errorstream of thepod for thiscall. Defaultsto true.

false boolean


594

QueryParameter

tty TTY if trueindicates thata tty will beallocated forthe exec call.Defaults tofalse.

false boolean

QueryParameter

container Container inwhich toexecute thecommand.Defaults toonly containerif there is onlyone containerin the pod.

false string

QueryParameter

command Command isthe remotecommand toexecute. argvarray. Notexecutedwithin a shell.

false string

PathParameter


true string

PathParameter

name name of thePod

true string


3.2.49.2. Responses


595



3.2.49.3. Consumes

/

3.2.49.4. Produces

/

3.2.49.5. Tags

apiv1

3.2.50. connect POST requests to exec of Pod

POST /api/v1/namespaces/{namespace}/pods/{name}/exec



QueryParameter

stdin Redirect thestandard inputstream of thepod for thiscall. Defaultsto false.

false boolean

QueryParameter

stdout Redirect thestandardoutput streamof the pod forthis call.Defaults totrue.

false boolean


596

QueryParameter

stderr Redirect thestandard errorstream of thepod for thiscall. Defaultsto true.

false boolean

QueryParameter

tty TTY if trueindicates thata tty will beallocated forthe exec call.Defaults tofalse.

false boolean

QueryParameter

container Container inwhich toexecute thecommand.Defaults toonly containerif there is onlyone containerin the pod.

false string

QueryParameter

command Command isthe remotecommand toexecute. argvarray. Notexecutedwithin a shell.

false string

PathParameter


true string

PathParameter

name name of thePod

true string


3.2.50.2. Responses


597



3.2.50.3. Consumes

/

3.2.50.4. Produces

/

3.2.50.5. Tags

apiv1

3.2.51. read log of the specified Pod

GET /api/v1/namespaces/{namespace}/pods/{name}/log



QueryParameter


false string

QueryParameter

container The containerfor which tostream logs.Defaults toonly containerif there is onecontainer inthe pod.

false string

QueryParameter

follow Follow the logstream of thepod. Defaultsto false.

false boolean


598

QueryParameter

previous Returnpreviousterminatedcontainer logs.Defaults tofalse.

false boolean

QueryParameter

sinceSeconds A relative timein secondsbefore thecurrent timefrom which toshow logs. Ifthis valueprecedes thetime a podwas started,only logs sincethe pod startwill bereturned. Ifthis value is inthe future, nologs will bereturned. Onlyone ofsinceSecondsor sinceTimemay bespecified.

false ref



599

QueryParameter

sinceTime An RFC3339timestampfrom which toshow logs. Ifthis valuepreceeds thetime a podwas started,only logs sincethe pod startwill bereturned. Ifthis value is inthe future, nologs will bereturned. Onlyone ofsinceSecondsor sinceTimemay bespecified.

false string

QueryParameter

timestamps If true, add anRFC3339 orRFC3339Nano timestampat thebeginning ofevery line oflog output.Defaults tofalse.

false boolean

QueryParameter

tailLines If set, thenumber oflines from theend of thelogs to show.If notspecified, logsare shownfrom thecreation of thecontainer orsinceSecondsor sinceTime

false ref



600

QueryParameter

limitBytes If set, thenumber ofbytes to readfrom theserver beforeterminatingthe log output.This may notdisplay acomplete finalline of logging,and mayreturn slightlymore orslightly lessthan thespecified limit.

false ref

PathParameter


true string

PathParameter

name name of thePod

true string


3.2.51.2. Responses



3.2.51.3. Consumes

/

3.2.51.4. Produces

application/json

3.2.51.5. Tags


601

apiv1

3.2.52. connect GET requests to portforward of Pod

GET /api/v1/namespaces/{namespace}/pods/{name}/portforward



PathParameter


true string

PathParameter

name name of thePod

true string

3.2.52.2. Responses



3.2.52.3. Consumes

/

3.2.52.4. Produces

/

3.2.52.5. Tags

apiv1

3.2.53. connect POST requests to portforward of Pod

POST /api/v1/namespaces/{namespace}/pods/{name}/portforward



602


PathParameter


true string

PathParameter

name name of thePod

true string

3.2.53.2. Responses



3.2.53.3. Consumes

/

3.2.53.4. Produces

/

3.2.53.5. Tags

apiv1

3.2.54. connect GET requests to proxy of Pod

GET /api/v1/namespaces/{namespace}/pods/{name}/proxy




603

QueryParameter


false string

PathParameter


true string

PathParameter

name name of thePod

true string


3.2.54.2. Responses



3.2.54.3. Consumes

/

3.2.54.4. Produces

/

3.2.54.5. Tags

apiv1

3.2.55. connect PUT requests to proxy of Pod

PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy



604


QueryParameter


false string

PathParameter


true string

PathParameter

name name of thePod

true string

3.2.55.2. Responses



3.2.55.3. Consumes

/

3.2.55.4. Produces

/

3.2.55.5. Tags

apiv1

3.2.56. connect DELETE requests to proxy of Pod

DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy



605


QueryParameter


false string

PathParameter


true string

PathParameter

name name of thePod

true string

3.2.56.2. Responses



3.2.56.3. Consumes

/

3.2.56.4. Produces

/

3.2.56.5. Tags

apiv1

3.2.57. connect POST requests to proxy of Pod

POST /api/v1/namespaces/{namespace}/pods/{name}/proxy



606


QueryParameter


false string

PathParameter


true string

PathParameter

name name of thePod

true string

3.2.57.2. Responses



3.2.57.3. Consumes

/

3.2.57.4. Produces

/

3.2.57.5. Tags

apiv1

3.2.58. connect GET requests to proxy of Pod

GET /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path:*}



607


QueryParameter


false string

PathParameter


true string

PathParameter

name name of thePod

true string

PathParameter


true string

3.2.58.2. Responses



3.2.58.3. Consumes

/

3.2.58.4. Produces

/

3.2.58.5. Tags

apiv1

3.2.59. connect PUT requests to proxy of Pod

PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path:*}


608



QueryParameter


false string

PathParameter


true string

PathParameter

name name of thePod

true string

PathParameter


true string

3.2.59.2. Responses



3.2.59.3. Consumes

/

3.2.59.4. Produces

/

3.2.59.5. Tags

apiv1

3.2.60. connect DELETE requests to proxy of Pod


609

DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path:*}



QueryParameter


false string

PathParameter


true string

PathParameter

name name of thePod

true string

PathParameter


true string

3.2.60.2. Responses



3.2.60.3. Consumes

/

3.2.60.4. Produces

/

3.2.60.5. Tags

apiv1


610

3.2.61. connect POST requests to proxy of Pod

POST /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path:*}



QueryParameter


false string

PathParameter


true string

PathParameter

name name of thePod

true string

PathParameter


true string

3.2.61.2. Responses



3.2.61.3. Consumes

/

3.2.61.4. Produces

/

3.2.61.5. Tags


611

3.2.61.5. Tags

apiv1

3.2.62. replace status of the specified Pod

PUT /api/v1/namespaces/{namespace}/pods/{name}/status



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter

name name of thePod

true string

3.2.62.2. Responses



3.2.62.3. Consumes

/

3.2.62.4. Produces

application/json


612

3.2.62.5. Tags

apiv1

3.2.63. list or watch objects of kind PodTemplate

GET /api/v1/namespaces/{namespace}/podtemplates



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


613

QueryParameter

resourceVersion


false string

PathParameter


true string


3.2.63.2. Responses


200 success Section 3.3.122,“v1.PodTemplateList”

3.2.63.3. Consumes

/

3.2.63.4. Produces

application/json

3.2.63.5. Tags

apiv1

3.2.64. create a PodTemplate


614

POST /api/v1/namespaces/{namespace}/podtemplates



QueryParameter


false string

BodyParameter

body

true Section 3.3.77,“v1.PodTemplate”

PathParameter


true string

3.2.64.2. Responses


200 success Section 3.3.77,“v1.PodTemplate”

3.2.64.3. Consumes

/

3.2.64.4. Produces

application/json

3.2.64.5. Tags

apiv1

3.2.65. read the specified PodTemplate


615

GET /api/v1/namespaces/{namespace}/podtemplates/{name}



QueryParameter


false string

PathParameter


true string

PathParameter

name name of thePodTemplate

true string

3.2.65.2. Responses



3.2.65.3. Consumes

/

3.2.65.4. Produces

application/json

3.2.65.5. Tags

apiv1

3.2.66. replace the specified PodTemplate

PUT /api/v1/namespaces/{namespace}/podtemplates/{name}


616



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string

3.2.66.2. Responses



3.2.66.3. Consumes

/

3.2.66.4. Produces

application/json

3.2.66.5. Tags

apiv1

3.2.67. delete a PodTemplate


617

DELETE /api/v1/namespaces/{namespace}/podtemplates/{name}



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string

3.2.67.2. Responses



3.2.67.3. Consumes

/

3.2.67.4. Produces

application/json

3.2.67.5. Tags

apiv1


618

3.2.68. partially update the specified PodTemplate

PATCH /api/v1/namespaces/{namespace}/podtemplates/{name}



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string

3.2.68.2. Responses



3.2.68.3. Consumes




3.2.68.4. Produces


619

application/json

3.2.68.5. Tags

apiv1

3.2.69. list or watch objects of kind ReplicationController

GET /api/v1/namespaces/{namespace}/replicationcontrollers



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


620

QueryParameter

resourceVersion


false string

PathParameter


true string


3.2.69.2. Responses


200 success Section 3.3.6,“v1.ReplicationControllerList”

3.2.69.3. Consumes

/

3.2.69.4. Produces

application/json

3.2.69.5. Tags

apiv1

3.2.70. create a ReplicationController

POST /api/v1/namespaces/{namespace}/replicationcontrollers


621



QueryParameter


false string

BodyParameter

body

true Section 3.3.66,“v1.ReplicationController”

PathParameter


true string

3.2.70.2. Responses


200 success Section 3.3.66,“v1.ReplicationController”

3.2.70.3. Consumes

/

3.2.70.4. Produces

application/json

3.2.70.5. Tags

apiv1

3.2.71. read the specified ReplicationController

GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}


622



QueryParameter


false string

PathParameter


true string

PathParameter

name name of theReplicationController

true string

3.2.71.2. Responses



3.2.71.3. Consumes

/

3.2.71.4. Produces

application/json

3.2.71.5. Tags

apiv1

3.2.72. replace the specified ReplicationController

PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}



623


QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string

3.2.72.2. Responses



3.2.72.3. Consumes

/

3.2.72.4. Produces

application/json

3.2.72.5. Tags

apiv1

3.2.73. delete a ReplicationController

DELETE /api/v1/namespaces/{namespace}/replicationcontrollers/{name}


624



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string

3.2.73.2. Responses



3.2.73.3. Consumes

/

3.2.73.4. Produces

application/json

3.2.73.5. Tags

apiv1


625

3.2.74. partially update the specified ReplicationController

PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string

3.2.74.2. Responses



3.2.74.3. Consumes




3.2.74.4. Produces


626

3.2.74.4. Produces

application/json

3.2.74.5. Tags

apiv1

3.2.75. replace status of the specified ReplicationController

PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string

3.2.75.2. Responses




627

3.2.75.3. Consumes

/

3.2.75.4. Produces

application/json

3.2.75.5. Tags

apiv1

3.2.76. list or watch objects of kind ResourceQuota

GET /api/v1/namespaces/{namespace}/resourcequotas



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string


628

QueryParameter


false boolean

QueryParameter

resourceVersion


false string

PathParameter


true string


3.2.76.2. Responses


200 success Section 3.3.82,“v1.ResourceQuotaList”

3.2.76.3. Consumes

/


629

3.2.76.4. Produces

application/json

3.2.76.5. Tags

apiv1

3.2.77. create a ResourceQuota

POST /api/v1/namespaces/{namespace}/resourcequotas



QueryParameter


false string

BodyParameter

body

true Section 3.3.117,“v1.ResourceQuota”

PathParameter


true string

3.2.77.2. Responses


200 success Section 3.3.117,“v1.ResourceQuota”

3.2.77.3. Consumes

/


630

3.2.77.4. Produces

application/json

3.2.77.5. Tags

apiv1

3.2.78. read the specified ResourceQuota

GET /api/v1/namespaces/{namespace}/resourcequotas/{name}



QueryParameter


false string

PathParameter


true string

PathParameter

name name of theResourceQuota

true string

3.2.78.2. Responses



3.2.78.3. Consumes

/

3.2.78.4. Produces


631

application/json

3.2.78.5. Tags

apiv1

3.2.79. replace the specified ResourceQuota

PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string

3.2.79.2. Responses



3.2.79.3. Consumes


632

/

3.2.79.4. Produces

application/json

3.2.79.5. Tags

apiv1

3.2.80. delete a ResourceQuota

DELETE /api/v1/namespaces/{namespace}/resourcequotas/{name}



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string

3.2.80.2. Responses



633



3.2.80.3. Consumes

/

3.2.80.4. Produces

application/json

3.2.80.5. Tags

apiv1

3.2.81. partially update the specified ResourceQuota

PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}



QueryParameter


false string

BodyParameter

body


PathParameter


true string


634

PathParameter


true string


3.2.81.2. Responses



3.2.81.3. Consumes




3.2.81.4. Produces

application/json

3.2.81.5. Tags

apiv1

3.2.82. replace status of the specified ResourceQuota

PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}/status



QueryParameter


false string


635

BodyParameter

body


PathParameter


true string

PathParameter


true string


3.2.82.2. Responses



3.2.82.3. Consumes

/

3.2.82.4. Produces

application/json

3.2.82.5. Tags

apiv1

3.2.83. list or watch objects of kind Secret

GET /api/v1/namespaces/{namespace}/secrets



636


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


637

PathParameter


true string


3.2.83.2. Responses


200 success Section 3.3.16, “v1.SecretList”

3.2.83.3. Consumes

/

3.2.83.4. Produces

application/json

3.2.83.5. Tags

apiv1

3.2.84. create a Secret

POST /api/v1/namespaces/{namespace}/secrets


638



QueryParameter


false string

BodyParameter

body

true Section 3.3.97, “v1.Secret”

PathParameter


true string

3.2.84.2. Responses


200 success Section 3.3.97, “v1.Secret”

3.2.84.3. Consumes

/

3.2.84.4. Produces

application/json

3.2.84.5. Tags

apiv1

3.2.85. read the specified Secret

GET /api/v1/namespaces/{namespace}/secrets/{name}



639


QueryParameter


false string

PathParameter


true string

PathParameter

name name of theSecret

true string

3.2.85.2. Responses



3.2.85.3. Consumes

/

3.2.85.4. Produces

application/json

3.2.85.5. Tags

apiv1

3.2.86. replace the specified Secret

PUT /api/v1/namespaces/{namespace}/secrets/{name}



640


QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string

3.2.86.2. Responses



3.2.86.3. Consumes

/

3.2.86.4. Produces

application/json

3.2.86.5. Tags

apiv1

3.2.87. delete a Secret

DELETE /api/v1/namespaces/{namespace}/secrets/{name}



641


QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string

3.2.87.2. Responses



3.2.87.3. Consumes

/

3.2.87.4. Produces

application/json

3.2.87.5. Tags

apiv1

3.2.88. partially update the specified Secret

PATCH /api/v1/namespaces/{namespace}/secrets/{name}


642



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string

3.2.88.2. Responses



3.2.88.3. Consumes




3.2.88.4. Produces

application/json

3.2.88.5. Tags

apiv1


643

3.2.89. list or watch objects of kind ServiceAccount

GET /api/v1/namespaces/{namespace}/serviceaccounts



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


644

QueryParameter

resourceVersion


false string

PathParameter


true string


3.2.89.2. Responses


200 success Section 3.3.85,“v1.ServiceAccountList”

3.2.89.3. Consumes

/

3.2.89.4. Produces

application/json

3.2.89.5. Tags

apiv1

3.2.90. create a ServiceAccount

POST /api/v1/namespaces/{namespace}/serviceaccounts


645



QueryParameter


false string

BodyParameter

body

true Section 3.3.76,“v1.ServiceAccount”

PathParameter


true string

3.2.90.2. Responses


200 success Section 3.3.76,“v1.ServiceAccount”

3.2.90.3. Consumes

/

3.2.90.4. Produces

application/json

3.2.90.5. Tags

apiv1

3.2.91. read the specified ServiceAccount

GET /api/v1/namespaces/{namespace}/serviceaccounts/{name}


646



QueryParameter


false string

PathParameter


true string

PathParameter

name name of theServiceAccount

true string

3.2.91.2. Responses



3.2.91.3. Consumes

/

3.2.91.4. Produces

application/json

3.2.91.5. Tags

apiv1

3.2.92. replace the specified ServiceAccount

PUT /api/v1/namespaces/{namespace}/serviceaccounts/{name}



647


QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string

3.2.92.2. Responses



3.2.92.3. Consumes

/

3.2.92.4. Produces

application/json

3.2.92.5. Tags

apiv1

3.2.93. delete a ServiceAccount

DELETE /api/v1/namespaces/{namespace}/serviceaccounts/{name}


648



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string

3.2.93.2. Responses



3.2.93.3. Consumes

/

3.2.93.4. Produces

application/json

3.2.93.5. Tags

apiv1


649

3.2.94. partially update the specified ServiceAccount

PATCH /api/v1/namespaces/{namespace}/serviceaccounts/{name}



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string

3.2.94.2. Responses



3.2.94.3. Consumes




3.2.94.4. Produces


650

3.2.94.4. Produces

application/json

3.2.94.5. Tags

apiv1

3.2.95. list or watch objects of kind Service

GET /api/v1/namespaces/{namespace}/services



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string


651

QueryParameter


false boolean

QueryParameter

resourceVersion


false string

PathParameter


true string


3.2.95.2. Responses


200 success Section 3.3.37, “v1.ServiceList”

3.2.95.3. Consumes

/

3.2.95.4. Produces


652

application/json

3.2.95.5. Tags

apiv1

3.2.96. create a Service

POST /api/v1/namespaces/{namespace}/services



QueryParameter


false string

BodyParameter

body

true Section 3.3.105, “v1.Service”

PathParameter


true string

3.2.96.2. Responses


200 success Section 3.3.105, “v1.Service”

3.2.96.3. Consumes

/

3.2.96.4. Produces

application/json

3.2.96.5. Tags


653

apiv1

3.2.97. read the specified Service

GET /api/v1/namespaces/{namespace}/services/{name}



QueryParameter


false string

PathParameter


true string

PathParameter

name name of theService

true string

3.2.97.2. Responses



3.2.97.3. Consumes

/

3.2.97.4. Produces

application/json

3.2.97.5. Tags

apiv1

3.2.98. replace the specified Service


654

PUT /api/v1/namespaces/{namespace}/services/{name}



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string

3.2.98.2. Responses



3.2.98.3. Consumes

/

3.2.98.4. Produces

application/json

3.2.98.5. Tags

apiv1

3.2.99. delete a Service


655

DELETE /api/v1/namespaces/{namespace}/services/{name}



QueryParameter


false string

PathParameter


true string

PathParameter


true string

3.2.99.2. Responses



3.2.99.3. Consumes

/

3.2.99.4. Produces

application/json

3.2.99.5. Tags

apiv1

3.2.100. partially update the specified Service

PATCH /api/v1/namespaces/{namespace}/services/{name}


656



QueryParameter


false string

BodyParameter

body


PathParameter


true string

PathParameter


true string




3.2.100.3. Consumes




3.2.100.4. Produces

application/json

3.2.100.5. Tags

apiv1


657

3.2.101. read the specified Namespace

GET /api/v1/namespaces/{name}



QueryParameter


false string

PathParameter

name name of theNamespace

true string




3.2.101.3. Consumes

/

3.2.101.4. Produces

application/json

3.2.101.5. Tags

apiv1

3.2.102. replace the specified Namespace

PUT /api/v1/namespaces/{name}



658


QueryParameter


false string

BodyParameter

body


PathParameter


true string




3.2.102.3. Consumes

/

3.2.102.4. Produces

application/json

3.2.102.5. Tags

apiv1

3.2.103. delete a Namespace

DELETE /api/v1/namespaces/{name}



659


QueryParameter


false string

BodyParameter

body


PathParameter


true string




3.2.103.3. Consumes

/

3.2.103.4. Produces

application/json

3.2.103.5. Tags

apiv1

3.2.104. partially update the specified Namespace

PATCH /api/v1/namespaces/{name}



660


QueryParameter


false string

BodyParameter

body


PathParameter


true string




3.2.104.3. Consumes




3.2.104.4. Produces

application/json

3.2.104.5. Tags

apiv1

3.2.105. replace finalize of the specified Namespace

PUT /api/v1/namespaces/{name}/finalize



661


QueryParameter


false string

BodyParameter

body


PathParameter


true string




3.2.105.3. Consumes

/

3.2.105.4. Produces

application/json

3.2.105.5. Tags

apiv1

3.2.106. replace status of the specified Namespace

PUT /api/v1/namespaces/{name}/status



662


QueryParameter


false string

BodyParameter

body


PathParameter


true string




3.2.106.3. Consumes

/

3.2.106.4. Produces

application/json

3.2.106.5. Tags

apiv1

3.2.107. list or watch objects of kind Node

GET /api/v1/nodes



663


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


664




200 success Section 3.3.60, “v1.NodeList”

3.2.107.3. Consumes

/

3.2.107.4. Produces

application/json

3.2.107.5. Tags

apiv1

3.2.108. create a Node

POST /api/v1/nodes



665


QueryParameter


false string

BodyParameter

body

true Section 3.3.116, “v1.Node”



200 success Section 3.3.116, “v1.Node”

3.2.108.3. Consumes

/

3.2.108.4. Produces

application/json

3.2.108.5. Tags

apiv1

3.2.109. read the specified Node

GET /api/v1/nodes/{name}



QueryParameter


false string


666

PathParameter

name name of theNode

true string





3.2.109.3. Consumes

/

3.2.109.4. Produces

application/json

3.2.109.5. Tags

apiv1

3.2.110. replace the specified Node

PUT /api/v1/nodes/{name}



QueryParameter


false string

BodyParameter

body


PathParameter


true string


667




3.2.110.3. Consumes

/

3.2.110.4. Produces

application/json

3.2.110.5. Tags

apiv1

3.2.111. delete a Node

DELETE /api/v1/nodes/{name}



QueryParameter


false string

BodyParameter

body


PathParameter


true string



668



3.2.111.3. Consumes

/

3.2.111.4. Produces

application/json

3.2.111.5. Tags

apiv1

3.2.112. partially update the specified Node

PATCH /api/v1/nodes/{name}



QueryParameter


false string

BodyParameter

body


PathParameter


true string



669



3.2.112.3. Consumes




3.2.112.4. Produces

application/json

3.2.112.5. Tags

apiv1

3.2.113. replace status of the specified Node

PUT /api/v1/nodes/{name}/status



QueryParameter


false string

BodyParameter

body


PathParameter


true string



670



3.2.113.3. Consumes

/

3.2.113.4. Produces

application/json

3.2.113.5. Tags

apiv1

3.2.114. list or watch objects of kind PersistentVolumeClaim

GET /api/v1/persistentvolumeclaims

3.2.114.1. Description




QueryParameter


false string


671

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string




672


200 success Section 3.3.91,“v1.PersistentVolumeClaimList”

3.2.114.4. Consumes

/

3.2.114.5. Produces

application/json

3.2.114.6. Tags

apiv1

3.2.115. create a PersistentVolumeClaim

POST /api/v1/persistentvolumeclaims



QueryParameter


false string

BodyParameter

body






673

3.2.115.3. Consumes

/

3.2.115.4. Produces

application/json

3.2.115.5. Tags

apiv1

3.2.116. list or watch objects of kind PersistentVolume

GET /api/v1/persistentvolumes



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string


674

QueryParameter


false boolean

QueryParameter

resourceVersion


false string




200 success Section 3.3.38,“v1.PersistentVolumeList”

3.2.116.3. Consumes

/

3.2.116.4. Produces

application/json

3.2.116.5. Tags


675

apiv1

3.2.117. create a PersistentVolume

POST /api/v1/persistentvolumes



QueryParameter


false string

BodyParameter

body

true Section 3.3.1,“v1.PersistentVolume”



200 success Section 3.3.1,“v1.PersistentVolume”

3.2.117.3. Consumes

/

3.2.117.4. Produces

application/json

3.2.117.5. Tags

apiv1

3.2.118. read the specified PersistentVolume

GET /api/v1/persistentvolumes/{name}



676


QueryParameter


false string

PathParameter

name name of thePersistentVolume

true string




3.2.118.3. Consumes

/

3.2.118.4. Produces

application/json

3.2.118.5. Tags

apiv1

3.2.119. replace the specified PersistentVolume

PUT /api/v1/persistentvolumes/{name}



QueryParameter


false string


677

BodyParameter

body


PathParameter


true string





3.2.119.3. Consumes

/

3.2.119.4. Produces

application/json

3.2.119.5. Tags

apiv1

3.2.120. delete a PersistentVolume

DELETE /api/v1/persistentvolumes/{name}



QueryParameter


false string


678

BodyParameter

body


PathParameter


true string





3.2.120.3. Consumes

/

3.2.120.4. Produces

application/json

3.2.120.5. Tags

apiv1

3.2.121. partially update the specified PersistentVolume

PATCH /api/v1/persistentvolumes/{name}



QueryParameter


false string


679

BodyParameter

body


PathParameter


true string





3.2.121.3. Consumes




3.2.121.4. Produces

application/json

3.2.121.5. Tags

apiv1

3.2.122. replace status of the specified PersistentVolume

PUT /api/v1/persistentvolumes/{name}/status



680


QueryParameter


false string

BodyParameter

body


PathParameter


true string




3.2.122.3. Consumes

/

3.2.122.4. Produces

application/json

3.2.122.5. Tags

apiv1

3.2.123. list or watch objects of kind Pod

GET /api/v1/pods



681


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


682




200 success Section 3.3.78, “v1.PodList”

3.2.123.3. Consumes

/

3.2.123.4. Produces

application/json

3.2.123.5. Tags

apiv1

3.2.124. create a Pod

POST /api/v1/pods



683


QueryParameter


false string

BodyParameter

body





3.2.124.3. Consumes

/

3.2.124.4. Produces

application/json

3.2.124.5. Tags

apiv1

3.2.125. list or watch objects of kind PodTemplate

GET /api/v1/podtemplates



QueryParameter


false string


684

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string




685


200 success Section 3.3.122,“v1.PodTemplateList”

3.2.125.3. Consumes

/

3.2.125.4. Produces

application/json

3.2.125.5. Tags

apiv1

3.2.126. create a PodTemplate

POST /api/v1/podtemplates



QueryParameter


false string

BodyParameter

body






686

3.2.126.3. Consumes

/

3.2.126.4. Produces

application/json

3.2.126.5. Tags

apiv1

3.2.127. proxy GET requests to Pod

GET /api/v1/proxy/namespaces/{namespace}/pods/{name}



PathParameter


true string

PathParameter

name name of thePod

true string




3.2.127.3. Consumes

/

3.2.127.4. Produces

/


687

3.2.127.5. Tags

apiv1

3.2.128. proxy PUT requests to Pod

PUT /api/v1/proxy/namespaces/{namespace}/pods/{name}



PathParameter


true string

PathParameter

name name of thePod

true string




3.2.128.3. Consumes

/

3.2.128.4. Produces

/

3.2.128.5. Tags

apiv1

3.2.129. proxy DELETE requests to Pod

DELETE /api/v1/proxy/namespaces/{namespace}/pods/{name}


688



PathParameter


true string

PathParameter

name name of thePod

true string




3.2.129.3. Consumes

/

3.2.129.4. Produces

/

3.2.129.5. Tags

apiv1

3.2.130. proxy POST requests to Pod

POST /api/v1/proxy/namespaces/{namespace}/pods/{name}




689

PathParameter


true string

PathParameter

name name of thePod

true string





3.2.130.3. Consumes

/

3.2.130.4. Produces

/

3.2.130.5. Tags

apiv1

3.2.131. proxy GET requests to Pod

GET /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path:*}




690

PathParameter


true string

PathParameter

name name of thePod

true string

PathParameter


true string





3.2.131.3. Consumes

/

3.2.131.4. Produces

/

3.2.131.5. Tags

apiv1

3.2.132. proxy PUT requests to Pod

PUT /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path:*}



691


PathParameter


true string

PathParameter

name name of thePod

true string

PathParameter


true string




3.2.132.3. Consumes

/

3.2.132.4. Produces

/

3.2.132.5. Tags

apiv1

3.2.133. proxy DELETE requests to Pod

DELETE /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path:*}



692


PathParameter


true string

PathParameter

name name of thePod

true string

PathParameter


true string




3.2.133.3. Consumes

/

3.2.133.4. Produces

/

3.2.133.5. Tags

apiv1

3.2.134. proxy POST requests to Pod

POST /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path:*}



693


PathParameter


true string

PathParameter

name name of thePod

true string

PathParameter


true string




3.2.134.3. Consumes

/

3.2.134.4. Produces

/

3.2.134.5. Tags

apiv1

3.2.135. proxy GET requests to Service

GET /api/v1/proxy/namespaces/{namespace}/services/{name}



694


PathParameter


true string

PathParameter


true string




3.2.135.3. Consumes

/

3.2.135.4. Produces

/

3.2.135.5. Tags

apiv1

3.2.136. proxy PUT requests to Service

PUT /api/v1/proxy/namespaces/{namespace}/services/{name}




695

PathParameter


true string

PathParameter


true string





3.2.136.3. Consumes

/

3.2.136.4. Produces

/

3.2.136.5. Tags

apiv1

3.2.137. proxy DELETE requests to Service

DELETE /api/v1/proxy/namespaces/{namespace}/services/{name}




696

PathParameter


true string

PathParameter


true string





3.2.137.3. Consumes

/

3.2.137.4. Produces

/

3.2.137.5. Tags

apiv1

3.2.138. proxy POST requests to Service

POST /api/v1/proxy/namespaces/{namespace}/services/{name}




697

PathParameter


true string

PathParameter


true string





3.2.138.3. Consumes

/

3.2.138.4. Produces

/

3.2.138.5. Tags

apiv1

3.2.139. proxy GET requests to Service

GET /api/v1/proxy/namespaces/{namespace}/services/{name}/{path:*}




698

PathParameter


true string

PathParameter


true string

PathParameter


true string





3.2.139.3. Consumes

/

3.2.139.4. Produces

/

3.2.139.5. Tags

apiv1

3.2.140. proxy PUT requests to Service

PUT /api/v1/proxy/namespaces/{namespace}/services/{name}/{path:*}



699


PathParameter


true string

PathParameter


true string

PathParameter


true string




3.2.140.3. Consumes

/

3.2.140.4. Produces

/

3.2.140.5. Tags

apiv1

3.2.141. proxy DELETE requests to Service

DELETE /api/v1/proxy/namespaces/{namespace}/services/{name}/{path:*}



700


PathParameter


true string

PathParameter


true string

PathParameter


true string




3.2.141.3. Consumes

/

3.2.141.4. Produces

/

3.2.141.5. Tags

apiv1

3.2.142. proxy POST requests to Service

POST /api/v1/proxy/namespaces/{namespace}/services/{name}/{path:*}



701


PathParameter


true string

PathParameter


true string

PathParameter


true string




3.2.142.3. Consumes

/

3.2.142.4. Produces

/

3.2.142.5. Tags

apiv1

3.2.143. proxy GET requests to Node

GET /api/v1/proxy/nodes/{name}



702


PathParameter


true string




3.2.143.3. Consumes

/

3.2.143.4. Produces

/

3.2.143.5. Tags

apiv1

3.2.144. proxy PUT requests to Node

PUT /api/v1/proxy/nodes/{name}



PathParameter


true string





703

3.2.144.3. Consumes

/

3.2.144.4. Produces

/

3.2.144.5. Tags

apiv1

3.2.145. proxy DELETE requests to Node

DELETE /api/v1/proxy/nodes/{name}



PathParameter


true string




3.2.145.3. Consumes

/

3.2.145.4. Produces

/

3.2.145.5. Tags

apiv1

3.2.146. proxy POST requests to Node

POST /api/v1/proxy/nodes/{name}


704



PathParameter


true string




3.2.146.3. Consumes

/

3.2.146.4. Produces

/

3.2.146.5. Tags

apiv1

3.2.147. proxy GET requests to Node

GET /api/v1/proxy/nodes/{name}/{path:*}



PathParameter


true string

PathParameter


true string


705




3.2.147.3. Consumes

/

3.2.147.4. Produces

/

3.2.147.5. Tags

apiv1

3.2.148. proxy PUT requests to Node

PUT /api/v1/proxy/nodes/{name}/{path:*}



PathParameter


true string

PathParameter


true string




3.2.148.3. Consumes


706

/

3.2.148.4. Produces

/

3.2.148.5. Tags

apiv1

3.2.149. proxy DELETE requests to Node

DELETE /api/v1/proxy/nodes/{name}/{path:*}



PathParameter


true string

PathParameter


true string




3.2.149.3. Consumes

/

3.2.149.4. Produces

/

3.2.149.5. Tags

apiv1



707


POST /api/v1/proxy/nodes/{name}/{path:*}



PathParameter


true string

PathParameter


true string




3.2.150.3. Consumes

/

3.2.150.4. Produces

/

3.2.150.5. Tags

apiv1

3.2.151. list or watch objects of kind ReplicationController

GET /api/v1/replicationcontrollers



708


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


709




200 success Section 3.3.6,“v1.ReplicationControllerList”

3.2.151.3. Consumes

/

3.2.151.4. Produces

application/json

3.2.151.5. Tags

apiv1

3.2.152. create a ReplicationController

POST /api/v1/replicationcontrollers



710


QueryParameter


false string

BodyParameter

body





3.2.152.3. Consumes

/

3.2.152.4. Produces

application/json

3.2.152.5. Tags

apiv1

3.2.153. list or watch objects of kind ResourceQuota

GET /api/v1/resourcequotas



QueryParameter


false string


711

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string




712


200 success Section 3.3.82,“v1.ResourceQuotaList”

3.2.153.3. Consumes

/

3.2.153.4. Produces

application/json

3.2.153.5. Tags

apiv1

3.2.154. create a ResourceQuota

POST /api/v1/resourcequotas



QueryParameter


false string

BodyParameter

body






713

3.2.154.3. Consumes

/

3.2.154.4. Produces

application/json

3.2.154.5. Tags

apiv1

3.2.155. list or watch objects of kind Secret

GET /api/v1/secrets



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string


714

QueryParameter


false boolean

QueryParameter

resourceVersion


false string




200 success Section 3.3.16, “v1.SecretList”

3.2.155.3. Consumes

/

3.2.155.4. Produces

application/json

3.2.155.5. Tags

apiv1


715

3.2.156. create a Secret

POST /api/v1/secrets



QueryParameter


false string

BodyParameter

body





3.2.156.3. Consumes

/

3.2.156.4. Produces

application/json

3.2.156.5. Tags

apiv1

3.2.157. list or watch objects of kind SecurityContextConstraints

GET /api/v1/securitycontextconstraints



716


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


717

QueryParameter

resourceVersion


false string




200 success Section 3.3.28,“v1.SecurityContextConstraintsList”

3.2.157.3. Consumes

/

3.2.157.4. Produces

application/json

3.2.157.5. Tags

apiv1

3.2.158. create a SecurityContextConstraints

POST /api/v1/securitycontextconstraints



718


QueryParameter


false string

BodyParameter

body

true Section 3.3.69,“v1.SecurityContextConstraints”



200 success Section 3.3.69,“v1.SecurityContextConstraints”

3.2.158.3. Consumes

/

3.2.158.4. Produces

application/json

3.2.158.5. Tags

apiv1

3.2.159. read the specified SecurityContextConstraints

GET /api/v1/securitycontextconstraints/{name}




719

QueryParameter


false string

PathParameter

name name of theSecurityContextConstraints

true string





3.2.159.3. Consumes

/

3.2.159.4. Produces

application/json

3.2.159.5. Tags

apiv1

3.2.160. replace the specified SecurityContextConstraints

PUT /api/v1/securitycontextconstraints/{name}



QueryParameter


false string


720

BodyParameter

body

true Section 3.3.69,“v1.SecurityContextConstraints”

PathParameter


true string





3.2.160.3. Consumes

/

3.2.160.4. Produces

application/json

3.2.160.5. Tags

apiv1

3.2.161. delete a SecurityContextConstraints

DELETE /api/v1/securitycontextconstraints/{name}




721

QueryParameter


false string

BodyParameter

body


PathParameter


true string





3.2.161.3. Consumes

/

3.2.161.4. Produces

application/json

3.2.161.5. Tags

apiv1

3.2.162. partially update the specified SecurityContextConstraints

PATCH /api/v1/securitycontextconstraints/{name}



722


QueryParameter


false string

BodyParameter

body


PathParameter


true string




3.2.162.3. Consumes




3.2.162.4. Produces

application/json

3.2.162.5. Tags

apiv1

3.2.163. list or watch objects of kind ServiceAccount

GET /api/v1/serviceaccounts



723


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


724




200 success Section 3.3.85,“v1.ServiceAccountList”

3.2.163.3. Consumes

/

3.2.163.4. Produces

application/json

3.2.163.5. Tags

apiv1

3.2.164. create a ServiceAccount

POST /api/v1/serviceaccounts



725


QueryParameter


false string

BodyParameter

body





3.2.164.3. Consumes

/

3.2.164.4. Produces

application/json

3.2.164.5. Tags

apiv1

3.2.165. list or watch objects of kind Service

GET /api/v1/services



QueryParameter


false string


726

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string




727


200 success Section 3.3.37, “v1.ServiceList”

3.2.165.3. Consumes

/

3.2.165.4. Produces

application/json

3.2.165.5. Tags

apiv1

3.2.166. create a Service

POST /api/v1/services



QueryParameter


false string

BodyParameter

body





3.2.166.3. Consumes

/


728

3.2.166.4. Produces

application/json

3.2.166.5. Tags

apiv1

3.2.167. watch individual changes to a list of Endpoints

GET /api/v1/watch/endpoints



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string


729

QueryParameter


false boolean

QueryParameter

resourceVersion


false string





3.2.167.3. Consumes

/

3.2.167.4. Produces

application/json

3.2.167.5. Tags

apiv1


730

3.2.168. watch individual changes to a list of Event

GET /api/v1/watch/events



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


731

QueryParameter

resourceVersion


false string





3.2.168.3. Consumes

/

3.2.168.4. Produces

application/json

3.2.168.5. Tags

apiv1

3.2.169. watch individual changes to a list of LimitRange

GET /api/v1/watch/limitranges



732


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


733





3.2.169.3. Consumes

/

3.2.169.4. Produces

application/json

3.2.169.5. Tags

apiv1

3.2.170. watch individual changes to a list of Namespace

GET /api/v1/watch/namespaces



734


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


735





3.2.170.3. Consumes

/

3.2.170.4. Produces

application/json

3.2.170.5. Tags

apiv1

3.2.171. watch individual changes to a list of Endpoints

GET /api/v1/watch/namespaces/{namespace}/endpoints



736


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


737

PathParameter


true string





3.2.171.3. Consumes

/

3.2.171.4. Produces

application/json

3.2.171.5. Tags

apiv1

3.2.172. watch changes to an object of kind Endpoints

GET /api/v1/watch/namespaces/{namespace}/endpoints/{name}


738



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


739

QueryParameter

resourceVersion


false string

PathParameter


true string

PathParameter


true string





3.2.172.3. Consumes

/

3.2.172.4. Produces

application/json

3.2.172.5. Tags

apiv1



740


GET /api/v1/watch/namespaces/{namespace}/events



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


741

QueryParameter

resourceVersion


false string

PathParameter


true string





3.2.173.3. Consumes

/

3.2.173.4. Produces

application/json

3.2.173.5. Tags

apiv1

3.2.174. watch changes to an object of kind Event

GET /api/v1/watch/namespaces/{namespace}/events/{name}


742



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


743

QueryParameter

resourceVersion


false string

PathParameter


true string

PathParameter


true string





3.2.174.3. Consumes

/

3.2.174.4. Produces

application/json

3.2.174.5. Tags

apiv1



744


GET /api/v1/watch/namespaces/{namespace}/limitranges



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


745

QueryParameter

resourceVersion


false string

PathParameter


true string





3.2.175.3. Consumes

/

3.2.175.4. Produces

application/json

3.2.175.5. Tags

apiv1

3.2.176. watch changes to an object of kind LimitRange

GET /api/v1/watch/namespaces/{namespace}/limitranges/{name}


746



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


747

QueryParameter

resourceVersion


false string

PathParameter


true string

PathParameter


true string





3.2.176.3. Consumes

/

3.2.176.4. Produces

application/json

3.2.176.5. Tags

apiv1

3.2.177. watch individual changes to a list of PersistentVolumeClaim


748


GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


749

QueryParameter

resourceVersion


false string

PathParameter


true string





3.2.177.3. Consumes

/

3.2.177.4. Produces

application/json

3.2.177.5. Tags

apiv1

3.2.178. watch changes to an object of kind PersistentVolumeClaim

GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims/{name}


750



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


751

QueryParameter

resourceVersion


false string

PathParameter


true string

PathParameter


true string





3.2.178.3. Consumes

/

3.2.178.4. Produces

application/json

3.2.178.5. Tags

apiv1


752

3.2.179. watch individual changes to a list of Pod

GET /api/v1/watch/namespaces/{namespace}/pods



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


753

QueryParameter

resourceVersion


false string

PathParameter


true string





3.2.179.3. Consumes

/

3.2.179.4. Produces

application/json

3.2.179.5. Tags

apiv1

3.2.180. watch changes to an object of kind Pod

GET /api/v1/watch/namespaces/{namespace}/pods/{name}


754



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


755

QueryParameter

resourceVersion


false string

PathParameter


true string

PathParameter

name name of thePod

true string





3.2.180.3. Consumes

/

3.2.180.4. Produces

application/json

3.2.180.5. Tags


756

apiv1

3.2.181. watch individual changes to a list of PodTemplate

GET /api/v1/watch/namespaces/{namespace}/podtemplates



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


757

QueryParameter

resourceVersion


false string

PathParameter


true string





3.2.181.3. Consumes

/

3.2.181.4. Produces

application/json

3.2.181.5. Tags

apiv1

3.2.182. watch changes to an object of kind PodTemplate

GET /api/v1/watch/namespaces/{namespace}/podtemplates/{name}


758



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


759

QueryParameter

resourceVersion


false string

PathParameter


true string

PathParameter


true string





3.2.182.3. Consumes

/

3.2.182.4. Produces

application/json

3.2.182.5. Tags

apiv1

3.2.183. watch individual changes to a list of ReplicationController


760


GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


761

QueryParameter

resourceVersion


false string

PathParameter


true string





3.2.183.3. Consumes

/

3.2.183.4. Produces

application/json

3.2.183.5. Tags

apiv1

3.2.184. watch changes to an object of kind ReplicationController

GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers/{name}


762



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


763

QueryParameter

resourceVersion


false string

PathParameter


true string

PathParameter


true string





3.2.184.3. Consumes

/

3.2.184.4. Produces

application/json

3.2.184.5. Tags

apiv1


764

3.2.185. watch individual changes to a list of ResourceQuota

GET /api/v1/watch/namespaces/{namespace}/resourcequotas



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


765

QueryParameter

resourceVersion


false string

PathParameter


true string





3.2.185.3. Consumes

/

3.2.185.4. Produces

application/json

3.2.185.5. Tags

apiv1

3.2.186. watch changes to an object of kind ResourceQuota

GET /api/v1/watch/namespaces/{namespace}/resourcequotas/{name}


766



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


767

QueryParameter

resourceVersion


false string

PathParameter


true string

PathParameter


true string





3.2.186.3. Consumes

/

3.2.186.4. Produces

application/json

3.2.186.5. Tags


768

3.2.186.5. Tags

apiv1

3.2.187. watch individual changes to a list of Secret

GET /api/v1/watch/namespaces/{namespace}/secrets



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


769

QueryParameter

resourceVersion


false string

PathParameter


true string





3.2.187.3. Consumes

/

3.2.187.4. Produces

application/json

3.2.187.5. Tags

apiv1

3.2.188. watch changes to an object of kind Secret

GET /api/v1/watch/namespaces/{namespace}/secrets/{name}


770



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


771

QueryParameter

resourceVersion


false string

PathParameter


true string

PathParameter


true string





3.2.188.3. Consumes

/

3.2.188.4. Produces

application/json

3.2.188.5. Tags

apiv1

3.2.189. watch individual changes to a list of ServiceAccount


772


GET /api/v1/watch/namespaces/{namespace}/serviceaccounts



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


773

QueryParameter

resourceVersion


false string

PathParameter


true string





3.2.189.3. Consumes

/

3.2.189.4. Produces

application/json

3.2.189.5. Tags

apiv1

3.2.190. watch changes to an object of kind ServiceAccount

GET /api/v1/watch/namespaces/{namespace}/serviceaccounts/{name}


774



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


775

QueryParameter

resourceVersion


false string

PathParameter


true string

PathParameter


true string





3.2.190.3. Consumes

/

3.2.190.4. Produces

application/json

3.2.190.5. Tags

apiv1


776

3.2.191. watch individual changes to a list of Service

GET /api/v1/watch/namespaces/{namespace}/services



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


777

QueryParameter

resourceVersion


false string

PathParameter


true string





3.2.191.3. Consumes

/

3.2.191.4. Produces

application/json

3.2.191.5. Tags

apiv1

3.2.192. watch changes to an object of kind Service

GET /api/v1/watch/namespaces/{namespace}/services/{name}


778



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


779

QueryParameter

resourceVersion


false string

PathParameter


true string

PathParameter


true string





3.2.192.3. Consumes

/

3.2.192.4. Produces

application/json

3.2.192.5. Tags


780

apiv1

3.2.193. watch changes to an object of kind Namespace

GET /api/v1/watch/namespaces/{name}



QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean


781

QueryParameter

resourceVersion


false string

PathParameter


true string





3.2.193.3. Consumes

/

3.2.193.4. Produces

application/json

3.2.193.5. Tags

apiv1

3.2.194. watch individual changes to a list of Node

GET /api/v1/watch/nodes



782


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


783





3.2.194.3. Consumes

/

3.2.194.4. Produces

application/json

3.2.194.5. Tags

apiv1

3.2.195. watch changes to an object of kind Node

GET /api/v1/watch/nodes/{name}



784


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


785

PathParameter


true string





3.2.195.3. Consumes

/

3.2.195.4. Produces

application/json

3.2.195.5. Tags

apiv1


GET /api/v1/watch/persistentvolumeclaims



786


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


787





3.2.196.3. Consumes

/

3.2.196.4. Produces

application/json

3.2.196.5. Tags

apiv1

3.2.197. watch individual changes to a list of PersistentVolume

GET /api/v1/watch/persistentvolumes



788


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


789





3.2.197.3. Consumes

/

3.2.197.4. Produces

application/json

3.2.197.5. Tags

apiv1

3.2.198. watch changes to an object of kind PersistentVolume

GET /api/v1/watch/persistentvolumes/{name}



790


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


791

PathParameter


true string





3.2.198.3. Consumes

/

3.2.198.4. Produces

application/json

3.2.198.5. Tags

apiv1

3.2.199. watch individual changes to a list of Pod

GET /api/v1/watch/pods



792


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


793





3.2.199.3. Consumes

/

3.2.199.4. Produces

application/json

3.2.199.5. Tags

apiv1

3.2.200. watch individual changes to a list of PodTemplate

GET /api/v1/watch/podtemplates



794


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


795





3.2.200.3. Consumes

/

3.2.200.4. Produces

application/json

3.2.200.5. Tags

apiv1


GET /api/v1/watch/replicationcontrollers



796


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


797





3.2.201.3. Consumes

/

3.2.201.4. Produces

application/json

3.2.201.5. Tags

apiv1

3.2.202. watch individual changes to a list of ResourceQuota

GET /api/v1/watch/resourcequotas



798


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


799





3.2.202.3. Consumes

/

3.2.202.4. Produces

application/json

3.2.202.5. Tags

apiv1

3.2.203. watch individual changes to a list of Secret

GET /api/v1/watch/secrets



800


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


801





3.2.203.3. Consumes

/

3.2.203.4. Produces

application/json

3.2.203.5. Tags

apiv1

3.2.204. watch individual changes to a list of SecurityContextConstraints

GET /api/v1/watch/securitycontextconstraints



802


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


803





3.2.204.3. Consumes

/

3.2.204.4. Produces

application/json

3.2.204.5. Tags

apiv1

3.2.205. watch changes to an object of kind SecurityContextConstraints

GET /api/v1/watch/securitycontextconstraints/{name}



804


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


805

PathParameter


true string





3.2.205.3. Consumes

/

3.2.205.4. Produces

application/json

3.2.205.5. Tags

apiv1


GET /api/v1/watch/serviceaccounts



806


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


807





3.2.206.3. Consumes

/

3.2.206.4. Produces

application/json

3.2.206.5. Tags

apiv1

3.2.207. watch individual changes to a list of Service

GET /api/v1/watch/services



808


QueryParameter


false string

QueryParameter


false string

QueryParameter


false string

QueryParameter


false boolean

QueryParameter

resourceVersion


false string


809





3.2.207.3. Consumes

/

3.2.207.4. Produces

application/json

3.2.207.5. Tags

apiv1

3.3. DEFINITIONS

3.3.1. v1.PersistentVolume

A Persistent Volume (PV) is a storage device that is made available for use by applications by anadministrator. When a user requests persistent storage be allocated for a pod, they create apersistent volume claim with the size and type of storage they need. The system will look forpersistent volumes that match that claim and, if one is available, it will assign that persistent volumeto the claim. Information about the volume (type, location, secrets necessary to use it) will beavailable to the claim and the claim may then be used from a pod as a volume source.

Deleting a persistent volume removes the cluster’s record of the volume, and may result in


810

automated processes destroying the underlying network store.



false string


false string


811





spec Spec defines aspecification of apersistent volumeowned by thecluster.Provisioned by anadministrator.More info:http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistent-volumes

false Section 3.3.33,“v1.PersistentVolumeSpec”

status Status representsthe currentinformation/statusfor the persistentvolume.Populated by thesystem. Read-only. More info:http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistent-volumes

false Section 3.3.51,“v1.PersistentVolumeStatus”


3.3.2. v1.MetadataVolumeSource



812


http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistent-volumes

http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistent-volumes

items list of metadatafiles

false Section 2.3.66,“v1.MetadataFile”array


3.3.3. v1.TCPSocketAction

TCPSocketAction describes an action based on opening a socket


port Number or nameof the port toaccess on thecontainer.Number must bein the range 1 to65535. Namemust be anIANA_SVC_NAME.

true string

3.3.4. v1.ResourceQuotaStatus

ResourceQuotaStatus defines the enforced hard limits and observed use.


hard Hard is the set ofenforced hardlimits for eachnamed resource.More info:http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota



813

http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota

used Used is thecurrent observedtotal usage of theresource in thenamespace.



3.3.5. v1.ContainerStateTerminated

ContainerStateTerminated is a terminated state of a container.


exitCode Exit status fromthe lasttermination of thecontainer


signal Signal from thelast termination ofthe container


reason (brief) reasonfrom the lasttermination of thecontainer

false string

message Messageregarding the lasttermination of thecontainer

false string

startedAt Time at whichpreviousexecution of thecontainer started

false string

finishedAt Time at which thecontainer lastterminated

false string


814

containerID Container’s ID inthe format'docker://<container_id>'

false string


3.3.6. v1.ReplicationControllerList

ReplicationControllerList is a collection of replication controllers.



false string


815



false string



items List of replicationcontrollers. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/replication-controller.md

true Section 3.3.66,“v1.ReplicationController” array


3.3.7. v1.Capability

3.3.8. v1.Pod

A pod corresponds to a group of containers running together on the same machine. All containers ina pod share an IP address, and may have access to shared volumes and local fileystem. Likeindividual application containers, pods are considered to be relatively ephemeral rather than durableentities. Pods are scheduled to nodes and remain there until termination (according to restart policy)


816



http://releases.k8s.io/HEAD/docs/user-guide/replication-controller.md

or deletion. When a node dies, the pods scheduled to that node are deleted. Specific pods are neverrescheduled to new nodes; instead, they must be replaced by a component like the replicationcontroller.

See the Kubernetes pod documentation for more information.



false string


false string


817

https://github.com/kubernetes/kubernetes/blob/master/docs/user-guide/pods.md







status Most recentlyobserved status ofthe pod. This datamay not be up todate. Populatedby the system.Read-only. Moreinfo:http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false Section 3.3.103,“v1.PodStatus”


3.3.9. v1.Event

Event is a report of an event somewhere in the cluster.



818





false string


false string


true Section 2.3.113,“v1.ObjectMeta”



819




involvedObject The object thatthis event isabout.


reason This should be ashort, machineunderstandablestring that givesthe reason for thetransition into theobject’s currentstatus.

false string


false string

source The componentreporting thisevent. Should bea short machineunderstandablestring.

false Section 3.3.61,“v1.EventSource”

firstTimestamp The time at whichthe event was firstrecorded. (Time ofserver receipt isin TypeMeta.)

false string

lastTimestamp The time at whichthe most recentoccurrence of thisevent wasrecorded.

false string

count The number oftimes this eventhas occurred.




820

3.3.10. v1.NodeDaemonEndpoints

NodeDaemonEndpoints lists ports opened by daemons running on the Node.


kubeletEndpoint Endpoint on whichKubelet islistening.

false Section 3.3.84,“v1.DaemonEndpoint”

3.3.11. v1.HostPathVolumeSource

HostPathVolumeSource represents bare host directory volume.


path Path of thedirectory on thehost. More info:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#hostpath

true string

3.3.12. v1.Volume

Volume represents a named volume in a pod that may be accessed by any container in the pod.


name Volume’s name.Must be aDNS_LABEL andunique within thepod. More info:http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names

true string


821



hostPath HostPathrepresents a pre-existing file ordirectory on thehost machine thatis directlyexposed to thecontainer. This isgenerally used forsystem agents orother privilegedthings that areallowed to see thehost machine.Most containerswill NOT needthis. More info:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#hostpath


emptyDir EmptyDirrepresents atemporarydirectory thatshares a pod’slifetime. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#emptydir

false Section 2.3.104,“v1.EmptyDirVolumeSource”



822



gcePersistentDisk GCEPersistentDisk represents aGCE Diskresource that isattached to akubelet’s hostmachine and thenexposed to thepod. More info:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk





gitRepo GitReporepresents a gitrepository at aparticular revision.

false Section 2.3.112,“v1.GitRepoVolumeSource”



823



secret Secret representsa secret thatshould populatethis volume. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#secrets

false Section 2.3.38,“v1.SecretVolumeSource”

nfs NFS representsan NFS mount onthe host thatshares a pod’slifetime More info:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs


iscsi ISCSI representsan ISCSI Diskresource that isattached to akubelet’s hostmachine and thenexposed to thepod. More info:http://releases.k8s.io/HEAD/examples/iscsi/README.md




824



http://releases.k8s.io/HEAD/examples/iscsi/README.md

glusterfs Glusterfsrepresents aGlusterfs mounton the host thatshares a pod’slifetime. Moreinfo:http://releases.k8s.io/HEAD/examples/glusterfs/README.md


persistentVolumeClaim

PersistentVolumeClaimVolumeSource represents areference to aPersistentVolumeClaim in the samenamespace. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

false Section 2.3.51,“v1.PersistentVolumeClaimVolumeSource”





825








flocker Flockerrepresents aFlocker volumeattached to akubelet’s hostmachine. Thisdepends on theFlocker controlservice beingrunning


downwardAPI DownwardAPIrepresentsdownward APIabout the pod thatshould populatethis volume

false Section 2.3.126,“v1.DownwardAPIVolumeSource”



826




metadata

false Section 2.3.1,“v1.MetadataVolumeSource”


3.3.13. v1.ContainerStateRunning

ContainerStateRunning is a running state of a container.


startedAt Time at which thecontainer was last(re-)started

false string

3.3.14. v1.DeleteOptions

DeleteOptions may be provided when deleting an API object



827


false string


false string



828



gracePeriodSeconds

The duration inseconds beforethe object shouldbe deleted. Valuemust be non-negative integer.The value zeroindicates deleteimmediately. Ifthis value is nil,the default graceperiod for thespecified type willbe used. Defaultsto a per objectvalue if notspecified. zeromeans deleteimmediately.



3.3.15. v1.PodTemplateSpec

PodTemplateSpec describes the data a pod should have when created from a template






3.3.16. v1.SecretList


829



3.3.16. v1.SecretList

SecretList is a list of Secret.



false string


false string


830





items Items is a list ofsecret objects.More info:http://releases.k8s.io/HEAD/docs/user-guide/secrets.md

true Section 3.3.97,“v1.Secret” array


3.3.17. v1.NFSVolumeSource

NFSVolumeSource represents an NFS mount that lasts the lifetime of a pod


server Server is thehostname or IPaddress of theNFS server. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs

true string


831


http://releases.k8s.io/HEAD/docs/user-guide/secrets.md


path Path that isexported by theNFS server. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs

true string

readOnly ReadOnly herewill force the NFSexport to bemounted withread-onlypermissions.Defaults to false.More info:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs

false boolean false


3.3.18. v1.CephFSVolumeSource

CephFSVolumeSource represents a Ceph Filesystem Mount that lasts the lifetime of a pod


monitors Required:Monitors is acollection of Cephmonitors Moreinfo:http://releases.k8s.io/HEAD/examples/cephfs/README.md#how-to-use-it

true string array


832




user Optional: User isthe rados username, default isadmin More info:http://releases.k8s.io/HEAD/examples/cephfs/README.md#how-to-use-it

false string

secretFile Optional:SecretFile is thepath to key ring forUser, default is/etc/ceph/user.secret More info:http://releases.k8s.io/HEAD/examples/cephfs/README.md#how-to-use-it

false string

secretRef Optional:SecretRef isreference to theauthenticationsecret for User,default is empty.More info:http://releases.k8s.io/HEAD/examples/cephfs/README.md#how-to-use-it




833




readOnly Optional: Defaultsto false(read/write).ReadOnly herewill force theReadOnly settingin VolumeMounts.More info:http://releases.k8s.io/HEAD/examples/cephfs/README.md#how-to-use-it

false boolean false


3.3.19. v1.Capabilities

Adds and removes POSIX capabilities from running containers.


add Added capabilities false Section 2.3.8,“v1.Capability”array

drop Removedcapabilities

false Section 2.3.8,“v1.Capability”array

3.3.20. v1.ComponentCondition

Information about the condition of a component.


type Type of conditionfor a component.Valid value:"Healthy"

true string


834


status Status of thecondition for acomponent. Validvalues for"Healthy": "True","False", or"Unknown".

true string

message Message aboutthe condition for acomponent. Forexample,information abouta health check.

false string

error Condition errorcode for acomponent. Forexample, a healthcheck error code.

false string


3.3.21. unversioned.Status

Status is a return value for calls that don’t return other objects.



835


false string


false string





836




status Status of theoperation. One of:"Success" or"Failure". Moreinfo:http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false string


false string

reason A machine-readabledescription of whythis operation is inthe "Failure"status. If thisvalue is emptythere is noinformationavailable. AReason clarifiesan HTTP statuscode but does notoverride it.

false string

details Extended dataassociated withthe reason. Eachreason maydefine its ownextended details.This field isoptional and thedata returned isnot guaranteed toconform to anyschema exceptthat defined bythe reason type.

false Section 2.3.37,“unversioned.StatusDetails”



837


code Suggested HTTPreturn code forthis status, 0 if notset.



3.3.22. v1.ServiceStatus

ServiceStatus represents the current status of a service.


loadBalancer LoadBalancercontains thecurrent status ofthe load-balancer,if one is present.

false Section 3.3.90,“v1.LoadBalancerStatus”

3.3.23. unversioned.StatusDetails

StatusDetails is a set of additional properties that MAY be set by the server to provide additionalinformation 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 assumethat any attribute may be empty, invalid, or under defined.


name The nameattribute of theresourceassociated withthe statusStatusReason(when there is asingle namewhich can bedescribed).

false string


838

kind The kind attributeof the resourceassociated withthe statusStatusReason. Onsome operationsmay differ fromthe requestedresource Kind.More info:http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false string

causes The Causes arrayincludes moredetails associatedwith theStatusReasonfailure. Not allStatusReasonsmay providedetailed causes.

false Section 2.3.159,“unversioned.StatusCause” array

retryAfterSeconds If specified, thetime in secondsbefore theoperation shouldbe retried.



3.3.24. v1.SecretVolumeSource

SecretVolumeSource adapts a Secret into a VolumeSource. More info:http://releases.k8s.io/HEAD/docs/design/secrets.md



839


http://releases.k8s.io/HEAD/docs/design/secrets.md

secretName SecretName isthe name of asecret in thepod’s namespace.More info:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#secrets

true string


3.3.25. v1.ResourceRequirements

ResourceRequirements describes the compute resource requirements.


limits Limits describesthe maximumamount ofcomputeresourcesallowed. Moreinfo:http://releases.k8s.io/HEAD/docs/design/resources.md#resource-specifications



840



requests Requestsdescribes theminimum amountof computeresourcesrequired. IfRequests isomitted for acontainer, itdefaults to Limitsif that is explicitlyspecified,otherwise to animplementation-defined value.More info:http://releases.k8s.io/HEAD/docs/design/resources.md#resource-specifications



3.3.26. v1.PersistentVolumeClaim




841



false string


false string





842




spec Spec defines thedesiredcharacteristics ofa volumerequested by apod author. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

false Section 3.3.65,“v1.PersistentVolumeClaimSpec”

status Status representsthe currentinformation/statusof a persistentvolume claim.Read-only. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

false Section 3.3.127,“v1.PersistentVolumeClaimStatus”


3.3.27. unversioned.Patch

Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.

3.3.28. v1.SecurityContextConstraintsList



843




false string


false string

metadata




844



items

true Section 3.3.69,“v1.SecurityContextConstraints”array


3.3.29. v1.NamespaceStatus

NamespaceStatus is information about the current status of a Namespace.


phase Phase is thecurrent lifecyclephase of thenamespace. Moreinfo:http://releases.k8s.io/HEAD/docs/design/namespaces.md#phases

false string

3.3.30. v1.PersistentVolumeAccessMode

3.3.31. v1.ResourceQuotaSpec

ResourceQuotaSpec defines the desired hard limits to enforce for Quota.


hard Hard is the set ofdesired hardlimits for eachnamed resource.More info:http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota



845

http://releases.k8s.io/HEAD/docs/design/namespaces.md#phases


3.3.32. v1.RunAsUserStrategyOptions


type strategy used togenerateRunAsUser

false string

uid the uid to alwaysrun as; requiredfor MustRunAs


uidRangeMin min value forrange basedallocators


uidRangeMax max value forrange basedallocators


3.3.33. v1.PersistentVolumeSpec

PersistentVolumeSpec is the specification of a persistent volume.


capacity A description ofthe persistentvolume’sresources andcapacity. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#capacity



846

http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#capacity

gcePersistentDisk GCEPersistentDisk represents aGCE Diskresource that isattached to akubelet’s hostmachine and thenexposed to thepod. Provisionedby an admin.More info:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk







847



hostPath HostPathrepresents adirectory on thehost. Provisionedby a developer ortester. This isuseful for single-nodedevelopment andtesting only! On-host storage isnot supported inany way andWILL NOT WORKin a multi-nodecluster. More info:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#hostpath


glusterfs Glusterfsrepresents aGlusterfs volumethat is attached toa host andexposed to thepod. Provisionedby an admin.More info:http://releases.k8s.io/HEAD/examples/glusterfs/README.md


nfs NFS representsan NFS mount onthe host.Provisioned by anadmin. More info:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#nfs




848






iscsi ISCSI representsan ISCSI Diskresource that isattached to akubelet’s hostmachine and thenexposed to thepod. Provisionedby an admin.








849





flocker Flockerrepresents aFlocker volumeattached to akubelet’s hostmachine andexposed to thepod for its usage.This depends onthe Flockercontrol servicebeing running


accessModes AccessModescontains all waysthe volume canbe mounted. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#access-modes

false Section 3.3.30,“v1.PersistentVolumeAccessMode”array



850

http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#access-modes

claimRef ClaimRef is partof a bi-directionalbinding betweenPersistentVolumeandPersistentVolumeClaim. Expectedto be non-nilwhen bound.claim.VolumeName is theauthoritative bindbetween PV andPVC. More info:http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#binding


persistentVolumeReclaimPolicy

What happens toa persistentvolume whenreleased from itsclaim. Validoptions are Retain(default) andRecycle. Recylingmust besupported by thevolume plug-inunderlying thispersistent volume.More info:http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#recycling-policy

false string


3.3.34. v1.ExecAction

ExecAction describes a "run in container" action.


851

http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#binding

http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#recycling-policy


command Command is thecommand line toexecute inside thecontainer, theworking directoryfor the commandis root ('/') in thecontainer’sfilesystem. Thecommand issimply exec’d, it isnot run inside ashell, sotraditional shellinstructions ('|',etc) won’t work.To use a shell,you need toexplicitly call outto that shell. Exitstatus of 0 istreated aslive/healthy andnon-zero isunhealthy.

false string array

3.3.35. v1.PersistentVolumeClaimVolumeSource

PersistentVolumeClaimVolumeSource references the user’s PVC in the same namespace. Thisvolume finds the bound PV and mounts that volume for the pod. APersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume thatis owned by someone else (the system).



852

claimName ClaimName is thename of aPersistentVolumeClaim in the samenamespace asthe pod using thisvolume. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

true string

readOnly Will force theReadOnly settingin VolumeMounts.Default false.

false boolean false


3.3.36. v1.ServiceSpec

ServiceSpec describes the attributes that a user creates on a service.


ports The list of portsthat are exposedby this service.More info:http://releases.k8s.io/HEAD/docs/user-guide/services.md#virtual-ips-and-service-proxies

true Section 3.3.56,“v1.ServicePort”array


853


http://releases.k8s.io/HEAD/docs/user-guide/services.md#virtual-ips-and-service-proxies

selector This service willroute traffic topods havinglabels matchingthis selector.Label keys andvalues that mustmatch in order toreceive traffic forthis service. Ifempty, all podsare selected, ifnot specified,endpoints must bemanuallyspecified. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/services.md#overview


portalIP deprecated, useclusterIP instead

false string



854

http://releases.k8s.io/HEAD/docs/user-guide/services.md#overview

clusterIP ClusterIP isusually assignedby the master andis the IP addressof the service. Ifspecified, it will beallocated to theservice if it isunused or elsecreation of theservice will fail.Valid values areNone, emptystring (""), or avalid IP address.'None' can bespecified for aheadless servicewhen proxying isnot required.Cannot beupdated. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/services.md#virtual-ips-and-service-proxies

false string

type Type of exposedservice. Must beClusterIP,NodePort, orLoadBalancer.Defaults toClusterIP. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/services.md#external-services

false string



855


http://releases.k8s.io/HEAD/docs/user-guide/services.md#external-services

externalIPs externalIPs is alist of IPaddresses forwhich nodes inthe cluster willalso accept trafficfor this service.These IPs are notmanaged byKubernetes. Theuser isresponsible forensuring thattraffic arrives at anode with this IP.A commonexample isexternal load-balancers that arenot part of theKubernetessystem. Aprevious form ofthis functionalityexists as thedeprecatedPublicIPs field. Whenusing this field,callers shouldalso clear thedeprecatedPublicIPs field.

false string array



856

deprecatedPublicIPs

deprecatedPublicIPs is deprecatedand replaced bythe externalIPsfield with almostthe exact samesemantics. Thisfield is retained inthe v1 API forcompatibility untilat least8/20/2016. It willbe removed fromany new APIrevisions. If bothdeprecatedPublicIPs andexternalIPs areset,deprecatedPublicIPs is used.

false string array

sessionAffinity Supports"ClientIP" and"None". Used tomaintain sessionaffinity. Enableclient IP basedsession affinity.Must be ClientIPor None. Defaultsto None. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/services.md#virtual-ips-and-service-proxies

false string



857


loadBalancerIP Only applies toService Type:LoadBalancerLoadBalancer willget created withthe IP specified inthis field. Thisfeature dependson whether theunderlying cloud-provider supportsspecifying theloadBalancerIPwhen a loadbalancer iscreated. This fieldwill be ignored ifthe cloud-providerdoes not supportthe feature.

false string


3.3.37. v1.ServiceList

ServiceList holds a list of services.



false string


858



false string



items List of services true Section 3.3.105,“v1.Service” array


3.3.38. v1.PersistentVolumeList

PersistentVolumeList is a list of PersistentVolume items.



859




false string


false string





860




items List of persistentvolumes. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md

true Section 3.3.1,“v1.PersistentVolume” array


3.3.39. v1.ContainerStatus

ContainerStatus contains details for the current status of this container.


name This must be aDNS_LABEL.Each container ina pod must have aunique name.Cannot beupdated.

true string

state Details about thecontainer’scurrent condition.

false Section 3.3.99,“v1.ContainerState”

lastState Details about thecontainer’s lastterminationcondition.

false Section 3.3.99,“v1.ContainerState”

ready Specifies whetherthe container haspassed itsreadiness probe.

true boolean false


861

http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md

restartCount The number oftimes thecontainer hasbeen restarted,currently basedon the number ofdead containersthat have not yetbeen removed.Note that this iscalculated fromdead containers.But thosecontainers aresubject togarbagecollection. Thisvalue will getcapped at 5 byGC.


image The image thecontainer isrunning. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/images.md

true string

imageID ImageID of thecontainer’s image.

true string

containerID Container’s ID inthe format'docker://<container_id>'. More info:http://releases.k8s.io/HEAD/docs/user-guide/container-environment.md#container-information

false string


3.3.40. v1.Handler


862


http://releases.k8s.io/HEAD/docs/user-guide/container-environment.md#container-information

Handler defines a specific action that should be taken








3.3.41. v1.NodeAddress

NodeAddress contains information for the node’s address.


type Node addresstype, one ofHostname,ExternalIP orInternalIP.

true string

address The nodeaddress.

true string

3.3.42. v1.FCVolumeSource

A Fibre Channel Disk can only be mounted as read/write once.


863


targetWWNs Required: FCtarget world widenames (WWNs)

true string array

lun Required: FCtarget lun number


fsType Required:Filesystem type tomount. Must be afilesystem typesupported by thehost operatingsystem. Ex."ext4", "xfs", "ntfs"

true string

readOnly Optional: Defaultsto false(read/write).ReadOnly herewill force theReadOnly settingin VolumeMounts.

false boolean false

3.3.43. v1.EndpointPort

EndpointPort is a tuple that describes a single port.


name The name of thisport (correspondstoServicePort.Name). Must be aDNS_LABEL.Optional only ifone port isdefined.

false string

port The port numberof the endpoint.



864

protocol The IP protocol forthis port. Must beUDP or TCP.Default is TCP.

false string


3.3.44. v1.DownwardAPIVolumeFile

DownwardAPIVolumeFile represents a single file containing information from the downward API


path Required: Path isthe relative pathname of the file tobe created. Mustnot be absolute orcontain the '..'path. Must be utf-8 encoded. Thefirst item of therelative path mustnot start with '..'

true string

fieldRef Required: Selectsa field of the pod:only annotations,labels, name andnamespace aresupported.


3.3.45. v1.EndpointSubset

EndpointSubset is a group of addresses with a common set of ports. The expanded set of endpointsis 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 ]


865


addresses IP addresseswhich offer therelated ports thatare marked asready. Theseendpoints shouldbe consideredsafe for loadbalancers andclients to utilize.

false Section 3.3.113,“v1.EndpointAddress” array

notReadyAddresses

IP addresseswhich offer therelated ports butare not currentlymarked as readybecause theyhave not yetfinished starting,have recentlyfailed a readinesscheck, or haverecently failed aliveness check.

false Section 3.3.113,“v1.EndpointAddress” array

ports Port numbersavailable on therelated IPaddresses.

false Section 3.3.43,“v1.EndpointPort”array

3.3.46. v1.LimitRangeList

LimitRangeList is a list of LimitRange items.



866


false string


false string





867




items Items is a list ofLimitRangeobjects. Moreinfo:http://releases.k8s.io/HEAD/docs/design/admission_control_limit_range.md

true Section 3.3.125,“v1.LimitRange”array


3.3.47. v1.Container

A single application container that you want to run within a pod.


name Name of thecontainerspecified as aDNS_LABEL.Each container ina pod must have aunique name(DNS_LABEL).Cannot beupdated.

true string

image Docker imagename. More info:http://releases.k8s.io/HEAD/docs/user-guide/images.md

false string


868

http://releases.k8s.io/HEAD/docs/design/admission_control_limit_range.md


command Entrypoint array.Not executedwithin a shell. Thedocker image’sentrypoint is usedif this is notprovided. Variablereferences$(VAR_NAME)are expandedusing thecontainer’senvironment. If avariable cannotbe resolved, thereference in theinput string will beunchanged. The$(VAR_NAME)syntax can beescaped with adouble , ie:(VAR_NAME).Escapedreferences willnever beexpanded,regardless ofwhether thevariable exists ornot. Cannot beupdated. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/containers.md#containers-and-commands

false string array



869


args Arguments to theentrypoint. Thedocker image’scmd is used if thisis not provided.Variablereferences$(VAR_NAME)are expandedusing thecontainer’senvironment. If avariable cannotbe resolved, thereference in theinput string will beunchanged. The$(VAR_NAME)syntax can beescaped with adouble , ie:(VAR_NAME).Escapedreferences willnever beexpanded,regardless ofwhether thevariable exists ornot. Cannot beupdated. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/containers.md#containers-and-commands

false string array

workingDir Container’sworking directory.Defaults toDocker’s default.D efaults toimage’s default.Cannot beupdated.

false string



870


ports List of ports toexpose from thecontainer. Cannotbe updated.

false Section 2.3.124,“v1.ContainerPort” array

env List ofenvironmentvariables to set inthe container.Cannot beupdated.


resources ComputeResourcesrequired by thiscontainer. Cannotbe updated. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#resources


volumeMounts Pod volumes tomount into thecontainer’sfilesyste. Cannotbe updated.

false Section 2.3.90,“v1.VolumeMount” array

livenessProbe Periodic probe ofcontainerliveness.Container will berestarted if theprobe fails.Cannot beupdated. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes




871



readinessProbe Periodic probe ofcontainer servicereadiness.Container will beremoved fromservice endpointsif the probe fails.Cannot beupdated. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes


lifecycle Actions that themanagementsystem shouldtake in responseto containerlifecycle events.Cannot beupdated.

false Section 2.3.139,“v1.Lifecycle”

terminationMessagePath

Optional: Path atwhich the file towhich thecontainer’sterminationmessage will bewritten is mountedinto thecontainer’sfilesystem.Message writtenis intended to bebrief final status,such as anassertion failuremessage.Defaults to/dev/termination-log. Cannot beupdated.

false string



872


imagePullPolicy Image pull policy.One of Always,Never,IfNotPresent.Defaults toAlways if :latesttag is specified, orIfNotPresentotherwise. Cannotbe updated. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/images.md#updating-images

false string

securityContext Security optionsthe pod shouldrun with. Moreinfo:http://releases.k8s.io/HEAD/docs/design/security_context.md

false Section 2.3.75,“v1.SecurityContext”

stdin Whether thiscontainer shouldallocate a bufferfor stdin in thecontainer runtime.If this is not set,reads from stdinin the containerwill always resultin EOF. Default isfalse.

false boolean false



873

http://releases.k8s.io/HEAD/docs/user-guide/images.md#updating-images

http://releases.k8s.io/HEAD/docs/design/security_context.md

stdinOnce Whether thecontainer runtimeshould close thestdin channelafter it has beenopened by asingle attach.When stdin is truethe stdin streamwill remain openacross multipleattach sessions. IfstdinOnce is setto true, stdin isopened oncontainer start, isempty until thefirst clientattaches to stdin,and then remainsopen and acceptsdata until theclient disconnects,at which timestdin is closedand remainsclosed until thecontainer isrestarted. If thisflag is false, acontainerprocesses thatreads from stdinwill never receivean EOF. Default isfalse

false boolean false

tty Whether thiscontainer shouldallocate a TTY foritself, alsorequires 'stdin' tobe true. Default isfalse.

false boolean false


3.3.48. v1.MetadataFile


874


name the name of thefile to be created

true string

fieldRef selects a field ofthe pod.Supported fields:metadata.annotations,metadata.labels,metadata.name,metadata.namespace


3.3.49. v1.PodSpec

PodSpec is a description of a pod.


volumes List of volumesthat can bemounted bycontainersbelonging to thepod. More info:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md

false Section 2.3.19,“v1.Volume” array


875

http://releases.k8s.io/HEAD/docs/user-guide/volumes.md

containers List of containersbelonging to thepod. Containerscannot currentlybe added orremoved. Theremust be at leastone container in aPod. Cannot beupdated. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/containers.md

true Section 2.3.64,“v1.Container”array

restartPolicy Restart policy forall containerswithin the pod.One of Always,OnFailure, Never.Default to Always.More info:http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#restartpolicy

false string



876

http://releases.k8s.io/HEAD/docs/user-guide/containers.md

http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#restartpolicy

terminationGracePeriodSeconds

Optional durationin seconds thepod needs toterminategracefully. May bedecreased indelete request.Value must benon-negativeinteger. The valuezero indicatesdeleteimmediately. Ifthis value is nil,the default graceperiod will beused instead. Thegrace period isthe duration inseconds after theprocessesrunning in the podare sent atermination signaland the timewhen theprocesses areforcibly haltedwith a kill signal.Set this valuelonger than theexpected cleanuptime for yourprocess. Defaultsto 30 seconds.




877

activeDeadlineSeconds

Optional durationin seconds thepod may beactive on thenode relative toStartTime beforethe system willactively try tomark it failed andkill associatedcontainers. Valuemust be a positiveinteger.


dnsPolicy Set DNS policy forcontainers withinthe pod. One of'ClusterFirst' or'Default'. Defaultsto "ClusterFirst".

false string

nodeSelector NodeSelector is aselector whichmust be true forthe pod to fit on anode. Selectorwhich must matcha node’s labels forthe pod to bescheduled on thatnode. More info:http://releases.k8s.io/HEAD/docs/user-guide/node-selection/README.md


host deprecated, usenodeNameinstead

false string



878

http://releases.k8s.io/HEAD/docs/user-guide/node-selection/README.md

serviceAccountName

ServiceAccountName is the nameof theServiceAccount touse to run thispod. More info:http://releases.k8s.io/HEAD/docs/design/service_accounts.md

false string

serviceAccount DeprecatedServiceAccount is adepreciated aliasforServiceAccountName. Deprecated:UseserviceAccountName instead.

false string

nodeName NodeName is arequest toschedule this podonto a specificnode. If it is non-empty, thescheduler simplyschedules thispod onto thatnode, assumingthat it fitsresourcerequirements.

false string

hostNetwork Host networkingrequested for thispod. Use thehost’s networknamespace. If thisoption is set, theports that will beused must bespecified. Defaultto false.

false boolean false



879

http://releases.k8s.io/HEAD/docs/design/service_accounts.md

hostPID Use the host’s pidnamespace.Optional: Defaultto false.

false boolean false

hostIPC Use the host’s ipcnamespace.Optional: Defaultto false.

false boolean false

securityContext SecurityContextholds pod-levelsecurity attributesand commoncontainer settings.Optional: Defaultsto empty. Seetype descriptionfor default valuesof each field.

false Section 2.3.96,“v1.PodSecurityContext”



880

imagePullSecrets ImagePullSecretsis an optional listof references tosecrets in thesame namespaceto use for pullingany of the imagesused by thisPodSpec. Ifspecified, thesesecrets will bepassed toindividual pullerimplementationsfor them to use.For example, inthe case ofdocker, onlyDockerConfigtype secrets arehonored. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/images.md#specifying-imagepullsecrets-on-a-pod



3.3.50. v1.FlockerVolumeSource

FlockerVolumeSource represents a Flocker volume mounted by the Flocker agent.


datasetName Required: thevolume name.This is going to bestore on metadata→ name on thepayload forFlocker

true string

3.3.51. v1.PersistentVolumeStatus

PersistentVolumeStatus is the current status of a persistent volume.


881

http://releases.k8s.io/HEAD/docs/user-guide/images.md#specifying-imagepullsecrets-on-a-pod


phase Phase indicates ifa volume isavailable, boundto a claim, orreleased by aclaim. More info:http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#phase

false string

message A human-readablemessageindicating detailsabout why thevolume is in thisstate.

false string

reason Reason is a briefCamelCase stringthat describesany failure and ismeant formachine parsingand tidy display inthe CLI.

false string


RBDVolumeSource represents a Rados Block Device Mount that lasts the lifetime of a pod


monitors A collection ofCeph monitors.More info:http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it

true string array


882

http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#phase


image The rados imagename. More info:http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it

true string

fsType Filesystem type ofthe volume thatyou want tomount. Tip:Ensure that thefilesystem type issupported by thehost operatingsystem.Examples: "ext4","xfs", "ntfs". Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#rbd

false string

pool The rados poolname. Default isrbd. More info:http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it.

true string

user The rados username. Default isadmin. More info:http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it

true string



883


http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#rbd



keyring Keyring is thepath to key ring forRBDUser. Defaultis/etc/ceph/keyring.More info:http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it

true string

secretRef SecretRef isname of theauthenticationsecret forRBDUser. Ifprovidedoverrides keyring.Default is empty.More info:http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it


readOnly ReadOnly herewill force theReadOnly settingin VolumeMounts.Defaults to false.More info:http://releases.k8s.io/HEAD/examples/rbd/README.md#how-to-use-it

false boolean false


3.3.53. v1.LoadBalancerIngress

LoadBalancerIngress represents the status of a load-balancer ingress point: traffic intended for theservice should be sent to an ingress point.



884




ip IP is set for load-balancer ingresspoints that are IPbased (typicallyGCE orOpenStack load-balancers)

false string

hostname Hostname is setfor load-balanceringress points thatare DNS based(typically AWSload-balancers)

false string


3.3.54. v1.SupplementalGroupsStrategyOptions

SupplementalGroupsStrategyOptions is the strategy that will dictate what supplemental groups areused by the SecurityContext.


type strategy used togeneratesupplementalgroups

false string

ranges ranges ofallowable IDs forsupplementalgroups

false Section 3.3.83,“v1.IDRange”array

3.3.55. v1.SecurityContext

SecurityContext holds security configuration that will be applied to a container. Some fields arepresent in both SecurityContext and PodSecurityContext. When both are set, the values inSecurityContext take precedence.


885


capabilities The capabilities toadd/drop whenrunningcontainers.Defaults to thedefault set ofcapabilitiesgranted by thecontainer runtime.

false Section 2.3.30,“v1.Capabilities”

privileged Run container inprivileged mode.Processes inprivilegedcontainers areessentiallyequivalent to rooton the host.Defaults to false.

false boolean false

seLinuxOptions The SELinuxcontext to beapplied to thecontainer. Ifunspecified, thecontainer runtimewill allocate arandom SELinuxcontext for eachcontainer. Mayalso be set inPodSecurityContext. If set in bothSecurityContextandPodSecurityContext, the valuespecified inSecurityContexttakesprecedence.



886

runAsUser The UID to runthe entrypoint ofthe containerprocess. Defaultsto user specifiedin imagemetadata ifunspecified. Mayalso be set inPodSecurityContext. If set in bothSecurityContextandPodSecurityContext, the valuespecified inSecurityContexttakesprecedence.


runAsNonRoot Indicates that thecontainer mustrun as a non-rootuser. If true, theKubelet willvalidate the imageat runtime toensure that itdoes not run asUID 0 (root) andfail to start thecontainer if itdoes. If unset orfalse, no suchvalidation will beperformed. Mayalso be set inPodSecurityContext. If set in bothSecurityContextandPodSecurityContext, the valuespecified inSecurityContexttakesprecedence.

false boolean false


3.3.56. v1.ServicePort


887

ServicePort conatins information on service’s port.


name The name of thisport within theservice. This mustbe aDNS_LABEL. Allports within aServiceSpec musthave uniquenames. Thismaps to the'Name' field inEndpointPortobjects. Optionalif only oneServicePort isdefined on thisservice.

false string

protocol The IP protocol forthis port.Supports "TCP"and "UDP".Default is TCP.

false string

port The port that willbe exposed bythis service.



888

targetPort Number or nameof the port toaccess on thepods targeted bythe service.Number must bein the range 1 to65535. Namemust be anIANA_SVC_NAME. If this is astring, it will belooked up as anamed port in thetarget Pod’scontainer ports. Ifthis is notspecified, thevalue of Port isused (an identitymap). Defaults tothe service port.More info:http://releases.k8s.io/HEAD/docs/user-guide/services.md#defining-a-service

false string



889

http://releases.k8s.io/HEAD/docs/user-guide/services.md#defining-a-service

nodePort The port on eachnode on whichthis service isexposed whentype=NodePort orLoadBalancer.Usually assignedby the system. Ifspecified, it will beallocated to theservice if unusedor else creation ofthe service willfail. Default is toauto-allocate aport if theServiceType ofthis Servicerequires one.More info:http://releases.k8s.io/HEAD/docs/user-guide/services.md#type— nodeport



3.3.57. v1.Namespace

Namespace provides a scope for Names. Use of multiple namespaces is optional.



890

http://releases.k8s.io/HEAD/docs/user-guide/services.md#type??nodeport


false string


false string



891





spec Spec defines thebehavior of theNamespace.More info:http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false Section 3.3.87,“v1.NamespaceSpec”

status Status describesthe current statusof a Namespace.More info:http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false Section 3.3.29,“v1.NamespaceStatus”


3.3.58. v1.GCEPersistentDiskVolumeSource

GCEPersistentDiskVolumeSource represents a Persistent Disk resource in Google ComputeEngine.

A GCE PD must exist and be formatted before mounting to a container. The disk must also be in thesame GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once.



892




pdName Unique name ofthe PD resourcein GCE. Used toidentify the disk inGCE. More info:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk

true string

fsType Filesystem type ofthe volume thatyou want tomount. Tip:Ensure that thefilesystem type issupported by thehost operatingsystem.Examples: "ext4","xfs", "ntfs". Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk

true string



893



partition The partition inthe volume thatyou want tomount. If omitted,the default is tomount by volumename. Examples:For volume/dev/sda1, youspecify thepartition as "1".Similarly, thevolume partitionfor /dev/sda is "0"(or you can leavethe propertyempty). More info:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk


readOnly ReadOnly herewill force theReadOnly settingin VolumeMounts.Defaults to false.More info:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#gcepersistentdisk

false boolean false


3.3.59. v1.EndpointsList

EndpointsList is a list of endpoints.



894




false string


false string





895




items List of endpoints. true Section 3.3.100,“v1.Endpoints”array


3.3.60. v1.NodeList

NodeList is the whole list of all Nodes which have been registered with master.



false string


896



false string



items List of nodes true Section 3.3.116,“v1.Node” array


3.3.61. v1.EventSource

EventSource contains information for an event.


component Component fromwhich the event isgenerated.

false string


897



host Host name onwhich the event isgenerated.

false string


3.3.62. v1.EnvVarSource

EnvVarSource represents a source for the value of an EnvVar.


fieldRef Selects a field ofthe pod. Onlyname andnamespace aresupported.


3.3.63. unversioned.ListMeta

ListMeta describes metadata that synthetic resources must have, including lists and various statusobjects. A resource may have only one of {ObjectMeta, ListMeta}.



false string


898

resourceVersion String thatidentifies theserver’s internalversion of thisobject that can beused by clients todetermine whenobjects havechanged. Valuemust be treatedas opaque byclients andpassedunmodified backto the server.Populated by thesystem. Read-only. More info:http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency

false string


3.3.64. v1.LimitRangeSpec

LimitRangeSpec defines a min/max usage limit for resources that match on kind.


limits Limits is the list ofLimitRangeItemobjects that areenforced.

true Section 3.3.123,“v1.LimitRangeItem” array

3.3.65. v1.PersistentVolumeClaimSpec

PersistentVolumeClaimSpec describes the common attributes of storage devices and allows aSource for provider-specific attributes


899



accessModes AccessModescontains thedesired accessmodes thevolume shouldhave. More info:http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#access-modes-1


resources Resourcesrepresents theminimumresources thevolume shouldhave. More info:http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#resources


volumeName VolumeName isthe bindingreference to thePersistentVolumebacking this claim.

false string

3.3.66. v1.ReplicationController

ReplicationController represents the configuration of a replication controller.



900

http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#access-modes-1



false string


false string



901



metadata If the Labels of aReplicationController are empty,they are defaultedto be the same asthe Pod(s) thatthe replicationcontrollermanages.Standard object’smetadata. Moreinfo:http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata


spec Spec defines thespecification ofthe desiredbehavior of thereplicationcontroller. Moreinfo:http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false Section 3.3.120,“v1.ReplicationControllerSpec”

status Status is the mostrecently observedstatus of thereplicationcontroller. Thisdata may be outof date by somewindow of time.Populated by thesystem. Read-only. More info:http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false Section 3.3.72,“v1.ReplicationControllerStatus”



902




3.3.67. v1.NamespaceList

NamespaceList is a list of Namespaces.



false string


false string


903





items Items is the list ofNamespaceobjects in the list.More info:http://releases.k8s.io/HEAD/docs/user-guide/namespaces.md

true Section 3.3.57,“v1.Namespace”array


3.3.68. integer

3.3.69. v1.SecurityContextConstraints



false string


904





false string

metadata


allowPrivilegedContainer

allow containersto run asprivileged

true boolean false

allowedCapabilities

capabilities thatare allowed to beadded

true Section 2.3.8,“v1.Capability”array

allowHostDirVolumePlugin

allow the use ofthe host dirvolume plugin

true boolean false

allowHostNetwork allow the use ofthe hostNetworkin the pod spec

true boolean false

allowHostPorts allow the use ofthe host ports inthe containers

true boolean false



905


allowHostPID allow the use ofthe host pid in thecontainers

true boolean false

allowHostIPC allow the use ofthe host ipc in thecontainers

true boolean false

seLinuxContext strategy used togenerateSELinuxOptions

false Section 3.3.102,“v1.SELinuxContextStrategyOptions”

runAsUser strategy used togenerateRunAsUser

false Section 3.3.32,“v1.RunAsUserStrategyOptions”

supplementalGroups

strategy used togeneratesupplementalgroups

false Section 3.3.54,“v1.SupplementalGroupsStrategyOptions”

fsGroup strategy used togenerate fsGroup

false Section 3.3.111,“v1.FSGroupStrategyOptions”

users users allowed touse thisSecurityContextConstraints

false string array

groups groups allowed touse thisSecurityContextConstraints

false string array


3.3.70. v1.VolumeMount


906

VolumeMount describes a mounting of a Volume within a container.


name This must matchthe Name of aVolume.

true string

readOnly Mounted read-only if true, read-write otherwise(false orunspecified).Defaults to false.

false boolean false

mountPath Path within thecontainer at whichthe volume shouldbe mounted.

true string

3.3.71. v1.NodeStatus

NodeStatus is information about the current status of a node.


capacity Capacityrepresents theavailableresources of anode. More info:http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#capacity for moredetails.



907

http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#capacity

phase NodePhase is therecently observedlifecycle phase ofthe node. Moreinfo:http://releases.k8s.io/HEAD/docs/admin/node.md#node-phase

false string

conditions Conditions is anarray of currentobserved nodeconditions. Moreinfo:http://releases.k8s.io/HEAD/docs/admin/node.md#node-condition

false Section 3.3.74,“v1.NodeCondition” array

addresses List of addressesreachable to thenode. Queriedfrom cloudprovider, ifavailable. Moreinfo:http://releases.k8s.io/HEAD/docs/admin/node.md#node-addresses

false Section 3.3.41,“v1.NodeAddress”array

daemonEndpoints Endpoints ofdaemons runningon the Node.

false Section 3.3.10,“v1.NodeDaemonEndpoints”



908

http://releases.k8s.io/HEAD/docs/admin/node.md#node-phase

http://releases.k8s.io/HEAD/docs/admin/node.md#node-condition

http://releases.k8s.io/HEAD/docs/admin/node.md#node-addresses

nodeInfo Set of ids/uuids touniquely identifythe node. Moreinfo:http://releases.k8s.io/HEAD/docs/admin/node.md#node-info

false Section 3.3.110,“v1.NodeSystemInfo”


3.3.72. v1.ReplicationControllerStatus

ReplicationControllerStatus represents the current status of a replication controller.


replicas Replicas is themost recentlyoberved numberof replicas. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/replication-controller.md#what-is-a-replication-controller


observedGeneration

ObservedGeneration reflects thegeneration of themost recentlyobservedreplicationcontroller.


3.3.73. v1.PodCondition

PodCondition contains details for the current condition of this pod.


909

http://releases.k8s.io/HEAD/docs/admin/node.md#node-info

http://releases.k8s.io/HEAD/docs/user-guide/replication-controller.md#what-is-a-replication-controller


type Type is the typeof the condition.Currently onlyReady. More info:http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#pod-conditions

true string

status Status is thestatus of thecondition. Can beTrue, False,Unknown. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#pod-conditions

true string

lastProbeTime Last time weprobed thecondition.

false string

lastTransitionTime

Last time theconditiontransitioned fromone status toanother.

false string

reason Unique, one-word,CamelCasereason for thecondition’s lasttransition.

false string

message Human-readablemessageindicating detailsabout lasttransition.

false string


910

http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#pod-conditions


3.3.74. v1.NodeCondition

NodeCondition contains condition infromation for a node.


type Type of nodecondition,currently onlyReady.

true string

status Status of thecondition, one ofTrue, False,Unknown.

true string

lastHeartbeatTime

Last time we gotan update on agiven condition.

false string

lastTransitionTime

Last time thecondition transitfrom one status toanother.

false string

reason (brief) reason forthe condition’slast transition.

false string

message Human readablemessageindicating detailsabout lasttransition.

false string

3.3.75. v1.PodSecurityContext

PodSecurityContext holds pod-level security attributes and common container settings. Some fieldsare also present in container.securityContext. Field values of container.securityContext takeprecedence over field values of PodSecurityContext.


911


seLinuxOptions The SELinuxcontext to beapplied to allcontainers. Ifunspecified, thecontainer runtimewill allocate arandom SELinuxcontext for eachcontainer. Mayalso be set inSecurityContext. Ifset in bothSecurityContextandPodSecurityContext, the valuespecified inSecurityContexttakes precedencefor that container.


runAsUser The UID to runthe entrypoint ofthe containerprocess. Defaultsto user specifiedin imagemetadata ifunspecified. Mayalso be set inSecurityContext. Ifset in bothSecurityContextandPodSecurityContext, the valuespecified inSecurityContexttakes precedencefor that container.



912

runAsNonRoot Indicates that thecontainer mustrun as a non-rootuser. If true, theKubelet willvalidate the imageat runtime toensure that itdoes not run asUID 0 (root) andfail to start thecontainer if itdoes. If unset orfalse, no suchvalidation will beperformed. Mayalso be set inSecurityContext. Ifset in bothSecurityContextandPodSecurityContext, the valuespecified inSecurityContexttakesprecedence.

false boolean false

supplementalGroups

A list of groupsapplied to the firstprocess run ineach container, inaddition to thecontainer’sprimary GID. Ifunspecified, nogroups will beadded to anycontainer.

false Section 2.3.89,“integer” array



913

fsGroup A specialsupplementalgroup that appliesto all containers ina pod. Somevolume typesallow the Kubeletto change theownership of thatvolume to beowned by the pod:

1. The owningGID will be theFSGroup 2. Thesetgid bit is set(new files createdin the volume willbe owned byFSGroup) 3. Thepermission bitsare OR’d with rw-rw



3.3.76. 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



914


false string


false string



915





secrets Secrets is the listof secrets allowedto be used bypods runningusing thisServiceAccount.More info:http://releases.k8s.io/HEAD/docs/user-guide/secrets.md

false Section 2.3.132,“v1.ObjectReference” array

imagePullSecrets ImagePullSecretsis a list ofreferences tosecrets in thesame namespaceto use for pullingany images inpods thatreference thisServiceAccount.ImagePullSecretsare distinct fromSecrets becauseSecrets can bemounted in thepod, butImagePullSecretsare only accessedby the kubelet.More info:http://releases.k8s.io/HEAD/docs/user-guide/secrets.md#manually-specifying-an-imagepullsecret




916


http://releases.k8s.io/HEAD/docs/user-guide/secrets.md

http://releases.k8s.io/HEAD/docs/user-guide/secrets.md#manually-specifying-an-imagepullsecret

3.3.77. v1.PodTemplate

PodTemplate describes a template for creating copies of a predefined pod.



false string


false string


917





template Template definesthe pods that willbe created fromthis pod template.http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status



3.3.78. v1.PodList

PodList is a list of Pods.



false string


918





false string



items List of pods. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/pods.md

true Section 3.3.8,“v1.Pod” array


3.3.79. v1.EmptyDirVolumeSource

EmptyDirVolumeSource is temporary directory that shares a pod’s lifetime.



919



http://releases.k8s.io/HEAD/docs/user-guide/pods.md

medium What type ofstorage mediumshould back thisdirectory. Thedefault is "" whichmeans to use thenode’s defaultmedium. Must bean empty string(default) orMemory. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#emptydir

false string


3.3.80. v1.NodeSpec

NodeSpec describes the attributes that a node is created with.


podCIDR PodCIDRrepresents thepod IP rangeassigned to thenode.

false string

externalID External ID of thenode assigned bysome machinedatabase (e.g. acloud provider).Deprecated.

false string

providerID ID of the nodeassigned by thecloud provider inthe format:<ProviderName>://<ProviderSpecificNodeID>

false string


920


unschedulable Unschedulablecontrols nodeschedulability ofnew pods. Bydefault, node isschedulable.More info:http://releases.k8s.io/HEAD/docs/admin/node.md#manual-node-administration

false boolean false


3.3.81. v1.HTTPGetAction

HTTPGetAction describes an action based on HTTP Get requests.


path Path to access onthe HTTP server.

false string

port Name or numberof the port toaccess on thecontainer.Number must bein the range 1 to65535. Namemust be anIANA_SVC_NAME.

true string

host Host name toconnect to,defaults to thepod IP.

false string

scheme Scheme to use forconnecting to thehost. Defaults toHTTP.

false string


921

http://releases.k8s.io/HEAD/docs/admin/node.md#manual-node-administration

3.3.82. v1.ResourceQuotaList

ResourceQuotaList is a list of ResourceQuota items.



false string


false string


922





items Items is a list ofResourceQuotaobjects. Moreinfo:http://releases.k8s.io/HEAD/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota

true Section 3.3.117,“v1.ResourceQuota” array


3.3.83. v1.IDRange

IDRange provides a min/max of an allowed range of IDs.


min min value for therange


max min value for therange


3.3.84. v1.DaemonEndpoint

DaemonEndpoint contains information about a single Daemon endpoint.


923




Port Port number ofthe givenendpoint.


3.3.85. v1.ServiceAccountList

ServiceAccountList is a list of ServiceAccount objects



false string


924



false string



items List ofServiceAccounts.More info:http://releases.k8s.io/HEAD/docs/design/service_accounts.md#service-accounts

true Section 3.3.76,“v1.ServiceAccount” array


3.3.86. v1.Probe

Probe describes a liveness probe to be examined to the container.


925



http://releases.k8s.io/HEAD/docs/design/service_accounts.md#service-accounts








initialDelaySeconds

Number ofseconds after thecontainer hasstarted beforeliveness probesare initiated. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes


timeoutSeconds Number ofseconds afterwhich livenessprobes timeout.Defaults to 1second. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-probes



926



3.3.87. v1.NamespaceSpec

NamespaceSpec describes the attributes on a Namespace.


finalizers Finalizers is anopaque list ofvalues that mustbe empty topermanentlyremove objectfrom storage.More info:http://releases.k8s.io/HEAD/docs/design/namespaces.md#finalizers

false Section 2.3.165,“v1.FinalizerName” array

3.3.88. v1.ISCSIVolumeSource

ISCSIVolumeSource describes an ISCSI Disk can only be mounted as read/write once.


targetPortal iSCSI targetportal. The portalis either an IP orip_addr:port if theport is other thandefault (typicallyTCP ports 860and 3260).

true string

iqn Target iSCSIQualified Name.

true string

lun iSCSI target lunnumber.



927

http://releases.k8s.io/HEAD/docs/design/namespaces.md#finalizers

fsType Filesystem type ofthe volume thatyou want tomount. Tip:Ensure that thefilesystem type issupported by thehost operatingsystem.Examples: "ext4","xfs", "ntfs". Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#iscsi

true string

readOnly ReadOnly herewill force theReadOnly settingin VolumeMounts.Defaults to false.

false boolean false


3.3.89. v1.EventList

EventList is a list of events.



928

http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#iscsi


false string


false string



929





items List of events true Section 3.3.9,“v1.Event” array


3.3.90. v1.LoadBalancerStatus

LoadBalancerStatus represents the status of a load-balancer.


ingress Ingress is a listcontaining ingresspoints for theload-balancer.Traffic intendedfor the serviceshould be sent tothese ingresspoints.

false Section 3.3.53,“v1.LoadBalancerIngress” array

3.3.91. v1.PersistentVolumeClaimList

PersistentVolumeClaimList is a list of PersistentVolumeClaim items.



930



false string


false string





931




items A list of persistentvolume claims.More info:http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

true Section 3.3.26,“v1.PersistentVolumeClaim” array


3.3.92. v1.ComponentStatus

ComponentStatus (and ComponentStatusList) holds the cluster validation info.



false string


932




false string



conditions List of componentconditionsobserved

false Section 3.3.20,“v1.ComponentCondition” array


3.3.93. v1.GitRepoVolumeSource

GitRepoVolumeSource represents a volume that is pulled from git when the pod is created.


repository Repository URL true string


933



revision Commit hash forthe specifiedrevision.

true string


3.3.94. v1.ObjectMeta

ObjectMeta is metadata that all persisted resources must have, which includes all objects usersmust create.


name Name must beunique within anamespace. Isrequired whencreatingresources,although someresources mayallow a client torequest thegeneration of anappropriate nameautomatically.Name is primarilyintended forcreationidempotence andconfigurationdefinition. Cannotbe updated. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names

false string

generateName GenerateName isan optional prefix,used by theserver, togenerate a uniquename ONLY IFthe Name fieldhas not beenprovided. If this

false string


934


field is used, thename returned tothe client will bedifferent than thename passed.This value willalso be combinedwith a uniquesuffix. Theprovided valuehas the samevalidation rules asthe Name field,and may betruncated by thelength of the suffixrequired to makethe value uniqueon the server.

If this field isspecified and thegenerated nameexists, the serverwill NOT return a409 - instead, itwill either return201 Created or500 with ReasonServerTimeoutindicating aunique namecould not befound in the timeallotted, and theclient should retry(optionally afterthe time indicatedin the Retry-Afterheader).

Applied only ifName is notspecified. Moreinfo:http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#idempotency



935

http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#idempotency

namespace Namespacedefines the spacewithin each namemust be unique.An emptynamespace isequivalent to the"default"namespace, but"default" is thecanonicalrepresentation.Not all objects arerequired to bescoped to anamespace - thevalue of this fieldfor those objectswill be empty.

Must be aDNS_LABEL.Cannot beupdated. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/namespaces.md

false string


false string



936


uid UID is the uniquein time and spacevalue for thisobject. It istypicallygenerated by theserver onsuccessfulcreation of aresource and isnot allowed tochange on PUToperations.

Populated by thesystem. Read-only. More info:http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#uids

false string



937


resourceVersion An opaque valuethat representsthe internalversion of thisobject that can beused by clients todetermine whenobjects havechanged. May beused for optimisticconcurrency,change detection,and the watchoperation on aresource or set ofresources. Clientsmust treat thesevalues as opaqueand passedunmodified backto the server.They may only bevalid for aparticularresource or set ofresources.

Populated by thesystem. Read-only. Value mustbe treated asopaque by clientsand . More info:http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency

false string



938


generation A sequencenumberrepresenting aspecificgeneration of thedesired state.Currently onlyimplemented byreplicationcontrollers.Populated by thesystem. Read-only.


creationTimestamp

CreationTimestamp is a timestamprepresenting theserver time whenthis object wascreated. It is notguaranteed to beset in happens-before orderacross separateoperations.Clients may notset this value. It isrepresented inRFC3339 formand is in UTC.

Populated by thesystem. Read-only. Null for lists.More info:http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

false string

deletionTimestamp

DeletionTimestamp is RFC 3339date and time atwhich thisresource will bedeleted. This field

false string



939


is set by theserver when agraceful deletionis requested bythe user, and isnot directlysettable by aclient. Theresource will bedeleted (no longervisible fromresource lists, andnot reachable byname) after thetime in this field.Once set, thisvalue may not beunset or be setfurther into thefuture, although itmay be shortenedor the resourcemay be deletedprior to this time.For example, auser may requestthat a pod isdeleted in 30seconds. TheKubelet will reactby sending agracefultermination signalto the containersin the pod. Oncethe resource isdeleted in theAPI, the Kubeletwill send a hardtermination signalto the container. Ifnot set, gracefuldeletion of theobject has notbeen requested.

Populated by thesystem when agraceful deletionis requested.Read-only. Moreinfo:http://releases.k8s



940


.io/HEAD/docs/devel/api-conventions.md#metadatadeletionGracePeri

odSecondsNumber ofseconds allowedfor this object togracefullyterminate before itwill be removedfrom the system.Only set whendeletionTimestamp is also set. Mayonly beshortened. Read-only.


labels Map of string keysand values thatcan be used toorganize andcategorize (scopeand select)objects. Maymatch selectors ofreplicationcontrollers andservices. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/labels.md




941

http://releases.k8s.io/HEAD/docs/user-guide/labels.md

annotations Annotations is anunstructured keyvalue map storedwith a resourcethat may be setby external toolsto store andretrieve arbitrarymetadata. Theyare not queryableand should bepreserved whenmodifying objects.More info:http://releases.k8s.io/HEAD/docs/user-guide/annotations.md



3.3.95. v1.LocalObjectReference

LocalObjectReference contains enough information to let you locate the referenced object inside thesame namespace.



false string

3.3.96. v1.ContainerPort

ContainerPort represents a network port in a single container.



942

http://releases.k8s.io/HEAD/docs/user-guide/annotations.md


name If specified, thismust be anIANA_SVC_NAME and uniquewithin the pod.Each named portin a pod musthave a uniquename. Name forthe port that canbe referred to byservices.

false string

hostPort Number of port toexpose on thehost. If specified,this must be avalid port number,0 < x < 65536. IfHostNetwork isspecified, thismust matchContainerPort.Most containersdo not need this.


containerPort Number of port toexpose on thepod’s IP address.This must be avalid port number,0 < x < 65536.


protocol Protocol for port.Must be UDP orTCP. Defaults to"TCP".

false string

hostIP What host IP tobind the externalport to.

false string



943

3.3.97. v1.Secret

Secret holds secret data of a certain type. The total bytes of the values in the Data field must be lessthan MaxSecretSize bytes.



false string


false string


944





data Data contains thesecret data. Eachkey must be avalidDNS_SUBDOMAIN or leading dotfollowed by validDNS_SUBDOMAIN. The serializedform of the secretdata is a base64encoded string,representing thearbitrary (possiblynon-string) datavalue here.Described inhttps://tools.ietf.org/html/rfc4648#section-4


type Used to facilitateprogrammatichandling of secretdata.

false string


3.3.98. v1.DownwardAPIVolumeSource

DownwardAPIVolumeSource represents a volume containing downward API info


items Items is a list ofdownward APIvolume file

false Section 2.3.63,“v1.DownwardAPIVolumeFile” array


945


https://tools.ietf.org/html/rfc4648#section-4

3.3.99. v1.ContainerState

ContainerState holds a possible state of container. Only one of its members may be specified. Ifnone of them is specified, the default one is ContainerStateWaiting.


waiting Details about awaiting container

false Section 3.3.121,“v1.ContainerStateWaiting”

running Details about arunning container

false Section 3.3.13,“v1.ContainerStateRunning”

terminated Details about aterminatedcontainer

false Section 3.3.5,“v1.ContainerStateTerminated”

3.3.100. 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}]},]



946


false string


false string





947




subsets The set of allendpoints is theunion of allsubsets.Addresses areplaced intosubsets accordingto the IPs theyshare. A singleaddress withmultiple ports,some of which areready and someof which are not(because theycome fromdifferentcontainers) willresult in theaddress beingdisplayed indifferent subsetsfor the differentports. No addresswill appear in bothAddresses andNotReadyAddresses in the samesubset. Sets ofaddresses andports thatcomprise aservice.

true Section 3.3.45,“v1.EndpointSubset” array


3.3.101. v1.CinderVolumeSource

CinderVolumeSource represents a cinder volume resource in Openstack. A Cinder volume mustexist before mounting to a container. The volume must also be in the same region as the kubelet.



948

volumeID volume id used toidentify thevolume in cinderMore info:http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

true string

fsType Required:Filesystem type tomount. Must be afilesystem typesupported by thehost operatingsystem. Only ext3and ext4 areallowed Moreinfo:http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

false string

readOnly Optional: Defaultsto false(read/write).ReadOnly herewill force theReadOnly settingin VolumeMounts.More info:http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

false boolean false


3.3.102. v1.SELinuxContextStrategyOptions


type strategy used togenerate theSELinux context

false string


949




seLinuxOptions seLinuxOptionsrequired to run as;required forMustRunAs



3.3.103. v1.PodStatus

PodStatus represents information about the status of a pod. Status may trail the actual state of asystem.


phase Current conditionof the pod. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#pod-phase

false string

conditions Current servicestate of pod. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#pod-conditions

false Section 3.3.73,“v1.PodCondition”array

message A humanreadablemessageindicating detailsabout why thepod is in thiscondition.

false string


950

http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#pod-phase


reason A briefCamelCasemessageindicating detailsabout why thepod is in thisstate. e.g.'OutOfDisk'

false string

hostIP IP address of thehost to which thepod is assigned.Empty if not yetscheduled.

false string

podIP IP addressallocated to thepod. Routable atleast within thecluster. Empty ifnot yet allocated.

false string

startTime RFC 3339 dateand time at whichthe object wasacknowledged bythe Kubelet. Thisis before theKubelet pulled thecontainerimage(s) for thepod.

false string



951

containerStatuses The list has oneentry percontainer in themanifest. Eachentry is currentlythe output of docker inspect. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-statuses

false Section 3.3.39,“v1.ContainerStatus” array


3.3.104. v1.SELinuxOptions

SELinuxOptions are the labels to be applied to the container


user User is a SELinuxuser label thatapplies to thecontainer.

false string

role Role is a SELinuxrole label thatapplies to thecontainer.

false string

type Type is a SELinuxtype label thatapplies to thecontainer.

false string

level Level is SELinuxlevel label thatapplies to thecontainer.

false string

3.3.105. v1.Service


952

http://releases.k8s.io/HEAD/docs/user-guide/pod-states.md#container-statuses

A Service is an abstraction which defines a logical set of Pods and a policy by which to access them- sometimes called a micro-service. The set of Pods targeted by a Service is (usually) determinedby a Label selector. Services broadly fall into two types - those that load balance a set of Pods andhide which Pod a client talks to (clusterIP set to an IP address), and those where clients want to talkto the individual member pods directly (clusterIP set to 'None', also known as 'headless’services).The cluster IP of a service is exposed as an environment variable in each pod in the samenamespace.

Services may be exposed only inside the cluster (type ClusterIP), inside the cluster and on a highport on each node (type NodePort), or exposed to a load balancer via the hosting cloudinfrastructure (type LoadBalancer). Services with a ClusterIP may choose to map the ports availableon the ClusterIP to different ports on the pods. Each service has a DNS entry of the form <name>.<namespace>.svc.cluster.local that will be valid from other pods in the cluster.

If the selector for pods is not specified, the service endpoints may be managed by the client directly.Update the endpoint resource to program the service - this can be used to inject external networkservices into a namsepace.

See the Kubernetes service documentation for more information.



false string


953

https://github.com/kubernetes/kubernetes/blob/master/docs/user-guide/services.md



false string



spec Spec defines thebehavior of aservice.http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false Section 3.3.36,“v1.ServiceSpec”



954




status Most recentlyobserved status ofthe service.Populated by thesystem. Read-only. More info:http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false Section 3.3.22,“v1.ServiceStatus”


3.3.106. v1.ObjectReference

ObjectReference contains enough information to let you inspect or modify the referred object.


kind Kind of thereferent. Moreinfo:http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

false string

namespace Namespace of thereferent. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/namespaces.md

false string


false string


955





uid UID of thereferent. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#uids

false string

apiVersion API version of thereferent.

false string

resourceVersion SpecificresourceVersionto which thisreference ismade, if any.More info:http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency

false string



956



fieldPath If referring to apiece of an objectinstead of anentire object, thisstring shouldcontain a validJSON/Go fieldaccess statement,such asdesiredState.manifest.containers[2].For example, ifthe objectreference is to acontainer within apod, this wouldtake on a valuelike:"spec.containers{name}" (where"name" refers tothe name of thecontainer thattriggered theevent) or if nocontainer name isspecified"spec.containers[2]" (container withindex 2 in thispod). This syntaxis chosen only tohave some well-defined way ofreferencing a partof an object.

false string


3.3.107. v1.ObjectFieldSelector

ObjectFieldSelector selects an APIVersioned field of an object.



957

apiVersion Version of theschema theFieldPath iswritten in termsof, defaults to"v1".

false string

fieldPath Path of the field toselect in thespecified APIversion.

true string


3.3.108. v1.ComponentStatusList

Status of all the conditions for the component as a list of ComponentStatus objects.



false string


958



false string



items List ofComponentStatusobjects.

true Section 3.3.92,“v1.ComponentStatus” array


3.3.109. v1.Lifecycle

Lifecycle describes actions that the management system should take in response to containerlifecycle events. For the PostStart and PreStop lifecycle handlers, management of the containerblocks until the action is complete, unless the container process fails, in which case the handler isaborted.



959



postStart PostStart is calledimmediately aftera container iscreated. If thehandler fails, thecontainer isterminated andrestartedaccording to itsrestart policy.Othermanagement ofthe containerblocks until thehook completes.More info:http://releases.k8s.io/HEAD/docs/user-guide/container-environment.md#hook-details




960


preStop PreStop is calledimmediatelybefore a containeris terminated. Thecontainer isterminated afterthe handlercompletes. Thereason fortermination ispassed to thehandler.Regardless of theoutcome of thehandler, thecontainer iseventuallyterminated. Othermanagement ofthe containerblocks until thehook completes.More info:http://releases.k8s.io/HEAD/docs/user-guide/container-environment.md#hook-details



3.3.110. v1.NodeSystemInfo

NodeSystemInfo is a set of ids/uuids to uniquely identify the node.


machineID Machine IDreported by thenode.

true string

systemUUID System UUIDreported by thenode.

true string


961


bootID Boot ID reportedby the node.

true string

kernelVersion Kernel Versionreported by thenode from 'uname-r' (e.g. 3.16.0-0.bpo.4-amd64).

true string

osImage OS Imagereported by thenode from /etc/os-release (e.g.DebianGNU/Linux 7(wheezy)).

true string

containerRuntimeVersion

ContainerRuntimeVersion reportedby the nodethrough runtimeremote API (e.g.docker://1.5.0).

true string

kubeletVersion Kubelet Versionreported by thenode.

true string

kubeProxyVersion KubeProxyVersion reportedby the node.

true string


3.3.111. v1.FSGroupStrategyOptions

FSGroupStrategyOptions is the strategy that will dictate what fs group is used by theSecurityContext.



962

type strategy used togenerate fsGroup

false string

ranges ranges ofallowable IDs forfsGroup

false Section 3.3.83,“v1.IDRange”array


3.3.112. json.WatchEvent


type the type of watchevent; may beADDED,MODIFIED,DELETED, orERROR

false string

object the object beingwatched; willmatch the type ofthe resourceendpoint or be aStatus object ifthe type isERROR

false string

3.3.113. v1.EndpointAddress

EndpointAddress is a tuple that describes single IP address.



963

ip The IP of thisendpoint. May notbe loopback(127.0.0.0/8), link-local(169.254.0.0/16),or link-localmulticast((224.0.0.0/24).

true string

targetRef Reference toobject providingthe endpoint.



3.3.114. v1.AWSElasticBlockStoreVolumeSource

Represents a persistent disk resource in AWS.

An Amazon Elastic Block Store (EBS) must already be created, formatted, and reside in the sameAWS zone as the kubelet before it can be mounted. Note: Amazon EBS volumes can be mounted toonly one instance at a time.


volumeID Unique ID of thepersistent diskresource in AWS(Amazon EBSvolume). Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore

true string


964


fsType Filesystem type ofthe volume thatyou want tomount. Tip:Ensure that thefilesystem type issupported by thehost operatingsystem.Examples: "ext4","xfs", "ntfs". Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore

true string

partition The partition inthe volume thatyou want tomount. If omitted,the default is tomount by volumename. Examples:For volume/dev/sda1, youspecify thepartition as "1".Similarly, thevolume partitionfor /dev/sda is "0"(or you can leavethe propertyempty).




965


readOnly Specify "true" toforce and set theReadOnlyproperty inVolumeMounts to"true". If omitted,the default is"false". More info:http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#awselasticblockstore

false boolean false


3.3.115. v1.Binding

Binding ties one object to another. For example, a pod is bound to a node by a scheduler.



false string


966




false string



target The target objectthat you want tobind to thestandard object.



3.3.116. v1.Node

Nodes represent the machines that run the pods and containers in the cluster. A node resource istypically created and modified by the software running on the node - reporting information aboutcapacity and the current health of the node. The labels of the node can be used by pods to specify asubset of the cluster to be scheduled on. The scheduler will only assign pods to nodes that have the schedulable condition set and also ready.



967




false string


false string



968





spec Spec defines thebehavior of anode.http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false Section 3.3.80,“v1.NodeSpec”

status Most recentlyobserved status ofthe node.Populated by thesystem. Read-only. More info:http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false Section 3.3.71,“v1.NodeStatus”


3.3.117. v1.ResourceQuota

ResourceQuota sets aggregate quota restrictions enforced per namespace



969





false string


false string





970




spec Spec defines thedesired quota.http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false Section 3.3.31,“v1.ResourceQuotaSpec”

status Status defines theactual enforcedquota and itscurrent usage.http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false Section 3.3.4,“v1.ResourceQuotaStatus”


3.3.118. v1.EnvVar

EnvVar represents an environment variable present in a Container.


name Name of theenvironmentvariable. Must bea C_IDENTIFIER.

true string


971



value Variablereferences$(VAR_NAME)are expandedusing theprevious definedenvironmentvariables in thecontainer and anyserviceenvironmentvariables. If avariable cannotbe resolved, thereference in theinput string will beunchanged. The$(VAR_NAME)syntax can beescaped with adouble , ie:(VAR_NAME).Escapedreferences willnever beexpanded,regardless ofwhether thevariable exists ornot. Defaults to "".

false string

valueFrom Source for theenvironmentvariable’s value.Cannot be used ifvalue is notempty.

false Section 2.3.83,“v1.EnvVarSource”


3.3.119. unversioned.StatusCause

StatusCause provides more information about an api.Status failure, including cases when multipleerrors are encountered.



972

reason A machine-readabledescription of thecause of theerror. If this valueis empty there isno informationavailable.

false string

message A human-readabledescription of thecause of theerror. This fieldmay be presentedas-is to a reader.

false string

field The field of theresource that hascaused this error,as named by itsJSONserialization. Mayinclude dot andpostfix notation fornested attributes.Arrays are zero-indexed. Fieldsmay appear morethan once in anarray of causesdue to fieldshaving multipleerrors. Optional.

Examples:"name" - the field"name" on thecurrent resource"items[0].name" -the field "name"on the first arrayentry in "items"

false string


3.3.120. v1.ReplicationControllerSpec

ReplicationControllerSpec is the specification of a replication controller.


973


replicas Replicas is thenumber of desiredreplicas. This is apointer todistinguishbetween explicitzero andunspecified.Defaults to 1.More info:http://releases.k8s.io/HEAD/docs/user-guide/replication-controller.md#what-is-a-replication-controller


selector Selector is a labelquery over podsthat should matchthe Replicascount. If Selectoris empty, it isdefaulted to thelabels present onthe Pod template.Label keys andvalues that mustmatch in order tobe controlled bythis replicationcontroller, ifempty defaultedto labels on Podtemplate. Moreinfo:http://releases.k8s.io/HEAD/docs/user-guide/labels.md#label-selectors



974

http://releases.k8s.io/HEAD/docs/user-guide/replication-controller.md#what-is-a-replication-controller

http://releases.k8s.io/HEAD/docs/user-guide/labels.md#label-selectors

template Template is theobject thatdescribes the podthat will becreated ifinsufficientreplicas aredetected. Thistakes precedenceover aTemplateRef.More info:http://releases.k8s.io/HEAD/docs/user-guide/replication-controller.md#pod-template



3.3.121. v1.ContainerStateWaiting

ContainerStateWaiting is a waiting state of a container.


reason (brief) reason thecontainer is notyet running.

false string

message Messageregarding why thecontainer is notyet running.

false string

3.3.122. v1.PodTemplateList

PodTemplateList is a list of PodTemplates.



975

http://releases.k8s.io/HEAD/docs/user-guide/replication-controller.md#pod-template


false string


false string





976




items List of podtemplates

true Section 3.3.77,“v1.PodTemplate”array


3.3.123. v1.LimitRangeItem

LimitRangeItem defines a min/max usage limit for any resource that matches on kind.


type Type of resourcethat this limitapplies to.

false string

max Max usageconstraints on thiskind by resourcename.


min Min usageconstraints on thiskind by resourcename.


default Default resourcerequirement limitvalue by resourcename if resourcelimit is omitted.


defaultRequest DefaultRequest isthe defaultresourcerequirementrequest value byresource name ifresource requestis omitted.



977

maxLimitRequestRatio

MaxLimitRequestRatio if specified,the namedresource musthave a requestand limit that areboth non-zerowhere limitdivided by requestis less than orequal to theenumeratedvalue; thisrepresents themax burst for thenamed resource.



3.3.124. v1.FinalizerName

3.3.125. v1.LimitRange

LimitRange sets resource usage limits for each kind of resource in a Namespace.



false string


978



false string



spec Spec defines thelimits enforced.More info:http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

false Section 3.3.64,“v1.LimitRangeSpec”


3.3.126. v1.GlusterfsVolumeSource

GlusterfsVolumeSource represents a Glusterfs Mount that lasts the lifetime of a pod.


979





endpoints EndpointsName isthe endpointname that detailsGlusterfstopology. Moreinfo:http://releases.k8s.io/HEAD/examples/glusterfs/README.md#create-a-pod

true string

path Path is theGlusterfs volumepath. More info:http://releases.k8s.io/HEAD/examples/glusterfs/README.md#create-a-pod

true string

readOnly ReadOnly herewill force theGlusterfs volumeto be mountedwith read-onlypermissions.Defaults to false.More info:http://releases.k8s.io/HEAD/examples/glusterfs/README.md#create-a-pod

false boolean false

3.3.127. v1.PersistentVolumeClaimStatus

PersistentVolumeClaimStatus is the current status of a persistent volume claim.



980




phase Phase representsthe current phaseofPersistentVolumeClaim.

false string

accessModes AccessModescontains theactual accessmodes thevolume backingthe PVC has.More info:http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#access-modes-1


capacity Represents theactual resourcesof the underlyingvolume.



3.3.128. any

Represents an untyped JSON map - see the description of the field for more info about the structureof this object.


981

http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#access-modes-1

CHAPTER 4. REVISION HISTORY: REST API REFERENCE

4.1. TUE OCT 04 2016

Affected Topic Description of Change

Overview Updated the oc whoami --token command to show the shorter flag of oc whoami --t.

4.2. THU NOV 19 2015

OpenShift Enterprise 3.1 release.


982

openshift enterprise 3.1 rest api reference - red hat 536 536 812 982 982 982 table of contents 1....

Documents