diff --git a/_data/samples.yml b/_data/samples.yml index 52ac8d572a..3a9f0bcf28 100644 --- a/_data/samples.yml +++ b/_data/samples.yml @@ -12,6 +12,8 @@ toc: path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/rbd/ - title: CephFS path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/cephfs/ + - title: CockroachDB + path: https://github.com/kubernetes/kubernetes/tree/release-1.4/examples/cockroachdb/ - title: GlusterFS path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/glusterfs/ - title: Hazelcast diff --git a/_data/tasks.yml b/_data/tasks.yml index 90c1f3b8b2..38e1a89c68 100644 --- a/_data/tasks.yml +++ b/_data/tasks.yml @@ -8,6 +8,8 @@ toc: path: /docs/tasks/configure-pod-container/define-environment-variable-container/ - title: Defining a Command and Arguments for a Container path: /docs/tasks/configure-pod-container/define-command-argument-container/ + - title: Assigning CPU and RAM Resources to a Container + path: /docs/tasks/configure-pod-container/assign-cpu-ram-container/ - title: Accessing Applications in a Cluster section: - title: Using Port Forwarding to Access Applications in a Cluster diff --git a/_includes/partner-script.js b/_includes/partner-script.js index 00dc9f1ee1..e4a5362df0 100644 --- a/_includes/partner-script.js +++ b/_includes/partner-script.js @@ -188,6 +188,13 @@ logo: 'jetstack', link: 'https://www.jetstack.io/', blurb: 'Jetstack is an organisation focused entirely on Kubernetes. They will help you to get the most out of Kubernetes through expert professional services and open source tooling. Get in touch, and accelerate your project.' + }, + { + type: 1, + name: 'Tigera', + logo: 'tigera', + link: 'http://docs.projectcalico.org/v1.5/getting-started/kubernetes/', + blurb: 'Tigera builds high performance, policy driven, cloud native networking solutions for Kubernetes.' } ] diff --git a/_includes/v1.4/extensions-v1beta1-definitions.html b/_includes/v1.4/extensions-v1beta1-definitions.html index 59be34cd40..62b899b9fd 100755 --- a/_includes/v1.4/extensions-v1beta1-definitions.html +++ b/_includes/v1.4/extensions-v1beta1-definitions.html @@ -69,12 +69,6 @@

  • v1beta1.NetworkPolicyList

    • -
  • -

    v1beta1.StorageClass

    -
    • -
  • -

    v1beta1.StorageClassList

    -
    • @@ -1213,71 +1207,6 @@ Examples:
    - -
    -

    v1beta1.StorageClass

    -
    -

    StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned.

    -
    -
    -

    StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name.

    -
    - ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    v1.ObjectMeta

    provisioner

    Provisioner indicates the type of the provisioner.

    true

    string

    parameters

    Parameters holds the parameters for the provisioner that should create volumes of this storage class.

    false

    object

    -

    v1.ExecAction

    @@ -1859,61 +1788,6 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

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

    -
    -
    -

    v1beta1.StorageClassList

    -
    -

    StorageClassList is a collection of storage classes.

    -
    - ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    Standard list metadata More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    unversioned.ListMeta

    items

    Items is the list of StorageClasses

    true

    v1beta1.StorageClass array

    -

    v1.FlockerVolumeSource

    @@ -6328,7 +6202,7 @@ Both these may change in the future. Incoming requests are matched against the h
    diff --git a/_includes/v1.4/extensions-v1beta1-operations.html b/_includes/v1.4/extensions-v1beta1-operations.html index 8ac8f8e6f3..a18a2f6030 100755 --- a/_includes/v1.4/extensions-v1beta1-operations.html +++ b/_includes/v1.4/extensions-v1beta1-operations.html @@ -11229,10 +11229,10 @@
    -

    list or watch objects of kind StorageClass

    +

    list or watch objects of kind ThirdPartyResource

    -
    GET /apis/extensions/v1beta1/storageclasses
    +
    GET /apis/extensions/v1beta1/thirdpartyresources
    @@ -11328,7 +11328,7 @@

    200

    success

    -

    v1beta1.StorageClassList

    +

    v1beta1.ThirdPartyResourceList

    @@ -11372,10 +11372,10 @@
    -

    delete collection of StorageClass

    +

    delete collection of ThirdPartyResource

    -
    DELETE /apis/extensions/v1beta1/storageclasses
    +
    DELETE /apis/extensions/v1beta1/thirdpartyresources
    @@ -11515,10 +11515,10 @@
    -

    create a StorageClass

    +

    create a ThirdPartyResource

    -
    POST /apis/extensions/v1beta1/storageclasses
    +
    POST /apis/extensions/v1beta1/thirdpartyresources
    @@ -11556,7 +11556,7 @@

    body

    true

    -

    v1beta1.StorageClass

    +

    v1beta1.ThirdPartyResource

    @@ -11582,7 +11582,7 @@

    200

    success

    -

    v1beta1.StorageClass

    +

    v1beta1.ThirdPartyResource

    @@ -11626,10 +11626,10 @@
    -

    read the specified StorageClass

    +

    read the specified ThirdPartyResource

    -
    GET /apis/extensions/v1beta1/storageclasses/{name}
    +
    GET /apis/extensions/v1beta1/thirdpartyresources/{name}
    @@ -11681,7 +11681,7 @@

    PathParameter

    name

    -

    name of the StorageClass

    +

    name of the ThirdPartyResource

    true

    string

    @@ -11709,7 +11709,7 @@

    200

    success

    -

    v1beta1.StorageClass

    +

    v1beta1.ThirdPartyResource

    @@ -11753,10 +11753,10 @@
    -

    replace the specified StorageClass

    +

    replace the specified ThirdPartyResource

    -
    PUT /apis/extensions/v1beta1/storageclasses/{name}
    +
    PUT /apis/extensions/v1beta1/thirdpartyresources/{name}
    @@ -11794,13 +11794,13 @@

    body

    true

    -

    v1beta1.StorageClass

    +

    v1beta1.ThirdPartyResource

    PathParameter

    name

    -

    name of the StorageClass

    +

    name of the ThirdPartyResource

    true

    string

    @@ -11828,7 +11828,7 @@

    200

    success

    -

    v1beta1.StorageClass

    +

    v1beta1.ThirdPartyResource

    @@ -11872,10 +11872,10 @@
    -

    delete a StorageClass

    +

    delete a ThirdPartyResource

    -
    DELETE /apis/extensions/v1beta1/storageclasses/{name}
    +
    DELETE /apis/extensions/v1beta1/thirdpartyresources/{name}
    @@ -11919,7 +11919,7 @@

    PathParameter

    name

    -

    name of the StorageClass

    +

    name of the ThirdPartyResource

    true

    string

    @@ -11991,10 +11991,10 @@
    -

    partially update the specified StorageClass

    +

    partially update the specified ThirdPartyResource

    -
    PATCH /apis/extensions/v1beta1/storageclasses/{name}
    +
    PATCH /apis/extensions/v1beta1/thirdpartyresources/{name}
    @@ -12038,7 +12038,7 @@

    PathParameter

    name

    -

    name of the StorageClass

    +

    name of the ThirdPartyResource

    true

    string

    @@ -12066,7 +12066,7 @@

    200

    success

    -

    v1beta1.StorageClass

    +

    v1beta1.ThirdPartyResource

    @@ -12116,10 +12116,10 @@
    -

    list or watch objects of kind ThirdPartyResource

    +

    watch individual changes to a list of DaemonSet

    -
    GET /apis/extensions/v1beta1/thirdpartyresources
    +
    GET /apis/extensions/v1beta1/watch/daemonsets
    @@ -12215,7 +12215,7 @@

    200

    success

    -

    v1beta1.ThirdPartyResourceList

    +

    *versioned.Event

    @@ -12239,11 +12239,14 @@

    application/json

  • -

    application/yaml

    +

    application/json;stream=watch

  • application/vnd.kubernetes.protobuf

    • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
    • @@ -12259,10 +12262,10 @@
    -

    delete collection of ThirdPartyResource

    +

    watch individual changes to a list of Deployment

    -
    DELETE /apis/extensions/v1beta1/thirdpartyresources
    +
    GET /apis/extensions/v1beta1/watch/deployments
    @@ -12358,7 +12361,7 @@

    200

    success

    -

    unversioned.Status

    +

    *versioned.Event

    @@ -12382,11 +12385,14 @@

    application/json

  • -

    application/yaml

    +

    application/json;stream=watch

  • application/vnd.kubernetes.protobuf

    • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
    • @@ -12402,10 +12408,10 @@
    -

    create a ThirdPartyResource

    +

    watch individual changes to a list of HorizontalPodAutoscaler

    -
    POST /apis/extensions/v1beta1/thirdpartyresources
    +
    GET /apis/extensions/v1beta1/watch/horizontalpodautoscalers
    @@ -12439,11 +12445,43 @@ -

    BodyParameter

    -

    body

    +

    QueryParameter

    +

    labelSelector

    +

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    +

    false

    +

    string

    -

    true

    -

    v1beta1.ThirdPartyResource

    + + +

    QueryParameter

    +

    fieldSelector

    +

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    +

    false

    +

    string

    + + + +

    QueryParameter

    +

    watch

    +

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    +

    false

    +

    boolean

    + + + +

    QueryParameter

    +

    resourceVersion

    +

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    +

    false

    +

    string

    + + + +

    QueryParameter

    +

    timeoutSeconds

    +

    Timeout for the list/watch call.

    +

    false

    +

    integer (int32)

    @@ -12469,7 +12507,7 @@

    200

    success

    -

    v1beta1.ThirdPartyResource

    +

    *versioned.Event

    @@ -12493,11 +12531,14 @@

    application/json

  • -

    application/yaml

    +

    application/json;stream=watch

  • application/vnd.kubernetes.protobuf

    • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
    • @@ -12513,10 +12554,10 @@
    -

    read the specified ThirdPartyResource

    +

    watch individual changes to a list of Ingress

    -
    GET /apis/extensions/v1beta1/thirdpartyresources/{name}
    +
    GET /apis/extensions/v1beta1/watch/ingresses
    @@ -12551,26 +12592,42 @@

    QueryParameter

    -

    export

    -

    Should this value be exported. Export strips fields that a user can not specify.

    +

    labelSelector

    +

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    +

    false

    +

    string

    + + + +

    QueryParameter

    +

    fieldSelector

    +

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    +

    false

    +

    string

    + + + +

    QueryParameter

    +

    watch

    +

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    -

    exact

    -

    Should the export be exact. Exact export maintains cluster-specific fields like Namespace

    +

    resourceVersion

    +

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    -

    boolean

    +

    string

    -

    PathParameter

    -

    name

    -

    name of the ThirdPartyResource

    -

    true

    -

    string

    +

    QueryParameter

    +

    timeoutSeconds

    +

    Timeout for the list/watch call.

    +

    false

    +

    integer (int32)

    @@ -12596,7 +12653,7 @@

    200

    success

    -

    v1beta1.ThirdPartyResource

    +

    *versioned.Event

    @@ -12620,11 +12677,14 @@

    application/json

  • -

    application/yaml

    +

    application/json;stream=watch

  • application/vnd.kubernetes.protobuf

    • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
    • @@ -12640,10 +12700,10 @@
    -

    replace the specified ThirdPartyResource

    +

    watch individual changes to a list of Job

    -
    PUT /apis/extensions/v1beta1/thirdpartyresources/{name}
    +
    GET /apis/extensions/v1beta1/watch/jobs
    @@ -12677,21 +12737,45 @@ -

    BodyParameter

    -

    body

    - -

    true

    -

    v1beta1.ThirdPartyResource

    +

    QueryParameter

    +

    labelSelector

    +

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    +

    false

    +

    string

    -

    PathParameter

    -

    name

    -

    name of the ThirdPartyResource

    -

    true

    +

    QueryParameter

    +

    fieldSelector

    +

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    +

    false

    string

    + +

    QueryParameter

    +

    watch

    +

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    +

    false

    +

    boolean

    + + + +

    QueryParameter

    +

    resourceVersion

    +

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    +

    false

    +

    string

    + + + +

    QueryParameter

    +

    timeoutSeconds

    +

    Timeout for the list/watch call.

    +

    false

    +

    integer (int32)

    + + @@ -12715,7 +12799,7 @@

    200

    success

    -

    v1beta1.ThirdPartyResource

    +

    *versioned.Event

    @@ -12739,11 +12823,14 @@

    application/json

  • -

    application/yaml

    +

    application/json;stream=watch

  • application/vnd.kubernetes.protobuf

    • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
    • @@ -12759,980 +12846,6 @@
    -

    delete a ThirdPartyResource

    -
    -
    -
    DELETE /apis/extensions/v1beta1/thirdpartyresources/{name}
    -
    -
    -
    -

    Parameters

    - -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    v1.DeleteOptions

    PathParameter

    name

    name of the ThirdPartyResource

    true

    string

    - -
    -
    -

    Responses

    - ----- - - - - - - - - - - - - - - -
    HTTP CodeDescriptionSchema

    200

    success

    unversioned.Status

    - -
    -
    -

    Consumes

    -
    -
      -
    • -

      /

      -
      • -
    -
    -
    -
    -

    Produces

    -
    -
      -
    • -

      application/json

      -
      • -
    • -

      application/yaml

      -
      • -
    • -

      application/vnd.kubernetes.protobuf

      -
      • -
    -
    -
    -
    -

    Tags

    -
    -
      -
    • -

      apisextensionsv1beta1

      -
      • -
    -
    -
    -
    -
    -

    partially update the specified ThirdPartyResource

    -
    -
    -
    PATCH /apis/extensions/v1beta1/thirdpartyresources/{name}
    -
    -
    -
    -

    Parameters

    - -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    unversioned.Patch

    PathParameter

    name

    name of the ThirdPartyResource

    true

    string

    - -
    -
    -

    Responses

    - ----- - - - - - - - - - - - - - - -
    HTTP CodeDescriptionSchema

    200

    success

    v1beta1.ThirdPartyResource

    - -
    -
    -

    Consumes

    -
    -
      -
    • -

      application/json-patch+json

      -
      • -
    • -

      application/merge-patch+json

      -
      • -
    • -

      application/strategic-merge-patch+json

      -
      • -
    -
    -
    -
    -

    Produces

    -
    -
      -
    • -

      application/json

      -
      • -
    • -

      application/yaml

      -
      • -
    • -

      application/vnd.kubernetes.protobuf

      -
      • -
    -
    -
    -
    -

    Tags

    -
    -
      -
    • -

      apisextensionsv1beta1

      -
      • -
    -
    -
    -
    -
    -

    watch individual changes to a list of DaemonSet

    -
    -
    -
    GET /apis/extensions/v1beta1/watch/daemonsets
    -
    -
    -
    -

    Parameters

    - -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    - -
    -
    -

    Responses

    - ----- - - - - - - - - - - - - - - -
    HTTP CodeDescriptionSchema

    200

    success

    *versioned.Event

    - -
    -
    -

    Consumes

    -
    -
      -
    • -

      /

      -
      • -
    -
    -
    -
    -

    Produces

    -
    -
      -
    • -

      application/json

      -
      • -
    • -

      application/json;stream=watch

      -
      • -
    • -

      application/vnd.kubernetes.protobuf

      -
      • -
    • -

      application/vnd.kubernetes.protobuf;stream=watch

      -
      • -
    -
    -
    -
    -

    Tags

    -
    -
      -
    • -

      apisextensionsv1beta1

      -
      • -
    -
    -
    -
    -
    -

    watch individual changes to a list of Deployment

    -
    -
    -
    GET /apis/extensions/v1beta1/watch/deployments
    -
    -
    -
    -

    Parameters

    - -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    - -
    -
    -

    Responses

    - ----- - - - - - - - - - - - - - - -
    HTTP CodeDescriptionSchema

    200

    success

    *versioned.Event

    - -
    -
    -

    Consumes

    -
    -
      -
    • -

      /

      -
      • -
    -
    -
    -
    -

    Produces

    -
    -
      -
    • -

      application/json

      -
      • -
    • -

      application/json;stream=watch

      -
      • -
    • -

      application/vnd.kubernetes.protobuf

      -
      • -
    • -

      application/vnd.kubernetes.protobuf;stream=watch

      -
      • -
    -
    -
    -
    -

    Tags

    -
    -
      -
    • -

      apisextensionsv1beta1

      -
      • -
    -
    -
    -
    -
    -

    watch individual changes to a list of HorizontalPodAutoscaler

    -
    -
    -
    GET /apis/extensions/v1beta1/watch/horizontalpodautoscalers
    -
    -
    -
    -

    Parameters

    - -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    - -
    -
    -

    Responses

    - ----- - - - - - - - - - - - - - - -
    HTTP CodeDescriptionSchema

    200

    success

    *versioned.Event

    - -
    -
    -

    Consumes

    -
    -
      -
    • -

      /

      -
      • -
    -
    -
    -
    -

    Produces

    -
    -
      -
    • -

      application/json

      -
      • -
    • -

      application/json;stream=watch

      -
      • -
    • -

      application/vnd.kubernetes.protobuf

      -
      • -
    • -

      application/vnd.kubernetes.protobuf;stream=watch

      -
      • -
    -
    -
    -
    -

    Tags

    -
    -
      -
    • -

      apisextensionsv1beta1

      -
      • -
    -
    -
    -
    -
    -

    watch individual changes to a list of Ingress

    -
    -
    -
    GET /apis/extensions/v1beta1/watch/ingresses
    -
    -
    -
    -

    Parameters

    - -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    - -
    -
    -

    Responses

    - ----- - - - - - - - - - - - - - - -
    HTTP CodeDescriptionSchema

    200

    success

    *versioned.Event

    - -
    -
    -

    Consumes

    -
    -
      -
    • -

      /

      -
      • -
    -
    -
    -
    -

    Produces

    -
    -
      -
    • -

      application/json

      -
      • -
    • -

      application/json;stream=watch

      -
      • -
    • -

      application/vnd.kubernetes.protobuf

      -
      • -
    • -

      application/vnd.kubernetes.protobuf;stream=watch

      -
      • -
    -
    -
    -
    -

    Tags

    -
    -
      -
    • -

      apisextensionsv1beta1

      -
      • -
    -
    -
    -
    -
    -

    watch individual changes to a list of Job

    -
    -
    -
    GET /apis/extensions/v1beta1/watch/jobs
    -
    -
    -
    -

    Parameters

    - -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    - -
    -
    -

    Responses

    - ----- - - - - - - - - - - - - - - -
    HTTP CodeDescriptionSchema

    200

    success

    *versioned.Event

    - -
    -
    -

    Consumes

    -
    -
      -
    • -

      /

      -
      • -
    -
    -
    -
    -

    Produces

    -
    -
      -
    • -

      application/json

      -
      • -
    • -

      application/json;stream=watch

      -
      • -
    • -

      application/vnd.kubernetes.protobuf

      -
      • -
    • -

      application/vnd.kubernetes.protobuf;stream=watch

      -
      • -
    -
    -
    -
    -

    Tags

    -
    -
      -
    • -

      apisextensionsv1beta1

      -
      • -
    -
    -
    -
    -

    watch individual changes to a list of DaemonSet

    @@ -13740,7 +12853,7 @@
    -

    Parameters

    +

    Parameters

    @@ -13822,7 +12935,7 @@
    -

    Responses

    +

    Responses

    @@ -13847,7 +12960,7 @@
    -

    Consumes

    +

    Consumes

    • @@ -13857,7 +12970,7 @@
    -

    Produces

    +

    Produces

    • @@ -13876,7 +12989,7 @@
    -

    Tags

    +

    Tags

    • @@ -13894,7 +13007,7 @@
    -

    Parameters

    +

    Parameters

    @@ -13984,7 +13097,7 @@
    -

    Responses

    +

    Responses

    @@ -14009,7 +13122,7 @@
    -

    Consumes

    +

    Consumes

    • @@ -14019,7 +13132,7 @@
    -

    Produces

    +

    Produces

    • @@ -14038,7 +13151,7 @@
    -

    Tags

    +

    Tags

    • @@ -14056,7 +13169,7 @@
    -

    Parameters

    +

    Parameters

    @@ -14138,7 +13251,7 @@
    -

    Responses

    +

    Responses

    @@ -14163,7 +13276,7 @@
    -

    Consumes

    +

    Consumes

    • @@ -14173,7 +13286,7 @@
    -

    Produces

    +

    Produces

    • @@ -14192,7 +13305,7 @@
    -

    Tags

    +

    Tags

    • @@ -14210,7 +13323,7 @@
    -

    Parameters

    +

    Parameters

    @@ -14300,7 +13413,7 @@
    -

    Responses

    +

    Responses

    @@ -14325,7 +13438,7 @@
    -

    Consumes

    +

    Consumes

    • @@ -14335,7 +13448,7 @@
    -

    Produces

    +

    Produces

    • @@ -14354,7 +13467,7 @@
    -

    Tags

    +

    Tags

    • @@ -14372,7 +13485,7 @@
    -

    Parameters

    +

    Parameters

    @@ -14454,7 +13567,7 @@
    -

    Responses

    +

    Responses

    @@ -14479,7 +13592,7 @@
    -

    Consumes

    +

    Consumes

    • @@ -14489,7 +13602,7 @@
    -

    Produces

    +

    Produces

    • @@ -14508,7 +13621,7 @@
    -

    Tags

    +

    Tags

    • @@ -14526,7 +13639,7 @@
    -

    Parameters

    +

    Parameters

    @@ -14616,7 +13729,7 @@
    -

    Responses

    +

    Responses

    @@ -14641,7 +13754,7 @@
    -

    Consumes

    +

    Consumes

    • @@ -14651,7 +13764,7 @@
    -

    Produces

    +

    Produces

    • @@ -14670,7 +13783,7 @@
    -

    Tags

    +

    Tags

    • @@ -14688,7 +13801,7 @@
    -

    Parameters

    +

    Parameters

    @@ -14770,7 +13883,7 @@
    -

    Responses

    +

    Responses

    @@ -14795,7 +13908,7 @@
    -

    Consumes

    +

    Consumes

    • @@ -14805,7 +13918,7 @@
    -

    Produces

    +

    Produces

    • @@ -14824,7 +13937,7 @@
    -

    Tags

    +

    Tags

    • @@ -14842,7 +13955,7 @@
    -

    Parameters

    +

    Parameters

    @@ -14932,7 +14045,7 @@
    -

    Responses

    +

    Responses

    @@ -14957,7 +14070,7 @@
    -

    Consumes

    +

    Consumes

    • @@ -14967,7 +14080,7 @@
    -

    Produces

    +

    Produces

    • @@ -14986,7 +14099,7 @@
    -

    Tags

    +

    Tags

    • @@ -15004,7 +14117,7 @@
    -

    Parameters

    +

    Parameters

    @@ -15086,7 +14199,7 @@
    -

    Responses

    +

    Responses

    @@ -15111,7 +14224,7 @@
    -

    Consumes

    +

    Consumes

    • @@ -15121,7 +14234,7 @@
    -

    Produces

    +

    Produces

    • @@ -15140,7 +14253,7 @@
    -

    Tags

    +

    Tags

    • @@ -15158,7 +14271,7 @@
    -

    Parameters

    +

    Parameters

    @@ -15248,7 +14361,7 @@
    -

    Responses

    +

    Responses

    @@ -15273,7 +14386,7 @@
    -

    Consumes

    +

    Consumes

    • @@ -15283,7 +14396,7 @@
    -

    Produces

    +

    Produces

    • @@ -15302,7 +14415,7 @@
    -

    Tags

    +

    Tags

    • @@ -15320,7 +14433,7 @@
    -

    Parameters

    +

    Parameters

    @@ -15402,7 +14515,7 @@
    -

    Responses

    +

    Responses

    @@ -15427,7 +14540,7 @@
    -

    Consumes

    +

    Consumes

    • @@ -15437,7 +14550,7 @@
    -

    Produces

    +

    Produces

    • @@ -15456,7 +14569,7 @@
    -

    Tags

    +

    Tags

    • @@ -15474,7 +14587,7 @@
    -

    Parameters

    +

    Parameters

    @@ -15564,7 +14677,7 @@
    -

    Responses

    +

    Responses

    @@ -15589,7 +14702,7 @@
    -

    Consumes

    +

    Consumes

    • @@ -15599,7 +14712,7 @@
    -

    Produces

    +

    Produces

    • @@ -15618,7 +14731,7 @@
    -

    Tags

    +

    Tags

    • @@ -15636,7 +14749,7 @@
    -

    Parameters

    +

    Parameters

    @@ -15718,7 +14831,7 @@
    -

    Responses

    +

    Responses

    @@ -15743,7 +14856,7 @@
    -

    Consumes

    +

    Consumes

    • @@ -15753,7 +14866,7 @@
    -

    Produces

    +

    Produces

    • @@ -15772,7 +14885,7 @@
    -

    Tags

    +

    Tags

    • @@ -15790,7 +14903,7 @@
    -

    Parameters

    +

    Parameters

    @@ -15880,7 +14993,7 @@
    -

    Responses

    +

    Responses

    @@ -15905,7 +15018,7 @@
    -

    Consumes

    +

    Consumes

    • @@ -15915,7 +15028,7 @@
    -

    Produces

    +

    Produces

    • @@ -15934,7 +15047,7 @@
    -

    Tags

    +

    Tags

    • @@ -15952,7 +15065,7 @@
    -

    Parameters

    +

    Parameters

    @@ -16026,7 +15139,7 @@
    -

    Responses

    +

    Responses

    @@ -16051,7 +15164,7 @@
    -

    Consumes

    +

    Consumes

    • @@ -16061,7 +15174,7 @@
    -

    Produces

    +

    Produces

    • @@ -16080,7 +15193,7 @@
    -

    Tags

    +

    Tags

    • @@ -16098,7 +15211,7 @@
    -

    Parameters

    +

    Parameters

    @@ -16172,7 +15285,7 @@
    -

    Responses

    +

    Responses

    @@ -16197,7 +15310,7 @@
    -

    Consumes

    +

    Consumes

    • @@ -16207,7 +15320,7 @@
    -

    Produces

    +

    Produces

    • @@ -16226,307 +15339,7 @@
    -

    Tags

    -
    -
      -
    • -

      apisextensionsv1beta1

      -
      • -
    -
    -
    - -
    -

    watch individual changes to a list of StorageClass

    -
    -
    -
    GET /apis/extensions/v1beta1/watch/storageclasses
    -
    -
    -
    -

    Parameters

    -
    -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    - -
    -
    -

    Responses

    - ----- - - - - - - - - - - - - - - -
    HTTP CodeDescriptionSchema

    200

    success

    *versioned.Event

    - -
    -
    -

    Consumes

    -
    -
      -
    • -

      /

      -
      • -
    -
    -
    -
    -

    Produces

    -
    -
      -
    • -

      application/json

      -
      • -
    • -

      application/json;stream=watch

      -
      • -
    • -

      application/vnd.kubernetes.protobuf

      -
      • -
    • -

      application/vnd.kubernetes.protobuf;stream=watch

      -
      • -
    -
    -
    -
    -

    Tags

    -
    -
      -
    • -

      apisextensionsv1beta1

      -
      • -
    -
    -
    -
    -
    -

    watch changes to an object of kind StorageClass

    -
    -
    -
    GET /apis/extensions/v1beta1/watch/storageclasses/{name}
    -
    -
    -
    -

    Parameters

    - -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    PathParameter

    name

    name of the StorageClass

    true

    string

    - -
    -
    -

    Responses

    - ----- - - - - - - - - - - - - - - -
    HTTP CodeDescriptionSchema

    200

    success

    *versioned.Event

    - -
    -
    -

    Consumes

    -
    -
      -
    • -

      /

      -
      • -
    -
    -
    -
    -

    Produces

    -
    -
      -
    • -

      application/json

      -
      • -
    • -

      application/json;stream=watch

      -
      • -
    • -

      application/vnd.kubernetes.protobuf

      -
      • -
    • -

      application/vnd.kubernetes.protobuf;stream=watch

      -
      • -
    -
    -
    -
    -

    Tags

    +

    Tags

    • @@ -16544,7 +15357,7 @@
    -

    Parameters

    +

    Parameters

    @@ -16618,7 +15431,7 @@
    -

    Responses

    +

    Responses

    @@ -16643,7 +15456,7 @@
    -

    Consumes

    +

    Consumes

    • @@ -16653,7 +15466,7 @@
    -

    Produces

    +

    Produces

    • @@ -16672,7 +15485,7 @@
    -

    Tags

    +

    Tags

    • @@ -16690,7 +15503,7 @@
    -

    Parameters

    +

    Parameters

    @@ -16772,7 +15585,7 @@
    -

    Responses

    +

    Responses

    @@ -16797,7 +15610,7 @@
    -

    Consumes

    +

    Consumes

    • @@ -16807,7 +15620,7 @@
    -

    Produces

    +

    Produces

    • @@ -16826,7 +15639,7 @@
    -

    Tags

    +

    Tags

    • @@ -16841,7 +15654,7 @@
    diff --git a/_includes/v1.4/v1-definitions.html b/_includes/v1.4/v1-definitions.html index 1c1afc4106..b75f8b350b 100755 --- a/_includes/v1.4/v1-definitions.html +++ b/_includes/v1.4/v1-definitions.html @@ -6391,7 +6391,7 @@ The resulting set of endpoints can be viewed as:

    v1alpha1.Eviction

    -

    Eviction evicts a pod from its node subject to certain policies and safety constraints. This is a subresource of Pod. A request to cause such an eviction is created by POSTing to …/pods/foo/evictions.

    +

    Eviction evicts a pod from its node subject to certain policies and safety constraints. This is a subresource of Pod. A request to cause such an eviction is created by POSTing to …/pods/<pod name>/evictions.

    diff --git a/docs/admin/addons.md b/docs/admin/addons.md index e802343ab9..1969ab04c7 100644 --- a/docs/admin/addons.md +++ b/docs/admin/addons.md @@ -10,7 +10,7 @@ This page lists some of the available add-ons and links to their respective inst ## Networking and Network Policy * [Weave Net](https://github.com/weaveworks/weave-kube) provides networking and network policy, will carry on working on both sides of a network partition, and does not require an external database. -* [Calico](https://github.com/projectcalico/calico-containers/tree/master/docs/cni/kubernetes/manifests/kubeadm) is a secure L3 networking and network policy provider. +* [Calico](http://docs.projectcalico.org/v1.5/getting-started/kubernetes/installation/hosted/) is a secure L3 networking and network policy provider. * [Canal](https://github.com/tigera/canal/tree/master/k8s-install/kubeadm) unites Flannel and Calico, providing networking and network policy. * [Romana](http://romana.io) is a Layer 3 networking solution for pod networks that also supports the [NetworkPolicy API](/docs/user-guide/networkpolicies/). Kubeadm add-on installation details available [here](https://github.com/romana/romana/tree/master/containerize). diff --git a/docs/admin/disruptions.md b/docs/admin/disruptions.md index c6e2b7852a..0743b565e6 100644 --- a/docs/admin/disruptions.md +++ b/docs/admin/disruptions.md @@ -61,17 +61,17 @@ itself. To attempt an eviction (perhaps more REST-precisely, to attempt to { "apiVersion": "policy/v1alpha1", "kind": "Eviction", - "name": "quux", - "namespace": "default" + "metadata": { + "name": "quux", + "namespace": "default" + } } ``` -and here is how you would attempt this with `curl` +You can attempt an eviction using `curl`: ```bash -curl -v -X POST -H 'Content-type: application/json' -http://127.0.0.1:8080/api/v1/namespaces/default/pods/quux/eviction -d -eviction.json +$ curl -v -H 'Content-type: application/json' http://127.0.0.1:8080/api/v1/namespaces/default/pods/quux/eviction -d @eviction.json ``` The API can respond in one of three ways. diff --git a/docs/admin/federation-apiserver.md b/docs/admin/federation-apiserver.md index 7e2e15c3b1..00fb08c1a0 100644 --- a/docs/admin/federation-apiserver.md +++ b/docs/admin/federation-apiserver.md @@ -42,7 +42,7 @@ federation-apiserver --cloud-provider string The provider for cloud services. Empty string for no provider. --cors-allowed-origins value List of allowed origins for CORS, comma separated. An allowed origin can be a regular expression to support subdomain matching. If this list is empty CORS will not be enabled. (default []) --delete-collection-workers int Number of workers spawned for DeleteCollection call. These are used to speed up namespace cleanup. (default 1) - --deserialization-cache-size int Number of deserialized json objects to cache in memory. (default 50000) + --deserialization-cache-size int Number of deserialized json objects to cache in memory. --enable-swagger-ui Enables swagger ui on the apiserver at /swagger-ui --etcd-cafile string SSL Certificate Authority file used to secure etcd communication. --etcd-certfile string SSL certification file used to secure etcd communication. @@ -79,7 +79,7 @@ DynamicVolumeProvisioning=true|false (ALPHA - default=true) --service-node-port-range value A port range to reserve for services with NodePort visibility. Example: '30000-32767'. Inclusive at both ends of the range. (default 30000-32767) --storage-backend string The storage backend for persistence. Options: 'etcd2' (default), 'etcd3'. --storage-media-type string The media type to use to store objects in storage. Defaults to application/json. Some resources may only support a specific media type and will ignore this setting. (default "application/json") - --storage-versions string The per-group version to store resources in. Specified in the format "group1/version1,group2/version2,...". In the case where objects are moved from one group to the other, you may specify the format "group1=group2/v1beta1,group3/v1beta1,...". You only need to pass the groups you wish to change from the defaults. It defaults to a list of preferred versions of all registered groups, which is derived from the KUBE_API_VERSIONS environment variable. (default "apps/v1alpha1,authentication.k8s.io/v1beta1,authorization.k8s.io/v1beta1,autoscaling/v1,batch/v1,certificates/v1alpha1,componentconfig/v1alpha1,extensions/v1beta1,federation/v1beta1,policy/v1alpha1,rbac.authorization.k8s.io/v1alpha1,v1") + --storage-versions string The per-group version to store resources in. Specified in the format "group1/version1,group2/version2,...". In the case where objects are moved from one group to the other, you may specify the format "group1=group2/v1beta1,group3/v1beta1,...". You only need to pass the groups you wish to change from the defaults. It defaults to a list of preferred versions of all registered groups, which is derived from the KUBE_API_VERSIONS environment variable. (default "apps/v1alpha1,authentication.k8s.io/v1beta1,authorization.k8s.io/v1beta1,autoscaling/v1,batch/v1,certificates.k8s.io/v1alpha1,componentconfig/v1alpha1,extensions/v1beta1,federation/v1beta1,policy/v1alpha1,rbac.authorization.k8s.io/v1alpha1,storage.k8s.io/v1beta1,v1") --target-ram-mb int Memory limit for apiserver in MB (used to configure sizes of caches, etc.) --tls-cert-file string File containing x509 Certificate for HTTPS. (CA cert, if any, concatenated after server cert). If HTTPS serving is enabled, and --tls-cert-file and --tls-private-key-file are not provided, a self-signed certificate and key are generated for the public address and saved to /var/run/kubernetes. --tls-private-key-file string File containing x509 private key matching --tls-cert-file. @@ -88,7 +88,7 @@ DynamicVolumeProvisioning=true|false (ALPHA - default=true) --watch-cache-sizes value List of watch cache sizes for every resource (pods, nodes, etc.), comma separated. The individual override format: resource#size, where size is a number. It takes effect when watch-cache is enabled. (default []) ``` -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/admin/federation-controller-manager.md b/docs/admin/federation-controller-manager.md index 8fb25088e7..d73dde0b9e 100644 --- a/docs/admin/federation-controller-manager.md +++ b/docs/admin/federation-controller-manager.md @@ -44,7 +44,7 @@ federation-controller-manager --zone-name string Zone name, like example.com. ``` -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/admin/kube-apiserver.md b/docs/admin/kube-apiserver.md index 8eb04089a4..4e24cd2d89 100644 --- a/docs/admin/kube-apiserver.md +++ b/docs/admin/kube-apiserver.md @@ -45,7 +45,7 @@ kube-apiserver --cloud-provider string The provider for cloud services. Empty string for no provider. --cors-allowed-origins value List of allowed origins for CORS, comma separated. An allowed origin can be a regular expression to support subdomain matching. If this list is empty CORS will not be enabled. (default []) --delete-collection-workers int Number of workers spawned for DeleteCollection call. These are used to speed up namespace cleanup. (default 1) - --deserialization-cache-size int Number of deserialized json objects to cache in memory. (default 50000) + --deserialization-cache-size int Number of deserialized json objects to cache in memory. --enable-garbage-collector Enables the generic garbage collector. MUST be synced with the corresponding flag of the kube-controller-manager. (default true) --enable-swagger-ui Enables swagger ui on the apiserver at /swagger-ui --etcd-cafile string SSL Certificate Authority file used to secure etcd communication. @@ -95,7 +95,7 @@ DynamicVolumeProvisioning=true|false (ALPHA - default=true) --ssh-user string If non-empty, use secure SSH proxy to the nodes, using this user name --storage-backend string The storage backend for persistence. Options: 'etcd2' (default), 'etcd3'. --storage-media-type string The media type to use to store objects in storage. Defaults to application/json. Some resources may only support a specific media type and will ignore this setting. (default "application/json") - --storage-versions string The per-group version to store resources in. Specified in the format "group1/version1,group2/version2,...". In the case where objects are moved from one group to the other, you may specify the format "group1=group2/v1beta1,group3/v1beta1,...". You only need to pass the groups you wish to change from the defaults. It defaults to a list of preferred versions of all registered groups, which is derived from the KUBE_API_VERSIONS environment variable. (default "apps/v1alpha1,authentication.k8s.io/v1beta1,authorization.k8s.io/v1beta1,autoscaling/v1,batch/v1,certificates/v1alpha1,componentconfig/v1alpha1,extensions/v1beta1,imagepolicy.k8s.io/v1alpha1,policy/v1alpha1,rbac.authorization.k8s.io/v1alpha1,v1") + --storage-versions string The per-group version to store resources in. Specified in the format "group1/version1,group2/version2,...". In the case where objects are moved from one group to the other, you may specify the format "group1=group2/v1beta1,group3/v1beta1,...". You only need to pass the groups you wish to change from the defaults. It defaults to a list of preferred versions of all registered groups, which is derived from the KUBE_API_VERSIONS environment variable. (default "apps/v1alpha1,authentication.k8s.io/v1beta1,authorization.k8s.io/v1beta1,autoscaling/v1,batch/v1,certificates.k8s.io/v1alpha1,componentconfig/v1alpha1,extensions/v1beta1,imagepolicy.k8s.io/v1alpha1,policy/v1alpha1,rbac.authorization.k8s.io/v1alpha1,storage.k8s.io/v1beta1,v1") --target-ram-mb int Memory limit for apiserver in MB (used to configure sizes of caches, etc.) --tls-cert-file string File containing x509 Certificate for HTTPS. (CA cert, if any, concatenated after server cert). If HTTPS serving is enabled, and --tls-cert-file and --tls-private-key-file are not provided, a self-signed certificate and key are generated for the public address and saved to /var/run/kubernetes. --tls-private-key-file string File containing x509 private key matching --tls-cert-file. @@ -104,7 +104,7 @@ DynamicVolumeProvisioning=true|false (ALPHA - default=true) --watch-cache-sizes value List of watch cache sizes for every resource (pods, nodes, etc.), comma separated. The individual override format: resource#size, where size is a number. It takes effect when watch-cache is enabled. (default []) ``` -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/admin/kube-controller-manager.md b/docs/admin/kube-controller-manager.md index 2af4899176..c6db5ea858 100644 --- a/docs/admin/kube-controller-manager.md +++ b/docs/admin/kube-controller-manager.md @@ -42,7 +42,7 @@ kube-controller-manager --concurrent-serviceaccount-token-syncs value The number of service account token objects that are allowed to sync concurrently. Larger number = more responsive token generation, but more CPU (and network) load (default 5) --concurrent_rc_syncs value The number of replication controllers that are allowed to sync concurrently. Larger number = more responsive replica management, but more CPU (and network) load (default 5) --configure-cloud-routes Should CIDRs allocated by allocate-node-cidrs be configured on the cloud provider. (default true) - --controller-start-interval duration Interval between starting controller managers. + --controller-start-interval duration Interval between starting controller managers. (default 0s) --daemonset-lookup-cache-size value The the size of lookup cache for daemonsets. Larger number = more responsive daemonsets, but more MEM load. (default 1024) --deployment-controller-sync-period duration Period for syncing the deployments. (default 30s) --enable-dynamic-provisioning Enable dynamic provisioning for environments that support it. (default true) @@ -98,7 +98,7 @@ DynamicVolumeProvisioning=true|false (ALPHA - default=true) --unhealthy-zone-threshold value Fraction of Nodes in a zone which needs to be not Ready (minimum 3) for zone to be treated as unhealthy. (default 0.55) ``` -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/admin/kube-proxy.md b/docs/admin/kube-proxy.md index bee1964392..98480612cb 100644 --- a/docs/admin/kube-proxy.md +++ b/docs/admin/kube-proxy.md @@ -27,8 +27,8 @@ kube-proxy --cleanup-iptables If true cleanup iptables rules and exit. --cluster-cidr string The CIDR range of pods in the cluster. It is used to bridge traffic coming from outside of the cluster. If not provided, no off-cluster bridging will be performed. --config-sync-period duration How often configuration from the apiserver is refreshed. Must be greater than 0. (default 15m0s) - --conntrack-max value Maximum number of NAT connections to track (0 to leave as-is). - --conntrack-max-per-core value Maximum number of NAT connections to track per CPU core (0 to leave as-is). This is only considered if conntrack-max is 0. (default 32768) + --conntrack-max-per-core value Maximum number of NAT connections to track per CPU core (0 to leave the limit as-is and ignore conntrack-min). (default 32768) + --conntrack-min value Minimum number of conntrack entries to allocate, regardless of conntrack-max-per-core (set conntrack-max-per-core=0 to leave the limit as-is). (default 131072) --conntrack-tcp-timeout-established duration Idle timeout for established TCP connections (0 to leave as-is) (default 24h0m0s) --feature-gates value A set of key=value pairs that describe feature gates for alpha/experimental features. Options are: AllAlpha=true|false (ALPHA - default=false) @@ -54,7 +54,7 @@ DynamicVolumeProvisioning=true|false (ALPHA - default=true) --udp-timeout duration How long an idle UDP connection will be kept open (e.g. '250ms', '2s'). Must be greater than 0. Only applicable for proxy-mode=userspace (default 250ms) ``` -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/admin/kube-scheduler.md b/docs/admin/kube-scheduler.md index c1f1c24911..3316d7e10d 100644 --- a/docs/admin/kube-scheduler.md +++ b/docs/admin/kube-scheduler.md @@ -27,11 +27,11 @@ kube-scheduler --algorithm-provider string The scheduling algorithm provider to use, one of: DefaultProvider | ClusterAutoscalerProvider (default "DefaultProvider") --failure-domains string Indicate the "all topologies" set for an empty topologyKey when it's used for PreferredDuringScheduling pod anti-affinity. (default "kubernetes.io/hostname,failure-domain.beta.kubernetes.io/zone,failure-domain.beta.kubernetes.io/region") --feature-gates value A set of key=value pairs that describe feature gates for alpha/experimental features. Options are: -DynamicKubeletConfig=true|false (ALPHA - default=false) -DynamicVolumeProvisioning=true|false (ALPHA - default=true) AllAlpha=true|false (ALPHA - default=false) AllowExtTrafficLocalEndpoints=true|false (ALPHA - default=false) AppArmor=true|false (BETA - default=true) +DynamicKubeletConfig=true|false (ALPHA - default=false) +DynamicVolumeProvisioning=true|false (ALPHA - default=true) --google-json-key string The Google Cloud Platform Service Account JSON Key to use for authentication. --hard-pod-affinity-symmetric-weight int RequiredDuringScheduling affinity is not symmetric, but there is an implicit PreferredDuringScheduling affinity rule corresponding to every RequiredDuringScheduling affinity rule. --hard-pod-affinity-symmetric-weight represents the weight of implicit PreferredDuringScheduling affinity rule. (default 1) --kube-api-burst value Burst to use while talking with kubernetes apiserver (default 100) @@ -49,7 +49,7 @@ AppArmor=true|false (BETA - default=true) --scheduler-name string Name of the scheduler, used to select which pods will be processed by this scheduler, based on pod's annotation with key 'scheduler.alpha.kubernetes.io/name' (default "default-scheduler") ``` -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/admin/kubelet.md b/docs/admin/kubelet.md index ce5855289f..88842eab14 100644 --- a/docs/admin/kubelet.md +++ b/docs/admin/kubelet.md @@ -44,7 +44,8 @@ kubelet --cloud-provider string The provider for cloud services. By default, kubelet will attempt to auto-detect the cloud provider. Specify empty string for running with no cloud provider. [default=auto-detect] (default "auto-detect") --cluster-dns string IP address for a cluster DNS server. This value is used for containers' DNS server in case of Pods with "dnsPolicy=ClusterFirst" --cluster-domain string Domain for this cluster. If set, kubelet will configure all containers to search this domain in addition to the host's search domains - --configure-cbr0 If true, kubelet will configure cbr0 based on Node.Spec.PodCIDR. + --cni-bin-dir string The full path of the directory in which to search for CNI plugin binaries. Default: /opt/cni/bin + --cni-conf-dir string The full path of the directory in which to search for CNI config files. Default: /etc/cni/net.d --container-runtime string The container runtime to use. Possible values: 'docker', 'rkt'. Default: 'docker'. (default "docker") --container-runtime-endpoint string The unix socket endpoint of remote runtime service. If not empty, this option will override --container-runtime. This is an experimental feature. Intended for testing only. --containerized Experimental support for running kubelet in a container. Intended for testing. [default=false] @@ -66,7 +67,6 @@ kubelet --exit-on-lock-contention Whether kubelet should exit upon lock-file contention. --experimental-allowed-unsafe-sysctls value Comma-separated whitelist of unsafe sysctls or unsafe sysctl patterns (ending in *). Use these at your own risk. (default []) --experimental-bootstrap-kubeconfig string Path to a kubeconfig file that will be used to get client certificate for kubelet. If the file specified by --kubeconfig does not exist, the bootstrap kubeconfig is used to request a client certificate from the API server. On success, a kubeconfig file referencing the generated key and obtained certificate is written to the path specified by --kubeconfig. The certificate and key file will be stored in the directory pointed by --cert-dir. - --experimental-flannel-overlay Experimental support for starting the kubelet with the default overlay network (flannel). Assumes flanneld is already running in client mode. [default=false] --experimental-nvidia-gpus value Number of NVIDIA GPU devices on this node. Only 0 (default) and 1 are currently supported. --feature-gates value A set of key=value pairs that describe feature gates for alpha/experimental features. Options are: AllAlpha=true|false (ALPHA - default=false) @@ -105,7 +105,7 @@ DynamicVolumeProvisioning=true|false (ALPHA - default=true) --max-pods value Number of Pods that can run on this Kubelet. (default 110) --minimum-image-ttl-duration duration Minimum age for an unused image before it is garbage collected. Examples: '300ms', '10s' or '2h45m'. Default: '2m' (default 2m0s) --network-plugin string The name of the network plugin to be invoked for various events in kubelet/pod lifecycle - --network-plugin-dir string The full path of the directory in which to search for network plugins (default "/usr/libexec/kubernetes/kubelet-plugins/net/exec/") + --network-plugin-dir string The full path of the directory in which to search for network plugins or CNI config --network-plugin-mtu value The MTU to be passed to the network plugin, to override the default. Set to 0 to use the default 1460 MTU. --node-ip string IP address of the node. If set, kubelet will use this IP address for the node --node-labels value Labels to add when registering the node in the cluster. Labels must be key=value pairs separated by ','. @@ -146,7 +146,7 @@ DynamicVolumeProvisioning=true|false (ALPHA - default=true) --volume-stats-agg-period duration Specifies interval for kubelet to calculate and cache the volume disk usage for all pods and volumes. To disable volume calculations, set to 0. Default: '1m' (default 1m0s) ``` -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/api-reference/apps/v1alpha1/definitions.html b/docs/api-reference/apps/v1alpha1/definitions.html new file mode 100755 index 0000000000..0dfdf27a56 --- /dev/null +++ b/docs/api-reference/apps/v1alpha1/definitions.html @@ -0,0 +1,4010 @@ +--- +--- + + + + + + +Top Level API Objects + + + +
    +
    +

    Top Level API Objects

    +
    +
    + +
    +
    +
    +
    +

    Definitions

    +
    +
    +

    v1.Preconditions

    +
    +

    Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.

    +
    +
    +++++++ + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    uid

    Specifies the target UID.

    false

    types.UID

    + +
    +
    +

    v1.SELinuxOptions

    +
    +

    SELinuxOptions are the labels to be applied to the container

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    user

    User is a SELinux user label that applies to the container.

    false

    string

    role

    Role is a SELinux role label that applies to the container.

    false

    string

    type

    Type is a SELinux type label that applies to the container.

    false

    string

    level

    Level is SELinux level label that applies to the container.

    false

    string

    + +
    +
    +

    v1.ObjectFieldSelector

    +
    +

    ObjectFieldSelector selects an APIVersioned field of an object.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    apiVersion

    Version of the schema the FieldPath is written in terms of, defaults to "v1".

    false

    string

    fieldPath

    Path of the field to select in the specified API version.

    true

    string

    + +
    +
    +

    v1.VolumeMount

    +
    +

    VolumeMount describes a mounting of a Volume within a container.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    name

    This must match the Name of a Volume.

    true

    string

    readOnly

    Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

    false

    boolean

    false

    mountPath

    Path within the container at which the volume should be mounted. Must not contain :.

    true

    string

    subPath

    Path within the volume from which the container’s volume should be mounted. Defaults to "" (volume’s root).

    false

    string

    + +
    +
    +

    v1.NFSVolumeSource

    +
    +

    Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    server

    Server is the hostname or IP address of the NFS server. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#nfs

    true

    string

    path

    Path that is exported by the NFS server. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#nfs

    true

    string

    readOnly

    ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#nfs

    false

    boolean

    false

    + +
    +
    +

    v1.PersistentVolumeClaimSpec

    +
    +

    PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    accessModes

    AccessModes contains the desired access modes the volume should have. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#access-modes-1

    false

    v1.PersistentVolumeAccessMode array

    selector

    A label query over volumes to consider for binding.

    false

    unversioned.LabelSelector

    resources

    Resources represents the minimum resources the volume should have. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#resources

    false

    v1.ResourceRequirements

    volumeName

    VolumeName is the binding reference to the PersistentVolume backing this claim.

    false

    string

    + +
    +
    +

    v1.CephFSVolumeSource

    +
    +

    Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    monitors

    Required: Monitors is a collection of Ceph monitors More info: http://releases.k8s.io/release-1.4/examples/volumes/cephfs/README.md#how-to-use-it

    true

    string array

    path

    Optional: Used as the mounted root, rather than the full Ceph tree, default is /

    false

    string

    user

    Optional: User is the rados user name, default is admin More info: http://releases.k8s.io/release-1.4/examples/volumes/cephfs/README.md#how-to-use-it

    false

    string

    secretFile

    Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: http://releases.k8s.io/release-1.4/examples/volumes/cephfs/README.md#how-to-use-it

    false

    string

    secretRef

    Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: http://releases.k8s.io/release-1.4/examples/volumes/cephfs/README.md#how-to-use-it

    false

    v1.LocalObjectReference

    readOnly

    Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/release-1.4/examples/volumes/cephfs/README.md#how-to-use-it

    false

    boolean

    false

    + +
    +
    +

    v1.HTTPHeader

    +
    +

    HTTPHeader describes a custom header to be used in HTTP probes

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    name

    The header field name

    true

    string

    value

    The header field value

    true

    string

    + +
    +
    +

    v1.FCVolumeSource

    +
    +

    Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    targetWWNs

    Required: FC target worldwide names (WWNs)

    true

    string array

    lun

    Required: FC target lun number

    true

    integer (int32)

    fsType

    Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

    false

    string

    readOnly

    Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

    false

    boolean

    false

    + +
    +
    +

    v1.DownwardAPIVolumeSource

    +
    +

    DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    items

    Items is a list of downward API volume file

    false

    v1.DownwardAPIVolumeFile array

    defaultMode

    Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    false

    integer (int32)

    + +
    +
    +

    unversioned.StatusCause

    +
    +

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

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    reason

    A machine-readable description of the cause of the error. If this value is empty there is no information available.

    false

    string

    message

    A human-readable description of the cause of the error. This field may be presented as-is to a reader.

    false

    string

    field

    The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.
    +
    +Examples:
    + "name" - the field "name" on the current resource
    + "items[0].name" - the field "name" on the first array entry in "items"

    false

    string

    + +
    +
    +

    v1.GCEPersistentDiskVolumeSource

    +
    +

    Represents a Persistent Disk resource in Google Compute Engine.

    +
    +
    +

    A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    pdName

    Unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#gcepersistentdisk

    true

    string

    fsType

    Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#gcepersistentdisk

    false

    string

    partition

    The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#gcepersistentdisk

    false

    integer (int32)

    readOnly

    ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#gcepersistentdisk

    false

    boolean

    false

    + +
    +
    +

    v1.TCPSocketAction

    +
    +

    TCPSocketAction describes an action based on opening a socket

    +
    + +++++++ + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    port

    Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

    true

    string

    + +
    +
    +

    v1.ConfigMapVolumeSource

    +
    +

    Adapts a ConfigMap into a volume.

    +
    +
    +

    The contents of the target ConfigMap’s Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    name

    Name of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

    false

    string

    items

    If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error. Paths must be relative and may not contain the .. path or start with ...

    false

    v1.KeyToPath array

    defaultMode

    Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    false

    integer (int32)

    + +
    +
    +

    *versioned.Event

    + +
    +
    +

    unversioned.StatusDetails

    +
    +

    StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    name

    The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).

    false

    string

    group

    The group attribute of the resource associated with the status StatusReason.

    false

    string

    kind

    The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    causes

    The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.

    false

    unversioned.StatusCause array

    retryAfterSeconds

    If specified, the time in seconds before the operation should be retried.

    false

    integer (int32)

    + +
    +
    +

    v1.GitRepoVolumeSource

    +
    +

    Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    repository

    Repository URL

    true

    string

    revision

    Commit hash for the specified revision.

    false

    string

    directory

    Target directory name. Must not contain or start with ... If . is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.

    false

    string

    + +
    +
    +

    v1.HTTPGetAction

    +
    +

    HTTPGetAction describes an action based on HTTP Get requests.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    path

    Path to access on the HTTP server.

    false

    string

    port

    Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

    true

    string

    host

    Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

    false

    string

    scheme

    Scheme to use for connecting to the host. Defaults to HTTP.

    false

    string

    httpHeaders

    Custom headers to set in the request. HTTP allows repeated headers.

    false

    v1.HTTPHeader array

    + +
    +
    +

    v1.Capabilities

    +
    +

    Adds and removes POSIX capabilities from running containers.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    add

    Added capabilities

    false

    v1.Capability array

    drop

    Removed capabilities

    false

    v1.Capability array

    + +
    +
    +

    v1.LocalObjectReference

    +
    +

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

    +
    + +++++++ + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    name

    Name of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

    false

    string

    + +
    +
    +

    v1.Container

    +
    +

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

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    name

    Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.

    true

    string

    image

    Docker image name. More info: http://releases.k8s.io/release-1.4/docs/user-guide/images.md

    false

    string

    command

    Entrypoint array. Not executed within a shell. The docker image’s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/containers.md#containers-and-commands

    false

    string array

    args

    Arguments to the entrypoint. The docker image’s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/containers.md#containers-and-commands

    false

    string array

    workingDir

    Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image. Cannot be updated.

    false

    string

    ports

    List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated.

    false

    v1.ContainerPort array

    env

    List of environment variables to set in the container. Cannot be updated.

    false

    v1.EnvVar array

    resources

    Compute Resources required by this container. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#resources

    false

    v1.ResourceRequirements

    volumeMounts

    Pod volumes to mount into the container’s filesystem. Cannot be updated.

    false

    v1.VolumeMount array

    livenessProbe

    Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/pod-states.md#container-probes

    false

    v1.Probe

    readinessProbe

    Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/pod-states.md#container-probes

    false

    v1.Probe

    lifecycle

    Actions that the management system should take in response to container lifecycle events. Cannot be updated.

    false

    v1.Lifecycle

    terminationMessagePath

    Optional: Path at which the file to which the container’s termination message will be written is mounted into the container’s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Defaults to /dev/termination-log. Cannot be updated.

    false

    string

    imagePullPolicy

    Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/images.md#updating-images

    false

    string

    securityContext

    Security options the pod should run with. More info: http://releases.k8s.io/release-1.4/docs/design/security_context.md

    false

    v1.SecurityContext

    stdin

    Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.

    false

    boolean

    false

    stdinOnce

    Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false

    false

    boolean

    false

    tty

    Whether this container should allocate a TTY for itself, also requires stdin to be true. Default is false.

    false

    boolean

    false

    + +
    +
    +

    v1.PodSecurityContext

    +
    +

    PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    seLinuxOptions

    The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.

    false

    v1.SELinuxOptions

    runAsUser

    The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.

    false

    integer (int64)

    runAsNonRoot

    Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

    false

    boolean

    false

    supplementalGroups

    A list of groups applied to the first process run in each container, in addition to the container’s primary GID. If unspecified, no groups will be added to any container.

    false

    integer (int32) array

    fsGroup

    A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:
    +
    +1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR’d with rw-rw

    false

    integer (int64)

    + +
    +
    +

    v1.ExecAction

    +
    +

    ExecAction describes a "run in container" action.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    command

    Command is the command line to execute inside the container, the working directory for the command is root (/) in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('

    ', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

    false

    string array

    + +
    +
    +

    v1.ObjectMeta

    +
    +

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

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    name

    Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

    false

    string

    generateName

    GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
    +
    +If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
    +
    +Applied only if Name is not specified. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#idempotency

    false

    string

    namespace

    Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
    +
    +Must be a DNS_LABEL. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/namespaces.md

    false

    string

    selfLink

    SelfLink is a URL representing this object. Populated by the system. Read-only.

    false

    string

    uid

    UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
    +
    +Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#uids

    false

    string

    resourceVersion

    An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
    +
    +Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#concurrency-control-and-consistency

    false

    string

    generation

    A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

    false

    integer (int64)

    creationTimestamp

    CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
    +
    +Populated by the system. Read-only. Null for lists. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    string (date-time)

    deletionTimestamp

    DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource will be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. Once the resource is deleted in the API, the Kubelet will send a hard termination signal to the container. If not set, graceful deletion of the object has not been requested.
    +
    +Populated by the system when a graceful deletion is requested. Read-only. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    string (date-time)

    deletionGracePeriodSeconds

    Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

    false

    integer (int64)

    labels

    Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://releases.k8s.io/release-1.4/docs/user-guide/labels.md

    false

    object

    annotations

    Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://releases.k8s.io/release-1.4/docs/user-guide/annotations.md

    false

    object

    ownerReferences

    List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

    false

    v1.OwnerReference array

    finalizers

    Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.

    false

    string array

    clusterName

    The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

    false

    string

    + +
    +
    +

    v1.OwnerReference

    +
    +

    OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    apiVersion

    API version of the referent.

    true

    string

    kind

    Kind of the referent. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    true

    string

    name

    Name of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

    true

    string

    uid

    UID of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#uids

    true

    string

    controller

    If true, this reference points to the managing controller.

    false

    boolean

    false

    + +
    +
    +

    types.UID

    + +
    +
    +

    v1.HostPathVolumeSource

    +
    +

    Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    path

    Path of the directory on the host. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#hostpath

    true

    string

    + +
    +
    +

    v1.AzureFileVolumeSource

    +
    +

    AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    secretName

    the name of secret that contains Azure Storage Account Name and Key

    true

    string

    shareName

    Share Name

    true

    string

    readOnly

    Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

    false

    boolean

    false

    + +
    +
    +

    v1.ISCSIVolumeSource

    +
    +

    Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    targetPortal

    iSCSI target portal. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).

    true

    string

    iqn

    Target iSCSI Qualified Name.

    true

    string

    lun

    iSCSI target lun number.

    true

    integer (int32)

    iscsiInterface

    Optional: Defaults to default (tcp). iSCSI interface name that uses an iSCSI transport.

    false

    string

    fsType

    Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#iscsi

    false

    string

    readOnly

    ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.

    false

    boolean

    false

    + +
    +
    +

    v1alpha1.PetSetSpec

    +
    +

    A PetSetSpec is the specification of a PetSet.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    replicas

    Replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.

    false

    integer (int32)

    selector

    Selector is a label query over pods that should match the replica count. If empty, defaulted to labels on the pod template. More info: http://releases.k8s.io/release-1.4/docs/user-guide/labels.md#label-selectors

    false

    unversioned.LabelSelector

    template

    Template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the PetSet will fulfill this Template, but have a unique identity from the rest of the PetSet.

    true

    v1.PodTemplateSpec

    volumeClaimTemplates

    VolumeClaimTemplates is a list of claims that pets are allowed to reference. The PetSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pet. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.

    false

    v1.PersistentVolumeClaim array

    serviceName

    ServiceName is the name of the service that governs this PetSet. This service must exist before the PetSet, and is responsible for the network identity of the set. Pets get DNS/hostnames that follow the pattern: pet-specific-string.serviceName.default.svc.cluster.local where "pet-specific-string" is managed by the PetSet controller.

    true

    string

    + +
    +
    +

    v1.EmptyDirVolumeSource

    +
    +

    Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    medium

    What type of storage medium should back this directory. The default is "" which means to use the node’s default medium. Must be an empty string (default) or Memory. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#emptydir

    false

    string

    + +
    +
    +

    unversioned.Patch

    +
    +

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

    +
    +
    +
    +

    v1.CinderVolumeSource

    +
    +

    Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    volumeID

    volume id used to identify the volume in cinder More info: http://releases.k8s.io/release-1.4/examples/mysql-cinder-pd/README.md

    true

    string

    fsType

    Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.4/examples/mysql-cinder-pd/README.md

    false

    string

    readOnly

    Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/release-1.4/examples/mysql-cinder-pd/README.md

    false

    boolean

    false

    + +
    +
    +

    v1.PersistentVolumeClaim

    +
    +

    PersistentVolumeClaim is a user’s request for and claim to a persistent volume

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    v1.ObjectMeta

    spec

    Spec defines the desired characteristics of a volume requested by a pod author. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

    false

    v1.PersistentVolumeClaimSpec

    status

    Status represents the current information/status of a persistent volume claim. Read-only. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

    false

    v1.PersistentVolumeClaimStatus

    + +
    +
    +

    v1.SecurityContext

    +
    +

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

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    capabilities

    The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.

    false

    v1.Capabilities

    privileged

    Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.

    false

    boolean

    false

    seLinuxOptions

    The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

    false

    v1.SELinuxOptions

    runAsUser

    The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

    false

    integer (int64)

    runAsNonRoot

    Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

    false

    boolean

    false

    readOnlyRootFilesystem

    Whether this container has a read-only root filesystem. Default is false.

    false

    boolean

    false

    + +
    +
    +

    v1.PersistentVolumeClaimVolumeSource

    +
    +

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

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    claimName

    ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

    true

    string

    readOnly

    Will force the ReadOnly setting in VolumeMounts. Default false.

    false

    boolean

    false

    + +
    +
    +

    v1.AWSElasticBlockStoreVolumeSource

    +
    +

    Represents a Persistent Disk resource in AWS.

    +
    +
    +

    An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    volumeID

    Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#awselasticblockstore

    true

    string

    fsType

    Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#awselasticblockstore

    false

    string

    partition

    The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).

    false

    integer (int32)

    readOnly

    Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#awselasticblockstore

    false

    boolean

    false

    + +
    +
    +

    v1.FlockerVolumeSource

    +
    +

    Represents a Flocker volume mounted by the Flocker agent. Flocker volumes do not support ownership management or SELinux relabeling.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    datasetName

    Required: the volume name. This is going to be store on metadata → name on the payload for Flocker

    true

    string

    + +
    +
    +

    unversioned.ListMeta

    +
    +

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

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    selfLink

    SelfLink is a URL representing this object. Populated by the system. Read-only.

    false

    string

    resourceVersion

    String that identifies the server’s internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#concurrency-control-and-consistency

    false

    string

    + +
    +
    +

    v1.PersistentVolumeClaimStatus

    +
    +

    PersistentVolumeClaimStatus is the current status of a persistent volume claim.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    phase

    Phase represents the current phase of PersistentVolumeClaim.

    false

    string

    accessModes

    AccessModes contains the actual access modes the volume backing the PVC has. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#access-modes-1

    false

    v1.PersistentVolumeAccessMode array

    capacity

    Represents the actual resources of the underlying volume.

    false

    object

    + +
    +
    +

    v1.QuobyteVolumeSource

    +
    +

    Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    registry

    Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes

    true

    string

    volume

    Volume is a string that references an already created Quobyte volume by name.

    true

    string

    readOnly

    ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.

    false

    boolean

    false

    user

    User to map volume access to Defaults to serivceaccount user

    false

    string

    group

    Group to map volume access to Default is no group

    false

    string

    + +
    +
    +

    v1alpha1.PetSet

    +
    +

    PetSet represents a set of pods with consistent identities. Identities are defined as:
    + - Network: A single stable DNS and hostname.
    + - Storage: As many VolumeClaims as requested.
    +The PetSet guarantees that a given network identity will always map to the same storage identity. PetSet is currently in alpha and subject to change without notice.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    false

    v1.ObjectMeta

    spec

    Spec defines the desired identities of pets in this set.

    false

    v1alpha1.PetSetSpec

    status

    Status is the current status of Pets in this PetSet. This data may be out of date by some window of time.

    false

    v1alpha1.PetSetStatus

    + +
    +
    +

    unversioned.LabelSelector

    +
    +

    A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    matchLabels

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

    false

    object

    matchExpressions

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

    false

    unversioned.LabelSelectorRequirement array

    + +
    +
    +

    v1.SecretVolumeSource

    +
    +

    Adapts a Secret into a volume.

    +
    +
    +

    The contents of the target Secret’s Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    secretName

    Name of the secret in the pod’s namespace to use. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#secrets

    false

    string

    items

    If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error. Paths must be relative and may not contain the .. path or start with ...

    false

    v1.KeyToPath array

    defaultMode

    Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    false

    integer (int32)

    + +
    +
    +

    v1.EnvVar

    +
    +

    EnvVar represents an environment variable present in a Container.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    name

    Name of the environment variable. Must be a C_IDENTIFIER.

    true

    string

    value

    Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".

    false

    string

    valueFrom

    Source for the environment variable’s value. Cannot be used if value is not empty.

    false

    v1.EnvVarSource

    + +
    +
    +

    v1.PersistentVolumeAccessMode

    + +
    +
    +

    v1.ResourceRequirements

    +
    +

    ResourceRequirements describes the compute resource requirements.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    limits

    Limits describes the maximum amount of compute resources allowed. More info: http://kubernetes.io/docs/user-guide/compute-resources/

    false

    object

    requests

    Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: http://kubernetes.io/docs/user-guide/compute-resources/

    false

    object

    + +
    +
    +

    v1.FlexVolumeSource

    +
    +

    FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    driver

    Driver is the name of the driver to use for this volume.

    true

    string

    fsType

    Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.

    false

    string

    secretRef

    Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.

    false

    v1.LocalObjectReference

    readOnly

    Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

    false

    boolean

    false

    options

    Optional: Extra command options if any.

    false

    object

    + +
    +
    +

    v1.EnvVarSource

    +
    +

    EnvVarSource represents a source for the value of an EnvVar.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    fieldRef

    Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.podIP.

    false

    v1.ObjectFieldSelector

    resourceFieldRef

    Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

    false

    v1.ResourceFieldSelector

    configMapKeyRef

    Selects a key of a ConfigMap.

    false

    v1.ConfigMapKeySelector

    secretKeyRef

    Selects a key of a secret in the pod’s namespace

    false

    v1.SecretKeySelector

    + +
    +
    +

    v1.PodTemplateSpec

    +
    +

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

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    metadata

    Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    v1.ObjectMeta

    spec

    Specification of the desired behavior of the pod. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

    false

    v1.PodSpec

    + +
    +
    +

    v1.KeyToPath

    +
    +

    Maps a string key to a path within a volume.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    key

    The key to project.

    true

    string

    path

    The relative path of the file to map the key to. May not be an absolute path. May not contain the path element ... May not start with the string ...

    true

    string

    mode

    Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    false

    integer (int32)

    + +
    +
    +

    v1.AzureDiskVolumeSource

    +
    +

    AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    diskName

    The Name of the data disk in the blob storage

    true

    string

    diskURI

    The URI the data disk in the blob storage

    true

    string

    cachingMode

    Host Caching mode: None, Read Only, Read Write.

    false

    v1.AzureDataDiskCachingMode

    fsType

    Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

    false

    string

    readOnly

    Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

    false

    boolean

    false

    + +
    +
    +

    v1.VsphereVirtualDiskVolumeSource

    +
    +

    Represents a vSphere volume resource.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    volumePath

    Path that identifies vSphere volume vmdk

    true

    string

    fsType

    Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

    false

    string

    + +
    +
    +

    v1alpha1.PetSetStatus

    +
    +

    PetSetStatus represents the current state of a PetSet.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    observedGeneration

    most recent generation observed by this autoscaler.

    false

    integer (int64)

    replicas

    Replicas is the number of actual replicas.

    true

    integer (int32)

    + +
    +
    +

    v1.DeleteOptions

    +
    +

    DeleteOptions may be provided when deleting an API object

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

    false

    string

    gracePeriodSeconds

    The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    false

    integer (int64)

    preconditions

    Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.

    false

    v1.Preconditions

    orphanDependents

    Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

    false

    boolean

    false

    + +
    +
    +

    v1.Volume

    +
    +

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

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    name

    Volume’s name. Must be a DNS_LABEL and unique within the pod. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

    true

    string

    hostPath

    HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#hostpath

    false

    v1.HostPathVolumeSource

    emptyDir

    EmptyDir represents a temporary directory that shares a pod’s lifetime. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#emptydir

    false

    v1.EmptyDirVolumeSource

    gcePersistentDisk

    GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#gcepersistentdisk

    false

    v1.GCEPersistentDiskVolumeSource

    awsElasticBlockStore

    AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#awselasticblockstore

    false

    v1.AWSElasticBlockStoreVolumeSource

    gitRepo

    GitRepo represents a git repository at a particular revision.

    false

    v1.GitRepoVolumeSource

    secret

    Secret represents a secret that should populate this volume. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#secrets

    false

    v1.SecretVolumeSource

    nfs

    NFS represents an NFS mount on the host that shares a pod’s lifetime More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#nfs

    false

    v1.NFSVolumeSource

    iscsi

    ISCSI represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://releases.k8s.io/release-1.4/examples/volumes/iscsi/README.md

    false

    v1.ISCSIVolumeSource

    glusterfs

    Glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/release-1.4/examples/volumes/glusterfs/README.md

    false

    v1.GlusterfsVolumeSource

    persistentVolumeClaim

    PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

    false

    v1.PersistentVolumeClaimVolumeSource

    rbd

    RBD represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md

    false

    v1.RBDVolumeSource

    flexVolume

    FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.

    false

    v1.FlexVolumeSource

    cinder

    Cinder represents a cinder volume attached and mounted on kubelets host machine More info: http://releases.k8s.io/release-1.4/examples/mysql-cinder-pd/README.md

    false

    v1.CinderVolumeSource

    cephfs

    CephFS represents a Ceph FS mount on the host that shares a pod’s lifetime

    false

    v1.CephFSVolumeSource

    flocker

    Flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running

    false

    v1.FlockerVolumeSource

    downwardAPI

    DownwardAPI represents downward API about the pod that should populate this volume

    false

    v1.DownwardAPIVolumeSource

    fc

    FC represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.

    false

    v1.FCVolumeSource

    azureFile

    AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

    false

    v1.AzureFileVolumeSource

    configMap

    ConfigMap represents a configMap that should populate this volume

    false

    v1.ConfigMapVolumeSource

    vsphereVolume

    VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

    false

    v1.VsphereVirtualDiskVolumeSource

    quobyte

    Quobyte represents a Quobyte mount on the host that shares a pod’s lifetime

    false

    v1.QuobyteVolumeSource

    azureDisk

    AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

    false

    v1.AzureDiskVolumeSource

    + +
    +
    +

    v1.ResourceFieldSelector

    +
    +

    ResourceFieldSelector represents container resources (cpu, memory) and their output format

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    containerName

    Container name: required for volumes, optional for env vars

    false

    string

    resource

    Required: resource to select

    true

    string

    divisor

    Specifies the output format of the exposed resources, defaults to "1"

    false

    string

    + +
    +
    +

    v1.Probe

    +
    +

    Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    exec

    One and only one of the following should be specified. Exec specifies the action to take.

    false

    v1.ExecAction

    httpGet

    HTTPGet specifies the http request to perform.

    false

    v1.HTTPGetAction

    tcpSocket

    TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

    false

    v1.TCPSocketAction

    initialDelaySeconds

    Number of seconds after the container has started before liveness probes are initiated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/pod-states.md#container-probes

    false

    integer (int32)

    timeoutSeconds

    Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: http://releases.k8s.io/release-1.4/docs/user-guide/pod-states.md#container-probes

    false

    integer (int32)

    periodSeconds

    How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

    false

    integer (int32)

    successThreshold

    Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1.

    false

    integer (int32)

    failureThreshold

    Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

    false

    integer (int32)

    + +
    +
    +

    unversioned.LabelSelectorRequirement

    +
    +

    A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    key

    key is the label key that the selector applies to.

    true

    string

    operator

    operator represents a key’s relationship to a set of values. Valid operators ard In, NotIn, Exists and DoesNotExist.

    true

    string

    values

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

    false

    string array

    + +
    +
    +

    unversioned.APIResourceList

    +
    +

    APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

    false

    string

    groupVersion

    groupVersion is the group and version this APIResourceList is for.

    true

    string

    resources

    resources contains the name of the resources and if they are namespaced.

    true

    unversioned.APIResource array

    + +
    +
    +

    v1.SecretKeySelector

    +
    +

    SecretKeySelector selects a key of a Secret.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    name

    Name of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

    false

    string

    key

    The key of the secret to select from. Must be a valid secret key.

    true

    string

    + +
    +
    +

    unversioned.Status

    +
    +

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

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    unversioned.ListMeta

    status

    Status of the operation. One of: "Success" or "Failure". More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

    false

    string

    message

    A human-readable description of the status of this operation.

    false

    string

    reason

    A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.

    false

    string

    details

    Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.

    false

    unversioned.StatusDetails

    code

    Suggested HTTP return code for this status, 0 if not set.

    false

    integer (int32)

    + +
    +
    +

    v1.Capability

    + +
    +
    +

    unversioned.APIResource

    +
    +

    APIResource specifies the name of a resource and whether it is namespaced.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    name

    name is the name of the resource.

    true

    string

    namespaced

    namespaced indicates if a resource is namespaced or not.

    true

    boolean

    false

    kind

    kind is the kind for the resource (e.g. Foo is the kind for a resource foo)

    true

    string

    + +
    +
    +

    v1.DownwardAPIVolumeFile

    +
    +

    DownwardAPIVolumeFile represents information to create the file containing the pod field

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    path

    Required: Path is the relative path name of the file to be created. Must not be absolute or contain the .. path. Must be utf-8 encoded. The first item of the relative path must not start with ..

    true

    string

    fieldRef

    Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

    false

    v1.ObjectFieldSelector

    resourceFieldRef

    Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

    false

    v1.ResourceFieldSelector

    mode

    Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    false

    integer (int32)

    + +
    +
    +

    v1.PodSpec

    +
    +

    PodSpec is a description of a pod.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    volumes

    List of volumes that can be mounted by containers belonging to the pod. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md

    false

    v1.Volume array

    containers

    List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/containers.md

    true

    v1.Container array

    restartPolicy

    Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: http://releases.k8s.io/release-1.4/docs/user-guide/pod-states.md#restartpolicy

    false

    string

    terminationGracePeriodSeconds

    Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.

    false

    integer (int64)

    activeDeadlineSeconds

    Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer.

    false

    integer (int64)

    dnsPolicy

    Set DNS policy for containers within the pod. One of ClusterFirst or Default. Defaults to "ClusterFirst".

    false

    string

    nodeSelector

    NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: http://releases.k8s.io/release-1.4/docs/user-guide/node-selection/README.md

    false

    object

    serviceAccountName

    ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: http://releases.k8s.io/release-1.4/docs/design/service_accounts.md

    false

    string

    serviceAccount

    DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.

    false

    string

    nodeName

    NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.

    false

    string

    hostNetwork

    Host networking requested for this pod. Use the host’s network namespace. If this option is set, the ports that will be used must be specified. Default to false.

    false

    boolean

    false

    hostPID

    Use the host’s pid namespace. Optional: Default to false.

    false

    boolean

    false

    hostIPC

    Use the host’s ipc namespace. Optional: Default to false.

    false

    boolean

    false

    securityContext

    SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.

    false

    v1.PodSecurityContext

    imagePullSecrets

    ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: http://releases.k8s.io/release-1.4/docs/user-guide/images.md#specifying-imagepullsecrets-on-a-pod

    false

    v1.LocalObjectReference array

    hostname

    Specifies the hostname of the Pod If not specified, the pod’s hostname will be set to a system-defined value.

    false

    string

    subdomain

    If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". If not specified, the pod will not have a domainname at all.

    false

    string

    + +
    +
    +

    v1.ContainerPort

    +
    +

    ContainerPort represents a network port in a single container.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    name

    If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.

    false

    string

    hostPort

    Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.

    false

    integer (int32)

    containerPort

    Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536.

    true

    integer (int32)

    protocol

    Protocol for port. Must be UDP or TCP. Defaults to "TCP".

    false

    string

    hostIP

    What host IP to bind the external port to.

    false

    string

    + +
    +
    +

    v1.Lifecycle

    +
    +

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

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    postStart

    PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: http://releases.k8s.io/release-1.4/docs/user-guide/container-environment.md#hook-details

    false

    v1.Handler

    preStop

    PreStop is called immediately before a container is terminated. The container is terminated after the handler completes. The reason for termination is passed to the handler. Regardless of the outcome of the handler, the container is eventually terminated. Other management of the container blocks until the hook completes. More info: http://releases.k8s.io/release-1.4/docs/user-guide/container-environment.md#hook-details

    false

    v1.Handler

    + +
    +
    +

    v1.ConfigMapKeySelector

    +
    +

    Selects a key from a ConfigMap.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    name

    Name of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

    false

    string

    key

    The key to select.

    true

    string

    + +
    +
    +

    v1.Handler

    +
    +

    Handler defines a specific action that should be taken

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    exec

    One and only one of the following should be specified. Exec specifies the action to take.

    false

    v1.ExecAction

    httpGet

    HTTPGet specifies the http request to perform.

    false

    v1.HTTPGetAction

    tcpSocket

    TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

    false

    v1.TCPSocketAction

    + +
    +
    +

    v1.GlusterfsVolumeSource

    +
    +

    Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    endpoints

    EndpointsName is the endpoint name that details Glusterfs topology. More info: http://releases.k8s.io/release-1.4/examples/volumes/glusterfs/README.md#create-a-pod

    true

    string

    path

    Path is the Glusterfs volume path. More info: http://releases.k8s.io/release-1.4/examples/volumes/glusterfs/README.md#create-a-pod

    true

    string

    readOnly

    ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: http://releases.k8s.io/release-1.4/examples/volumes/glusterfs/README.md#create-a-pod

    false

    boolean

    false

    + +
    +
    +

    v1alpha1.PetSetList

    +
    +

    PetSetList is a collection of PetSets.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    false

    unversioned.ListMeta

    items

    true

    v1alpha1.PetSet array

    + +
    +
    +

    v1.AzureDataDiskCachingMode

    + +
    +
    +

    v1.RBDVolumeSource

    +
    +

    Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    monitors

    A collection of Ceph monitors. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md#how-to-use-it

    true

    string array

    image

    The rados image name. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md#how-to-use-it

    true

    string

    fsType

    Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#rbd

    false

    string

    pool

    The rados pool name. Default is rbd. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md#how-to-use-it.

    false

    string

    user

    The rados user name. Default is admin. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md#how-to-use-it

    false

    string

    keyring

    Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md#how-to-use-it

    false

    string

    secretRef

    SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md#how-to-use-it

    false

    v1.LocalObjectReference

    readOnly

    ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md#how-to-use-it

    false

    boolean

    false

    + +
    +
    +

    any

    +
    +

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

    +
    +
    +
    + + + + + \ No newline at end of file diff --git a/docs/api-reference/apps/v1alpha1/operations.html b/docs/api-reference/apps/v1alpha1/operations.html new file mode 100755 index 0000000000..b46e335e91 --- /dev/null +++ b/docs/api-reference/apps/v1alpha1/operations.html @@ -0,0 +1,2029 @@ +--- +--- + + + + + + +Operations + + + +
    +
    +

    Operations

    +
    +
    +

    get available resources

    +
    +
    +
    GET /apis/apps/v1alpha1
    +
    +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    default

    success

    unversioned.APIResourceList

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisappsv1alpha1

      +
      • +
    +
    +
    +
    +
    +

    list or watch objects of kind PetSet

    +
    +
    +
    GET /apis/apps/v1alpha1/namespaces/{namespace}/petsets
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.PetSetList

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisappsv1alpha1

      +
      • +
    +
    +
    +
    +
    +

    delete collection of PetSet

    +
    +
    +
    DELETE /apis/apps/v1alpha1/namespaces/{namespace}/petsets
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    unversioned.Status

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisappsv1alpha1

      +
      • +
    +
    +
    +
    +
    +

    create a PetSet

    +
    +
    +
    POST /apis/apps/v1alpha1/namespaces/{namespace}/petsets
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    v1alpha1.PetSet

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.PetSet

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisappsv1alpha1

      +
      • +
    +
    +
    +
    +
    +

    read the specified PetSet

    +
    +
    +
    GET /apis/apps/v1alpha1/namespaces/{namespace}/petsets/{name}
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    export

    Should this value be exported. Export strips fields that a user can not specify.

    false

    boolean

    QueryParameter

    exact

    Should the export be exact. Exact export maintains cluster-specific fields like Namespace

    false

    boolean

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    PathParameter

    name

    name of the PetSet

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.PetSet

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisappsv1alpha1

      +
      • +
    +
    +
    +
    +
    +

    replace the specified PetSet

    +
    +
    +
    PUT /apis/apps/v1alpha1/namespaces/{namespace}/petsets/{name}
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    v1alpha1.PetSet

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    PathParameter

    name

    name of the PetSet

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.PetSet

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisappsv1alpha1

      +
      • +
    +
    +
    +
    +
    +

    delete a PetSet

    +
    +
    +
    DELETE /apis/apps/v1alpha1/namespaces/{namespace}/petsets/{name}
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    v1.DeleteOptions

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    PathParameter

    name

    name of the PetSet

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    unversioned.Status

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisappsv1alpha1

      +
      • +
    +
    +
    +
    +
    +

    partially update the specified PetSet

    +
    +
    +
    PATCH /apis/apps/v1alpha1/namespaces/{namespace}/petsets/{name}
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    unversioned.Patch

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    PathParameter

    name

    name of the PetSet

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.PetSet

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      application/json-patch+json

      +
      • +
    • +

      application/merge-patch+json

      +
      • +
    • +

      application/strategic-merge-patch+json

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisappsv1alpha1

      +
      • +
    +
    +
    +
    +
    +

    read status of the specified PetSet

    +
    +
    +
    GET /apis/apps/v1alpha1/namespaces/{namespace}/petsets/{name}/status
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    PathParameter

    name

    name of the PetSet

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.PetSet

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisappsv1alpha1

      +
      • +
    +
    +
    +
    +
    +

    replace status of the specified PetSet

    +
    +
    +
    PUT /apis/apps/v1alpha1/namespaces/{namespace}/petsets/{name}/status
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    v1alpha1.PetSet

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    PathParameter

    name

    name of the PetSet

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.PetSet

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisappsv1alpha1

      +
      • +
    +
    +
    +
    +
    +

    partially update status of the specified PetSet

    +
    +
    +
    PATCH /apis/apps/v1alpha1/namespaces/{namespace}/petsets/{name}/status
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    unversioned.Patch

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    PathParameter

    name

    name of the PetSet

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.PetSet

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      application/json-patch+json

      +
      • +
    • +

      application/merge-patch+json

      +
      • +
    • +

      application/strategic-merge-patch+json

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisappsv1alpha1

      +
      • +
    +
    +
    +
    +
    +

    list or watch objects of kind PetSet

    +
    +
    +
    GET /apis/apps/v1alpha1/petsets
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.PetSetList

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisappsv1alpha1

      +
      • +
    +
    +
    +
    +
    +

    watch individual changes to a list of PetSet

    +
    +
    +
    GET /apis/apps/v1alpha1/watch/namespaces/{namespace}/petsets
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    *versioned.Event

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisappsv1alpha1

      +
      • +
    +
    +
    +
    +
    +

    watch changes to an object of kind PetSet

    +
    +
    +
    GET /apis/apps/v1alpha1/watch/namespaces/{namespace}/petsets/{name}
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    PathParameter

    name

    name of the PetSet

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    *versioned.Event

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisappsv1alpha1

      +
      • +
    +
    +
    +
    +
    +

    watch individual changes to a list of PetSet

    +
    +
    +
    GET /apis/apps/v1alpha1/watch/petsets
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    *versioned.Event

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisappsv1alpha1

      +
      • +
    +
    +
    +
    +
    +
    +
    + + + \ No newline at end of file diff --git a/docs/api-reference/authentication.k8s.io/v1beta1/definitions.html b/docs/api-reference/authentication.k8s.io/v1beta1/definitions.html new file mode 100755 index 0000000000..1ffd8c00cd --- /dev/null +++ b/docs/api-reference/authentication.k8s.io/v1beta1/definitions.html @@ -0,0 +1,555 @@ +--- +--- + + + + + + +Top Level API Objects + + + +
    +
    +

    Top Level API Objects

    +
    +
    + +
    +
    +
    +
    +

    Definitions

    +
    +
    +

    v1beta1.UserInfo

    +
    +

    UserInfo holds the information about the user needed to implement the user.Info interface.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    username

    The name that uniquely identifies this user among all active users.

    false

    string

    uid

    A unique value that identifies this user across time. If this user is deleted and another user by the same name is added, they will have different UIDs.

    false

    string

    groups

    The names of groups this user is a part of.

    false

    string array

    extra

    Any additional information provided by the authenticator.

    false

    object

    + +
    +
    +

    v1.OwnerReference

    +
    +

    OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    apiVersion

    API version of the referent.

    true

    string

    kind

    Kind of the referent. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    true

    string

    name

    Name of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

    true

    string

    uid

    UID of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#uids

    true

    string

    controller

    If true, this reference points to the managing controller.

    false

    boolean

    false

    + +
    +
    +

    v1.ObjectMeta

    +
    +

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

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    name

    Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

    false

    string

    generateName

    GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
    +
    +If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
    +
    +Applied only if Name is not specified. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#idempotency

    false

    string

    namespace

    Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
    +
    +Must be a DNS_LABEL. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/namespaces.md

    false

    string

    selfLink

    SelfLink is a URL representing this object. Populated by the system. Read-only.

    false

    string

    uid

    UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
    +
    +Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#uids

    false

    string

    resourceVersion

    An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
    +
    +Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#concurrency-control-and-consistency

    false

    string

    generation

    A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

    false

    integer (int64)

    creationTimestamp

    CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
    +
    +Populated by the system. Read-only. Null for lists. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    string (date-time)

    deletionTimestamp

    DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource will be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. Once the resource is deleted in the API, the Kubelet will send a hard termination signal to the container. If not set, graceful deletion of the object has not been requested.
    +
    +Populated by the system when a graceful deletion is requested. Read-only. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    string (date-time)

    deletionGracePeriodSeconds

    Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

    false

    integer (int64)

    labels

    Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://releases.k8s.io/release-1.4/docs/user-guide/labels.md

    false

    object

    annotations

    Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://releases.k8s.io/release-1.4/docs/user-guide/annotations.md

    false

    object

    ownerReferences

    List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

    false

    v1.OwnerReference array

    finalizers

    Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.

    false

    string array

    clusterName

    The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

    false

    string

    + +
    +
    +

    v1beta1.TokenReviewStatus

    +
    +

    TokenReviewStatus is the result of the token authentication request.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    authenticated

    Authenticated indicates that the token was associated with a known user.

    false

    boolean

    false

    user

    User is the UserInfo associated with the provided token.

    false

    v1beta1.UserInfo

    error

    Error indicates that the token couldn’t be checked

    false

    string

    + +
    +
    +

    v1beta1.TokenReviewSpec

    +
    +

    TokenReviewSpec is a description of the token authentication request.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    token

    Token is the opaque bearer token.

    false

    string

    + +
    +
    +

    v1beta1.TokenReview

    +
    +

    TokenReview attempts to authenticate a token to a known user. Note: TokenReview requests may be cached by the webhook token authenticator plugin in the kube-apiserver.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    false

    v1.ObjectMeta

    spec

    Spec holds information about the request being evaluated

    true

    v1beta1.TokenReviewSpec

    status

    Status is filled in by the server and indicates whether the request can be authenticated.

    false

    v1beta1.TokenReviewStatus

    + +
    +
    +

    unversioned.APIResourceList

    +
    +

    APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

    false

    string

    groupVersion

    groupVersion is the group and version this APIResourceList is for.

    true

    string

    resources

    resources contains the name of the resources and if they are namespaced.

    true

    unversioned.APIResource array

    + +
    +
    +

    unversioned.APIResource

    +
    +

    APIResource specifies the name of a resource and whether it is namespaced.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    name

    name is the name of the resource.

    true

    string

    namespaced

    namespaced indicates if a resource is namespaced or not.

    true

    boolean

    false

    kind

    kind is the kind for the resource (e.g. Foo is the kind for a resource foo)

    true

    string

    + +
    +
    +

    any

    +
    +

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

    +
    +
    +
    +
    +
    + + + \ No newline at end of file diff --git a/docs/api-reference/authentication.k8s.io/v1beta1/operations.html b/docs/api-reference/authentication.k8s.io/v1beta1/operations.html new file mode 100755 index 0000000000..2934b11a6f --- /dev/null +++ b/docs/api-reference/authentication.k8s.io/v1beta1/operations.html @@ -0,0 +1,213 @@ +--- +--- + + + + + + +Operations + + + +
    +
    +

    Operations

    +
    +
    +

    get available resources

    +
    +
    +
    GET /apis/authentication.k8s.io/v1beta1
    +
    +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    default

    success

    unversioned.APIResourceList

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisauthentication.k8s.iov1beta1

      +
      • +
    +
    +
    +
    +
    +

    create a TokenReview

    +
    +
    +
    POST /apis/authentication.k8s.io/v1beta1/tokenreviews
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    v1beta1.TokenReview

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1beta1.TokenReview

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisauthentication.k8s.iov1beta1

      +
      • +
    +
    +
    +
    +
    +
    +
    + + + \ No newline at end of file diff --git a/docs/api-reference/authorization.k8s.io/v1beta1/definitions.html b/docs/api-reference/authorization.k8s.io/v1beta1/definitions.html new file mode 100755 index 0000000000..958bbea4b2 --- /dev/null +++ b/docs/api-reference/authorization.k8s.io/v1beta1/definitions.html @@ -0,0 +1,645 @@ +--- +--- + + + + + + +Top Level API Objects + + + +
    +
    +

    Top Level API Objects

    +
    +
    + +
    +
    +
    +
    +

    Definitions

    +
    +
    +

    v1.OwnerReference

    +
    +

    OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    apiVersion

    API version of the referent.

    true

    string

    kind

    Kind of the referent. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    true

    string

    name

    Name of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

    true

    string

    uid

    UID of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#uids

    true

    string

    controller

    If true, this reference points to the managing controller.

    false

    boolean

    false

    + +
    +
    +

    v1.ObjectMeta

    +
    +

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

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    name

    Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

    false

    string

    generateName

    GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
    +
    +If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
    +
    +Applied only if Name is not specified. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#idempotency

    false

    string

    namespace

    Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
    +
    +Must be a DNS_LABEL. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/namespaces.md

    false

    string

    selfLink

    SelfLink is a URL representing this object. Populated by the system. Read-only.

    false

    string

    uid

    UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
    +
    +Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#uids

    false

    string

    resourceVersion

    An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
    +
    +Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#concurrency-control-and-consistency

    false

    string

    generation

    A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

    false

    integer (int64)

    creationTimestamp

    CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
    +
    +Populated by the system. Read-only. Null for lists. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    string (date-time)

    deletionTimestamp

    DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource will be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. Once the resource is deleted in the API, the Kubelet will send a hard termination signal to the container. If not set, graceful deletion of the object has not been requested.
    +
    +Populated by the system when a graceful deletion is requested. Read-only. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    string (date-time)

    deletionGracePeriodSeconds

    Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

    false

    integer (int64)

    labels

    Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://releases.k8s.io/release-1.4/docs/user-guide/labels.md

    false

    object

    annotations

    Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://releases.k8s.io/release-1.4/docs/user-guide/annotations.md

    false

    object

    ownerReferences

    List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

    false

    v1.OwnerReference array

    finalizers

    Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.

    false

    string array

    clusterName

    The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

    false

    string

    + +
    +
    +

    v1beta1.SubjectAccessReview

    +
    +

    SubjectAccessReview checks whether or not a user or group can perform an action.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    false

    v1.ObjectMeta

    spec

    Spec holds information about the request being evaluated

    true

    v1beta1.SubjectAccessReviewSpec

    status

    Status is filled in by the server and indicates whether the request is allowed or not

    false

    v1beta1.SubjectAccessReviewStatus

    + +
    +
    +

    unversioned.APIResourceList

    +
    +

    APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

    false

    string

    groupVersion

    groupVersion is the group and version this APIResourceList is for.

    true

    string

    resources

    resources contains the name of the resources and if they are namespaced.

    true

    unversioned.APIResource array

    + +
    +
    +

    v1beta1.ResourceAttributes

    +
    +

    ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    namespace

    Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces "" (empty) is defaulted for LocalSubjectAccessReviews "" (empty) is empty for cluster-scoped resources "" (empty) means "all" for namespace scoped resources from a SubjectAccessReview or SelfSubjectAccessReview

    false

    string

    verb

    Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all.

    false

    string

    group

    Group is the API Group of the Resource. "*" means all.

    false

    string

    version

    Version is the API Version of the Resource. "*" means all.

    false

    string

    resource

    Resource is one of the existing resource types. "*" means all.

    false

    string

    subresource

    Subresource is one of the existing resource types. "" means none.

    false

    string

    name

    Name is the name of the resource being requested for a "get" or deleted for a "delete". "" (empty) means all.

    false

    string

    + +
    +
    +

    v1beta1.NonResourceAttributes

    +
    +

    NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    path

    Path is the URL path of the request

    false

    string

    verb

    Verb is the standard HTTP verb

    false

    string

    + +
    +
    +

    v1beta1.SubjectAccessReviewSpec

    +
    +

    SubjectAccessReviewSpec is a description of the access request. Exactly one of ResourceAuthorizationAttributes and NonResourceAuthorizationAttributes must be set

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    resourceAttributes

    ResourceAuthorizationAttributes describes information for a resource access request

    false

    v1beta1.ResourceAttributes

    nonResourceAttributes

    NonResourceAttributes describes information for a non-resource access request

    false

    v1beta1.NonResourceAttributes

    user

    User is the user you’re testing for. If you specify "User" but not "Group", then is it interpreted as "What if User were not a member of any groups

    false

    string

    group

    Groups is the groups you’re testing for.

    false

    string array

    extra

    Extra corresponds to the user.Info.GetExtra() method from the authenticator. Since that is input to the authorizer it needs a reflection here.

    false

    object

    + +
    +
    +

    unversioned.APIResource

    +
    +

    APIResource specifies the name of a resource and whether it is namespaced.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    name

    name is the name of the resource.

    true

    string

    namespaced

    namespaced indicates if a resource is namespaced or not.

    true

    boolean

    false

    kind

    kind is the kind for the resource (e.g. Foo is the kind for a resource foo)

    true

    string

    + +
    +
    +

    v1beta1.SubjectAccessReviewStatus

    +
    +

    SubjectAccessReviewStatus

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    allowed

    Allowed is required. True if the action would be allowed, false otherwise.

    true

    boolean

    false

    reason

    Reason is optional. It indicates why a request was allowed or denied.

    false

    string

    evaluationError

    EvaluationError is an indication that some error occurred during the authorization check. It is entirely possible to get an error and be able to continue determine authorization status in spite of it. For instance, RBAC can be missing a role, but enough roles are still present and bound to reason about the request.

    false

    string

    + +
    +
    +

    any

    +
    +

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

    +
    +
    +
    +
    +
    + + + \ No newline at end of file diff --git a/docs/api-reference/authorization.k8s.io/v1beta1/operations.html b/docs/api-reference/authorization.k8s.io/v1beta1/operations.html new file mode 100755 index 0000000000..fb0c129910 --- /dev/null +++ b/docs/api-reference/authorization.k8s.io/v1beta1/operations.html @@ -0,0 +1,213 @@ +--- +--- + + + + + + +Operations + + + +
    +
    +

    Operations

    +
    +
    +

    get available resources

    +
    +
    +
    GET /apis/authorization.k8s.io/v1beta1
    +
    +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    default

    success

    unversioned.APIResourceList

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisauthorization.k8s.iov1beta1

      +
      • +
    +
    +
    +
    +
    +

    create a SubjectAccessReview

    +
    +
    +
    POST /apis/authorization.k8s.io/v1beta1/subjectaccessreviews
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    v1beta1.SubjectAccessReview

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1beta1.SubjectAccessReview

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisauthorization.k8s.iov1beta1

      +
      • +
    +
    +
    +
    +
    +
    +
    + + + \ No newline at end of file diff --git a/docs/api-reference/batch/v2alpha1/definitions.html b/docs/api-reference/batch/v2alpha1/definitions.html new file mode 100755 index 0000000000..2253dc2e50 --- /dev/null +++ b/docs/api-reference/batch/v2alpha1/definitions.html @@ -0,0 +1,142 @@ +--- +--- + + + + + + +Top Level API Objects + + + +
    +
    +

    Top Level API Objects

    +
    + +
    +
    +
    +

    Definitions

    +
    +
    +

    unversioned.APIResourceList

    +
    +

    APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

    false

    string

    groupVersion

    groupVersion is the group and version this APIResourceList is for.

    true

    string

    resources

    resources contains the name of the resources and if they are namespaced.

    true

    unversioned.APIResource array

    + +
    +
    +

    unversioned.APIResource

    +
    +

    APIResource specifies the name of a resource and whether it is namespaced.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    name

    name is the name of the resource.

    true

    string

    namespaced

    namespaced indicates if a resource is namespaced or not.

    true

    boolean

    false

    kind

    kind is the kind for the resource (e.g. Foo is the kind for a resource foo)

    true

    string

    + +
    +
    +

    any

    +
    +

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

    +
    +
    +
    +
    +
    + + + \ No newline at end of file diff --git a/docs/api-reference/batch/v2alpha1/operations.html b/docs/api-reference/batch/v2alpha1/operations.html new file mode 100755 index 0000000000..bad277d7d6 --- /dev/null +++ b/docs/api-reference/batch/v2alpha1/operations.html @@ -0,0 +1,102 @@ +--- +--- + + + + + + +Operations + + + +
    +
    +

    Operations

    +
    +
    +

    get available resources

    +
    +
    +
    GET /apis/batch/v2alpha1
    +
    +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    default

    success

    unversioned.APIResourceList

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisbatchv2alpha1

      +
      • +
    +
    +
    +
    +
    +
    +
    + + + \ No newline at end of file diff --git a/docs/api-reference/certificates/v1alpha1/definitions.html b/docs/api-reference/certificates.k8s.io/v1alpha1/definitions.html similarity index 99% rename from docs/api-reference/certificates/v1alpha1/definitions.html rename to docs/api-reference/certificates.k8s.io/v1alpha1/definitions.html index 0d1984dc50..9efd8bcb04 100755 --- a/docs/api-reference/certificates/v1alpha1/definitions.html +++ b/docs/api-reference/certificates.k8s.io/v1alpha1/definitions.html @@ -44,7 +44,7 @@ - + @@ -99,7 +99,7 @@ - + @@ -161,7 +161,7 @@ - + @@ -216,7 +216,7 @@ - + @@ -282,7 +282,7 @@ - + @@ -320,7 +320,7 @@ - + @@ -358,7 +358,7 @@ - + @@ -413,7 +413,7 @@ - + @@ -447,7 +447,7 @@ - + @@ -509,7 +509,7 @@ - + @@ -564,7 +564,7 @@ - + @@ -647,7 +647,7 @@ - + @@ -695,7 +695,7 @@ - + @@ -841,7 +841,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i - + @@ -907,7 +907,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i - + diff --git a/docs/api-reference/certificates/v1alpha1/operations.html b/docs/api-reference/certificates.k8s.io/v1alpha1/operations.html similarity index 96% rename from docs/api-reference/certificates/v1alpha1/operations.html rename to docs/api-reference/certificates.k8s.io/v1alpha1/operations.html index 08ed0012d0..2fe9549f2e 100755 --- a/docs/api-reference/certificates/v1alpha1/operations.html +++ b/docs/api-reference/certificates.k8s.io/v1alpha1/operations.html @@ -19,7 +19,7 @@

    get available resources

    -
    GET /apis/certificates/v1alpha1
    +
    GET /apis/certificates.k8s.io/v1alpha1
    @@ -28,7 +28,7 @@ - + @@ -84,7 +84,7 @@
    @@ -94,7 +94,7 @@

    list or watch objects of kind CertificateSigningRequest

    -
    GET /apis/certificates/v1alpha1/certificatesigningrequests
    +
    GET /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests
    @@ -106,7 +106,7 @@ - + @@ -177,7 +177,7 @@ - + @@ -227,7 +227,7 @@
    • -

      apiscertificatesv1alpha1

      +

      apiscertificates.k8s.iov1alpha1

    @@ -237,7 +237,7 @@

    delete collection of CertificateSigningRequest

    -
    DELETE /apis/certificates/v1alpha1/certificatesigningrequests
    +
    DELETE /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests
    @@ -249,7 +249,7 @@ - + @@ -320,7 +320,7 @@ - + @@ -370,7 +370,7 @@
    • -

      apiscertificatesv1alpha1

      +

      apiscertificates.k8s.iov1alpha1

    @@ -380,7 +380,7 @@

    create a CertificateSigningRequest

    -
    POST /apis/certificates/v1alpha1/certificatesigningrequests
    +
    POST /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests
    @@ -392,7 +392,7 @@ - + @@ -431,7 +431,7 @@ - + @@ -481,7 +481,7 @@
    • -

      apiscertificatesv1alpha1

      +

      apiscertificates.k8s.iov1alpha1

    @@ -491,7 +491,7 @@

    read the specified CertificateSigningRequest

    -
    GET /apis/certificates/v1alpha1/certificatesigningrequests/{name}
    +
    GET /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests/{name}
    @@ -503,7 +503,7 @@ - + @@ -558,7 +558,7 @@ - + @@ -608,7 +608,7 @@
    • -

      apiscertificatesv1alpha1

      +

      apiscertificates.k8s.iov1alpha1

    @@ -618,7 +618,7 @@

    replace the specified CertificateSigningRequest

    -
    PUT /apis/certificates/v1alpha1/certificatesigningrequests/{name}
    +
    PUT /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests/{name}
    @@ -630,7 +630,7 @@ - + @@ -677,7 +677,7 @@ - + @@ -727,7 +727,7 @@
    • -

      apiscertificatesv1alpha1

      +

      apiscertificates.k8s.iov1alpha1

    @@ -737,7 +737,7 @@

    delete a CertificateSigningRequest

    -
    DELETE /apis/certificates/v1alpha1/certificatesigningrequests/{name}
    +
    DELETE /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests/{name}
    @@ -749,7 +749,7 @@ - + @@ -796,7 +796,7 @@ - + @@ -846,7 +846,7 @@
    • -

      apiscertificatesv1alpha1

      +

      apiscertificates.k8s.iov1alpha1

    @@ -856,7 +856,7 @@

    partially update the specified CertificateSigningRequest

    -
    PATCH /apis/certificates/v1alpha1/certificatesigningrequests/{name}
    +
    PATCH /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests/{name}
    @@ -868,7 +868,7 @@ - + @@ -915,7 +915,7 @@ - + @@ -971,7 +971,7 @@
    • -

      apiscertificatesv1alpha1

      +

      apiscertificates.k8s.iov1alpha1

    @@ -981,7 +981,7 @@

    replace approval of the specified CertificateSigningRequest

    -
    PUT /apis/certificates/v1alpha1/certificatesigningrequests/{name}/approval
    +
    PUT /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests/{name}/approval
    @@ -993,7 +993,7 @@ - + @@ -1040,7 +1040,7 @@ - + @@ -1090,7 +1090,7 @@
    • -

      apiscertificatesv1alpha1

      +

      apiscertificates.k8s.iov1alpha1

    @@ -1100,7 +1100,7 @@

    replace status of the specified CertificateSigningRequest

    -
    PUT /apis/certificates/v1alpha1/certificatesigningrequests/{name}/status
    +
    PUT /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests/{name}/status
    @@ -1112,7 +1112,7 @@ - + @@ -1159,7 +1159,7 @@ - + @@ -1209,7 +1209,7 @@
    • -

      apiscertificatesv1alpha1

      +

      apiscertificates.k8s.iov1alpha1

    @@ -1219,7 +1219,7 @@

    watch individual changes to a list of CertificateSigningRequest

    -
    GET /apis/certificates/v1alpha1/watch/certificatesigningrequests
    +
    GET /apis/certificates.k8s.io/v1alpha1/watch/certificatesigningrequests
    @@ -1231,7 +1231,7 @@ - + @@ -1302,7 +1302,7 @@ - + @@ -1355,7 +1355,7 @@
    • -

      apiscertificatesv1alpha1

      +

      apiscertificates.k8s.iov1alpha1

    @@ -1365,7 +1365,7 @@

    watch changes to an object of kind CertificateSigningRequest

    -
    GET /apis/certificates/v1alpha1/watch/certificatesigningrequests/{name}
    +
    GET /apis/certificates.k8s.io/v1alpha1/watch/certificatesigningrequests/{name}
    @@ -1377,7 +1377,7 @@ - + @@ -1456,7 +1456,7 @@ - + @@ -1509,7 +1509,7 @@
    • -

      apiscertificatesv1alpha1

      +

      apiscertificates.k8s.iov1alpha1

    @@ -1520,7 +1520,7 @@
    diff --git a/docs/api-reference/extensions/v1beta1/definitions.html b/docs/api-reference/extensions/v1beta1/definitions.html index dcbce6cfc9..105a63d12d 100755 --- a/docs/api-reference/extensions/v1beta1/definitions.html +++ b/docs/api-reference/extensions/v1beta1/definitions.html @@ -71,12 +71,6 @@

  • v1beta1.NetworkPolicyList

    • -
  • -

    v1beta1.StorageClass

    -
    • -
  • -

    v1beta1.StorageClassList

    -
    • @@ -1215,71 +1209,6 @@ Examples:
    -
    -
    -

    v1beta1.StorageClass

    -
    -

    StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned.

    -
    -
    -

    StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name.

    -
    - ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    v1.ObjectMeta

    provisioner

    Provisioner indicates the type of the provisioner.

    true

    string

    parameters

    Parameters holds the parameters for the provisioner that should create volumes of this storage class.

    false

    object

    -

    v1.ExecAction

    @@ -1861,61 +1790,6 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

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

    -
    -
    -

    v1beta1.StorageClassList

    -
    -

    StorageClassList is a collection of storage classes.

    -
    - ------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    Standard list metadata More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    unversioned.ListMeta

    items

    Items is the list of StorageClasses

    true

    v1beta1.StorageClass array

    -

    v1.FlockerVolumeSource

    @@ -6330,7 +6204,7 @@ Both these may change in the future. Incoming requests are matched against the h
    diff --git a/docs/api-reference/extensions/v1beta1/operations.html b/docs/api-reference/extensions/v1beta1/operations.html index 1b11d2bd9e..78a0f60bf6 100755 --- a/docs/api-reference/extensions/v1beta1/operations.html +++ b/docs/api-reference/extensions/v1beta1/operations.html @@ -11231,10 +11231,10 @@
    -

    list or watch objects of kind StorageClass

    +

    list or watch objects of kind ThirdPartyResource

    -
    GET /apis/extensions/v1beta1/storageclasses
    +
    GET /apis/extensions/v1beta1/thirdpartyresources
    @@ -11330,7 +11330,7 @@

    200

    success

    -

    v1beta1.StorageClassList

    +

    v1beta1.ThirdPartyResourceList

    @@ -11374,10 +11374,10 @@
    -

    delete collection of StorageClass

    +

    delete collection of ThirdPartyResource

    -
    DELETE /apis/extensions/v1beta1/storageclasses
    +
    DELETE /apis/extensions/v1beta1/thirdpartyresources
    @@ -11517,10 +11517,10 @@
    -

    create a StorageClass

    +

    create a ThirdPartyResource

    -
    POST /apis/extensions/v1beta1/storageclasses
    +
    POST /apis/extensions/v1beta1/thirdpartyresources
    @@ -11558,7 +11558,7 @@

    body

    true

    -

    v1beta1.StorageClass

    +

    v1beta1.ThirdPartyResource

    @@ -11584,7 +11584,7 @@

    200

    success

    -

    v1beta1.StorageClass

    +

    v1beta1.ThirdPartyResource

    @@ -11628,10 +11628,10 @@
    -

    read the specified StorageClass

    +

    read the specified ThirdPartyResource

    -
    GET /apis/extensions/v1beta1/storageclasses/{name}
    +
    GET /apis/extensions/v1beta1/thirdpartyresources/{name}
    @@ -11683,7 +11683,7 @@

    PathParameter

    name

    -

    name of the StorageClass

    +

    name of the ThirdPartyResource

    true

    string

    @@ -11711,7 +11711,7 @@

    200

    success

    -

    v1beta1.StorageClass

    +

    v1beta1.ThirdPartyResource

    @@ -11755,10 +11755,10 @@
    -

    replace the specified StorageClass

    +

    replace the specified ThirdPartyResource

    -
    PUT /apis/extensions/v1beta1/storageclasses/{name}
    +
    PUT /apis/extensions/v1beta1/thirdpartyresources/{name}
    @@ -11796,13 +11796,13 @@

    body

    true

    -

    v1beta1.StorageClass

    +

    v1beta1.ThirdPartyResource

    PathParameter

    name

    -

    name of the StorageClass

    +

    name of the ThirdPartyResource

    true

    string

    @@ -11830,7 +11830,7 @@

    200

    success

    -

    v1beta1.StorageClass

    +

    v1beta1.ThirdPartyResource

    @@ -11874,10 +11874,10 @@
    -

    delete a StorageClass

    +

    delete a ThirdPartyResource

    -
    DELETE /apis/extensions/v1beta1/storageclasses/{name}
    +
    DELETE /apis/extensions/v1beta1/thirdpartyresources/{name}
    @@ -11921,7 +11921,7 @@

    PathParameter

    name

    -

    name of the StorageClass

    +

    name of the ThirdPartyResource

    true

    string

    @@ -11993,10 +11993,10 @@
    -

    partially update the specified StorageClass

    +

    partially update the specified ThirdPartyResource

    -
    PATCH /apis/extensions/v1beta1/storageclasses/{name}
    +
    PATCH /apis/extensions/v1beta1/thirdpartyresources/{name}
    @@ -12040,7 +12040,7 @@

    PathParameter

    name

    -

    name of the StorageClass

    +

    name of the ThirdPartyResource

    true

    string

    @@ -12068,7 +12068,7 @@

    200

    success

    -

    v1beta1.StorageClass

    +

    v1beta1.ThirdPartyResource

    @@ -12118,10 +12118,10 @@
    -

    list or watch objects of kind ThirdPartyResource

    +

    watch individual changes to a list of DaemonSet

    -
    GET /apis/extensions/v1beta1/thirdpartyresources
    +
    GET /apis/extensions/v1beta1/watch/daemonsets
    @@ -12217,7 +12217,7 @@

    200

    success

    -

    v1beta1.ThirdPartyResourceList

    +

    *versioned.Event

    @@ -12241,11 +12241,14 @@

    application/json

  • -

    application/yaml

    +

    application/json;stream=watch

  • application/vnd.kubernetes.protobuf

    • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
    • @@ -12261,10 +12264,10 @@
    -

    delete collection of ThirdPartyResource

    +

    watch individual changes to a list of Deployment

    -
    DELETE /apis/extensions/v1beta1/thirdpartyresources
    +
    GET /apis/extensions/v1beta1/watch/deployments
    @@ -12360,7 +12363,7 @@

    200

    success

    -

    unversioned.Status

    +

    *versioned.Event

    @@ -12384,11 +12387,14 @@

    application/json

  • -

    application/yaml

    +

    application/json;stream=watch

  • application/vnd.kubernetes.protobuf

    • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
    • @@ -12404,10 +12410,10 @@
    -

    create a ThirdPartyResource

    +

    watch individual changes to a list of HorizontalPodAutoscaler

    -
    POST /apis/extensions/v1beta1/thirdpartyresources
    +
    GET /apis/extensions/v1beta1/watch/horizontalpodautoscalers
    @@ -12441,11 +12447,43 @@ -

    BodyParameter

    -

    body

    +

    QueryParameter

    +

    labelSelector

    +

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    +

    false

    +

    string

    -

    true

    -

    v1beta1.ThirdPartyResource

    + + +

    QueryParameter

    +

    fieldSelector

    +

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    +

    false

    +

    string

    + + + +

    QueryParameter

    +

    watch

    +

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    +

    false

    +

    boolean

    + + + +

    QueryParameter

    +

    resourceVersion

    +

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    +

    false

    +

    string

    + + + +

    QueryParameter

    +

    timeoutSeconds

    +

    Timeout for the list/watch call.

    +

    false

    +

    integer (int32)

    @@ -12471,7 +12509,7 @@

    200

    success

    -

    v1beta1.ThirdPartyResource

    +

    *versioned.Event

    @@ -12495,11 +12533,14 @@

    application/json

  • -

    application/yaml

    +

    application/json;stream=watch

  • application/vnd.kubernetes.protobuf

    • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
    • @@ -12515,10 +12556,10 @@
    -

    read the specified ThirdPartyResource

    +

    watch individual changes to a list of Ingress

    -
    GET /apis/extensions/v1beta1/thirdpartyresources/{name}
    +
    GET /apis/extensions/v1beta1/watch/ingresses
    @@ -12553,26 +12594,42 @@

    QueryParameter

    -

    export

    -

    Should this value be exported. Export strips fields that a user can not specify.

    +

    labelSelector

    +

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    +

    false

    +

    string

    + + + +

    QueryParameter

    +

    fieldSelector

    +

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    +

    false

    +

    string

    + + + +

    QueryParameter

    +

    watch

    +

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    -

    exact

    -

    Should the export be exact. Exact export maintains cluster-specific fields like Namespace

    +

    resourceVersion

    +

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    -

    boolean

    +

    string

    -

    PathParameter

    -

    name

    -

    name of the ThirdPartyResource

    -

    true

    -

    string

    +

    QueryParameter

    +

    timeoutSeconds

    +

    Timeout for the list/watch call.

    +

    false

    +

    integer (int32)

    @@ -12598,7 +12655,7 @@

    200

    success

    -

    v1beta1.ThirdPartyResource

    +

    *versioned.Event

    @@ -12622,11 +12679,14 @@

    application/json

  • -

    application/yaml

    +

    application/json;stream=watch

  • application/vnd.kubernetes.protobuf

    • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
    • @@ -12642,10 +12702,10 @@
    -

    replace the specified ThirdPartyResource

    +

    watch individual changes to a list of Job

    -
    PUT /apis/extensions/v1beta1/thirdpartyresources/{name}
    +
    GET /apis/extensions/v1beta1/watch/jobs
    @@ -12679,21 +12739,45 @@ -

    BodyParameter

    -

    body

    - -

    true

    -

    v1beta1.ThirdPartyResource

    +

    QueryParameter

    +

    labelSelector

    +

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    +

    false

    +

    string

    -

    PathParameter

    -

    name

    -

    name of the ThirdPartyResource

    -

    true

    +

    QueryParameter

    +

    fieldSelector

    +

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    +

    false

    string

    + +

    QueryParameter

    +

    watch

    +

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    +

    false

    +

    boolean

    + + + +

    QueryParameter

    +

    resourceVersion

    +

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    +

    false

    +

    string

    + + + +

    QueryParameter

    +

    timeoutSeconds

    +

    Timeout for the list/watch call.

    +

    false

    +

    integer (int32)

    + + @@ -12717,7 +12801,7 @@

    200

    success

    -

    v1beta1.ThirdPartyResource

    +

    *versioned.Event

    @@ -12741,11 +12825,14 @@

    application/json

  • -

    application/yaml

    +

    application/json;stream=watch

  • application/vnd.kubernetes.protobuf

    • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
    • @@ -12761,980 +12848,6 @@
    -

    delete a ThirdPartyResource

    -
    -
    -
    DELETE /apis/extensions/v1beta1/thirdpartyresources/{name}
    -
    -
    -
    -

    Parameters

    - -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    v1.DeleteOptions

    PathParameter

    name

    name of the ThirdPartyResource

    true

    string

    - -
    -
    -

    Responses

    - ----- - - - - - - - - - - - - - - -
    HTTP CodeDescriptionSchema

    200

    success

    unversioned.Status

    - -
    -
    -

    Consumes

    -
    -
      -
    • -

      /

      -
      • -
    -
    -
    -
    -

    Produces

    -
    -
      -
    • -

      application/json

      -
      • -
    • -

      application/yaml

      -
      • -
    • -

      application/vnd.kubernetes.protobuf

      -
      • -
    -
    -
    -
    -

    Tags

    -
    -
      -
    • -

      apisextensionsv1beta1

      -
      • -
    -
    -
    -
    -
    -

    partially update the specified ThirdPartyResource

    -
    -
    -
    PATCH /apis/extensions/v1beta1/thirdpartyresources/{name}
    -
    -
    -
    -

    Parameters

    - -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    unversioned.Patch

    PathParameter

    name

    name of the ThirdPartyResource

    true

    string

    - -
    -
    -

    Responses

    - ----- - - - - - - - - - - - - - - -
    HTTP CodeDescriptionSchema

    200

    success

    v1beta1.ThirdPartyResource

    - -
    -
    -

    Consumes

    -
    -
      -
    • -

      application/json-patch+json

      -
      • -
    • -

      application/merge-patch+json

      -
      • -
    • -

      application/strategic-merge-patch+json

      -
      • -
    -
    -
    -
    -

    Produces

    -
    -
      -
    • -

      application/json

      -
      • -
    • -

      application/yaml

      -
      • -
    • -

      application/vnd.kubernetes.protobuf

      -
      • -
    -
    -
    -
    -

    Tags

    -
    -
      -
    • -

      apisextensionsv1beta1

      -
      • -
    -
    -
    -
    -
    -

    watch individual changes to a list of DaemonSet

    -
    -
    -
    GET /apis/extensions/v1beta1/watch/daemonsets
    -
    -
    -
    -

    Parameters

    - -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    - -
    -
    -

    Responses

    - ----- - - - - - - - - - - - - - - -
    HTTP CodeDescriptionSchema

    200

    success

    *versioned.Event

    - -
    -
    -

    Consumes

    -
    -
      -
    • -

      /

      -
      • -
    -
    -
    -
    -

    Produces

    -
    -
      -
    • -

      application/json

      -
      • -
    • -

      application/json;stream=watch

      -
      • -
    • -

      application/vnd.kubernetes.protobuf

      -
      • -
    • -

      application/vnd.kubernetes.protobuf;stream=watch

      -
      • -
    -
    -
    -
    -

    Tags

    -
    -
      -
    • -

      apisextensionsv1beta1

      -
      • -
    -
    -
    -
    -
    -

    watch individual changes to a list of Deployment

    -
    -
    -
    GET /apis/extensions/v1beta1/watch/deployments
    -
    -
    -
    -

    Parameters

    - -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    - -
    -
    -

    Responses

    - ----- - - - - - - - - - - - - - - -
    HTTP CodeDescriptionSchema

    200

    success

    *versioned.Event

    - -
    -
    -

    Consumes

    -
    -
      -
    • -

      /

      -
      • -
    -
    -
    -
    -

    Produces

    -
    -
      -
    • -

      application/json

      -
      • -
    • -

      application/json;stream=watch

      -
      • -
    • -

      application/vnd.kubernetes.protobuf

      -
      • -
    • -

      application/vnd.kubernetes.protobuf;stream=watch

      -
      • -
    -
    -
    -
    -

    Tags

    -
    -
      -
    • -

      apisextensionsv1beta1

      -
      • -
    -
    -
    -
    -
    -

    watch individual changes to a list of HorizontalPodAutoscaler

    -
    -
    -
    GET /apis/extensions/v1beta1/watch/horizontalpodautoscalers
    -
    -
    -
    -

    Parameters

    - -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    - -
    -
    -

    Responses

    - ----- - - - - - - - - - - - - - - -
    HTTP CodeDescriptionSchema

    200

    success

    *versioned.Event

    - -
    -
    -

    Consumes

    -
    -
      -
    • -

      /

      -
      • -
    -
    -
    -
    -

    Produces

    -
    -
      -
    • -

      application/json

      -
      • -
    • -

      application/json;stream=watch

      -
      • -
    • -

      application/vnd.kubernetes.protobuf

      -
      • -
    • -

      application/vnd.kubernetes.protobuf;stream=watch

      -
      • -
    -
    -
    -
    -

    Tags

    -
    -
      -
    • -

      apisextensionsv1beta1

      -
      • -
    -
    -
    -
    -
    -

    watch individual changes to a list of Ingress

    -
    -
    -
    GET /apis/extensions/v1beta1/watch/ingresses
    -
    -
    -
    -

    Parameters

    - -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    - -
    -
    -

    Responses

    - ----- - - - - - - - - - - - - - - -
    HTTP CodeDescriptionSchema

    200

    success

    *versioned.Event

    - -
    -
    -

    Consumes

    -
    -
      -
    • -

      /

      -
      • -
    -
    -
    -
    -

    Produces

    -
    -
      -
    • -

      application/json

      -
      • -
    • -

      application/json;stream=watch

      -
      • -
    • -

      application/vnd.kubernetes.protobuf

      -
      • -
    • -

      application/vnd.kubernetes.protobuf;stream=watch

      -
      • -
    -
    -
    -
    -

    Tags

    -
    -
      -
    • -

      apisextensionsv1beta1

      -
      • -
    -
    -
    -
    -
    -

    watch individual changes to a list of Job

    -
    -
    -
    GET /apis/extensions/v1beta1/watch/jobs
    -
    -
    -
    -

    Parameters

    - -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    - -
    -
    -

    Responses

    - ----- - - - - - - - - - - - - - - -
    HTTP CodeDescriptionSchema

    200

    success

    *versioned.Event

    - -
    -
    -

    Consumes

    -
    -
      -
    • -

      /

      -
      • -
    -
    -
    -
    -

    Produces

    -
    -
      -
    • -

      application/json

      -
      • -
    • -

      application/json;stream=watch

      -
      • -
    • -

      application/vnd.kubernetes.protobuf

      -
      • -
    • -

      application/vnd.kubernetes.protobuf;stream=watch

      -
      • -
    -
    -
    -
    -

    Tags

    -
    -
      -
    • -

      apisextensionsv1beta1

      -
      • -
    -
    -
    -
    -

    watch individual changes to a list of DaemonSet

    @@ -13742,7 +12855,7 @@
    -

    Parameters

    +

    Parameters

    @@ -13824,7 +12937,7 @@
    -

    Responses

    +

    Responses

    @@ -13849,7 +12962,7 @@
    -

    Consumes

    +

    Consumes

    • @@ -13859,7 +12972,7 @@
    -

    Produces

    +

    Produces

    • @@ -13878,7 +12991,7 @@
    -

    Tags

    +

    Tags

    • @@ -13896,7 +13009,7 @@
    -

    Parameters

    +

    Parameters

    @@ -13986,7 +13099,7 @@
    -

    Responses

    +

    Responses

    @@ -14011,7 +13124,7 @@
    -

    Consumes

    +

    Consumes

    • @@ -14021,7 +13134,7 @@
    -

    Produces

    +

    Produces

    • @@ -14040,7 +13153,7 @@
    -

    Tags

    +

    Tags

    • @@ -14058,7 +13171,7 @@
    -

    Parameters

    +

    Parameters

    @@ -14140,7 +13253,7 @@
    -

    Responses

    +

    Responses

    @@ -14165,7 +13278,7 @@
    -

    Consumes

    +

    Consumes

    • @@ -14175,7 +13288,7 @@
    -

    Produces

    +

    Produces

    • @@ -14194,7 +13307,7 @@
    -

    Tags

    +

    Tags

    • @@ -14212,7 +13325,7 @@
    -

    Parameters

    +

    Parameters

    @@ -14302,7 +13415,7 @@
    -

    Responses

    +

    Responses

    @@ -14327,7 +13440,7 @@
    -

    Consumes

    +

    Consumes

    • @@ -14337,7 +13450,7 @@
    -

    Produces

    +

    Produces

    • @@ -14356,7 +13469,7 @@
    -

    Tags

    +

    Tags

    • @@ -14374,7 +13487,7 @@
    -

    Parameters

    +

    Parameters

    @@ -14456,7 +13569,7 @@
    -

    Responses

    +

    Responses

    @@ -14481,7 +13594,7 @@
    -

    Consumes

    +

    Consumes

    • @@ -14491,7 +13604,7 @@
    -

    Produces

    +

    Produces

    • @@ -14510,7 +13623,7 @@
    -

    Tags

    +

    Tags

    • @@ -14528,7 +13641,7 @@
    -

    Parameters

    +

    Parameters

    @@ -14618,7 +13731,7 @@
    -

    Responses

    +

    Responses

    @@ -14643,7 +13756,7 @@
    -

    Consumes

    +

    Consumes

    • @@ -14653,7 +13766,7 @@
    -

    Produces

    +

    Produces

    • @@ -14672,7 +13785,7 @@
    -

    Tags

    +

    Tags

    • @@ -14690,7 +13803,7 @@
    -

    Parameters

    +

    Parameters

    @@ -14772,7 +13885,7 @@
    -

    Responses

    +

    Responses

    @@ -14797,7 +13910,7 @@
    -

    Consumes

    +

    Consumes

    • @@ -14807,7 +13920,7 @@
    -

    Produces

    +

    Produces

    • @@ -14826,7 +13939,7 @@
    -

    Tags

    +

    Tags

    • @@ -14844,7 +13957,7 @@
    -

    Parameters

    +

    Parameters

    @@ -14934,7 +14047,7 @@
    -

    Responses

    +

    Responses

    @@ -14959,7 +14072,7 @@
    -

    Consumes

    +

    Consumes

    • @@ -14969,7 +14082,7 @@
    -

    Produces

    +

    Produces

    • @@ -14988,7 +14101,7 @@
    -

    Tags

    +

    Tags

    • @@ -15006,7 +14119,7 @@
    -

    Parameters

    +

    Parameters

    @@ -15088,7 +14201,7 @@
    -

    Responses

    +

    Responses

    @@ -15113,7 +14226,7 @@
    -

    Consumes

    +

    Consumes

    • @@ -15123,7 +14236,7 @@
    -

    Produces

    +

    Produces

    • @@ -15142,7 +14255,7 @@
    -

    Tags

    +

    Tags

    • @@ -15160,7 +14273,7 @@
    -

    Parameters

    +

    Parameters

    @@ -15250,7 +14363,7 @@
    -

    Responses

    +

    Responses

    @@ -15275,7 +14388,7 @@
    -

    Consumes

    +

    Consumes

    • @@ -15285,7 +14398,7 @@
    -

    Produces

    +

    Produces

    • @@ -15304,7 +14417,7 @@
    -

    Tags

    +

    Tags

    • @@ -15322,7 +14435,7 @@
    -

    Parameters

    +

    Parameters

    @@ -15404,7 +14517,7 @@
    -

    Responses

    +

    Responses

    @@ -15429,7 +14542,7 @@
    -

    Consumes

    +

    Consumes

    • @@ -15439,7 +14552,7 @@
    -

    Produces

    +

    Produces

    • @@ -15458,7 +14571,7 @@
    -

    Tags

    +

    Tags

    • @@ -15476,7 +14589,7 @@
    -

    Parameters

    +

    Parameters

    @@ -15566,7 +14679,7 @@
    -

    Responses

    +

    Responses

    @@ -15591,7 +14704,7 @@
    -

    Consumes

    +

    Consumes

    • @@ -15601,7 +14714,7 @@
    -

    Produces

    +

    Produces

    • @@ -15620,7 +14733,7 @@
    -

    Tags

    +

    Tags

    • @@ -15638,7 +14751,7 @@
    -

    Parameters

    +

    Parameters

    @@ -15720,7 +14833,7 @@
    -

    Responses

    +

    Responses

    @@ -15745,7 +14858,7 @@
    -

    Consumes

    +

    Consumes

    • @@ -15755,7 +14868,7 @@
    -

    Produces

    +

    Produces

    • @@ -15774,7 +14887,7 @@
    -

    Tags

    +

    Tags

    • @@ -15792,7 +14905,7 @@
    -

    Parameters

    +

    Parameters

    @@ -15882,7 +14995,7 @@
    -

    Responses

    +

    Responses

    @@ -15907,7 +15020,7 @@
    -

    Consumes

    +

    Consumes

    • @@ -15917,7 +15030,7 @@
    -

    Produces

    +

    Produces

    • @@ -15936,7 +15049,7 @@
    -

    Tags

    +

    Tags

    • @@ -15954,7 +15067,7 @@
    -

    Parameters

    +

    Parameters

    @@ -16028,7 +15141,7 @@
    -

    Responses

    +

    Responses

    @@ -16053,7 +15166,7 @@
    -

    Consumes

    +

    Consumes

    • @@ -16063,7 +15176,7 @@
    -

    Produces

    +

    Produces

    • @@ -16082,7 +15195,7 @@
    -

    Tags

    +

    Tags

    • @@ -16100,7 +15213,7 @@
    -

    Parameters

    +

    Parameters

    @@ -16174,7 +15287,7 @@
    -

    Responses

    +

    Responses

    @@ -16199,7 +15312,7 @@
    -

    Consumes

    +

    Consumes

    • @@ -16209,7 +15322,7 @@
    -

    Produces

    +

    Produces

    • @@ -16228,307 +15341,7 @@
    -

    Tags

    -
    -
      -
    • -

      apisextensionsv1beta1

      -
      • -
    -
    -
    - -
    -

    watch individual changes to a list of StorageClass

    -
    -
    -
    GET /apis/extensions/v1beta1/watch/storageclasses
    -
    -
    -
    -

    Parameters

    -
    -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    - -
    -
    -

    Responses

    - ----- - - - - - - - - - - - - - - -
    HTTP CodeDescriptionSchema

    200

    success

    *versioned.Event

    - -
    -
    -

    Consumes

    -
    -
      -
    • -

      /

      -
      • -
    -
    -
    -
    -

    Produces

    -
    -
      -
    • -

      application/json

      -
      • -
    • -

      application/json;stream=watch

      -
      • -
    • -

      application/vnd.kubernetes.protobuf

      -
      • -
    • -

      application/vnd.kubernetes.protobuf;stream=watch

      -
      • -
    -
    -
    -
    -

    Tags

    -
    -
      -
    • -

      apisextensionsv1beta1

      -
      • -
    -
    -
    -
    -
    -

    watch changes to an object of kind StorageClass

    -
    -
    -
    GET /apis/extensions/v1beta1/watch/storageclasses/{name}
    -
    -
    -
    -

    Parameters

    - -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    PathParameter

    name

    name of the StorageClass

    true

    string

    - -
    -
    -

    Responses

    - ----- - - - - - - - - - - - - - - -
    HTTP CodeDescriptionSchema

    200

    success

    *versioned.Event

    - -
    -
    -

    Consumes

    -
    -
      -
    • -

      /

      -
      • -
    -
    -
    -
    -

    Produces

    -
    -
      -
    • -

      application/json

      -
      • -
    • -

      application/json;stream=watch

      -
      • -
    • -

      application/vnd.kubernetes.protobuf

      -
      • -
    • -

      application/vnd.kubernetes.protobuf;stream=watch

      -
      • -
    -
    -
    -
    -

    Tags

    +

    Tags

    • @@ -16546,7 +15359,7 @@
    -

    Parameters

    +

    Parameters

    @@ -16620,7 +15433,7 @@
    -

    Responses

    +

    Responses

    @@ -16645,7 +15458,7 @@
    -

    Consumes

    +

    Consumes

    • @@ -16655,7 +15468,7 @@
    -

    Produces

    +

    Produces

    • @@ -16674,7 +15487,7 @@
    -

    Tags

    +

    Tags

    • @@ -16692,7 +15505,7 @@
    -

    Parameters

    +

    Parameters

    @@ -16774,7 +15587,7 @@
    -

    Responses

    +

    Responses

    @@ -16799,7 +15612,7 @@
    -

    Consumes

    +

    Consumes

    • @@ -16809,7 +15622,7 @@
    -

    Produces

    +

    Produces

    • @@ -16828,7 +15641,7 @@
    -

    Tags

    +

    Tags

    • @@ -16843,7 +15656,7 @@
    diff --git a/docs/api-reference/policy/v1alpha1/definitions.html b/docs/api-reference/policy/v1alpha1/definitions.html new file mode 100755 index 0000000000..d5c2c1124a --- /dev/null +++ b/docs/api-reference/policy/v1alpha1/definitions.html @@ -0,0 +1,1009 @@ +--- +--- + + + + + + +Top Level API Objects + + + +
    +
    +

    Top Level API Objects

    +
    +
    + +
    +
    +
    +
    +

    Definitions

    +
    +
    +

    unversioned.Patch

    +
    +

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

    +
    +
    +
    +

    v1.DeleteOptions

    +
    +

    DeleteOptions may be provided when deleting an API object

    +
    +
    +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

    false

    string

    gracePeriodSeconds

    The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    false

    integer (int64)

    preconditions

    Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.

    false

    v1.Preconditions

    orphanDependents

    Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

    false

    boolean

    false

    + +
    +
    +

    v1alpha1.PodDisruptionBudgetStatus

    +
    +

    PodDisruptionBudgetStatus represents information about the status of a PodDisruptionBudget. Status may trail the actual state of a system.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    disruptionAllowed

    Whether or not a disruption is currently allowed.

    true

    boolean

    false

    currentHealthy

    current number of healthy pods

    true

    integer (int32)

    desiredHealthy

    minimum desired number of healthy pods

    true

    integer (int32)

    expectedPods

    total number of pods counted by this disruption budget

    true

    integer (int32)

    + +
    +
    +

    *versioned.Event

    + +
    +
    +

    unversioned.StatusDetails

    +
    +

    StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    name

    The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).

    false

    string

    group

    The group attribute of the resource associated with the status StatusReason.

    false

    string

    kind

    The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    causes

    The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.

    false

    unversioned.StatusCause array

    retryAfterSeconds

    If specified, the time in seconds before the operation should be retried.

    false

    integer (int32)

    + +
    +
    +

    v1alpha1.PodDisruptionBudgetList

    +
    +

    PodDisruptionBudgetList is a collection of PodDisruptionBudgets.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    false

    unversioned.ListMeta

    items

    true

    v1alpha1.PodDisruptionBudget array

    + +
    +
    +

    unversioned.ListMeta

    +
    +

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

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    selfLink

    SelfLink is a URL representing this object. Populated by the system. Read-only.

    false

    string

    resourceVersion

    String that identifies the server’s internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#concurrency-control-and-consistency

    false

    string

    + +
    +
    +

    v1.Preconditions

    +
    +

    Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    uid

    Specifies the target UID.

    false

    types.UID

    + +
    +
    +

    unversioned.LabelSelectorRequirement

    +
    +

    A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    key

    key is the label key that the selector applies to.

    true

    string

    operator

    operator represents a key’s relationship to a set of values. Valid operators ard In, NotIn, Exists and DoesNotExist.

    true

    string

    values

    values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

    false

    string array

    + +
    +
    +

    unversioned.APIResourceList

    +
    +

    APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

    false

    string

    groupVersion

    groupVersion is the group and version this APIResourceList is for.

    true

    string

    resources

    resources contains the name of the resources and if they are namespaced.

    true

    unversioned.APIResource array

    + +
    +
    +

    unversioned.LabelSelector

    +
    +

    A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    matchLabels

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

    false

    object

    matchExpressions

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

    false

    unversioned.LabelSelectorRequirement array

    + +
    +
    +

    unversioned.Status

    +
    +

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

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    unversioned.ListMeta

    status

    Status of the operation. One of: "Success" or "Failure". More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

    false

    string

    message

    A human-readable description of the status of this operation.

    false

    string

    reason

    A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.

    false

    string

    details

    Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.

    false

    unversioned.StatusDetails

    code

    Suggested HTTP return code for this status, 0 if not set.

    false

    integer (int32)

    + +
    +
    +

    unversioned.APIResource

    +
    +

    APIResource specifies the name of a resource and whether it is namespaced.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    name

    name is the name of the resource.

    true

    string

    namespaced

    namespaced indicates if a resource is namespaced or not.

    true

    boolean

    false

    kind

    kind is the kind for the resource (e.g. Foo is the kind for a resource foo)

    true

    string

    + +
    +
    +

    v1.ObjectMeta

    +
    +

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

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    name

    Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

    false

    string

    generateName

    GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
    +
    +If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
    +
    +Applied only if Name is not specified. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#idempotency

    false

    string

    namespace

    Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
    +
    +Must be a DNS_LABEL. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/namespaces.md

    false

    string

    selfLink

    SelfLink is a URL representing this object. Populated by the system. Read-only.

    false

    string

    uid

    UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
    +
    +Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#uids

    false

    string

    resourceVersion

    An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
    +
    +Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#concurrency-control-and-consistency

    false

    string

    generation

    A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

    false

    integer (int64)

    creationTimestamp

    CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
    +
    +Populated by the system. Read-only. Null for lists. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    string (date-time)

    deletionTimestamp

    DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource will be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. Once the resource is deleted in the API, the Kubelet will send a hard termination signal to the container. If not set, graceful deletion of the object has not been requested.
    +
    +Populated by the system when a graceful deletion is requested. Read-only. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    string (date-time)

    deletionGracePeriodSeconds

    Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

    false

    integer (int64)

    labels

    Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://releases.k8s.io/release-1.4/docs/user-guide/labels.md

    false

    object

    annotations

    Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://releases.k8s.io/release-1.4/docs/user-guide/annotations.md

    false

    object

    ownerReferences

    List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

    false

    v1.OwnerReference array

    finalizers

    Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.

    false

    string array

    clusterName

    The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

    false

    string

    + +
    +
    +

    v1.OwnerReference

    +
    +

    OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    apiVersion

    API version of the referent.

    true

    string

    kind

    Kind of the referent. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    true

    string

    name

    Name of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

    true

    string

    uid

    UID of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#uids

    true

    string

    controller

    If true, this reference points to the managing controller.

    false

    boolean

    false

    + +
    +
    +

    v1alpha1.PodDisruptionBudgetSpec

    +
    +

    PodDisruptionBudgetSpec is a description of a PodDisruptionBudget.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    minAvailable

    The minimum number of pods that must be available simultaneously. This can be either an integer or a string specifying a percentage, e.g. "28%".

    false

    string

    selector

    Label query over pods whose evictions are managed by the disruption budget.

    false

    unversioned.LabelSelector

    + +
    +
    +

    types.UID

    + +
    +
    +

    v1alpha1.PodDisruptionBudget

    +
    +

    PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    false

    v1.ObjectMeta

    spec

    Specification of the desired behavior of the PodDisruptionBudget.

    false

    v1alpha1.PodDisruptionBudgetSpec

    status

    Most recently observed status of the PodDisruptionBudget.

    false

    v1alpha1.PodDisruptionBudgetStatus

    + +
    +
    +

    unversioned.StatusCause

    +
    +

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

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    reason

    A machine-readable description of the cause of the error. If this value is empty there is no information available.

    false

    string

    message

    A human-readable description of the cause of the error. This field may be presented as-is to a reader.

    false

    string

    field

    The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.
    +
    +Examples:
    + "name" - the field "name" on the current resource
    + "items[0].name" - the field "name" on the first array entry in "items"

    false

    string

    + +
    +
    +

    any

    +
    +

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

    +
    +
    +
    + + + + + \ No newline at end of file diff --git a/docs/api-reference/policy/v1alpha1/operations.html b/docs/api-reference/policy/v1alpha1/operations.html new file mode 100755 index 0000000000..471c07188c --- /dev/null +++ b/docs/api-reference/policy/v1alpha1/operations.html @@ -0,0 +1,2029 @@ +--- +--- + + + + + + +Operations + + + +
    +
    +

    Operations

    +
    +
    +

    get available resources

    +
    +
    +
    GET /apis/policy/v1alpha1
    +
    +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    default

    success

    unversioned.APIResourceList

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apispolicyv1alpha1

      +
      • +
    +
    +
    +
    +
    +

    list or watch objects of kind PodDisruptionBudget

    +
    +
    +
    GET /apis/policy/v1alpha1/namespaces/{namespace}/poddisruptionbudgets
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.PodDisruptionBudgetList

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apispolicyv1alpha1

      +
      • +
    +
    +
    +
    +
    +

    delete collection of PodDisruptionBudget

    +
    +
    +
    DELETE /apis/policy/v1alpha1/namespaces/{namespace}/poddisruptionbudgets
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    unversioned.Status

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apispolicyv1alpha1

      +
      • +
    +
    +
    +
    +
    +

    create a PodDisruptionBudget

    +
    +
    +
    POST /apis/policy/v1alpha1/namespaces/{namespace}/poddisruptionbudgets
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    v1alpha1.PodDisruptionBudget

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.PodDisruptionBudget

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apispolicyv1alpha1

      +
      • +
    +
    +
    +
    +
    +

    read the specified PodDisruptionBudget

    +
    +
    +
    GET /apis/policy/v1alpha1/namespaces/{namespace}/poddisruptionbudgets/{name}
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    export

    Should this value be exported. Export strips fields that a user can not specify.

    false

    boolean

    QueryParameter

    exact

    Should the export be exact. Exact export maintains cluster-specific fields like Namespace

    false

    boolean

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    PathParameter

    name

    name of the PodDisruptionBudget

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.PodDisruptionBudget

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apispolicyv1alpha1

      +
      • +
    +
    +
    +
    +
    +

    replace the specified PodDisruptionBudget

    +
    +
    +
    PUT /apis/policy/v1alpha1/namespaces/{namespace}/poddisruptionbudgets/{name}
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    v1alpha1.PodDisruptionBudget

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    PathParameter

    name

    name of the PodDisruptionBudget

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.PodDisruptionBudget

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apispolicyv1alpha1

      +
      • +
    +
    +
    +
    +
    +

    delete a PodDisruptionBudget

    +
    +
    +
    DELETE /apis/policy/v1alpha1/namespaces/{namespace}/poddisruptionbudgets/{name}
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    v1.DeleteOptions

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    PathParameter

    name

    name of the PodDisruptionBudget

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    unversioned.Status

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apispolicyv1alpha1

      +
      • +
    +
    +
    +
    +
    +

    partially update the specified PodDisruptionBudget

    +
    +
    +
    PATCH /apis/policy/v1alpha1/namespaces/{namespace}/poddisruptionbudgets/{name}
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    unversioned.Patch

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    PathParameter

    name

    name of the PodDisruptionBudget

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.PodDisruptionBudget

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      application/json-patch+json

      +
      • +
    • +

      application/merge-patch+json

      +
      • +
    • +

      application/strategic-merge-patch+json

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apispolicyv1alpha1

      +
      • +
    +
    +
    +
    +
    +

    read status of the specified PodDisruptionBudget

    +
    +
    +
    GET /apis/policy/v1alpha1/namespaces/{namespace}/poddisruptionbudgets/{name}/status
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    PathParameter

    name

    name of the PodDisruptionBudget

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.PodDisruptionBudget

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apispolicyv1alpha1

      +
      • +
    +
    +
    +
    +
    +

    replace status of the specified PodDisruptionBudget

    +
    +
    +
    PUT /apis/policy/v1alpha1/namespaces/{namespace}/poddisruptionbudgets/{name}/status
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    v1alpha1.PodDisruptionBudget

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    PathParameter

    name

    name of the PodDisruptionBudget

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.PodDisruptionBudget

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apispolicyv1alpha1

      +
      • +
    +
    +
    +
    +
    +

    partially update status of the specified PodDisruptionBudget

    +
    +
    +
    PATCH /apis/policy/v1alpha1/namespaces/{namespace}/poddisruptionbudgets/{name}/status
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    unversioned.Patch

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    PathParameter

    name

    name of the PodDisruptionBudget

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.PodDisruptionBudget

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      application/json-patch+json

      +
      • +
    • +

      application/merge-patch+json

      +
      • +
    • +

      application/strategic-merge-patch+json

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apispolicyv1alpha1

      +
      • +
    +
    +
    +
    +
    +

    list or watch objects of kind PodDisruptionBudget

    +
    +
    +
    GET /apis/policy/v1alpha1/poddisruptionbudgets
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.PodDisruptionBudgetList

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apispolicyv1alpha1

      +
      • +
    +
    +
    +
    +
    +

    watch individual changes to a list of PodDisruptionBudget

    +
    +
    +
    GET /apis/policy/v1alpha1/watch/namespaces/{namespace}/poddisruptionbudgets
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    *versioned.Event

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apispolicyv1alpha1

      +
      • +
    +
    +
    +
    +
    +

    watch changes to an object of kind PodDisruptionBudget

    +
    +
    +
    GET /apis/policy/v1alpha1/watch/namespaces/{namespace}/poddisruptionbudgets/{name}
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    PathParameter

    name

    name of the PodDisruptionBudget

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    *versioned.Event

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apispolicyv1alpha1

      +
      • +
    +
    +
    +
    +
    +

    watch individual changes to a list of PodDisruptionBudget

    +
    +
    +
    GET /apis/policy/v1alpha1/watch/poddisruptionbudgets
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    *versioned.Event

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apispolicyv1alpha1

      +
      • +
    +
    +
    +
    +
    +
    +
    + + + \ No newline at end of file diff --git a/docs/api-reference/rbac.authorization.k8s.io/v1alpha1/definitions.html b/docs/api-reference/rbac.authorization.k8s.io/v1alpha1/definitions.html new file mode 100755 index 0000000000..914be07005 --- /dev/null +++ b/docs/api-reference/rbac.authorization.k8s.io/v1alpha1/definitions.html @@ -0,0 +1,1379 @@ +--- +--- + + + + + + +Top Level API Objects + + + +
    +
    +

    Top Level API Objects

    +
    +
    + +
    +
    +
    +
    +

    Definitions

    +
    +
    +

    unversioned.Patch

    +
    +

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

    +
    +
    +
    +

    v1.DeleteOptions

    +
    +

    DeleteOptions may be provided when deleting an API object

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

    false

    string

    gracePeriodSeconds

    The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    false

    integer (int64)

    preconditions

    Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.

    false

    v1.Preconditions

    orphanDependents

    Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

    false

    boolean

    false

    + +
    +
    +

    unversioned.StatusDetails

    +
    +

    StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    name

    The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).

    false

    string

    group

    The group attribute of the resource associated with the status StatusReason.

    false

    string

    kind

    The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    causes

    The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.

    false

    unversioned.StatusCause array

    retryAfterSeconds

    If specified, the time in seconds before the operation should be retried.

    false

    integer (int32)

    + +
    +
    +

    *versioned.Event

    + +
    +
    +

    unversioned.ListMeta

    +
    +

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

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    selfLink

    SelfLink is a URL representing this object. Populated by the system. Read-only.

    false

    string

    resourceVersion

    String that identifies the server’s internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#concurrency-control-and-consistency

    false

    string

    + +
    +
    +

    v1alpha1.RoleBindingList

    +
    +

    RoleBindingList is a collection of RoleBindings

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    Standard object’s metadata.

    false

    unversioned.ListMeta

    items

    Items is a list of RoleBindings

    true

    v1alpha1.RoleBinding array

    + +
    +
    +

    v1.Preconditions

    +
    +

    Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    uid

    Specifies the target UID.

    false

    types.UID

    + +
    +
    +

    v1.ObjectReference

    +
    +

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

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind of the referent. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    namespace

    Namespace of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/namespaces.md

    false

    string

    name

    Name of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

    false

    string

    uid

    UID of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#uids

    false

    string

    apiVersion

    API version of the referent.

    false

    string

    resourceVersion

    Specific resourceVersion to which this reference is made, if any. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#concurrency-control-and-consistency

    false

    string

    fieldPath

    If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.

    false

    string

    + +
    +
    +

    v1alpha1.ClusterRoleBindingList

    +
    +

    ClusterRoleBindingList is a collection of ClusterRoleBindings

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    Standard object’s metadata.

    false

    unversioned.ListMeta

    items

    Items is a list of ClusterRoleBindings

    true

    v1alpha1.ClusterRoleBinding array

    + +
    +
    +

    v1alpha1.Subject

    +
    +

    Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error.

    true

    string

    apiVersion

    APIVersion holds the API group and version of the referenced object.

    false

    string

    name

    Name of the object being referenced.

    true

    string

    namespace

    Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error.

    false

    string

    + +
    +
    +

    unversioned.APIResourceList

    +
    +

    APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

    false

    string

    groupVersion

    groupVersion is the group and version this APIResourceList is for.

    true

    string

    resources

    resources contains the name of the resources and if they are namespaced.

    true

    unversioned.APIResource array

    + +
    +
    +

    v1alpha1.RoleList

    +
    +

    RoleList is a collection of Roles

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    Standard object’s metadata.

    false

    unversioned.ListMeta

    items

    Items is a list of Roles

    true

    v1alpha1.Role array

    + +
    +
    +

    v1alpha1.ClusterRole

    +
    +

    ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    Standard object’s metadata.

    false

    v1.ObjectMeta

    rules

    Rules holds all the PolicyRules for this ClusterRole

    true

    v1alpha1.PolicyRule array

    + +
    +
    +

    unversioned.Status

    +
    +

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

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    unversioned.ListMeta

    status

    Status of the operation. One of: "Success" or "Failure". More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

    false

    string

    message

    A human-readable description of the status of this operation.

    false

    string

    reason

    A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.

    false

    string

    details

    Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.

    false

    unversioned.StatusDetails

    code

    Suggested HTTP return code for this status, 0 if not set.

    false

    integer (int32)

    + +
    +
    +

    unversioned.APIResource

    +
    +

    APIResource specifies the name of a resource and whether it is namespaced.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    name

    name is the name of the resource.

    true

    string

    namespaced

    namespaced indicates if a resource is namespaced or not.

    true

    boolean

    false

    kind

    kind is the kind for the resource (e.g. Foo is the kind for a resource foo)

    true

    string

    + +
    +
    +

    v1alpha1.ClusterRoleList

    +
    +

    ClusterRoleList is a collection of ClusterRoles

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    Standard object’s metadata.

    false

    unversioned.ListMeta

    items

    Items is a list of ClusterRoles

    true

    v1alpha1.ClusterRole array

    + +
    +
    +

    v1.ObjectMeta

    +
    +

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

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    name

    Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

    false

    string

    generateName

    GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
    +
    +If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
    +
    +Applied only if Name is not specified. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#idempotency

    false

    string

    namespace

    Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
    +
    +Must be a DNS_LABEL. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/namespaces.md

    false

    string

    selfLink

    SelfLink is a URL representing this object. Populated by the system. Read-only.

    false

    string

    uid

    UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
    +
    +Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#uids

    false

    string

    resourceVersion

    An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
    +
    +Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#concurrency-control-and-consistency

    false

    string

    generation

    A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

    false

    integer (int64)

    creationTimestamp

    CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
    +
    +Populated by the system. Read-only. Null for lists. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    string (date-time)

    deletionTimestamp

    DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource will be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. Once the resource is deleted in the API, the Kubelet will send a hard termination signal to the container. If not set, graceful deletion of the object has not been requested.
    +
    +Populated by the system when a graceful deletion is requested. Read-only. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    string (date-time)

    deletionGracePeriodSeconds

    Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

    false

    integer (int64)

    labels

    Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://releases.k8s.io/release-1.4/docs/user-guide/labels.md

    false

    object

    annotations

    Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://releases.k8s.io/release-1.4/docs/user-guide/annotations.md

    false

    object

    ownerReferences

    List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

    false

    v1.OwnerReference array

    finalizers

    Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.

    false

    string array

    clusterName

    The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

    false

    string

    + +
    +
    +

    v1.OwnerReference

    +
    +

    OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    apiVersion

    API version of the referent.

    true

    string

    kind

    Kind of the referent. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    true

    string

    name

    Name of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

    true

    string

    uid

    UID of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#uids

    true

    string

    controller

    If true, this reference points to the managing controller.

    false

    boolean

    false

    + +
    +
    +

    v1alpha1.ClusterRoleBinding

    +
    +

    ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    Standard object’s metadata.

    false

    v1.ObjectMeta

    subjects

    Subjects holds references to the objects the role applies to.

    true

    v1alpha1.Subject array

    roleRef

    RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.

    true

    v1.ObjectReference

    + +
    +
    +

    v1alpha1.RoleBinding

    +
    +

    RoleBinding references a role, but does not contain it. It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    Standard object’s metadata.

    false

    v1.ObjectMeta

    subjects

    Subjects holds references to the objects the role applies to.

    true

    v1alpha1.Subject array

    roleRef

    RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.

    true

    v1.ObjectReference

    + +
    +
    +

    v1alpha1.PolicyRule

    +
    +

    PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    verbs

    Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.

    true

    string array

    attributeRestrictions

    AttributeRestrictions will vary depending on what the Authorizer/AuthorizationAttributeBuilder pair supports. If the Authorizer does not recognize how to handle the AttributeRestrictions, the Authorizer should report an error.

    false

    string

    apiGroups

    APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed.

    false

    string array

    resources

    Resources is a list of resources this rule applies to. ResourceAll represents all resources.

    false

    string array

    resourceNames

    ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.

    false

    string array

    nonResourceURLs

    NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path This name is intentionally different than the internal type so that the DefaultConvert works nicely and because the ordering may be different. Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.

    false

    string array

    + +
    +
    +

    types.UID

    + +
    +
    +

    unversioned.StatusCause

    +
    +

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

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    reason

    A machine-readable description of the cause of the error. If this value is empty there is no information available.

    false

    string

    message

    A human-readable description of the cause of the error. This field may be presented as-is to a reader.

    false

    string

    field

    The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.
    +
    +Examples:
    + "name" - the field "name" on the current resource
    + "items[0].name" - the field "name" on the first array entry in "items"

    false

    string

    + +
    +
    +

    v1alpha1.Role

    +
    +

    Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    Standard object’s metadata.

    false

    v1.ObjectMeta

    rules

    Rules holds all the PolicyRules for this Role

    true

    v1alpha1.PolicyRule array

    + +
    +
    +

    any

    +
    +

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

    +
    +
    +
    +
    +
    + + + \ No newline at end of file diff --git a/docs/api-reference/rbac.authorization.k8s.io/v1alpha1/operations.html b/docs/api-reference/rbac.authorization.k8s.io/v1alpha1/operations.html new file mode 100755 index 0000000000..d59a73f278 --- /dev/null +++ b/docs/api-reference/rbac.authorization.k8s.io/v1alpha1/operations.html @@ -0,0 +1,5508 @@ +--- +--- + + + + + + +Operations + + + +
    +
    +

    Operations

    +
    +
    +

    get available resources

    +
    +
    +
    GET /apis/rbac.authorization.k8s.io/v1alpha1
    +
    +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    default

    success

    unversioned.APIResourceList

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    list or watch objects of kind ClusterRoleBinding

    +
    +
    +
    GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.ClusterRoleBindingList

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    delete collection of ClusterRoleBinding

    +
    +
    +
    DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    unversioned.Status

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    create a ClusterRoleBinding

    +
    +
    +
    POST /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    v1alpha1.ClusterRoleBinding

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.ClusterRoleBinding

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    read the specified ClusterRoleBinding

    +
    +
    +
    GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    PathParameter

    name

    name of the ClusterRoleBinding

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.ClusterRoleBinding

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    replace the specified ClusterRoleBinding

    +
    +
    +
    PUT /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    v1alpha1.ClusterRoleBinding

    PathParameter

    name

    name of the ClusterRoleBinding

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.ClusterRoleBinding

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    delete a ClusterRoleBinding

    +
    +
    +
    DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    v1.DeleteOptions

    PathParameter

    name

    name of the ClusterRoleBinding

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    unversioned.Status

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    partially update the specified ClusterRoleBinding

    +
    +
    +
    PATCH /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    unversioned.Patch

    PathParameter

    name

    name of the ClusterRoleBinding

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.ClusterRoleBinding

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      application/json-patch+json

      +
      • +
    • +

      application/merge-patch+json

      +
      • +
    • +

      application/strategic-merge-patch+json

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    list or watch objects of kind ClusterRole

    +
    +
    +
    GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.ClusterRoleList

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    delete collection of ClusterRole

    +
    +
    +
    DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    unversioned.Status

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    create a ClusterRole

    +
    +
    +
    POST /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    v1alpha1.ClusterRole

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.ClusterRole

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    read the specified ClusterRole

    +
    +
    +
    GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    PathParameter

    name

    name of the ClusterRole

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.ClusterRole

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    replace the specified ClusterRole

    +
    +
    +
    PUT /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    v1alpha1.ClusterRole

    PathParameter

    name

    name of the ClusterRole

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.ClusterRole

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    delete a ClusterRole

    +
    +
    +
    DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    v1.DeleteOptions

    PathParameter

    name

    name of the ClusterRole

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    unversioned.Status

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    partially update the specified ClusterRole

    +
    +
    +
    PATCH /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    unversioned.Patch

    PathParameter

    name

    name of the ClusterRole

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.ClusterRole

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      application/json-patch+json

      +
      • +
    • +

      application/merge-patch+json

      +
      • +
    • +

      application/strategic-merge-patch+json

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    list or watch objects of kind RoleBinding

    +
    +
    +
    GET /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.RoleBindingList

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    delete collection of RoleBinding

    +
    +
    +
    DELETE /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    unversioned.Status

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    create a RoleBinding

    +
    +
    +
    POST /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    v1alpha1.RoleBinding

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.RoleBinding

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    read the specified RoleBinding

    +
    +
    +
    GET /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings/{name}
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    PathParameter

    name

    name of the RoleBinding

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.RoleBinding

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    replace the specified RoleBinding

    +
    +
    +
    PUT /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings/{name}
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    v1alpha1.RoleBinding

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    PathParameter

    name

    name of the RoleBinding

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.RoleBinding

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    delete a RoleBinding

    +
    +
    +
    DELETE /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings/{name}
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    v1.DeleteOptions

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    PathParameter

    name

    name of the RoleBinding

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    unversioned.Status

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    partially update the specified RoleBinding

    +
    +
    +
    PATCH /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings/{name}
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    unversioned.Patch

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    PathParameter

    name

    name of the RoleBinding

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.RoleBinding

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      application/json-patch+json

      +
      • +
    • +

      application/merge-patch+json

      +
      • +
    • +

      application/strategic-merge-patch+json

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    list or watch objects of kind Role

    +
    +
    +
    GET /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.RoleList

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    delete collection of Role

    +
    +
    +
    DELETE /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    unversioned.Status

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    create a Role

    +
    +
    +
    POST /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    v1alpha1.Role

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.Role

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    read the specified Role

    +
    +
    +
    GET /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles/{name}
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    PathParameter

    name

    name of the Role

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.Role

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    replace the specified Role

    +
    +
    +
    PUT /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles/{name}
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    v1alpha1.Role

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    PathParameter

    name

    name of the Role

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.Role

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    delete a Role

    +
    +
    +
    DELETE /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles/{name}
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    v1.DeleteOptions

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    PathParameter

    name

    name of the Role

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    unversioned.Status

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    partially update the specified Role

    +
    +
    +
    PATCH /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles/{name}
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    unversioned.Patch

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    PathParameter

    name

    name of the Role

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.Role

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      application/json-patch+json

      +
      • +
    • +

      application/merge-patch+json

      +
      • +
    • +

      application/strategic-merge-patch+json

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    list or watch objects of kind RoleBinding

    +
    +
    +
    GET /apis/rbac.authorization.k8s.io/v1alpha1/rolebindings
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.RoleBindingList

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    list or watch objects of kind Role

    +
    +
    +
    GET /apis/rbac.authorization.k8s.io/v1alpha1/roles
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1alpha1.RoleList

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    watch individual changes to a list of ClusterRoleBinding

    +
    +
    +
    GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterrolebindings
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    *versioned.Event

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    watch changes to an object of kind ClusterRoleBinding

    +
    +
    +
    GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterrolebindings/{name}
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    PathParameter

    name

    name of the ClusterRoleBinding

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    *versioned.Event

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    watch individual changes to a list of ClusterRole

    +
    +
    +
    GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterroles
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    *versioned.Event

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    watch changes to an object of kind ClusterRole

    +
    +
    +
    GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterroles/{name}
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    PathParameter

    name

    name of the ClusterRole

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    *versioned.Event

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    watch individual changes to a list of RoleBinding

    +
    +
    +
    GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/rolebindings
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    *versioned.Event

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    watch changes to an object of kind RoleBinding

    +
    +
    +
    GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/rolebindings/{name}
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    PathParameter

    name

    name of the RoleBinding

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    *versioned.Event

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    watch individual changes to a list of Role

    +
    +
    +
    GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/roles
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    *versioned.Event

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    watch changes to an object of kind Role

    +
    +
    +
    GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/roles/{name}
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    true

    string

    PathParameter

    name

    name of the Role

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    *versioned.Event

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    watch individual changes to a list of RoleBinding

    +
    +
    +
    GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/rolebindings
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    *versioned.Event

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +

    watch individual changes to a list of Role

    +
    +
    +
    GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/roles
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    *versioned.Event

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisrbac.authorization.k8s.iov1alpha1

      +
      • +
    +
    +
    +
    +
    +
    +
    + + + \ No newline at end of file diff --git a/docs/api-reference/storage.k8s.io/v1beta1/definitions.html b/docs/api-reference/storage.k8s.io/v1beta1/definitions.html new file mode 100755 index 0000000000..18fc6c13b0 --- /dev/null +++ b/docs/api-reference/storage.k8s.io/v1beta1/definitions.html @@ -0,0 +1,827 @@ +--- +--- + + + + + + +Top Level API Objects + + + +
    +
    +

    Top Level API Objects

    +
    +
    + +
    +
    +
    +
    +

    Definitions

    +
    +
    +

    unversioned.Patch

    +
    +

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

    +
    +
    +
    +

    v1beta1.StorageClassList

    +
    +

    StorageClassList is a collection of storage classes.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    Standard list metadata More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    unversioned.ListMeta

    items

    Items is the list of StorageClasses

    true

    v1beta1.StorageClass array

    + +
    +
    +

    v1.DeleteOptions

    +
    +

    DeleteOptions may be provided when deleting an API object

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

    false

    string

    gracePeriodSeconds

    The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    false

    integer (int64)

    preconditions

    Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.

    false

    v1.Preconditions

    orphanDependents

    Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

    false

    boolean

    false

    + +
    +
    +

    unversioned.StatusDetails

    +
    +

    StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    name

    The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).

    false

    string

    group

    The group attribute of the resource associated with the status StatusReason.

    false

    string

    kind

    The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    causes

    The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.

    false

    unversioned.StatusCause array

    retryAfterSeconds

    If specified, the time in seconds before the operation should be retried.

    false

    integer (int32)

    + +
    +
    +

    *versioned.Event

    + +
    +
    +

    unversioned.ListMeta

    +
    +

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

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    selfLink

    SelfLink is a URL representing this object. Populated by the system. Read-only.

    false

    string

    resourceVersion

    String that identifies the server’s internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#concurrency-control-and-consistency

    false

    string

    + +
    +
    +

    v1.Preconditions

    +
    +

    Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    uid

    Specifies the target UID.

    false

    types.UID

    + +
    +
    +

    unversioned.APIResourceList

    +
    +

    APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

    false

    string

    groupVersion

    groupVersion is the group and version this APIResourceList is for.

    true

    string

    resources

    resources contains the name of the resources and if they are namespaced.

    true

    unversioned.APIResource array

    + +
    +
    +

    v1beta1.StorageClass

    +
    +

    StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned.

    +
    +
    +

    StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    v1.ObjectMeta

    provisioner

    Provisioner indicates the type of the provisioner.

    true

    string

    parameters

    Parameters holds the parameters for the provisioner that should create volumes of this storage class.

    false

    object

    + +
    +
    +

    unversioned.Status

    +
    +

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

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    unversioned.ListMeta

    status

    Status of the operation. One of: "Success" or "Failure". More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

    false

    string

    message

    A human-readable description of the status of this operation.

    false

    string

    reason

    A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.

    false

    string

    details

    Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.

    false

    unversioned.StatusDetails

    code

    Suggested HTTP return code for this status, 0 if not set.

    false

    integer (int32)

    + +
    +
    +

    unversioned.APIResource

    +
    +

    APIResource specifies the name of a resource and whether it is namespaced.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    name

    name is the name of the resource.

    true

    string

    namespaced

    namespaced indicates if a resource is namespaced or not.

    true

    boolean

    false

    kind

    kind is the kind for the resource (e.g. Foo is the kind for a resource foo)

    true

    string

    + +
    +
    +

    v1.ObjectMeta

    +
    +

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

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    name

    Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

    false

    string

    generateName

    GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
    +
    +If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
    +
    +Applied only if Name is not specified. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#idempotency

    false

    string

    namespace

    Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
    +
    +Must be a DNS_LABEL. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/namespaces.md

    false

    string

    selfLink

    SelfLink is a URL representing this object. Populated by the system. Read-only.

    false

    string

    uid

    UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
    +
    +Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#uids

    false

    string

    resourceVersion

    An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
    +
    +Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#concurrency-control-and-consistency

    false

    string

    generation

    A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

    false

    integer (int64)

    creationTimestamp

    CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
    +
    +Populated by the system. Read-only. Null for lists. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    string (date-time)

    deletionTimestamp

    DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource will be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. Once the resource is deleted in the API, the Kubelet will send a hard termination signal to the container. If not set, graceful deletion of the object has not been requested.
    +
    +Populated by the system when a graceful deletion is requested. Read-only. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    string (date-time)

    deletionGracePeriodSeconds

    Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

    false

    integer (int64)

    labels

    Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://releases.k8s.io/release-1.4/docs/user-guide/labels.md

    false

    object

    annotations

    Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://releases.k8s.io/release-1.4/docs/user-guide/annotations.md

    false

    object

    ownerReferences

    List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

    false

    v1.OwnerReference array

    finalizers

    Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.

    false

    string array

    clusterName

    The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

    false

    string

    + +
    +
    +

    v1.OwnerReference

    +
    +

    OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    apiVersion

    API version of the referent.

    true

    string

    kind

    Kind of the referent. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    true

    string

    name

    Name of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

    true

    string

    uid

    UID of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#uids

    true

    string

    controller

    If true, this reference points to the managing controller.

    false

    boolean

    false

    + +
    +
    +

    types.UID

    + +
    +
    +

    unversioned.StatusCause

    +
    +

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

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    reason

    A machine-readable description of the cause of the error. If this value is empty there is no information available.

    false

    string

    message

    A human-readable description of the cause of the error. This field may be presented as-is to a reader.

    false

    string

    field

    The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.
    +
    +Examples:
    + "name" - the field "name" on the current resource
    + "items[0].name" - the field "name" on the first array entry in "items"

    false

    string

    + +
    +
    +

    any

    +
    +

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

    +
    +
    +
    +
    +
    + + + \ No newline at end of file diff --git a/docs/api-reference/storage.k8s.io/v1beta1/operations.html b/docs/api-reference/storage.k8s.io/v1beta1/operations.html new file mode 100755 index 0000000000..0a621a2d5f --- /dev/null +++ b/docs/api-reference/storage.k8s.io/v1beta1/operations.html @@ -0,0 +1,1289 @@ +--- +--- + + + + + + +Operations + + + +
    +
    +

    Operations

    +
    +
    +

    get available resources

    +
    +
    +
    GET /apis/storage.k8s.io/v1beta1
    +
    +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    default

    success

    unversioned.APIResourceList

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisstorage.k8s.iov1beta1

      +
      • +
    +
    +
    +
    +
    +

    list or watch objects of kind StorageClass

    +
    +
    +
    GET /apis/storage.k8s.io/v1beta1/storageclasses
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1beta1.StorageClassList

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisstorage.k8s.iov1beta1

      +
      • +
    +
    +
    +
    +
    +

    delete collection of StorageClass

    +
    +
    +
    DELETE /apis/storage.k8s.io/v1beta1/storageclasses
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    unversioned.Status

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisstorage.k8s.iov1beta1

      +
      • +
    +
    +
    +
    +
    +

    create a StorageClass

    +
    +
    +
    POST /apis/storage.k8s.io/v1beta1/storageclasses
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    v1beta1.StorageClass

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1beta1.StorageClass

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisstorage.k8s.iov1beta1

      +
      • +
    +
    +
    +
    +
    +

    read the specified StorageClass

    +
    +
    +
    GET /apis/storage.k8s.io/v1beta1/storageclasses/{name}
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    export

    Should this value be exported. Export strips fields that a user can not specify.

    false

    boolean

    QueryParameter

    exact

    Should the export be exact. Exact export maintains cluster-specific fields like Namespace

    false

    boolean

    PathParameter

    name

    name of the StorageClass

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1beta1.StorageClass

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisstorage.k8s.iov1beta1

      +
      • +
    +
    +
    +
    +
    +

    replace the specified StorageClass

    +
    +
    +
    PUT /apis/storage.k8s.io/v1beta1/storageclasses/{name}
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    v1beta1.StorageClass

    PathParameter

    name

    name of the StorageClass

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1beta1.StorageClass

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisstorage.k8s.iov1beta1

      +
      • +
    +
    +
    +
    +
    +

    delete a StorageClass

    +
    +
    +
    DELETE /apis/storage.k8s.io/v1beta1/storageclasses/{name}
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    v1.DeleteOptions

    PathParameter

    name

    name of the StorageClass

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    unversioned.Status

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisstorage.k8s.iov1beta1

      +
      • +
    +
    +
    +
    +
    +

    partially update the specified StorageClass

    +
    +
    +
    PATCH /apis/storage.k8s.io/v1beta1/storageclasses/{name}
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    unversioned.Patch

    PathParameter

    name

    name of the StorageClass

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1beta1.StorageClass

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      application/json-patch+json

      +
      • +
    • +

      application/merge-patch+json

      +
      • +
    • +

      application/strategic-merge-patch+json

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisstorage.k8s.iov1beta1

      +
      • +
    +
    +
    +
    +
    +

    watch individual changes to a list of StorageClass

    +
    +
    +
    GET /apis/storage.k8s.io/v1beta1/watch/storageclasses
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    *versioned.Event

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisstorage.k8s.iov1beta1

      +
      • +
    +
    +
    +
    +
    +

    watch changes to an object of kind StorageClass

    +
    +
    +
    GET /apis/storage.k8s.io/v1beta1/watch/storageclasses/{name}
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    PathParameter

    name

    name of the StorageClass

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    *versioned.Event

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
      • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
      • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisstorage.k8s.iov1beta1

      +
      • +
    +
    +
    +
    +
    +
    +
    + + + \ No newline at end of file diff --git a/docs/api-reference/v1/definitions.html b/docs/api-reference/v1/definitions.html index fd4f478503..b82f02dc56 100755 --- a/docs/api-reference/v1/definitions.html +++ b/docs/api-reference/v1/definitions.html @@ -6393,7 +6393,7 @@ The resulting set of endpoints can be viewed as:

    v1alpha1.Eviction

    -

    Eviction evicts a pod from its node subject to certain policies and safety constraints. This is a subresource of Pod. A request to cause such an eviction is created by POSTing to …/pods/foo/evictions.

    +

    Eviction evicts a pod from its node subject to certain policies and safety constraints. This is a subresource of Pod. A request to cause such an eviction is created by POSTing to …/pods/<pod name>/evictions.

    diff --git a/docs/federation/api-reference/README.md b/docs/federation/api-reference/README.md index 18f9c4f63d..ca5bc7f800 100644 --- a/docs/federation/api-reference/README.md +++ b/docs/federation/api-reference/README.md @@ -10,10 +10,6 @@ Federation API server supports the following group versions: * extensions/v1beta1: [operations](/docs/federation/api-reference/extensions/v1beta1/operations.html), [model definitions](/docs/federation/api-reference/extensions/v1beta1/definitions.html) - - - - [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/federation/api-reference/README.md?pixel)]() diff --git a/docs/getting-started-guides/aws.md b/docs/getting-started-guides/aws.md index df4a6cdeb3..a76cfeeeea 100644 --- a/docs/getting-started-guides/aws.md +++ b/docs/getting-started-guides/aws.md @@ -2,13 +2,28 @@ assignees: - justinsb - lavalamp +- clove --- * TOC {:toc} -## Prerequisites + +## Supported Production Grade Tools with High Availability Options + +* [Kubernetes Operations](https://github.com/kubernetes/kops) - Production Grade K8s Installation, Upgrades, and Management. Supports running Debian, Ubuntu, CentOS, and RHEL in AWS. + +* CoreOS maintains [a CLI tool](https://coreos.com/kubernetes/docs/latest/kubernetes-on-aws.html), `kube-aws` that will create and manage a Kubernetes cluster based on [CoreOS](http://www.coreos.com), using AWS tools: EC2, CloudFormation and Autoscaling. + +--- + +## kube-up bash script + +> `kube-up.sh` is a legacy tool that is an easy way to spin up a cluster. This tool is being deprecated, and does not create a production ready environment. + + +### Prerequisites 1. You need an AWS account. Visit [http://aws.amazon.com](http://aws.amazon.com) to get started 2. Install and configure the [AWS Command Line Interface](http://aws.amazon.com/cli) @@ -21,9 +36,9 @@ You may explicitly set the AWS profile to use using the `AWS_DEFAULT_PROFILE` en export AWS_DEFAULT_PROFILE=myawsprofile ``` -## Cluster turnup +### Cluster turnup -### Supported procedure: `get-kube` +#### Supported procedure: `get-kube` ```shell #Using wget @@ -97,12 +112,7 @@ If these already exist, make sure you want them to be used here. NOTE: If using an existing keypair named "kubernetes" then you must set the `AWS_SSH_KEY` key to point to your private key. -### Alternatives -* [kops](https://github.com/kubernetes/kops) "kubernetes-ops" is a complete Kubernetes cluster lifecycle management tool, - that supports AWS. - -* CoreOS maintains [a CLI tool](https://coreos.com/kubernetes/docs/latest/kubernetes-on-aws.html), `kube-aws` that will create and manage a Kubernetes cluster based on [CoreOS](http://www.coreos.com), using AWS tools: EC2, CloudFormation and Autoscaling. ## Getting started with your cluster @@ -162,6 +172,3 @@ For support level information on all solutions, see the [Table of solutions](/do Please see the [Kubernetes docs](/docs/) for more details on administering and using a Kubernetes cluster. - - - diff --git a/docs/getting-started-guides/kubeadm.md b/docs/getting-started-guides/kubeadm.md index 5848fbdc5f..8f4a3db26c 100644 --- a/docs/getting-started-guides/kubeadm.md +++ b/docs/getting-started-guides/kubeadm.md @@ -34,7 +34,7 @@ orchestration system (e.g. Puppet) that you have to integrate with. If you are not constrained, other tools build on kubeadm to give you complete clusters: * On GCE, [Google Container Engine](https://cloud.google.com/container-engine/) gives you turn-key Kubernetes -* On AWS, [kops](kops) makes installation and cluster management easy (and supports high availability) +* On AWS, [kops](https://github.com/kubernetes/kops) makes installation and cluster management easy (and supports high availability) ## Prerequisites @@ -101,7 +101,7 @@ Note: `setenforce 0` will no longer be necessary on CentOS once [#33555](https:/ The master is the machine where the "control plane" components run, including `etcd` (the cluster database) and the API server (which the `kubectl` CLI communicates with). All of these components run in pods started by `kubelet`. -Right now you can't run `kubeadm init` twice without turning down the cluster in between, see [Turndown](#turndown). +Right now you can't run `kubeadm init` twice without tearing down the cluster in between, see [Tear down](#tear-down). To initialize the master, pick one of the machines you previously installed `kubelet` and `kubeadm` on, and run: diff --git a/docs/getting-started-guides/scratch.md b/docs/getting-started-guides/scratch.md index d1695c0bab..72a9ee3125 100644 --- a/docs/getting-started-guides/scratch.md +++ b/docs/getting-started-guides/scratch.md @@ -83,8 +83,8 @@ to implement one of the above options: - Kubernetes supports the [CNI](https://github.com/containernetworking/cni) network plugin interface. - There are a number of solutions which provide plugins for Kubernetes: - [Flannel](https://github.com/coreos/flannel) - - [Calico](http://https://github.com/projectcalico/calico-containers) - - [Weave](http://weave.works/) + - [Calico](https://github.com/projectcalico/calico-containers) + - [Weave](https://weave.works/) - [Romana](http://romana.io/) - [Open vSwitch (OVS)](http://openvswitch.org/) - [More found here](/docs/admin/networking#how-to-achieve-this) diff --git a/docs/tasks/configure-pod-container/assign-cpu-ram-container.md b/docs/tasks/configure-pod-container/assign-cpu-ram-container.md new file mode 100644 index 0000000000..5b05afedb8 --- /dev/null +++ b/docs/tasks/configure-pod-container/assign-cpu-ram-container.md @@ -0,0 +1,104 @@ +--- +--- + +{% capture overview %} + +This page shows how assign CPU and RAM resources to containers running +in a Kubernetes Pod. + +{% endcapture %} + + +{% capture prerequisites %} + +{% include task-tutorial-prereqs.md %} + +{% endcapture %} + + +{% capture steps %} + +### Assigning CPU and RAM resources to a container + +When you create a Pod, you can request CPU and RAM resources for the containers +that run in the Pod. You can also set limits for CPU and RAM resources. To +request CPU and RAM resources, include the `resources:requests` field in the +configuration file. To set limits on CPU and RAM resources, include the +`resources:limits` field. + +Kubernetes schedules a Pod to run on a Node only if the Node has enough CPU and +RAM available to satisfy the total CPU and RAM requested by all of the +containers in the Pod. Also, as a container runs on a Node, Kubernetes doesn't +allow the CPU and RAM consumed by the container to exceed the limits you specify +for the container. If a container exceeds its RAM limit, it is terminated. If a +container exceeds its CPU limit, it becomes a candidate for having its CPU use +throttled. + +In this exercise, you create a Pod that runs one container. The configuration +file for the Pod requests 250 milicpu and 64 mebibytes of RAM. It also sets +upper limits of 1 cpu and 128 mebibytes of RAM. Here is the configuration file +for the `Pod`: + +{% include code.html language="yaml" file="cpu-ram.yaml" ghlink="/docs/tasks/configure-pod-container/cpu-ram.yaml" %} + +1. Create a Pod based on the YAML configuration file: + + export REPO=https://raw.githubusercontent.com/kubernetes/kubernetes.github.io/master + kubectl create -f $REPO/docs/tasks/configure-pod-container/cpu-ram.yaml + +1. Display information about the pod: + + kubectl describe pod cpu-ram-demo + + The output is similar to this: + + Name: cpu-ram-demo + ... + Containers: + cpu-ram-demo-container: + ... + Limits: + cpu: 1 + memory: 128Mi + Requests: + cpu: 250m + memory: 64Mi + +### Understanding CPU and RAM units + +The CPU resource is measured in *cpu*s. Fractional values are allowed. You can +use the suffix *m* to mean mili. For example 100m cpu is 100 milicpu, and is +the same as 0.1 cpu. + +The RAM resource is measured in bytes. You can express RAM as a plain integer +or a fixed-point integer with one of these suffixes: E, P, T, G, M, K, Ei, Pi, +Ti, Gi, Mi, Ki. For example, the following represent approximately the same value: + + 128974848, 129e6, 129M , 123Mi + +### If you don't specify limits or requests + +If you don't specify a RAM limit, Kubernetes places no upper bound on the +amount of RAM a Container can use. A Container could use all the RAM +available on the Node where the Container is running. Similarly, if you don't +specify a CPU limit, Kubernetes places no upper bound on CPU resources, and a +Container could use all of the CPU resources available on the Node. + +For information about why you would want to specify limits, see +[Setting Pod CPU and Memory Limits](/docs/admin/limitrange/). + +For information about what happens if you don't specify CPU and RAM requests, see +[Resource Requests and Limits of Pod and Container](/docs/user-guide/compute-resources/). + +{% endcapture %} + +{% capture whatsnext %} + +* Learn more about [managing compute resources](/docs/user-guide/compute-resources/). +* See [ResourceRequirements](/docs/api-reference/v1/definitions/#_v1_resourcerequirements). + +{% endcapture %} + + +{% include templates/task.md %} + diff --git a/docs/tasks/configure-pod-container/cpu-ram.yaml b/docs/tasks/configure-pod-container/cpu-ram.yaml new file mode 100644 index 0000000000..c45189fb1e --- /dev/null +++ b/docs/tasks/configure-pod-container/cpu-ram.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Pod +metadata: + name: cpu-ram-demo +spec: + containers: + - name: cpu-ram-demo-container + image: gcr.io/google-samples/node-hello:1.0 + resources: + requests: + memory: "64Mi" + cpu: "250m" + limits: + memory: "128Mi" + cpu: "1" diff --git a/docs/tasks/index.md b/docs/tasks/index.md index fc08a0469a..e59f8732b2 100644 --- a/docs/tasks/index.md +++ b/docs/tasks/index.md @@ -7,6 +7,7 @@ The Tasks section of the Kubernetes documentation is a work in progress * [Defining Environment Variables for a Container](/docs/tasks/configure-pod-container/define-environment-variable-container/) * [Defining a Command and Arguments for a Container](/docs/tasks/configure-pod-container/define-command-argument-container/) +* [Assigning CPU and RAM Resources to a Container](/docs/tasks/configure-pod-container/assign-cpu-ram-container/) #### Accessing Applications in a Cluster @@ -23,5 +24,4 @@ The Tasks section of the Kubernetes documentation is a work in progress ### What's next If you would like to write a task page, see -[Using Page Templates](/docs/contribute/page-templates/) -for information about the task page type and the task template. +[Creating a Documentation Pull Request](/docs/create-pull-request/). diff --git a/docs/user-guide/kubectl/index.md b/docs/user-guide/kubectl/index.md index e5dc7f0afb..53af54780e 100644 --- a/docs/user-guide/kubectl/index.md +++ b/docs/user-guide/kubectl/index.md @@ -82,7 +82,7 @@ kubectl * [kubectl uncordon](kubectl_uncordon.md) - Mark node as schedulable * [kubectl version](kubectl_version.md) - Print the client and server version information -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_annotate.md b/docs/user-guide/kubectl/kubectl_annotate.md index 0ac1443b61..a6cf10855f 100644 --- a/docs/user-guide/kubectl/kubectl_annotate.md +++ b/docs/user-guide/kubectl/kubectl_annotate.md @@ -16,11 +16,32 @@ It is intended to store non-identifying auxiliary data, especially data manipula If --overwrite is true, then existing annotations can be overwritten, otherwise attempting to overwrite an annotation will result in an error. If --resource-version is specified, then updates will use this resource version, otherwise the existing resource-version will be used. -Possible resources include (case insensitive): - pod (po), service (svc), replicationcontroller (rc), - node (no), event (ev), componentstatuse (cs), - limitrange (limits), persistentvolume (pv), persistentvolumeclaim (pvc), - horizontalpodautoscaler (hpa), resourcequota (quota), secret +Valid resource types include: + * clusters (valid only for federation apiservers) + * componentstatuses (aka 'cs') + * configmaps (aka 'cm') + * daemonsets (aka 'ds') + * deployments (aka 'deploy') + * events (aka 'ev') + * endpoints (aka 'ep') + * horizontalpodautoscalers (aka 'hpa') + * ingress (aka 'ing') + * jobs + * limitranges (aka 'limits') + * nodes (aka 'no') + * namespaces (aka 'ns') + * petsets (alpha feature, may be unstable) + * pods (aka 'po') + * persistentvolumes (aka 'pv') + * persistentvolumeclaims (aka 'pvc') + * quota + * resourcequotas (aka 'quota') + * replicasets (aka 'rs') + * replicationcontrollers (aka 'rc') + * secrets + * serviceaccounts (aka 'sa') + * services (aka 'svc') + ``` kubectl annotate [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--resource-version=version] @@ -100,7 +121,7 @@ kubectl annotate pods foo description- -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_api-versions.md b/docs/user-guide/kubectl/kubectl_api-versions.md index ddde2267d0..b6a14e3ba5 100644 --- a/docs/user-guide/kubectl/kubectl_api-versions.md +++ b/docs/user-guide/kubectl/kubectl_api-versions.md @@ -43,7 +43,7 @@ kubectl api-versions -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_apply.md b/docs/user-guide/kubectl/kubectl_apply.md index eac7846e6e..ad21e9cbdc 100644 --- a/docs/user-guide/kubectl/kubectl_apply.md +++ b/docs/user-guide/kubectl/kubectl_apply.md @@ -72,7 +72,7 @@ cat pod.json | kubectl apply -f - -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_attach.md b/docs/user-guide/kubectl/kubectl_attach.md index 1d1cbcb7f4..0e90db298b 100644 --- a/docs/user-guide/kubectl/kubectl_attach.md +++ b/docs/user-guide/kubectl/kubectl_attach.md @@ -66,7 +66,7 @@ kubectl attach 123456-7890 -c ruby-container -i -t -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_autoscale.md b/docs/user-guide/kubectl/kubectl_autoscale.md index 05d5bf143d..b99b9bcc19 100644 --- a/docs/user-guide/kubectl/kubectl_autoscale.md +++ b/docs/user-guide/kubectl/kubectl_autoscale.md @@ -21,6 +21,7 @@ kubectl autoscale (-f FILENAME | TYPE NAME | TYPE/NAME) [--min=MINPODS] --max=MA ### Examples ``` + # Auto scale a deployment "foo", with the number of pods between 2 and 10, target CPU utilization specified so a default autoscaling policy will be used: kubectl autoscale deployment foo --min=2 --max=10 @@ -80,7 +81,7 @@ kubectl autoscale rc foo --max=5 --cpu-percent=80 -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_cluster-info.md b/docs/user-guide/kubectl/kubectl_cluster-info.md index b3a1480dab..4d1105b086 100644 --- a/docs/user-guide/kubectl/kubectl_cluster-info.md +++ b/docs/user-guide/kubectl/kubectl_cluster-info.md @@ -50,7 +50,7 @@ kubectl cluster-info -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_cluster-info_dump.md b/docs/user-guide/kubectl/kubectl_cluster-info_dump.md index c13257c390..d672149697 100644 --- a/docs/user-guide/kubectl/kubectl_cluster-info_dump.md +++ b/docs/user-guide/kubectl/kubectl_cluster-info_dump.md @@ -75,7 +75,7 @@ kubectl cluster-info dump --namespaces default,kube-system --output-directory=/p -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_completion.md b/docs/user-guide/kubectl/kubectl_completion.md index f69aacb619..bead2c68fd 100644 --- a/docs/user-guide/kubectl/kubectl_completion.md +++ b/docs/user-guide/kubectl/kubectl_completion.md @@ -68,7 +68,7 @@ $ source <(kubectl completion zsh) -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_config.md b/docs/user-guide/kubectl/kubectl_config.md index 354464e7d4..a9c41de181 100644 --- a/docs/user-guide/kubectl/kubectl_config.md +++ b/docs/user-guide/kubectl/kubectl_config.md @@ -54,7 +54,7 @@ kubectl config SUBCOMMAND -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_config_current-context.md b/docs/user-guide/kubectl/kubectl_config_current-context.md index 73c7cb5366..64fd7adbdb 100644 --- a/docs/user-guide/kubectl/kubectl_config_current-context.md +++ b/docs/user-guide/kubectl/kubectl_config_current-context.md @@ -52,7 +52,7 @@ kubectl config current-context -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_config_delete-cluster.md b/docs/user-guide/kubectl/kubectl_config_delete-cluster.md index 698c72c1a2..b42ad2c6a7 100644 --- a/docs/user-guide/kubectl/kubectl_config_delete-cluster.md +++ b/docs/user-guide/kubectl/kubectl_config_delete-cluster.md @@ -43,7 +43,7 @@ kubectl config delete-cluster NAME -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_config_delete-context.md b/docs/user-guide/kubectl/kubectl_config_delete-context.md index e58ac663c3..4d3bc05331 100644 --- a/docs/user-guide/kubectl/kubectl_config_delete-context.md +++ b/docs/user-guide/kubectl/kubectl_config_delete-context.md @@ -43,7 +43,7 @@ kubectl config delete-context NAME -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_config_get-clusters.md b/docs/user-guide/kubectl/kubectl_config_get-clusters.md index 6e5494aac2..0a78eb7684 100644 --- a/docs/user-guide/kubectl/kubectl_config_get-clusters.md +++ b/docs/user-guide/kubectl/kubectl_config_get-clusters.md @@ -43,7 +43,7 @@ kubectl config get-clusters -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_config_get-contexts.md b/docs/user-guide/kubectl/kubectl_config_get-contexts.md index b1ad750ddc..4a4486f927 100644 --- a/docs/user-guide/kubectl/kubectl_config_get-contexts.md +++ b/docs/user-guide/kubectl/kubectl_config_get-contexts.md @@ -60,7 +60,7 @@ kubectl config get-contexts my-context -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_config_set-cluster.md b/docs/user-guide/kubectl/kubectl_config_set-cluster.md index 165dae4878..3da8dbc094 100644 --- a/docs/user-guide/kubectl/kubectl_config_set-cluster.md +++ b/docs/user-guide/kubectl/kubectl_config_set-cluster.md @@ -66,7 +66,7 @@ kubectl config set-cluster e2e --insecure-skip-tls-verify=true -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_config_set-context.md b/docs/user-guide/kubectl/kubectl_config_set-context.md index 325516d461..86db115730 100644 --- a/docs/user-guide/kubectl/kubectl_config_set-context.md +++ b/docs/user-guide/kubectl/kubectl_config_set-context.md @@ -58,7 +58,7 @@ kubectl config set-context gce --user=cluster-admin -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_config_set-credentials.md b/docs/user-guide/kubectl/kubectl_config_set-credentials.md index 6c81890be8..49743220f2 100644 --- a/docs/user-guide/kubectl/kubectl_config_set-credentials.md +++ b/docs/user-guide/kubectl/kubectl_config_set-credentials.md @@ -89,7 +89,7 @@ kubectl config set-credentials cluster-admin --auth-provider=oidc --auth-provide -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_config_set.md b/docs/user-guide/kubectl/kubectl_config_set.md index ace136ef20..52d8b6397c 100644 --- a/docs/user-guide/kubectl/kubectl_config_set.md +++ b/docs/user-guide/kubectl/kubectl_config_set.md @@ -52,7 +52,7 @@ kubectl config set PROPERTY_NAME PROPERTY_VALUE -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_config_unset.md b/docs/user-guide/kubectl/kubectl_config_unset.md index 8b2cd98164..3ee8de73fc 100644 --- a/docs/user-guide/kubectl/kubectl_config_unset.md +++ b/docs/user-guide/kubectl/kubectl_config_unset.md @@ -45,7 +45,7 @@ kubectl config unset PROPERTY_NAME -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_config_use-context.md b/docs/user-guide/kubectl/kubectl_config_use-context.md index a551a6640b..66cc439eac 100644 --- a/docs/user-guide/kubectl/kubectl_config_use-context.md +++ b/docs/user-guide/kubectl/kubectl_config_use-context.md @@ -43,7 +43,7 @@ kubectl config use-context CONTEXT_NAME -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_config_view.md b/docs/user-guide/kubectl/kubectl_config_view.md index 529c4871da..aed1c205c8 100644 --- a/docs/user-guide/kubectl/kubectl_config_view.md +++ b/docs/user-guide/kubectl/kubectl_config_view.md @@ -73,7 +73,7 @@ kubectl config view -o jsonpath='{.users[?(@.name == "e2e")].user.password}' -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_convert.md b/docs/user-guide/kubectl/kubectl_convert.md index 354e681297..e46e6fdd15 100644 --- a/docs/user-guide/kubectl/kubectl_convert.md +++ b/docs/user-guide/kubectl/kubectl_convert.md @@ -87,7 +87,7 @@ kubectl convert -f . | kubectl create -f - -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_cordon.md b/docs/user-guide/kubectl/kubectl_cordon.md index bc945d5d79..5d757265d8 100644 --- a/docs/user-guide/kubectl/kubectl_cordon.md +++ b/docs/user-guide/kubectl/kubectl_cordon.md @@ -54,7 +54,7 @@ kubectl cordon foo -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_create.md b/docs/user-guide/kubectl/kubectl_create.md index c47c3fc72a..95da4d6775 100644 --- a/docs/user-guide/kubectl/kubectl_create.md +++ b/docs/user-guide/kubectl/kubectl_create.md @@ -70,7 +70,7 @@ cat pod.json | kubectl create -f - -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_create_configmap.md b/docs/user-guide/kubectl/kubectl_create_configmap.md index 190db2f567..2c733fc055 100644 --- a/docs/user-guide/kubectl/kubectl_create_configmap.md +++ b/docs/user-guide/kubectl/kubectl_create_configmap.md @@ -87,7 +87,7 @@ kubectl create configmap my-config --from-literal=key1=config1 --from-literal=ke -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_create_deployment.md b/docs/user-guide/kubectl/kubectl_create_deployment.md index 88627ff03b..35c2707cd1 100644 --- a/docs/user-guide/kubectl/kubectl_create_deployment.md +++ b/docs/user-guide/kubectl/kubectl_create_deployment.md @@ -70,7 +70,7 @@ kubectl create deployment my-dep --image=busybox -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_create_namespace.md b/docs/user-guide/kubectl/kubectl_create_namespace.md index 8c4181f50c..fd46a53e5e 100644 --- a/docs/user-guide/kubectl/kubectl_create_namespace.md +++ b/docs/user-guide/kubectl/kubectl_create_namespace.md @@ -69,7 +69,7 @@ kubectl create namespace my-namespace -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_create_quota.md b/docs/user-guide/kubectl/kubectl_create_quota.md index 843ed6b194..ec2e31a45b 100644 --- a/docs/user-guide/kubectl/kubectl_create_quota.md +++ b/docs/user-guide/kubectl/kubectl_create_quota.md @@ -73,7 +73,7 @@ kubectl create quota NAME [--hard=key1=value1,key2=value2] [--scopes=Scope1,Scop -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_create_secret.md b/docs/user-guide/kubectl/kubectl_create_secret.md index ce60df1bb4..f9f80c8740 100644 --- a/docs/user-guide/kubectl/kubectl_create_secret.md +++ b/docs/user-guide/kubectl/kubectl_create_secret.md @@ -43,7 +43,7 @@ kubectl create secret -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_create_secret_docker-registry.md b/docs/user-guide/kubectl/kubectl_create_secret_docker-registry.md index 3be76dbfa5..18c2eba2dd 100644 --- a/docs/user-guide/kubectl/kubectl_create_secret_docker-registry.md +++ b/docs/user-guide/kubectl/kubectl_create_secret_docker-registry.md @@ -85,7 +85,7 @@ kubectl create secret docker-registry my-secret --docker-server=DOCKER_REGISTRY_ -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_create_secret_generic.md b/docs/user-guide/kubectl/kubectl_create_secret_generic.md index 5d9bccfdbb..c81404e954 100644 --- a/docs/user-guide/kubectl/kubectl_create_secret_generic.md +++ b/docs/user-guide/kubectl/kubectl_create_secret_generic.md @@ -88,7 +88,7 @@ kubectl create secret generic my-secret --from-literal=key1=supersecret --from-l -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_create_secret_tls.md b/docs/user-guide/kubectl/kubectl_create_secret_tls.md index 9fb1050d58..0e3badb512 100644 --- a/docs/user-guide/kubectl/kubectl_create_secret_tls.md +++ b/docs/user-guide/kubectl/kubectl_create_secret_tls.md @@ -73,7 +73,7 @@ kubectl create secret tls tls-secret --cert=path/to/tls.cert --key=path/to/tls.k -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_create_service.md b/docs/user-guide/kubectl/kubectl_create_service.md index deece74de9..5183e75de7 100644 --- a/docs/user-guide/kubectl/kubectl_create_service.md +++ b/docs/user-guide/kubectl/kubectl_create_service.md @@ -43,7 +43,7 @@ kubectl create service -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_create_service_clusterip.md b/docs/user-guide/kubectl/kubectl_create_service_clusterip.md index 05258fc991..d1a86da92b 100644 --- a/docs/user-guide/kubectl/kubectl_create_service_clusterip.md +++ b/docs/user-guide/kubectl/kubectl_create_service_clusterip.md @@ -74,7 +74,7 @@ kubectl create service clusterip my-cs --clusterip="None" -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_create_service_loadbalancer.md b/docs/user-guide/kubectl/kubectl_create_service_loadbalancer.md index 8d3d22098a..83d60f0584 100644 --- a/docs/user-guide/kubectl/kubectl_create_service_loadbalancer.md +++ b/docs/user-guide/kubectl/kubectl_create_service_loadbalancer.md @@ -70,7 +70,7 @@ kubectl create service loadbalancer my-lbs --tcp=5678:8080 -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_create_service_nodeport.md b/docs/user-guide/kubectl/kubectl_create_service_nodeport.md index e95c16b207..38822d879a 100644 --- a/docs/user-guide/kubectl/kubectl_create_service_nodeport.md +++ b/docs/user-guide/kubectl/kubectl_create_service_nodeport.md @@ -70,7 +70,7 @@ kubectl create service nodeport my-ns --tcp=5678:8080 -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_create_serviceaccount.md b/docs/user-guide/kubectl/kubectl_create_serviceaccount.md index 96092c3cb4..20490abfc2 100644 --- a/docs/user-guide/kubectl/kubectl_create_serviceaccount.md +++ b/docs/user-guide/kubectl/kubectl_create_serviceaccount.md @@ -70,7 +70,7 @@ $ kubectl create serviceaccount my-service-account -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_delete.md b/docs/user-guide/kubectl/kubectl_delete.md index 5e8c303714..585ccee091 100644 --- a/docs/user-guide/kubectl/kubectl_delete.md +++ b/docs/user-guide/kubectl/kubectl_delete.md @@ -62,7 +62,7 @@ kubectl delete pods --all -o, --output string Output mode. Use "-o name" for shorter output (resource/name). -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. -l, --selector string Selector (label query) to filter on. - --timeout duration The length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object + --timeout duration The length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object (default 0s) ``` ### Options inherited from parent commands @@ -94,7 +94,7 @@ kubectl delete pods --all -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_describe.md b/docs/user-guide/kubectl/kubectl_describe.md index ff3c804c95..e34a2e4d9f 100644 --- a/docs/user-guide/kubectl/kubectl_describe.md +++ b/docs/user-guide/kubectl/kubectl_describe.md @@ -113,7 +113,7 @@ kubectl describe pods frontend -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_drain.md b/docs/user-guide/kubectl/kubectl_drain.md index 248ad68285..26e61779a0 100644 --- a/docs/user-guide/kubectl/kubectl_drain.md +++ b/docs/user-guide/kubectl/kubectl_drain.md @@ -12,13 +12,13 @@ Drain node in preparation for maintenance Drain node in preparation for maintenance. The given node will be marked unschedulable to prevent new pods from arriving. -The `drain` deletes all pods except mirror pods (which cannot be deleted through +Then drain deletes all pods except mirror pods (which cannot be deleted through the API server). If there are DaemonSet-managed pods, drain will not proceed without --ignore-daemonsets, and regardless it will not delete any DaemonSet-managed pods, because those pods would be immediately replaced by the DaemonSet controller, which ignores unschedulable markings. If there are any -pods that are neither mirror pods nor managed by ReplicationController, -ReplicaSet, DaemonSet or Job, then drain will not delete any pods unless you +pods that are neither mirror pods nor managed--by ReplicationController, +ReplicaSet, DaemonSet or Job--, then drain will not delete any pods unless you use --force. When you are ready to put the node back into service, use kubectl uncordon, which @@ -81,7 +81,7 @@ $ kubectl drain foo --grace-period=900 -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_edit.md b/docs/user-guide/kubectl/kubectl_edit.md index 61d18ca825..dc626b9440 100644 --- a/docs/user-guide/kubectl/kubectl_edit.md +++ b/docs/user-guide/kubectl/kubectl_edit.md @@ -91,7 +91,7 @@ kubectl edit svc/docker-registry --output-version=v1 -o json -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_exec.md b/docs/user-guide/kubectl/kubectl_exec.md index 188ffd9e62..94bbd4bff0 100644 --- a/docs/user-guide/kubectl/kubectl_exec.md +++ b/docs/user-guide/kubectl/kubectl_exec.md @@ -67,7 +67,7 @@ kubectl exec 123456-7890 -c ruby-container -i -t -- bash -il -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_explain.md b/docs/user-guide/kubectl/kubectl_explain.md index c919415944..70f52d6ee4 100644 --- a/docs/user-guide/kubectl/kubectl_explain.md +++ b/docs/user-guide/kubectl/kubectl_explain.md @@ -89,7 +89,7 @@ kubectl explain pods.spec.containers -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_expose.md b/docs/user-guide/kubectl/kubectl_expose.md index d699ea2a63..6ecb7e5951 100644 --- a/docs/user-guide/kubectl/kubectl_expose.md +++ b/docs/user-guide/kubectl/kubectl_expose.md @@ -20,7 +20,7 @@ labels are specified, the new service will re-use the labels from the resource i Possible resources include (case insensitive): pod (po), service (svc), replicationcontroller (rc), -deployment, replicaset (rs) +deployment (deploy), replicaset (rs) ``` @@ -112,7 +112,7 @@ kubectl expose deployment nginx --port=80 --target-port=8000 -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_get.md b/docs/user-guide/kubectl/kubectl_get.md index 9a6f7fc228..275a9b620b 100644 --- a/docs/user-guide/kubectl/kubectl_get.md +++ b/docs/user-guide/kubectl/kubectl_get.md @@ -12,7 +12,6 @@ Display one or many resources Display one or many resources. Valid resource types include: - * clusters (valid only for federation apiservers) * componentstatuses (aka 'cs') * configmaps (aka 'cm') @@ -69,9 +68,7 @@ kubectl get -o json pod web-pod-13je7 kubectl get -f pod.yaml -o json # Return only the phase value of the specified pod. -{% raw %} kubectl get -o template pod/web-pod-13je7 --template={{.status.phase}} -{% endraw %} # List all replication controllers and services together in ps output format. kubectl get rc,services @@ -132,7 +129,7 @@ kubectl get rc/web service/frontend pods/web-pod-13je7 -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_label.md b/docs/user-guide/kubectl/kubectl_label.md index 519111b41a..8a01e1c4e4 100644 --- a/docs/user-guide/kubectl/kubectl_label.md +++ b/docs/user-guide/kubectl/kubectl_label.md @@ -93,7 +93,7 @@ kubectl label pods foo bar- -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_logs.md b/docs/user-guide/kubectl/kubectl_logs.md index 5436ab7f08..a09a291797 100644 --- a/docs/user-guide/kubectl/kubectl_logs.md +++ b/docs/user-guide/kubectl/kubectl_logs.md @@ -42,7 +42,7 @@ kubectl logs --since=1h nginx --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true) --limit-bytes int Maximum bytes of logs to return. Defaults to no limit. -p, --previous If true, print the logs for the previous instance of the container in a pod if it exists. - --since duration Only return logs newer than a relative duration like 5s, 2m, or 3h. Defaults to all logs. Only one of since-time / since may be used. + --since duration Only return logs newer than a relative duration like 5s, 2m, or 3h. Defaults to all logs. Only one of since-time / since may be used. (default 0s) --since-time string Only return logs after a specific date (RFC3339). Defaults to all logs. Only one of since-time / since may be used. --tail int Lines of recent log file to display. Defaults to -1, showing all log lines. (default -1) --timestamps Include timestamps on each line in the log output @@ -77,7 +77,7 @@ kubectl logs --since=1h nginx -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_namespace.md b/docs/user-guide/kubectl/kubectl_namespace.md index 3af680938c..c5b7d60883 100644 --- a/docs/user-guide/kubectl/kubectl_namespace.md +++ b/docs/user-guide/kubectl/kubectl_namespace.md @@ -43,7 +43,7 @@ kubectl namespace [namespace] -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_options.md b/docs/user-guide/kubectl/kubectl_options.md index 060fc472f8..c82e556ec8 100644 --- a/docs/user-guide/kubectl/kubectl_options.md +++ b/docs/user-guide/kubectl/kubectl_options.md @@ -43,7 +43,7 @@ kubectl options -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_patch.md b/docs/user-guide/kubectl/kubectl_patch.md index c695889060..3497852c34 100644 --- a/docs/user-guide/kubectl/kubectl_patch.md +++ b/docs/user-guide/kubectl/kubectl_patch.md @@ -85,7 +85,7 @@ kubectl patch pod valid-pod --type='json' -p='[{"op": "replace", "path": "/spec/ -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_port-forward.md b/docs/user-guide/kubectl/kubectl_port-forward.md index c23318f172..3a0b6f548b 100644 --- a/docs/user-guide/kubectl/kubectl_port-forward.md +++ b/docs/user-guide/kubectl/kubectl_port-forward.md @@ -66,7 +66,7 @@ kubectl port-forward mypod 0:5000 -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_proxy.md b/docs/user-guide/kubectl/kubectl_proxy.md index 0e0abf0ee6..62f0417c2e 100644 --- a/docs/user-guide/kubectl/kubectl_proxy.md +++ b/docs/user-guide/kubectl/kubectl_proxy.md @@ -91,7 +91,7 @@ kubectl proxy --api-prefix=/k8s-api -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_replace.md b/docs/user-guide/kubectl/kubectl_replace.md index 61942a00fd..6816704c17 100644 --- a/docs/user-guide/kubectl/kubectl_replace.md +++ b/docs/user-guide/kubectl/kubectl_replace.md @@ -51,7 +51,7 @@ kubectl replace --force -f ./pod.json -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. --save-config If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. --schema-cache-dir string If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' (default "~/.kube/schema") - --timeout duration Only relevant during a force replace. The length of time to wait before giving up on a delete of the old resource, zero means determine a timeout from the size of the object. Any other values should contain a corresponding time unit (e.g. 1s, 2m, 3h). + --timeout duration Only relevant during a force replace. The length of time to wait before giving up on a delete of the old resource, zero means determine a timeout from the size of the object. Any other values should contain a corresponding time unit (e.g. 1s, 2m, 3h). (default 0s) --validate If true, use a schema to validate the input before sending it (default true) ``` @@ -84,7 +84,7 @@ kubectl replace --force -f ./pod.json -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_rolling-update.md b/docs/user-guide/kubectl/kubectl_rolling-update.md index f4c35789a2..3b9dcb7fb7 100644 --- a/docs/user-guide/kubectl/kubectl_rolling-update.md +++ b/docs/user-guide/kubectl/kubectl_rolling-update.md @@ -15,6 +15,9 @@ Replaces the specified replication controller with a new replication controller new PodTemplate. The new-controller.json must specify the same namespace as the existing replication controller and overwrite at least one (common) label in its replicaSelector. +![Workflow](http://kubernetes.io/images/docs/kubectl_rollingupdate.svg) + + ``` kubectl rolling-update OLD_CONTROLLER_NAME ([NEW_CONTROLLER_NAME] --image=NEW_CONTAINER_IMAGE | -f NEW_CONTROLLER_SPEC) ``` @@ -95,7 +98,7 @@ kubectl rolling-update frontend-v1 frontend-v2 --rollback -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_rollout.md b/docs/user-guide/kubectl/kubectl_rollout.md index 49d13e8f8f..6b3c2709c6 100644 --- a/docs/user-guide/kubectl/kubectl_rollout.md +++ b/docs/user-guide/kubectl/kubectl_rollout.md @@ -52,7 +52,7 @@ kubectl rollout undo deployment/abc -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_rollout_history.md b/docs/user-guide/kubectl/kubectl_rollout_history.md index db82c4a24d..f660162cd2 100644 --- a/docs/user-guide/kubectl/kubectl_rollout_history.md +++ b/docs/user-guide/kubectl/kubectl_rollout_history.md @@ -63,7 +63,7 @@ kubectl rollout history deployment/abc --revision=3 -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_rollout_pause.md b/docs/user-guide/kubectl/kubectl_rollout_pause.md index 0636160072..3e85d3b629 100644 --- a/docs/user-guide/kubectl/kubectl_rollout_pause.md +++ b/docs/user-guide/kubectl/kubectl_rollout_pause.md @@ -65,7 +65,7 @@ kubectl rollout pause deployment/nginx -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_rollout_resume.md b/docs/user-guide/kubectl/kubectl_rollout_resume.md index 3954ec033c..6460f30622 100644 --- a/docs/user-guide/kubectl/kubectl_rollout_resume.md +++ b/docs/user-guide/kubectl/kubectl_rollout_resume.md @@ -63,7 +63,7 @@ kubectl rollout resume deployment/nginx -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_rollout_status.md b/docs/user-guide/kubectl/kubectl_rollout_status.md index 5730266e30..e611dfe6f7 100644 --- a/docs/user-guide/kubectl/kubectl_rollout_status.md +++ b/docs/user-guide/kubectl/kubectl_rollout_status.md @@ -59,7 +59,7 @@ kubectl rollout status deployment/nginx -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_rollout_undo.md b/docs/user-guide/kubectl/kubectl_rollout_undo.md index 1f758bd68d..3e302c7db6 100644 --- a/docs/user-guide/kubectl/kubectl_rollout_undo.md +++ b/docs/user-guide/kubectl/kubectl_rollout_undo.md @@ -63,7 +63,7 @@ kubectl rollout undo deployment/abc --to-revision=3 -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_run.md b/docs/user-guide/kubectl/kubectl_run.md index a62adb32a1..c0a7d9cc6d 100644 --- a/docs/user-guide/kubectl/kubectl_run.md +++ b/docs/user-guide/kubectl/kubectl_run.md @@ -122,7 +122,7 @@ kubectl run pi --schedule="0/5 * * * ?" --image=perl --restart=OnFailure -- perl -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_scale.md b/docs/user-guide/kubectl/kubectl_scale.md index bf781d2ee6..4f97fce9ff 100644 --- a/docs/user-guide/kubectl/kubectl_scale.md +++ b/docs/user-guide/kubectl/kubectl_scale.md @@ -51,7 +51,7 @@ kubectl scale --replicas=3 job/cron -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. --replicas int The new desired number of replicas. Required. (default -1) --resource-version string Precondition for resource version. Requires that the current resource version match this value in order to scale. - --timeout duration The length of time to wait before giving up on a scale operation, zero means don't wait. Any other values should contain a corresponding time unit (e.g. 1s, 2m, 3h). + --timeout duration The length of time to wait before giving up on a scale operation, zero means don't wait. Any other values should contain a corresponding time unit (e.g. 1s, 2m, 3h). (default 0s) ``` ### Options inherited from parent commands @@ -83,7 +83,7 @@ kubectl scale --replicas=3 job/cron -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_set.md b/docs/user-guide/kubectl/kubectl_set.md index 7968396c09..dad43a25fc 100644 --- a/docs/user-guide/kubectl/kubectl_set.md +++ b/docs/user-guide/kubectl/kubectl_set.md @@ -46,7 +46,7 @@ kubectl set SUBCOMMAND -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_set_image.md b/docs/user-guide/kubectl/kubectl_set_image.md index 2797c4b83b..6e7a40c903 100644 --- a/docs/user-guide/kubectl/kubectl_set_image.md +++ b/docs/user-guide/kubectl/kubectl_set_image.md @@ -12,7 +12,7 @@ Update image of a pod template Update existing container image(s) of resources. Possible resources include (case insensitive): - pod (po), replicationcontroller (rc), deployment, daemonset (ds), job, replicaset (rs) + pod (po), replicationcontroller (rc), deployment (deploy), daemonset (ds), job, replicaset (rs) ``` kubectl set image (-f FILENAME | TYPE NAME) CONTAINER_NAME_1=CONTAINER_IMAGE_1 ... CONTAINER_NAME_N=CONTAINER_IMAGE_N @@ -82,7 +82,7 @@ kubectl set image -f path/to/file.yaml nginx=nginx:1.9.1 --local -o yaml -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_taint.md b/docs/user-guide/kubectl/kubectl_taint.md index 0f0abbf69f..3c4bb20b52 100644 --- a/docs/user-guide/kubectl/kubectl_taint.md +++ b/docs/user-guide/kubectl/kubectl_taint.md @@ -83,7 +83,7 @@ kubectl taint nodes foo dedicated- -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_top.md b/docs/user-guide/kubectl/kubectl_top.md index 392240410b..8721c3fa41 100644 --- a/docs/user-guide/kubectl/kubectl_top.md +++ b/docs/user-guide/kubectl/kubectl_top.md @@ -46,7 +46,7 @@ kubectl top -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_top_node.md b/docs/user-guide/kubectl/kubectl_top_node.md index 724c2ab3f5..70737e905e 100644 --- a/docs/user-guide/kubectl/kubectl_top_node.md +++ b/docs/user-guide/kubectl/kubectl_top_node.md @@ -63,7 +63,7 @@ kubectl top node NODE_NAME -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_top_pod.md b/docs/user-guide/kubectl/kubectl_top_pod.md index 2c45fbe07c..04cf73524f 100644 --- a/docs/user-guide/kubectl/kubectl_top_pod.md +++ b/docs/user-guide/kubectl/kubectl_top_pod.md @@ -74,7 +74,7 @@ kubectl top pod -l name=myLabel -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_uncordon.md b/docs/user-guide/kubectl/kubectl_uncordon.md index ef142c72c2..8e1722f223 100644 --- a/docs/user-guide/kubectl/kubectl_uncordon.md +++ b/docs/user-guide/kubectl/kubectl_uncordon.md @@ -54,7 +54,7 @@ $ kubectl uncordon foo -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/kubectl/kubectl_version.md b/docs/user-guide/kubectl/kubectl_version.md index 9abc0c2856..66e582c4c7 100644 --- a/docs/user-guide/kubectl/kubectl_version.md +++ b/docs/user-guide/kubectl/kubectl_version.md @@ -49,7 +49,7 @@ kubectl version -###### Auto generated by spf13/cobra on 2-Sep-2016 +###### Auto generated by spf13/cobra on 24-Oct-2016 diff --git a/docs/user-guide/pod-states.md b/docs/user-guide/pod-states.md index 8806e3be7c..b29270e5f8 100644 --- a/docs/user-guide/pod-states.md +++ b/docs/user-guide/pod-states.md @@ -89,6 +89,40 @@ If a node dies or is disconnected from the rest of the cluster, some entity with ## Examples +### Advanced livenessProbe example + +Liveness probes are executed by `kubelet`, so all requests will be made within kubelet network namespace. + +```yaml +apiVersion: v1 +kind: Pod +metadata: + labels: + test: liveness + name: liveness-http +spec: + containers: + - args: + - /server + image: gcr.io/google_containers/liveness + livenessProbe: + httpGet: + # when "host" is not defined, "PodIP" will be used + # host: my-host + # when "scheme" is not defined, "HTTP" scheme will be used. Only "HTTP" and "HTTPS" are allowed + # scheme: HTTPS + path: /healthz + port: 8080 + httpHeaders: + - name: X-Custom-Header + value: Awesome + initialDelaySeconds: 15 + timeoutSeconds: 1 + name: liveness +``` + +### Example states + * Pod is `Running`, 1 container, container exits success * Log completion event * If RestartPolicy is: diff --git a/images/square-logos/tigera.png b/images/square-logos/tigera.png new file mode 100644 index 0000000000..bf5f759f64 Binary files /dev/null and b/images/square-logos/tigera.png differ