Skip to content

Latest commit

 

History

History
254 lines (180 loc) · 12 KB

ConfigMap.md

File metadata and controls

254 lines (180 loc) · 12 KB
Raw

ConfigMap

read

api.v1.namespaces(namespace).configmaps(name).get

read the specified ConfigMap

Path

Parameter Description
name name of the ConfigMap
namespace object name and auth scope, such as for teams and projects

Query

Parameter Description
qs Querystring object
qs.exact Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.
qs.export Should this value be exported. Export strips fields that a user can not specify.
qs.pretty If 'true', then the output is pretty printed.

api.v1.namespaces(namespace).configmaps.get

list or watch objects of kind ConfigMap

Path

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query

Parameter Description
qs Querystring object
qs.fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
qs.includeUninitialized If true, partially initialized resources are included in the response.
qs.labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
qs.resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
qs.timeoutSeconds Timeout for the list/watch call.
qs.watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
qs.pretty If 'true', then the output is pretty printed.

api.v1.watch.namespaces(namespace).configmaps(name).get

watch changes to an object of kind ConfigMap

Path

Parameter Description
name name of the ConfigMap
namespace object name and auth scope, such as for teams and projects

Query

Parameter Description
qs Querystring object
qs.fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
qs.includeUninitialized If true, partially initialized resources are included in the response.
qs.labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
qs.pretty If 'true', then the output is pretty printed.
qs.resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
qs.timeoutSeconds Timeout for the list/watch call.
qs.watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

api.v1.watch.namespaces(namespace).configmaps.get

watch individual changes to a list of ConfigMap

Path

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query

Parameter Description
qs Querystring object
qs.fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
qs.includeUninitialized If true, partially initialized resources are included in the response.
qs.labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
qs.pretty If 'true', then the output is pretty printed.
qs.resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
qs.timeoutSeconds Timeout for the list/watch call.
qs.watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

api.v1.watch.configmaps.get

watch individual changes to a list of ConfigMap

Query

Parameter Description
qs Querystring object
qs.fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
qs.includeUninitialized If true, partially initialized resources are included in the response.
qs.labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
qs.pretty If 'true', then the output is pretty printed.
qs.resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
qs.timeoutSeconds Timeout for the list/watch call.
qs.watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

api.v1.configmaps.get

list or watch objects of kind ConfigMap

Query

Parameter Description
qs Querystring object
qs.fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
qs.includeUninitialized If true, partially initialized resources are included in the response.
qs.labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
qs.pretty If 'true', then the output is pretty printed.
qs.resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
qs.timeoutSeconds Timeout for the list/watch call.
qs.watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

write

api.v1.namespaces(namespace).configmaps(name).delete

delete a ConfigMap

Path

Parameter Description
name name of the ConfigMap
namespace object name and auth scope, such as for teams and projects

Query

Parameter Description
qs Querystring object
qs.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.
qs.orphanDependents Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
qs.propagationPolicy Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.
qs.pretty If 'true', then the output is pretty printed.

Body

Parameter Description
body #/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions

api.v1.namespaces(namespace).configmaps(name).patch

partially update the specified ConfigMap

Path

Parameter Description
name name of the ConfigMap
namespace object name and auth scope, such as for teams and projects

Query

Parameter Description
qs Querystring object
qs.pretty If 'true', then the output is pretty printed.

Body

Parameter Description
body #/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Patch

api.v1.namespaces(namespace).configmaps(name).put

replace the specified ConfigMap

Path

Parameter Description
name name of the ConfigMap
namespace object name and auth scope, such as for teams and projects

Query

Parameter Description
qs Querystring object
qs.pretty If 'true', then the output is pretty printed.

Body

Parameter Description
body #/definitions/io.k8s.kubernetes.pkg.api.v1.ConfigMap

api.v1.namespaces(namespace).configmaps.delete

delete collection of ConfigMap

Path

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query

Parameter Description
qs Querystring object
qs.fieldSelector A selector to restrict the list of returned objects by their fields. Defaults to everything.
qs.includeUninitialized If true, partially initialized resources are included in the response.
qs.labelSelector A selector to restrict the list of returned objects by their labels. Defaults to everything.
qs.resourceVersion When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
qs.timeoutSeconds Timeout for the list/watch call.
qs.watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
qs.pretty If 'true', then the output is pretty printed.

api.v1.namespaces(namespace).configmaps.post

create a ConfigMap

Path

Parameter Description
namespace object name and auth scope, such as for teams and projects

Query

Parameter Description
qs Querystring object
qs.pretty If 'true', then the output is pretty printed.

Body

Parameter Description
body #/definitions/io.k8s.kubernetes.pkg.api.v1.ConfigMap