mirror of
https://github.com/ansible-collections/kubernetes.core.git
synced 2026-04-11 03:11:14 +00:00
update generated modules (#26)
This commit is contained in:
Fabian von Feilitzsch
committed by
Chris Houseknecht
Chris Houseknecht
parent
9a698071dd
commit
83e9dedd6e
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -90,7 +90,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -98,8 +98,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
scale:
|
||||
type: complex
|
||||
returned: on success
|
||||
@@ -120,338 +120,14 @@ scale:
|
||||
description:
|
||||
- Standard object metadata;
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource will
|
||||
be deleted. This field is set by the server when a graceful deletion is
|
||||
requested by the user, and is not directly settable by a client. The resource
|
||||
is expected to be deleted (no longer visible from resource lists, and
|
||||
not reachable by name) after the time in this field. Once set, this value
|
||||
may not be unset or be set further into the future, although it may be
|
||||
shortened or the resource may be deleted prior to this time. For example,
|
||||
a user may request that a pod is deleted in 30 seconds. The Kubelet will
|
||||
react by sending a graceful termination signal to the containers in the
|
||||
pod. After that 30 seconds, the Kubelet will send a hard termination signal
|
||||
(SIGKILL) to the container and after cleanup, remove the pod from the
|
||||
API. In the presence of network partitions, this object may still exist
|
||||
after this timestamp, until an administrator or automated process can
|
||||
determine the resource is fully terminated. If not set, graceful deletion
|
||||
of the object has not been requested. Populated by the system when a graceful
|
||||
deletion is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired state.
|
||||
Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant at
|
||||
object creation time. This field is a list of initializers that have not
|
||||
yet acted on this object. If nil or empty, this object has been completely
|
||||
initialized. Otherwise, the object is considered uninitialized and is
|
||||
hidden (in list/watch and get calls) from clients that haven't explicitly
|
||||
asked to observe uninitialized objects. When an object is created, the
|
||||
system will populate this list with the current set of initializers. Only
|
||||
privileged users may set or modify this list. Once it is empty, it may
|
||||
not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be set
|
||||
to nil and the object is considered as initialized and visible to
|
||||
all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with the
|
||||
StatusReason failure. Not all StatusReasons may provide detailed
|
||||
causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the error.
|
||||
If this value is empty there is no information available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the status
|
||||
StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the status
|
||||
StatusReason. On some operations may differ from the requested
|
||||
resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the status
|
||||
StatusReason (when there is a single name which can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should
|
||||
be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource which
|
||||
can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the
|
||||
system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until this
|
||||
reference is removed. Defaults to false. To set this field, a user
|
||||
needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
spec:
|
||||
description:
|
||||
- defines the behavior of the scale.
|
||||
type: complex
|
||||
contains:
|
||||
replicas:
|
||||
description:
|
||||
- desired number of instances for the scaled object.
|
||||
type: int
|
||||
status:
|
||||
description:
|
||||
- current status of the scale.
|
||||
type: complex
|
||||
contains:
|
||||
replicas:
|
||||
description:
|
||||
- actual number of observed instances of the scaled object.
|
||||
type: int
|
||||
selector:
|
||||
description:
|
||||
- label query over pods that should match the replicas count.
|
||||
type: complex
|
||||
contains: str, str
|
||||
target_selector:
|
||||
description:
|
||||
- label selector for pods that should match the replicas count. This is
|
||||
a serializated version of both map-based and more expressive set-based
|
||||
selectors. This is done to avoid introspection in the clients. The string
|
||||
will be in the same format as the query-param syntax. If the target type
|
||||
only supports map-based selectors, both this field and map-based selector
|
||||
field are populated.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -90,7 +90,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -98,8 +98,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
scale:
|
||||
type: complex
|
||||
returned: on success
|
||||
@@ -120,338 +120,14 @@ scale:
|
||||
description:
|
||||
- Standard object metadata;
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource will
|
||||
be deleted. This field is set by the server when a graceful deletion is
|
||||
requested by the user, and is not directly settable by a client. The resource
|
||||
is expected to be deleted (no longer visible from resource lists, and
|
||||
not reachable by name) after the time in this field. Once set, this value
|
||||
may not be unset or be set further into the future, although it may be
|
||||
shortened or the resource may be deleted prior to this time. For example,
|
||||
a user may request that a pod is deleted in 30 seconds. The Kubelet will
|
||||
react by sending a graceful termination signal to the containers in the
|
||||
pod. After that 30 seconds, the Kubelet will send a hard termination signal
|
||||
(SIGKILL) to the container and after cleanup, remove the pod from the
|
||||
API. In the presence of network partitions, this object may still exist
|
||||
after this timestamp, until an administrator or automated process can
|
||||
determine the resource is fully terminated. If not set, graceful deletion
|
||||
of the object has not been requested. Populated by the system when a graceful
|
||||
deletion is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired state.
|
||||
Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant at
|
||||
object creation time. This field is a list of initializers that have not
|
||||
yet acted on this object. If nil or empty, this object has been completely
|
||||
initialized. Otherwise, the object is considered uninitialized and is
|
||||
hidden (in list/watch and get calls) from clients that haven't explicitly
|
||||
asked to observe uninitialized objects. When an object is created, the
|
||||
system will populate this list with the current set of initializers. Only
|
||||
privileged users may set or modify this list. Once it is empty, it may
|
||||
not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be set
|
||||
to nil and the object is considered as initialized and visible to
|
||||
all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with the
|
||||
StatusReason failure. Not all StatusReasons may provide detailed
|
||||
causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the error.
|
||||
If this value is empty there is no information available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the status
|
||||
StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the status
|
||||
StatusReason. On some operations may differ from the requested
|
||||
resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the status
|
||||
StatusReason (when there is a single name which can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should
|
||||
be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource which
|
||||
can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the
|
||||
system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until this
|
||||
reference is removed. Defaults to false. To set this field, a user
|
||||
needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
spec:
|
||||
description:
|
||||
- defines the behavior of the scale.
|
||||
type: complex
|
||||
contains:
|
||||
replicas:
|
||||
description:
|
||||
- desired number of instances for the scaled object.
|
||||
type: int
|
||||
status:
|
||||
description:
|
||||
- current status of the scale.
|
||||
type: complex
|
||||
contains:
|
||||
replicas:
|
||||
description:
|
||||
- actual number of observed instances of the scaled object.
|
||||
type: int
|
||||
selector:
|
||||
description:
|
||||
- label query over pods that should match the replicas count.
|
||||
type: complex
|
||||
contains: str, str
|
||||
target_selector:
|
||||
description:
|
||||
- label selector for pods that should match the replicas count. This is
|
||||
a serializated version of both map-based and more expressive set-based
|
||||
selectors. This is done to avoid introspection in the clients. The string
|
||||
will be in the same format as the query-param syntax. If the target type
|
||||
only supports map-based selectors, both this field and map-based selector
|
||||
field are populated.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -100,13 +100,9 @@ options:
|
||||
target_name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
aliases:
|
||||
- name
|
||||
target_namespace:
|
||||
description:
|
||||
- Namespace of the referent.
|
||||
aliases:
|
||||
- namespace
|
||||
target_resource_version:
|
||||
description:
|
||||
- Specific resourceVersion to which this reference is made, if any.
|
||||
@@ -125,7 +121,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -133,8 +129,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
binding:
|
||||
type: complex
|
||||
returned: on success
|
||||
@@ -155,346 +151,10 @@ binding:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource will
|
||||
be deleted. This field is set by the server when a graceful deletion is
|
||||
requested by the user, and is not directly settable by a client. The resource
|
||||
is expected to be deleted (no longer visible from resource lists, and
|
||||
not reachable by name) after the time in this field. Once set, this value
|
||||
may not be unset or be set further into the future, although it may be
|
||||
shortened or the resource may be deleted prior to this time. For example,
|
||||
a user may request that a pod is deleted in 30 seconds. The Kubelet will
|
||||
react by sending a graceful termination signal to the containers in the
|
||||
pod. After that 30 seconds, the Kubelet will send a hard termination signal
|
||||
(SIGKILL) to the container and after cleanup, remove the pod from the
|
||||
API. In the presence of network partitions, this object may still exist
|
||||
after this timestamp, until an administrator or automated process can
|
||||
determine the resource is fully terminated. If not set, graceful deletion
|
||||
of the object has not been requested. Populated by the system when a graceful
|
||||
deletion is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired state.
|
||||
Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant at
|
||||
object creation time. This field is a list of initializers that have not
|
||||
yet acted on this object. If nil or empty, this object has been completely
|
||||
initialized. Otherwise, the object is considered uninitialized and is
|
||||
hidden (in list/watch and get calls) from clients that haven't explicitly
|
||||
asked to observe uninitialized objects. When an object is created, the
|
||||
system will populate this list with the current set of initializers. Only
|
||||
privileged users may set or modify this list. Once it is empty, it may
|
||||
not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be set
|
||||
to nil and the object is considered as initialized and visible to
|
||||
all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with the
|
||||
StatusReason failure. Not all StatusReasons may provide detailed
|
||||
causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the error.
|
||||
If this value is empty there is no information available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the status
|
||||
StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the status
|
||||
StatusReason. On some operations may differ from the requested
|
||||
resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the status
|
||||
StatusReason (when there is a single name which can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should
|
||||
be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource which
|
||||
can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the
|
||||
system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until this
|
||||
reference is removed. Defaults to false. To set this field, a user
|
||||
needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
target:
|
||||
description:
|
||||
- The target object that you want to bind to the standard object.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
field_path:
|
||||
description:
|
||||
- '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.'
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- Namespace of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- Specific resourceVersion to which this reference is made, if any.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
202
library/k8s_v1_cluster_role.py
Normal file
202
library/k8s_v1_cluster_role.py
Normal file
@@ -0,0 +1,202 @@
|
||||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
from ansible.module_utils.k8s_common import KubernetesAnsibleModule, KubernetesAnsibleException
|
||||
|
||||
DOCUMENTATION = '''
|
||||
module: k8s_v1_cluster_role
|
||||
short_description: Kubernetes ClusterRole
|
||||
description:
|
||||
- Manage the lifecycle of a cluster_role object. Supports check mode, and attempts
|
||||
to to be idempotent.
|
||||
version_added: 2.3.0
|
||||
author: OpenShift (@openshift)
|
||||
options:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: dict
|
||||
api_key:
|
||||
description:
|
||||
- Token used to connect to the API.
|
||||
cert_file:
|
||||
description:
|
||||
- Path to a certificate used to authenticate with the API.
|
||||
type: path
|
||||
context:
|
||||
description:
|
||||
- The name of a context found in the Kubernetes config file.
|
||||
debug:
|
||||
description:
|
||||
- Enable debug output from the OpenShift helper. Logging info is written to KubeObjHelper.log
|
||||
default: false
|
||||
type: bool
|
||||
force:
|
||||
description:
|
||||
- If set to C(True), and I(state) is C(present), an existing object will updated,
|
||||
and lists will be replaced, rather than merged.
|
||||
default: false
|
||||
type: bool
|
||||
host:
|
||||
description:
|
||||
- Provide a URL for acessing the Kubernetes API.
|
||||
key_file:
|
||||
description:
|
||||
- Path to a key file used to authenticate with the API.
|
||||
type: path
|
||||
kubeconfig:
|
||||
description:
|
||||
- Path to an existing Kubernetes config file. If not provided, and no other connection
|
||||
options are provided, the openshift client will attempt to load the default
|
||||
configuration file from I(~/.kube/config.json).
|
||||
type: path
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: dict
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
password:
|
||||
description:
|
||||
- Provide a password for connecting to the API. Use in conjunction with I(username).
|
||||
resource_definition:
|
||||
description:
|
||||
- Provide the YAML definition for the object, bypassing any modules parameters
|
||||
intended to define object attributes.
|
||||
type: dict
|
||||
rules:
|
||||
description:
|
||||
- Rules holds all the PolicyRules for this ClusterRole
|
||||
type: list
|
||||
src:
|
||||
description:
|
||||
- Provide a path to a file containing the YAML definition of the object. Mutually
|
||||
exclusive with I(resource_definition).
|
||||
type: path
|
||||
ssl_ca_cert:
|
||||
description:
|
||||
- Path to a CA certificate used to authenticate with the API.
|
||||
type: path
|
||||
state:
|
||||
description:
|
||||
- Determines if an object should be created, patched, or deleted. When set to
|
||||
C(present), the object will be created, if it does not exist, or patched, if
|
||||
parameter values differ from the existing object's attributes, and deleted,
|
||||
if set to C(absent). A patch operation results in merging lists and updating
|
||||
dictionaries, with lists being merged into a unique set of values. If a list
|
||||
contains a dictionary with a I(name) or I(type) attribute, a strategic merge
|
||||
is performed, where individual elements with a matching I(name_) or I(type)
|
||||
are merged. To force the replacement of lists, set the I(force) option to C(True).
|
||||
default: present
|
||||
choices:
|
||||
- present
|
||||
- absent
|
||||
username:
|
||||
description:
|
||||
- Provide a username for connecting to the API.
|
||||
verify_ssl:
|
||||
description:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
description: Requested API version
|
||||
type: string
|
||||
cluster_role:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
rules:
|
||||
description:
|
||||
- Rules holds all the PolicyRules for this ClusterRole
|
||||
type: list
|
||||
contains:
|
||||
api_groups:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
non_resource_ur_ls:
|
||||
description:
|
||||
- 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 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.
|
||||
type: list
|
||||
contains: str
|
||||
resource_names:
|
||||
description:
|
||||
- ResourceNames is an optional white list of names that the rule applies
|
||||
to. An empty set means that everything is allowed.
|
||||
type: list
|
||||
contains: str
|
||||
resources:
|
||||
description:
|
||||
- Resources is a list of resources this rule applies to. ResourceAll represents
|
||||
all resources.
|
||||
type: list
|
||||
contains: str
|
||||
verbs:
|
||||
description:
|
||||
- Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions
|
||||
contained in this rule. VerbAll represents all kinds.
|
||||
type: list
|
||||
contains: str
|
||||
'''
|
||||
|
||||
|
||||
def main():
|
||||
try:
|
||||
module = KubernetesAnsibleModule('cluster_role', 'v1')
|
||||
except KubernetesAnsibleException as exc:
|
||||
# The helper failed to init, so there is no module object. All we can do is raise the error.
|
||||
raise Exception(exc.message)
|
||||
|
||||
try:
|
||||
module.execute_module()
|
||||
except KubernetesAnsibleException as exc:
|
||||
module.fail_json(msg="Module failed!", error=str(exc))
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
207
library/k8s_v1_cluster_role_binding.py
Normal file
207
library/k8s_v1_cluster_role_binding.py
Normal file
@@ -0,0 +1,207 @@
|
||||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
from ansible.module_utils.k8s_common import KubernetesAnsibleModule, KubernetesAnsibleException
|
||||
|
||||
DOCUMENTATION = '''
|
||||
module: k8s_v1_cluster_role_binding
|
||||
short_description: Kubernetes ClusterRoleBinding
|
||||
description:
|
||||
- Manage the lifecycle of a cluster_role_binding object. Supports check mode, and
|
||||
attempts to to be idempotent.
|
||||
version_added: 2.3.0
|
||||
author: OpenShift (@openshift)
|
||||
options:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: dict
|
||||
api_key:
|
||||
description:
|
||||
- Token used to connect to the API.
|
||||
cert_file:
|
||||
description:
|
||||
- Path to a certificate used to authenticate with the API.
|
||||
type: path
|
||||
context:
|
||||
description:
|
||||
- The name of a context found in the Kubernetes config file.
|
||||
debug:
|
||||
description:
|
||||
- Enable debug output from the OpenShift helper. Logging info is written to KubeObjHelper.log
|
||||
default: false
|
||||
type: bool
|
||||
force:
|
||||
description:
|
||||
- If set to C(True), and I(state) is C(present), an existing object will updated,
|
||||
and lists will be replaced, rather than merged.
|
||||
default: false
|
||||
type: bool
|
||||
host:
|
||||
description:
|
||||
- Provide a URL for acessing the Kubernetes API.
|
||||
key_file:
|
||||
description:
|
||||
- Path to a key file used to authenticate with the API.
|
||||
type: path
|
||||
kubeconfig:
|
||||
description:
|
||||
- Path to an existing Kubernetes config file. If not provided, and no other connection
|
||||
options are provided, the openshift client will attempt to load the default
|
||||
configuration file from I(~/.kube/config.json).
|
||||
type: path
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: dict
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
password:
|
||||
description:
|
||||
- Provide a password for connecting to the API. Use in conjunction with I(username).
|
||||
resource_definition:
|
||||
description:
|
||||
- Provide the YAML definition for the object, bypassing any modules parameters
|
||||
intended to define object attributes.
|
||||
type: dict
|
||||
role_ref_api_group:
|
||||
description:
|
||||
- APIGroup is the group for the resource being referenced
|
||||
aliases:
|
||||
- api_group
|
||||
role_ref_kind:
|
||||
description:
|
||||
- Kind is the type of resource being referenced
|
||||
aliases:
|
||||
- kind
|
||||
role_ref_name:
|
||||
description:
|
||||
- Name is the name of resource being referenced
|
||||
src:
|
||||
description:
|
||||
- Provide a path to a file containing the YAML definition of the object. Mutually
|
||||
exclusive with I(resource_definition).
|
||||
type: path
|
||||
ssl_ca_cert:
|
||||
description:
|
||||
- Path to a CA certificate used to authenticate with the API.
|
||||
type: path
|
||||
state:
|
||||
description:
|
||||
- Determines if an object should be created, patched, or deleted. When set to
|
||||
C(present), the object will be created, if it does not exist, or patched, if
|
||||
parameter values differ from the existing object's attributes, and deleted,
|
||||
if set to C(absent). A patch operation results in merging lists and updating
|
||||
dictionaries, with lists being merged into a unique set of values. If a list
|
||||
contains a dictionary with a I(name) or I(type) attribute, a strategic merge
|
||||
is performed, where individual elements with a matching I(name_) or I(type)
|
||||
are merged. To force the replacement of lists, set the I(force) option to C(True).
|
||||
default: present
|
||||
choices:
|
||||
- present
|
||||
- absent
|
||||
subjects:
|
||||
description:
|
||||
- Subjects holds references to the objects the role applies to.
|
||||
type: list
|
||||
username:
|
||||
description:
|
||||
- Provide a username for connecting to the API.
|
||||
verify_ssl:
|
||||
description:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
description: Requested API version
|
||||
type: string
|
||||
cluster_role_binding:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
role_ref:
|
||||
description:
|
||||
- RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef
|
||||
cannot be resolved, the Authorizer must return an error.
|
||||
type: complex
|
||||
subjects:
|
||||
description:
|
||||
- Subjects holds references to the objects the role applies to.
|
||||
type: list
|
||||
contains:
|
||||
api_group:
|
||||
description:
|
||||
- APIGroup holds the API group of the referenced subject. Defaults to ""
|
||||
for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for
|
||||
User and Group subjects.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the object being referenced.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
def main():
|
||||
try:
|
||||
module = KubernetesAnsibleModule('cluster_role_binding', 'v1')
|
||||
except KubernetesAnsibleException as exc:
|
||||
# The helper failed to init, so there is no module object. All we can do is raise the error.
|
||||
raise Exception(exc.message)
|
||||
|
||||
try:
|
||||
module.execute_module()
|
||||
except KubernetesAnsibleException as exc:
|
||||
module.fail_json(msg="Module failed!", error=str(exc))
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
189
library/k8s_v1_cluster_role_binding_list.py
Normal file
189
library/k8s_v1_cluster_role_binding_list.py
Normal file
@@ -0,0 +1,189 @@
|
||||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
from ansible.module_utils.k8s_common import KubernetesAnsibleModule, KubernetesAnsibleException
|
||||
|
||||
DOCUMENTATION = '''
|
||||
module: k8s_v1_cluster_role_binding_list
|
||||
short_description: Kubernetes ClusterRoleBindingList
|
||||
description:
|
||||
- Retrieve a list of cluster_role_bindings. List operations provide a snapshot read
|
||||
of the underlying objects, returning a resource_version representing a consistent
|
||||
version of the listed objects.
|
||||
version_added: 2.3.0
|
||||
author: OpenShift (@openshift)
|
||||
options:
|
||||
api_key:
|
||||
description:
|
||||
- Token used to connect to the API.
|
||||
cert_file:
|
||||
description:
|
||||
- Path to a certificate used to authenticate with the API.
|
||||
type: path
|
||||
context:
|
||||
description:
|
||||
- The name of a context found in the Kubernetes config file.
|
||||
debug:
|
||||
description:
|
||||
- Enable debug output from the OpenShift helper. Logging info is written to KubeObjHelper.log
|
||||
default: false
|
||||
type: bool
|
||||
force:
|
||||
description:
|
||||
- If set to C(True), and I(state) is C(present), an existing object will updated,
|
||||
and lists will be replaced, rather than merged.
|
||||
default: false
|
||||
type: bool
|
||||
host:
|
||||
description:
|
||||
- Provide a URL for acessing the Kubernetes API.
|
||||
key_file:
|
||||
description:
|
||||
- Path to a key file used to authenticate with the API.
|
||||
type: path
|
||||
kubeconfig:
|
||||
description:
|
||||
- Path to an existing Kubernetes config file. If not provided, and no other connection
|
||||
options are provided, the openshift client will attempt to load the default
|
||||
configuration file from I(~/.kube/config.json).
|
||||
type: path
|
||||
password:
|
||||
description:
|
||||
- Provide a password for connecting to the API. Use in conjunction with I(username).
|
||||
resource_definition:
|
||||
description:
|
||||
- Provide the YAML definition for the object, bypassing any modules parameters
|
||||
intended to define object attributes.
|
||||
type: dict
|
||||
src:
|
||||
description:
|
||||
- Provide a path to a file containing the YAML definition of the object. Mutually
|
||||
exclusive with I(resource_definition).
|
||||
type: path
|
||||
ssl_ca_cert:
|
||||
description:
|
||||
- Path to a CA certificate used to authenticate with the API.
|
||||
type: path
|
||||
state:
|
||||
description:
|
||||
- Determines if an object should be created, patched, or deleted. When set to
|
||||
C(present), the object will be created, if it does not exist, or patched, if
|
||||
parameter values differ from the existing object's attributes, and deleted,
|
||||
if set to C(absent). A patch operation results in merging lists and updating
|
||||
dictionaries, with lists being merged into a unique set of values. If a list
|
||||
contains a dictionary with a I(name) or I(type) attribute, a strategic merge
|
||||
is performed, where individual elements with a matching I(name_) or I(type)
|
||||
are merged. To force the replacement of lists, set the I(force) option to C(True).
|
||||
default: present
|
||||
choices:
|
||||
- present
|
||||
- absent
|
||||
username:
|
||||
description:
|
||||
- Provide a username for connecting to the API.
|
||||
verify_ssl:
|
||||
description:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
description: Requested API version
|
||||
type: string
|
||||
cluster_role_binding_list:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
items:
|
||||
description:
|
||||
- Items is a list of ClusterRoleBindings
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
role_ref:
|
||||
description:
|
||||
- RoleRef can only reference a ClusterRole in the global namespace. If the
|
||||
RoleRef cannot be resolved, the Authorizer must return an error.
|
||||
type: complex
|
||||
subjects:
|
||||
description:
|
||||
- Subjects holds references to the objects the role applies to.
|
||||
type: list
|
||||
contains:
|
||||
api_group:
|
||||
description:
|
||||
- APIGroup holds the API group of the referenced subject. Defaults to
|
||||
"" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io"
|
||||
for User and Group subjects.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the object being referenced.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
'''
|
||||
|
||||
|
||||
def main():
|
||||
try:
|
||||
module = KubernetesAnsibleModule('cluster_role_binding_list', 'v1')
|
||||
except KubernetesAnsibleException as exc:
|
||||
# The helper failed to init, so there is no module object. All we can do is raise the error.
|
||||
raise Exception(exc.message)
|
||||
|
||||
try:
|
||||
module.execute_module()
|
||||
except KubernetesAnsibleException as exc:
|
||||
module.fail_json(msg="Module failed!", error=str(exc))
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
197
library/k8s_v1_cluster_role_list.py
Normal file
197
library/k8s_v1_cluster_role_list.py
Normal file
@@ -0,0 +1,197 @@
|
||||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
from ansible.module_utils.k8s_common import KubernetesAnsibleModule, KubernetesAnsibleException
|
||||
|
||||
DOCUMENTATION = '''
|
||||
module: k8s_v1_cluster_role_list
|
||||
short_description: Kubernetes ClusterRoleList
|
||||
description:
|
||||
- Retrieve a list of cluster_roles. List operations provide a snapshot read of the
|
||||
underlying objects, returning a resource_version representing a consistent version
|
||||
of the listed objects.
|
||||
version_added: 2.3.0
|
||||
author: OpenShift (@openshift)
|
||||
options:
|
||||
api_key:
|
||||
description:
|
||||
- Token used to connect to the API.
|
||||
cert_file:
|
||||
description:
|
||||
- Path to a certificate used to authenticate with the API.
|
||||
type: path
|
||||
context:
|
||||
description:
|
||||
- The name of a context found in the Kubernetes config file.
|
||||
debug:
|
||||
description:
|
||||
- Enable debug output from the OpenShift helper. Logging info is written to KubeObjHelper.log
|
||||
default: false
|
||||
type: bool
|
||||
force:
|
||||
description:
|
||||
- If set to C(True), and I(state) is C(present), an existing object will updated,
|
||||
and lists will be replaced, rather than merged.
|
||||
default: false
|
||||
type: bool
|
||||
host:
|
||||
description:
|
||||
- Provide a URL for acessing the Kubernetes API.
|
||||
key_file:
|
||||
description:
|
||||
- Path to a key file used to authenticate with the API.
|
||||
type: path
|
||||
kubeconfig:
|
||||
description:
|
||||
- Path to an existing Kubernetes config file. If not provided, and no other connection
|
||||
options are provided, the openshift client will attempt to load the default
|
||||
configuration file from I(~/.kube/config.json).
|
||||
type: path
|
||||
password:
|
||||
description:
|
||||
- Provide a password for connecting to the API. Use in conjunction with I(username).
|
||||
resource_definition:
|
||||
description:
|
||||
- Provide the YAML definition for the object, bypassing any modules parameters
|
||||
intended to define object attributes.
|
||||
type: dict
|
||||
src:
|
||||
description:
|
||||
- Provide a path to a file containing the YAML definition of the object. Mutually
|
||||
exclusive with I(resource_definition).
|
||||
type: path
|
||||
ssl_ca_cert:
|
||||
description:
|
||||
- Path to a CA certificate used to authenticate with the API.
|
||||
type: path
|
||||
state:
|
||||
description:
|
||||
- Determines if an object should be created, patched, or deleted. When set to
|
||||
C(present), the object will be created, if it does not exist, or patched, if
|
||||
parameter values differ from the existing object's attributes, and deleted,
|
||||
if set to C(absent). A patch operation results in merging lists and updating
|
||||
dictionaries, with lists being merged into a unique set of values. If a list
|
||||
contains a dictionary with a I(name) or I(type) attribute, a strategic merge
|
||||
is performed, where individual elements with a matching I(name_) or I(type)
|
||||
are merged. To force the replacement of lists, set the I(force) option to C(True).
|
||||
default: present
|
||||
choices:
|
||||
- present
|
||||
- absent
|
||||
username:
|
||||
description:
|
||||
- Provide a username for connecting to the API.
|
||||
verify_ssl:
|
||||
description:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
description: Requested API version
|
||||
type: string
|
||||
cluster_role_list:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
items:
|
||||
description:
|
||||
- Items is a list of ClusterRoles
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
rules:
|
||||
description:
|
||||
- Rules holds all the PolicyRules for this ClusterRole
|
||||
type: list
|
||||
contains:
|
||||
api_groups:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
non_resource_ur_ls:
|
||||
description:
|
||||
- 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 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.
|
||||
type: list
|
||||
contains: str
|
||||
resource_names:
|
||||
description:
|
||||
- ResourceNames is an optional white list of names that the rule applies
|
||||
to. An empty set means that everything is allowed.
|
||||
type: list
|
||||
contains: str
|
||||
resources:
|
||||
description:
|
||||
- Resources is a list of resources this rule applies to. ResourceAll
|
||||
represents all resources.
|
||||
type: list
|
||||
contains: str
|
||||
verbs:
|
||||
description:
|
||||
- Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions
|
||||
contained in this rule. VerbAll represents all kinds.
|
||||
type: list
|
||||
contains: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
'''
|
||||
|
||||
|
||||
def main():
|
||||
try:
|
||||
module = KubernetesAnsibleModule('cluster_role_list', 'v1')
|
||||
except KubernetesAnsibleException as exc:
|
||||
# The helper failed to init, so there is no module object. All we can do is raise the error.
|
||||
raise Exception(exc.message)
|
||||
|
||||
try:
|
||||
module.execute_module()
|
||||
except KubernetesAnsibleException as exc:
|
||||
module.fail_json(msg="Module failed!", error=str(exc))
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
@@ -88,7 +88,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -96,8 +96,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
component_status:
|
||||
type: complex
|
||||
returned: on success
|
||||
@@ -142,306 +142,6 @@ component_status:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource will
|
||||
be deleted. This field is set by the server when a graceful deletion is
|
||||
requested by the user, and is not directly settable by a client. The resource
|
||||
is expected to be deleted (no longer visible from resource lists, and
|
||||
not reachable by name) after the time in this field. Once set, this value
|
||||
may not be unset or be set further into the future, although it may be
|
||||
shortened or the resource may be deleted prior to this time. For example,
|
||||
a user may request that a pod is deleted in 30 seconds. The Kubelet will
|
||||
react by sending a graceful termination signal to the containers in the
|
||||
pod. After that 30 seconds, the Kubelet will send a hard termination signal
|
||||
(SIGKILL) to the container and after cleanup, remove the pod from the
|
||||
API. In the presence of network partitions, this object may still exist
|
||||
after this timestamp, until an administrator or automated process can
|
||||
determine the resource is fully terminated. If not set, graceful deletion
|
||||
of the object has not been requested. Populated by the system when a graceful
|
||||
deletion is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired state.
|
||||
Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant at
|
||||
object creation time. This field is a list of initializers that have not
|
||||
yet acted on this object. If nil or empty, this object has been completely
|
||||
initialized. Otherwise, the object is considered uninitialized and is
|
||||
hidden (in list/watch and get calls) from clients that haven't explicitly
|
||||
asked to observe uninitialized objects. When an object is created, the
|
||||
system will populate this list with the current set of initializers. Only
|
||||
privileged users may set or modify this list. Once it is empty, it may
|
||||
not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be set
|
||||
to nil and the object is considered as initialized and visible to
|
||||
all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with the
|
||||
StatusReason failure. Not all StatusReasons may provide detailed
|
||||
causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the error.
|
||||
If this value is empty there is no information available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the status
|
||||
StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the status
|
||||
StatusReason. On some operations may differ from the requested
|
||||
resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the status
|
||||
StatusReason (when there is a single name which can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should
|
||||
be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource which
|
||||
can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the
|
||||
system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until this
|
||||
reference is removed. Defaults to false. To set this field, a user
|
||||
needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -62,7 +62,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -70,8 +70,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
component_status_list:
|
||||
type: complex
|
||||
returned: on success
|
||||
@@ -127,316 +127,6 @@ component_status_list:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource
|
||||
will be deleted. This field is set by the server when a graceful deletion
|
||||
is requested by the user, and is not directly settable by a client.
|
||||
The resource is expected to be deleted (no longer visible from resource
|
||||
lists, and not reachable by name) after the time in this field. Once
|
||||
set, this value may not be unset or be set further into the future,
|
||||
although it may be shortened or the resource may be deleted prior
|
||||
to this time. For example, a user may request that a pod is deleted
|
||||
in 30 seconds. The Kubelet will react by sending a graceful termination
|
||||
signal to the containers in the pod. After that 30 seconds, the Kubelet
|
||||
will send a hard termination signal (SIGKILL) to the container and
|
||||
after cleanup, remove the pod from the API. In the presence of network
|
||||
partitions, this object may still exist after this timestamp, until
|
||||
an administrator or automated process can determine the resource is
|
||||
fully terminated. If not set, graceful deletion of the object has
|
||||
not been requested. Populated by the system when a graceful deletion
|
||||
is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired
|
||||
state. Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant
|
||||
at object creation time. This field is a list of initializers that
|
||||
have not yet acted on this object. If nil or empty, this object has
|
||||
been completely initialized. Otherwise, the object is considered uninitialized
|
||||
and is hidden (in list/watch and get calls) from clients that haven't
|
||||
explicitly asked to observe uninitialized objects. When an object
|
||||
is created, the system will populate this list with the current set
|
||||
of initializers. Only privileged users may set or modify this list.
|
||||
Once it is empty, it may not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be
|
||||
set to nil and the object is considered as initialized and visible
|
||||
to all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with
|
||||
the StatusReason failure. Not all StatusReasons may provide
|
||||
detailed causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the
|
||||
error. If this value is empty there is no information
|
||||
available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the
|
||||
status StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the
|
||||
status StatusReason. On some operations may differ from
|
||||
the requested resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the
|
||||
status StatusReason (when there is a single name which
|
||||
can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation
|
||||
should be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource
|
||||
which can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated
|
||||
by the system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until
|
||||
this reference is removed. Defaults to false. To set this field,
|
||||
a user needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system.
|
||||
Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- Kind is a string value representing the REST resource this object represents.
|
||||
@@ -447,18 +137,6 @@ component_status_list:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -113,7 +113,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -121,8 +121,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
config_map:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -149,306 +149,6 @@ config_map:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource will
|
||||
be deleted. This field is set by the server when a graceful deletion is
|
||||
requested by the user, and is not directly settable by a client. The resource
|
||||
is expected to be deleted (no longer visible from resource lists, and
|
||||
not reachable by name) after the time in this field. Once set, this value
|
||||
may not be unset or be set further into the future, although it may be
|
||||
shortened or the resource may be deleted prior to this time. For example,
|
||||
a user may request that a pod is deleted in 30 seconds. The Kubelet will
|
||||
react by sending a graceful termination signal to the containers in the
|
||||
pod. After that 30 seconds, the Kubelet will send a hard termination signal
|
||||
(SIGKILL) to the container and after cleanup, remove the pod from the
|
||||
API. In the presence of network partitions, this object may still exist
|
||||
after this timestamp, until an administrator or automated process can
|
||||
determine the resource is fully terminated. If not set, graceful deletion
|
||||
of the object has not been requested. Populated by the system when a graceful
|
||||
deletion is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired state.
|
||||
Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant at
|
||||
object creation time. This field is a list of initializers that have not
|
||||
yet acted on this object. If nil or empty, this object has been completely
|
||||
initialized. Otherwise, the object is considered uninitialized and is
|
||||
hidden (in list/watch and get calls) from clients that haven't explicitly
|
||||
asked to observe uninitialized objects. When an object is created, the
|
||||
system will populate this list with the current set of initializers. Only
|
||||
privileged users may set or modify this list. Once it is empty, it may
|
||||
not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be set
|
||||
to nil and the object is considered as initialized and visible to
|
||||
all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with the
|
||||
StatusReason failure. Not all StatusReasons may provide detailed
|
||||
causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the error.
|
||||
If this value is empty there is no information available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the status
|
||||
StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the status
|
||||
StatusReason. On some operations may differ from the requested
|
||||
resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the status
|
||||
StatusReason (when there is a single name which can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should
|
||||
be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource which
|
||||
can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the
|
||||
system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until this
|
||||
reference is removed. Defaults to false. To set this field, a user
|
||||
needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -86,7 +86,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -94,8 +94,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
config_map_list:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -133,316 +133,6 @@ config_map_list:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource
|
||||
will be deleted. This field is set by the server when a graceful deletion
|
||||
is requested by the user, and is not directly settable by a client.
|
||||
The resource is expected to be deleted (no longer visible from resource
|
||||
lists, and not reachable by name) after the time in this field. Once
|
||||
set, this value may not be unset or be set further into the future,
|
||||
although it may be shortened or the resource may be deleted prior
|
||||
to this time. For example, a user may request that a pod is deleted
|
||||
in 30 seconds. The Kubelet will react by sending a graceful termination
|
||||
signal to the containers in the pod. After that 30 seconds, the Kubelet
|
||||
will send a hard termination signal (SIGKILL) to the container and
|
||||
after cleanup, remove the pod from the API. In the presence of network
|
||||
partitions, this object may still exist after this timestamp, until
|
||||
an administrator or automated process can determine the resource is
|
||||
fully terminated. If not set, graceful deletion of the object has
|
||||
not been requested. Populated by the system when a graceful deletion
|
||||
is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired
|
||||
state. Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant
|
||||
at object creation time. This field is a list of initializers that
|
||||
have not yet acted on this object. If nil or empty, this object has
|
||||
been completely initialized. Otherwise, the object is considered uninitialized
|
||||
and is hidden (in list/watch and get calls) from clients that haven't
|
||||
explicitly asked to observe uninitialized objects. When an object
|
||||
is created, the system will populate this list with the current set
|
||||
of initializers. Only privileged users may set or modify this list.
|
||||
Once it is empty, it may not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be
|
||||
set to nil and the object is considered as initialized and visible
|
||||
to all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with
|
||||
the StatusReason failure. Not all StatusReasons may provide
|
||||
detailed causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the
|
||||
error. If this value is empty there is no information
|
||||
available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the
|
||||
status StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the
|
||||
status StatusReason. On some operations may differ from
|
||||
the requested resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the
|
||||
status StatusReason (when there is a single name which
|
||||
can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation
|
||||
should be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource
|
||||
which can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated
|
||||
by the system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until
|
||||
this reference is removed. Defaults to false. To set this field,
|
||||
a user needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system.
|
||||
Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- Kind is a string value representing the REST resource this object represents.
|
||||
@@ -453,18 +143,6 @@ config_map_list:
|
||||
description:
|
||||
- ''
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -117,7 +117,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -125,8 +125,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
endpoints:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -147,306 +147,6 @@ endpoints:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource will
|
||||
be deleted. This field is set by the server when a graceful deletion is
|
||||
requested by the user, and is not directly settable by a client. The resource
|
||||
is expected to be deleted (no longer visible from resource lists, and
|
||||
not reachable by name) after the time in this field. Once set, this value
|
||||
may not be unset or be set further into the future, although it may be
|
||||
shortened or the resource may be deleted prior to this time. For example,
|
||||
a user may request that a pod is deleted in 30 seconds. The Kubelet will
|
||||
react by sending a graceful termination signal to the containers in the
|
||||
pod. After that 30 seconds, the Kubelet will send a hard termination signal
|
||||
(SIGKILL) to the container and after cleanup, remove the pod from the
|
||||
API. In the presence of network partitions, this object may still exist
|
||||
after this timestamp, until an administrator or automated process can
|
||||
determine the resource is fully terminated. If not set, graceful deletion
|
||||
of the object has not been requested. Populated by the system when a graceful
|
||||
deletion is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired state.
|
||||
Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant at
|
||||
object creation time. This field is a list of initializers that have not
|
||||
yet acted on this object. If nil or empty, this object has been completely
|
||||
initialized. Otherwise, the object is considered uninitialized and is
|
||||
hidden (in list/watch and get calls) from clients that haven't explicitly
|
||||
asked to observe uninitialized objects. When an object is created, the
|
||||
system will populate this list with the current set of initializers. Only
|
||||
privileged users may set or modify this list. Once it is empty, it may
|
||||
not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be set
|
||||
to nil and the object is considered as initialized and visible to
|
||||
all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with the
|
||||
StatusReason failure. Not all StatusReasons may provide detailed
|
||||
causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the error.
|
||||
If this value is empty there is no information available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the status
|
||||
StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the status
|
||||
StatusReason. On some operations may differ from the requested
|
||||
resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the status
|
||||
StatusReason (when there is a single name which can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should
|
||||
be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource which
|
||||
can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the
|
||||
system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until this
|
||||
reference is removed. Defaults to false. To set this field, a user
|
||||
needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
subsets:
|
||||
description:
|
||||
- The set of all endpoints is the union of all subsets. Addresses are placed
|
||||
@@ -485,43 +185,6 @@ endpoints:
|
||||
description:
|
||||
- Reference to object providing the endpoint.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
field_path:
|
||||
description:
|
||||
- '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.'
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- Namespace of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- Specific resourceVersion to which this reference is made, if any.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
not_ready_addresses:
|
||||
description:
|
||||
- IP addresses which offer the related ports but are not currently marked
|
||||
@@ -549,43 +212,6 @@ endpoints:
|
||||
description:
|
||||
- Reference to object providing the endpoint.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
field_path:
|
||||
description:
|
||||
- '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.'
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- Namespace of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- Specific resourceVersion to which this reference is made, if any.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
ports:
|
||||
description:
|
||||
- Port numbers available on the related IP addresses.
|
||||
|
||||
@@ -86,7 +86,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -94,8 +94,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
endpoints_list:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -127,316 +127,6 @@ endpoints_list:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource
|
||||
will be deleted. This field is set by the server when a graceful deletion
|
||||
is requested by the user, and is not directly settable by a client.
|
||||
The resource is expected to be deleted (no longer visible from resource
|
||||
lists, and not reachable by name) after the time in this field. Once
|
||||
set, this value may not be unset or be set further into the future,
|
||||
although it may be shortened or the resource may be deleted prior
|
||||
to this time. For example, a user may request that a pod is deleted
|
||||
in 30 seconds. The Kubelet will react by sending a graceful termination
|
||||
signal to the containers in the pod. After that 30 seconds, the Kubelet
|
||||
will send a hard termination signal (SIGKILL) to the container and
|
||||
after cleanup, remove the pod from the API. In the presence of network
|
||||
partitions, this object may still exist after this timestamp, until
|
||||
an administrator or automated process can determine the resource is
|
||||
fully terminated. If not set, graceful deletion of the object has
|
||||
not been requested. Populated by the system when a graceful deletion
|
||||
is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired
|
||||
state. Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant
|
||||
at object creation time. This field is a list of initializers that
|
||||
have not yet acted on this object. If nil or empty, this object has
|
||||
been completely initialized. Otherwise, the object is considered uninitialized
|
||||
and is hidden (in list/watch and get calls) from clients that haven't
|
||||
explicitly asked to observe uninitialized objects. When an object
|
||||
is created, the system will populate this list with the current set
|
||||
of initializers. Only privileged users may set or modify this list.
|
||||
Once it is empty, it may not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be
|
||||
set to nil and the object is considered as initialized and visible
|
||||
to all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with
|
||||
the StatusReason failure. Not all StatusReasons may provide
|
||||
detailed causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the
|
||||
error. If this value is empty there is no information
|
||||
available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the
|
||||
status StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the
|
||||
status StatusReason. On some operations may differ from
|
||||
the requested resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the
|
||||
status StatusReason (when there is a single name which
|
||||
can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation
|
||||
should be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource
|
||||
which can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated
|
||||
by the system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until
|
||||
this reference is removed. Defaults to false. To set this field,
|
||||
a user needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system.
|
||||
Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
subsets:
|
||||
description:
|
||||
- The set of all endpoints is the union of all subsets. Addresses are placed
|
||||
@@ -475,45 +165,6 @@ endpoints_list:
|
||||
description:
|
||||
- Reference to object providing the endpoint.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
field_path:
|
||||
description:
|
||||
- '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.'
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- Namespace of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- Specific resourceVersion to which this reference is made,
|
||||
if any.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
not_ready_addresses:
|
||||
description:
|
||||
- IP addresses which offer the related ports but are not currently marked
|
||||
@@ -541,45 +192,6 @@ endpoints_list:
|
||||
description:
|
||||
- Reference to object providing the endpoint.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
field_path:
|
||||
description:
|
||||
- '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.'
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- Namespace of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- Specific resourceVersion to which this reference is made,
|
||||
if any.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
ports:
|
||||
description:
|
||||
- Port numbers available on the related IP addresses.
|
||||
@@ -609,18 +221,6 @@ endpoints_list:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -74,13 +74,9 @@ options:
|
||||
involved_object_name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
aliases:
|
||||
- name
|
||||
involved_object_namespace:
|
||||
description:
|
||||
- Namespace of the referent.
|
||||
aliases:
|
||||
- namespace
|
||||
involved_object_resource_version:
|
||||
description:
|
||||
- Specific resourceVersion to which this reference is made, if any.
|
||||
@@ -144,8 +140,6 @@ options:
|
||||
source_host:
|
||||
description:
|
||||
- Node name on which the event is generated.
|
||||
aliases:
|
||||
- host
|
||||
src:
|
||||
description:
|
||||
- Provide a path to a file containing the YAML definition of the object. Mutually
|
||||
@@ -180,7 +174,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -188,8 +182,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
event:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -214,42 +208,6 @@ event:
|
||||
description:
|
||||
- The object that this event is about.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
field_path:
|
||||
description:
|
||||
- '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.'
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- Namespace of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- Specific resourceVersion to which this reference is made, if any.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- Kind is a string value representing the REST resource this object represents.
|
||||
@@ -269,306 +227,6 @@ event:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource will
|
||||
be deleted. This field is set by the server when a graceful deletion is
|
||||
requested by the user, and is not directly settable by a client. The resource
|
||||
is expected to be deleted (no longer visible from resource lists, and
|
||||
not reachable by name) after the time in this field. Once set, this value
|
||||
may not be unset or be set further into the future, although it may be
|
||||
shortened or the resource may be deleted prior to this time. For example,
|
||||
a user may request that a pod is deleted in 30 seconds. The Kubelet will
|
||||
react by sending a graceful termination signal to the containers in the
|
||||
pod. After that 30 seconds, the Kubelet will send a hard termination signal
|
||||
(SIGKILL) to the container and after cleanup, remove the pod from the
|
||||
API. In the presence of network partitions, this object may still exist
|
||||
after this timestamp, until an administrator or automated process can
|
||||
determine the resource is fully terminated. If not set, graceful deletion
|
||||
of the object has not been requested. Populated by the system when a graceful
|
||||
deletion is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired state.
|
||||
Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant at
|
||||
object creation time. This field is a list of initializers that have not
|
||||
yet acted on this object. If nil or empty, this object has been completely
|
||||
initialized. Otherwise, the object is considered uninitialized and is
|
||||
hidden (in list/watch and get calls) from clients that haven't explicitly
|
||||
asked to observe uninitialized objects. When an object is created, the
|
||||
system will populate this list with the current set of initializers. Only
|
||||
privileged users may set or modify this list. Once it is empty, it may
|
||||
not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be set
|
||||
to nil and the object is considered as initialized and visible to
|
||||
all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with the
|
||||
StatusReason failure. Not all StatusReasons may provide detailed
|
||||
causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the error.
|
||||
If this value is empty there is no information available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the status
|
||||
StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the status
|
||||
StatusReason. On some operations may differ from the requested
|
||||
resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the status
|
||||
StatusReason (when there is a single name which can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should
|
||||
be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource which
|
||||
can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the
|
||||
system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until this
|
||||
reference is removed. Defaults to false. To set this field, a user
|
||||
needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- This should be a short, machine understandable string that gives the reason
|
||||
@@ -579,15 +237,6 @@ event:
|
||||
- The component reporting this event. Should be a short machine understandable
|
||||
string.
|
||||
type: complex
|
||||
contains:
|
||||
component:
|
||||
description:
|
||||
- Component from which the event is generated.
|
||||
type: str
|
||||
host:
|
||||
description:
|
||||
- Node name on which the event is generated.
|
||||
type: str
|
||||
type:
|
||||
description:
|
||||
- Type of this event (Normal, Warning), new types could be added in the future
|
||||
|
||||
@@ -86,7 +86,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -94,8 +94,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
event_list:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -131,43 +131,6 @@ event_list:
|
||||
description:
|
||||
- The object that this event is about.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
field_path:
|
||||
description:
|
||||
- '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.'
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- Namespace of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- Specific resourceVersion to which this reference is made, if any.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- Kind is a string value representing the REST resource this object represents.
|
||||
@@ -187,316 +150,6 @@ event_list:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource
|
||||
will be deleted. This field is set by the server when a graceful deletion
|
||||
is requested by the user, and is not directly settable by a client.
|
||||
The resource is expected to be deleted (no longer visible from resource
|
||||
lists, and not reachable by name) after the time in this field. Once
|
||||
set, this value may not be unset or be set further into the future,
|
||||
although it may be shortened or the resource may be deleted prior
|
||||
to this time. For example, a user may request that a pod is deleted
|
||||
in 30 seconds. The Kubelet will react by sending a graceful termination
|
||||
signal to the containers in the pod. After that 30 seconds, the Kubelet
|
||||
will send a hard termination signal (SIGKILL) to the container and
|
||||
after cleanup, remove the pod from the API. In the presence of network
|
||||
partitions, this object may still exist after this timestamp, until
|
||||
an administrator or automated process can determine the resource is
|
||||
fully terminated. If not set, graceful deletion of the object has
|
||||
not been requested. Populated by the system when a graceful deletion
|
||||
is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired
|
||||
state. Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant
|
||||
at object creation time. This field is a list of initializers that
|
||||
have not yet acted on this object. If nil or empty, this object has
|
||||
been completely initialized. Otherwise, the object is considered uninitialized
|
||||
and is hidden (in list/watch and get calls) from clients that haven't
|
||||
explicitly asked to observe uninitialized objects. When an object
|
||||
is created, the system will populate this list with the current set
|
||||
of initializers. Only privileged users may set or modify this list.
|
||||
Once it is empty, it may not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be
|
||||
set to nil and the object is considered as initialized and visible
|
||||
to all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with
|
||||
the StatusReason failure. Not all StatusReasons may provide
|
||||
detailed causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the
|
||||
error. If this value is empty there is no information
|
||||
available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the
|
||||
status StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the
|
||||
status StatusReason. On some operations may differ from
|
||||
the requested resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the
|
||||
status StatusReason (when there is a single name which
|
||||
can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation
|
||||
should be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource
|
||||
which can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated
|
||||
by the system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until
|
||||
this reference is removed. Defaults to false. To set this field,
|
||||
a user needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system.
|
||||
Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- This should be a short, machine understandable string that gives the reason
|
||||
@@ -507,15 +160,6 @@ event_list:
|
||||
- The component reporting this event. Should be a short machine understandable
|
||||
string.
|
||||
type: complex
|
||||
contains:
|
||||
component:
|
||||
description:
|
||||
- Component from which the event is generated.
|
||||
type: str
|
||||
host:
|
||||
description:
|
||||
- Node name on which the event is generated.
|
||||
type: str
|
||||
type:
|
||||
description:
|
||||
- Type of this event (Normal, Warning), new types could be added in the
|
||||
@@ -531,18 +175,6 @@ event_list:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -144,7 +144,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -161,8 +161,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
horizontal_pod_autoscaler:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -183,375 +183,14 @@ horizontal_pod_autoscaler:
|
||||
description:
|
||||
- Standard object metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource will
|
||||
be deleted. This field is set by the server when a graceful deletion is
|
||||
requested by the user, and is not directly settable by a client. The resource
|
||||
is expected to be deleted (no longer visible from resource lists, and
|
||||
not reachable by name) after the time in this field. Once set, this value
|
||||
may not be unset or be set further into the future, although it may be
|
||||
shortened or the resource may be deleted prior to this time. For example,
|
||||
a user may request that a pod is deleted in 30 seconds. The Kubelet will
|
||||
react by sending a graceful termination signal to the containers in the
|
||||
pod. After that 30 seconds, the Kubelet will send a hard termination signal
|
||||
(SIGKILL) to the container and after cleanup, remove the pod from the
|
||||
API. In the presence of network partitions, this object may still exist
|
||||
after this timestamp, until an administrator or automated process can
|
||||
determine the resource is fully terminated. If not set, graceful deletion
|
||||
of the object has not been requested. Populated by the system when a graceful
|
||||
deletion is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired state.
|
||||
Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant at
|
||||
object creation time. This field is a list of initializers that have not
|
||||
yet acted on this object. If nil or empty, this object has been completely
|
||||
initialized. Otherwise, the object is considered uninitialized and is
|
||||
hidden (in list/watch and get calls) from clients that haven't explicitly
|
||||
asked to observe uninitialized objects. When an object is created, the
|
||||
system will populate this list with the current set of initializers. Only
|
||||
privileged users may set or modify this list. Once it is empty, it may
|
||||
not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be set
|
||||
to nil and the object is considered as initialized and visible to
|
||||
all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with the
|
||||
StatusReason failure. Not all StatusReasons may provide detailed
|
||||
causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the error.
|
||||
If this value is empty there is no information available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the status
|
||||
StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the status
|
||||
StatusReason. On some operations may differ from the requested
|
||||
resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the status
|
||||
StatusReason (when there is a single name which can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should
|
||||
be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource which
|
||||
can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the
|
||||
system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until this
|
||||
reference is removed. Defaults to false. To set this field, a user
|
||||
needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
spec:
|
||||
description:
|
||||
- behaviour of autoscaler.
|
||||
type: complex
|
||||
contains:
|
||||
max_replicas:
|
||||
description:
|
||||
- upper limit for the number of pods that can be set by the autoscaler;
|
||||
cannot be smaller than MinReplicas.
|
||||
type: int
|
||||
min_replicas:
|
||||
description:
|
||||
- lower limit for the number of pods that can be set by the autoscaler,
|
||||
default 1.
|
||||
type: int
|
||||
scale_target_ref:
|
||||
description:
|
||||
- reference to scaled resource; horizontal pod autoscaler will learn the
|
||||
current resource consumption and will set the desired number of pods by
|
||||
using its Scale subresource.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent;
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent;
|
||||
type: str
|
||||
target_cpu_utilization_percentage:
|
||||
description:
|
||||
- target average CPU utilization (represented as a percentage of requested
|
||||
CPU) over all the pods; if not specified the default autoscaling policy
|
||||
will be used.
|
||||
type: int
|
||||
status:
|
||||
description:
|
||||
- current information about the autoscaler.
|
||||
type: complex
|
||||
contains:
|
||||
current_cpu_utilization_percentage:
|
||||
description:
|
||||
- current average CPU utilization over all pods, represented as a percentage
|
||||
of requested CPU, e.g. 70 means that an average pod is using now 70% of
|
||||
its requested CPU.
|
||||
type: int
|
||||
current_replicas:
|
||||
description:
|
||||
- current number of replicas of pods managed by this autoscaler.
|
||||
type: int
|
||||
desired_replicas:
|
||||
description:
|
||||
- desired number of replicas of pods managed by this autoscaler.
|
||||
type: int
|
||||
last_scale_time:
|
||||
description:
|
||||
- last time the HorizontalPodAutoscaler scaled the number of pods; used
|
||||
by the autoscaler to control how often the number of pods is changed.
|
||||
type: complex
|
||||
contains: {}
|
||||
observed_generation:
|
||||
description:
|
||||
- most recent generation observed by this autoscaler.
|
||||
type: int
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -86,7 +86,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -94,8 +94,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
horizontal_pod_autoscaler_list:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -127,385 +127,14 @@ horizontal_pod_autoscaler_list:
|
||||
description:
|
||||
- Standard object metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource
|
||||
will be deleted. This field is set by the server when a graceful deletion
|
||||
is requested by the user, and is not directly settable by a client.
|
||||
The resource is expected to be deleted (no longer visible from resource
|
||||
lists, and not reachable by name) after the time in this field. Once
|
||||
set, this value may not be unset or be set further into the future,
|
||||
although it may be shortened or the resource may be deleted prior
|
||||
to this time. For example, a user may request that a pod is deleted
|
||||
in 30 seconds. The Kubelet will react by sending a graceful termination
|
||||
signal to the containers in the pod. After that 30 seconds, the Kubelet
|
||||
will send a hard termination signal (SIGKILL) to the container and
|
||||
after cleanup, remove the pod from the API. In the presence of network
|
||||
partitions, this object may still exist after this timestamp, until
|
||||
an administrator or automated process can determine the resource is
|
||||
fully terminated. If not set, graceful deletion of the object has
|
||||
not been requested. Populated by the system when a graceful deletion
|
||||
is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired
|
||||
state. Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant
|
||||
at object creation time. This field is a list of initializers that
|
||||
have not yet acted on this object. If nil or empty, this object has
|
||||
been completely initialized. Otherwise, the object is considered uninitialized
|
||||
and is hidden (in list/watch and get calls) from clients that haven't
|
||||
explicitly asked to observe uninitialized objects. When an object
|
||||
is created, the system will populate this list with the current set
|
||||
of initializers. Only privileged users may set or modify this list.
|
||||
Once it is empty, it may not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be
|
||||
set to nil and the object is considered as initialized and visible
|
||||
to all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with
|
||||
the StatusReason failure. Not all StatusReasons may provide
|
||||
detailed causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the
|
||||
error. If this value is empty there is no information
|
||||
available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the
|
||||
status StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the
|
||||
status StatusReason. On some operations may differ from
|
||||
the requested resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the
|
||||
status StatusReason (when there is a single name which
|
||||
can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation
|
||||
should be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource
|
||||
which can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated
|
||||
by the system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until
|
||||
this reference is removed. Defaults to false. To set this field,
|
||||
a user needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system.
|
||||
Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
spec:
|
||||
description:
|
||||
- behaviour of autoscaler.
|
||||
type: complex
|
||||
contains:
|
||||
max_replicas:
|
||||
description:
|
||||
- upper limit for the number of pods that can be set by the autoscaler;
|
||||
cannot be smaller than MinReplicas.
|
||||
type: int
|
||||
min_replicas:
|
||||
description:
|
||||
- lower limit for the number of pods that can be set by the autoscaler,
|
||||
default 1.
|
||||
type: int
|
||||
scale_target_ref:
|
||||
description:
|
||||
- reference to scaled resource; horizontal pod autoscaler will learn
|
||||
the current resource consumption and will set the desired number of
|
||||
pods by using its Scale subresource.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent;
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent;
|
||||
type: str
|
||||
target_cpu_utilization_percentage:
|
||||
description:
|
||||
- target average CPU utilization (represented as a percentage of requested
|
||||
CPU) over all the pods; if not specified the default autoscaling policy
|
||||
will be used.
|
||||
type: int
|
||||
status:
|
||||
description:
|
||||
- current information about the autoscaler.
|
||||
type: complex
|
||||
contains:
|
||||
current_cpu_utilization_percentage:
|
||||
description:
|
||||
- current average CPU utilization over all pods, represented as a percentage
|
||||
of requested CPU, e.g. 70 means that an average pod is using now 70%
|
||||
of its requested CPU.
|
||||
type: int
|
||||
current_replicas:
|
||||
description:
|
||||
- current number of replicas of pods managed by this autoscaler.
|
||||
type: int
|
||||
desired_replicas:
|
||||
description:
|
||||
- desired number of replicas of pods managed by this autoscaler.
|
||||
type: int
|
||||
last_scale_time:
|
||||
description:
|
||||
- last time the HorizontalPodAutoscaler scaled the number of pods; used
|
||||
by the autoscaler to control how often the number of pods is changed.
|
||||
type: complex
|
||||
contains: {}
|
||||
observed_generation:
|
||||
description:
|
||||
- most recent generation observed by this autoscaler.
|
||||
type: int
|
||||
kind:
|
||||
description:
|
||||
- Kind is a string value representing the REST resource this object represents.
|
||||
@@ -516,18 +145,6 @@ horizontal_pod_autoscaler_list:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -114,7 +114,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -122,8 +122,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
limit_range:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -144,350 +144,10 @@ limit_range:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource will
|
||||
be deleted. This field is set by the server when a graceful deletion is
|
||||
requested by the user, and is not directly settable by a client. The resource
|
||||
is expected to be deleted (no longer visible from resource lists, and
|
||||
not reachable by name) after the time in this field. Once set, this value
|
||||
may not be unset or be set further into the future, although it may be
|
||||
shortened or the resource may be deleted prior to this time. For example,
|
||||
a user may request that a pod is deleted in 30 seconds. The Kubelet will
|
||||
react by sending a graceful termination signal to the containers in the
|
||||
pod. After that 30 seconds, the Kubelet will send a hard termination signal
|
||||
(SIGKILL) to the container and after cleanup, remove the pod from the
|
||||
API. In the presence of network partitions, this object may still exist
|
||||
after this timestamp, until an administrator or automated process can
|
||||
determine the resource is fully terminated. If not set, graceful deletion
|
||||
of the object has not been requested. Populated by the system when a graceful
|
||||
deletion is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired state.
|
||||
Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant at
|
||||
object creation time. This field is a list of initializers that have not
|
||||
yet acted on this object. If nil or empty, this object has been completely
|
||||
initialized. Otherwise, the object is considered uninitialized and is
|
||||
hidden (in list/watch and get calls) from clients that haven't explicitly
|
||||
asked to observe uninitialized objects. When an object is created, the
|
||||
system will populate this list with the current set of initializers. Only
|
||||
privileged users may set or modify this list. Once it is empty, it may
|
||||
not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be set
|
||||
to nil and the object is considered as initialized and visible to
|
||||
all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with the
|
||||
StatusReason failure. Not all StatusReasons may provide detailed
|
||||
causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the error.
|
||||
If this value is empty there is no information available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the status
|
||||
StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the status
|
||||
StatusReason. On some operations may differ from the requested
|
||||
resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the status
|
||||
StatusReason (when there is a single name which can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should
|
||||
be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource which
|
||||
can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the
|
||||
system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until this
|
||||
reference is removed. Defaults to false. To set this field, a user
|
||||
needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
spec:
|
||||
description:
|
||||
- Spec defines the limits enforced.
|
||||
type: complex
|
||||
contains:
|
||||
limits:
|
||||
description:
|
||||
- Limits is the list of LimitRangeItem objects that are enforced.
|
||||
type: list
|
||||
contains:
|
||||
default:
|
||||
description:
|
||||
- Default resource requirement limit value by resource name if resource
|
||||
limit is omitted.
|
||||
type: complex
|
||||
contains: str, str
|
||||
default_request:
|
||||
description:
|
||||
- DefaultRequest is the default resource requirement request value by
|
||||
resource name if resource request is omitted.
|
||||
type: complex
|
||||
contains: str, str
|
||||
max:
|
||||
description:
|
||||
- Max usage constraints on this kind by resource name.
|
||||
type: complex
|
||||
contains: str, str
|
||||
max_limit_request_ratio:
|
||||
description:
|
||||
- MaxLimitRequestRatio if specified, the named resource must have a
|
||||
request and limit that are both non-zero where limit divided by request
|
||||
is less than or equal to the enumerated value; this represents the
|
||||
max burst for the named resource.
|
||||
type: complex
|
||||
contains: str, str
|
||||
min:
|
||||
description:
|
||||
- Min usage constraints on this kind by resource name.
|
||||
type: complex
|
||||
contains: str, str
|
||||
type:
|
||||
description:
|
||||
- Type of resource that this limit applies to.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -86,7 +86,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -94,8 +94,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
limit_range_list:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -127,360 +127,10 @@ limit_range_list:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource
|
||||
will be deleted. This field is set by the server when a graceful deletion
|
||||
is requested by the user, and is not directly settable by a client.
|
||||
The resource is expected to be deleted (no longer visible from resource
|
||||
lists, and not reachable by name) after the time in this field. Once
|
||||
set, this value may not be unset or be set further into the future,
|
||||
although it may be shortened or the resource may be deleted prior
|
||||
to this time. For example, a user may request that a pod is deleted
|
||||
in 30 seconds. The Kubelet will react by sending a graceful termination
|
||||
signal to the containers in the pod. After that 30 seconds, the Kubelet
|
||||
will send a hard termination signal (SIGKILL) to the container and
|
||||
after cleanup, remove the pod from the API. In the presence of network
|
||||
partitions, this object may still exist after this timestamp, until
|
||||
an administrator or automated process can determine the resource is
|
||||
fully terminated. If not set, graceful deletion of the object has
|
||||
not been requested. Populated by the system when a graceful deletion
|
||||
is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired
|
||||
state. Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant
|
||||
at object creation time. This field is a list of initializers that
|
||||
have not yet acted on this object. If nil or empty, this object has
|
||||
been completely initialized. Otherwise, the object is considered uninitialized
|
||||
and is hidden (in list/watch and get calls) from clients that haven't
|
||||
explicitly asked to observe uninitialized objects. When an object
|
||||
is created, the system will populate this list with the current set
|
||||
of initializers. Only privileged users may set or modify this list.
|
||||
Once it is empty, it may not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be
|
||||
set to nil and the object is considered as initialized and visible
|
||||
to all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with
|
||||
the StatusReason failure. Not all StatusReasons may provide
|
||||
detailed causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the
|
||||
error. If this value is empty there is no information
|
||||
available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the
|
||||
status StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the
|
||||
status StatusReason. On some operations may differ from
|
||||
the requested resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the
|
||||
status StatusReason (when there is a single name which
|
||||
can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation
|
||||
should be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource
|
||||
which can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated
|
||||
by the system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until
|
||||
this reference is removed. Defaults to false. To set this field,
|
||||
a user needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system.
|
||||
Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
spec:
|
||||
description:
|
||||
- Spec defines the limits enforced.
|
||||
type: complex
|
||||
contains:
|
||||
limits:
|
||||
description:
|
||||
- Limits is the list of LimitRangeItem objects that are enforced.
|
||||
type: list
|
||||
contains:
|
||||
default:
|
||||
description:
|
||||
- Default resource requirement limit value by resource name if resource
|
||||
limit is omitted.
|
||||
type: complex
|
||||
contains: str, str
|
||||
default_request:
|
||||
description:
|
||||
- DefaultRequest is the default resource requirement request value
|
||||
by resource name if resource request is omitted.
|
||||
type: complex
|
||||
contains: str, str
|
||||
max:
|
||||
description:
|
||||
- Max usage constraints on this kind by resource name.
|
||||
type: complex
|
||||
contains: str, str
|
||||
max_limit_request_ratio:
|
||||
description:
|
||||
- MaxLimitRequestRatio if specified, the named resource must have
|
||||
a request and limit that are both non-zero where limit divided
|
||||
by request is less than or equal to the enumerated value; this
|
||||
represents the max burst for the named resource.
|
||||
type: complex
|
||||
contains: str, str
|
||||
min:
|
||||
description:
|
||||
- Min usage constraints on this kind by resource name.
|
||||
type: complex
|
||||
contains: str, str
|
||||
type:
|
||||
description:
|
||||
- Type of resource that this limit applies to.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- Kind is a string value representing the REST resource this object represents.
|
||||
@@ -491,18 +141,6 @@ limit_range_list:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -136,6 +136,11 @@ options:
|
||||
- Version is the API Version of the Resource. "*" means all.
|
||||
aliases:
|
||||
- resource_attributes_version
|
||||
spec_uid:
|
||||
description:
|
||||
- UID information about the requesting user.
|
||||
aliases:
|
||||
- uid
|
||||
spec_user:
|
||||
description:
|
||||
- User is the user you're testing for. If you specify "User" but not "Groups",
|
||||
@@ -154,7 +159,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -162,8 +167,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
local_subject_access_review:
|
||||
type: complex
|
||||
returned: on success
|
||||
@@ -183,404 +188,16 @@ local_subject_access_review:
|
||||
metadata:
|
||||
description: []
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource will
|
||||
be deleted. This field is set by the server when a graceful deletion is
|
||||
requested by the user, and is not directly settable by a client. The resource
|
||||
is expected to be deleted (no longer visible from resource lists, and
|
||||
not reachable by name) after the time in this field. Once set, this value
|
||||
may not be unset or be set further into the future, although it may be
|
||||
shortened or the resource may be deleted prior to this time. For example,
|
||||
a user may request that a pod is deleted in 30 seconds. The Kubelet will
|
||||
react by sending a graceful termination signal to the containers in the
|
||||
pod. After that 30 seconds, the Kubelet will send a hard termination signal
|
||||
(SIGKILL) to the container and after cleanup, remove the pod from the
|
||||
API. In the presence of network partitions, this object may still exist
|
||||
after this timestamp, until an administrator or automated process can
|
||||
determine the resource is fully terminated. If not set, graceful deletion
|
||||
of the object has not been requested. Populated by the system when a graceful
|
||||
deletion is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired state.
|
||||
Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant at
|
||||
object creation time. This field is a list of initializers that have not
|
||||
yet acted on this object. If nil or empty, this object has been completely
|
||||
initialized. Otherwise, the object is considered uninitialized and is
|
||||
hidden (in list/watch and get calls) from clients that haven't explicitly
|
||||
asked to observe uninitialized objects. When an object is created, the
|
||||
system will populate this list with the current set of initializers. Only
|
||||
privileged users may set or modify this list. Once it is empty, it may
|
||||
not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be set
|
||||
to nil and the object is considered as initialized and visible to
|
||||
all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with the
|
||||
StatusReason failure. Not all StatusReasons may provide detailed
|
||||
causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the error.
|
||||
If this value is empty there is no information available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the status
|
||||
StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the status
|
||||
StatusReason. On some operations may differ from the requested
|
||||
resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the status
|
||||
StatusReason (when there is a single name which can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should
|
||||
be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource which
|
||||
can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the
|
||||
system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until this
|
||||
reference is removed. Defaults to false. To set this field, a user
|
||||
needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
spec:
|
||||
description:
|
||||
- Spec holds information about the request being evaluated. spec.namespace must
|
||||
be equal to the namespace you made the request against. If empty, it is defaulted.
|
||||
type: complex
|
||||
contains:
|
||||
extra:
|
||||
description:
|
||||
- Extra corresponds to the user.Info.GetExtra() method from the authenticator.
|
||||
Since that is input to the authorizer it needs a reflection here.
|
||||
type: complex
|
||||
contains: str, list[str]
|
||||
groups:
|
||||
description:
|
||||
- Groups is the groups you're testing for.
|
||||
type: list
|
||||
contains: str
|
||||
non_resource_attributes:
|
||||
description:
|
||||
- NonResourceAttributes describes information for a non-resource access
|
||||
request
|
||||
type: complex
|
||||
contains:
|
||||
path:
|
||||
description:
|
||||
- Path is the URL path of the request
|
||||
type: str
|
||||
verb:
|
||||
description:
|
||||
- Verb is the standard HTTP verb
|
||||
type: str
|
||||
resource_attributes:
|
||||
description:
|
||||
- ResourceAuthorizationAttributes describes information for a resource access
|
||||
request
|
||||
type: complex
|
||||
contains:
|
||||
group:
|
||||
description:
|
||||
- Group is the API Group of the Resource. "*" means all.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name is the name of the resource being requested for a "get" or deleted
|
||||
for a "delete". "" (empty) means all.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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
|
||||
type: str
|
||||
resource:
|
||||
description:
|
||||
- Resource is one of the existing resource types. "*" means all.
|
||||
type: str
|
||||
subresource:
|
||||
description:
|
||||
- Subresource is one of the existing resource types. "" means none.
|
||||
type: str
|
||||
verb:
|
||||
description:
|
||||
- 'Verb is a kubernetes resource API verb, like: get, list, watch, create,
|
||||
update, delete, proxy. "*" means all.'
|
||||
type: str
|
||||
version:
|
||||
description:
|
||||
- Version is the API Version of the Resource. "*" means all.
|
||||
type: str
|
||||
user:
|
||||
description:
|
||||
- User is the user you're testing for. If you specify "User" but not "Groups",
|
||||
then is it interpreted as "What if User were not a member of any groups
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- Status is filled in by the server and indicates whether the request is allowed
|
||||
or not
|
||||
type: complex
|
||||
contains:
|
||||
allowed:
|
||||
description:
|
||||
- Allowed is required. True if the action would be allowed, false otherwise.
|
||||
type: bool
|
||||
evaluation_error:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- Reason is optional. It indicates why a request was allowed or denied.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -115,7 +115,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -174,8 +174,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
namespace:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -196,326 +196,14 @@ namespace:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource will
|
||||
be deleted. This field is set by the server when a graceful deletion is
|
||||
requested by the user, and is not directly settable by a client. The resource
|
||||
is expected to be deleted (no longer visible from resource lists, and
|
||||
not reachable by name) after the time in this field. Once set, this value
|
||||
may not be unset or be set further into the future, although it may be
|
||||
shortened or the resource may be deleted prior to this time. For example,
|
||||
a user may request that a pod is deleted in 30 seconds. The Kubelet will
|
||||
react by sending a graceful termination signal to the containers in the
|
||||
pod. After that 30 seconds, the Kubelet will send a hard termination signal
|
||||
(SIGKILL) to the container and after cleanup, remove the pod from the
|
||||
API. In the presence of network partitions, this object may still exist
|
||||
after this timestamp, until an administrator or automated process can
|
||||
determine the resource is fully terminated. If not set, graceful deletion
|
||||
of the object has not been requested. Populated by the system when a graceful
|
||||
deletion is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired state.
|
||||
Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant at
|
||||
object creation time. This field is a list of initializers that have not
|
||||
yet acted on this object. If nil or empty, this object has been completely
|
||||
initialized. Otherwise, the object is considered uninitialized and is
|
||||
hidden (in list/watch and get calls) from clients that haven't explicitly
|
||||
asked to observe uninitialized objects. When an object is created, the
|
||||
system will populate this list with the current set of initializers. Only
|
||||
privileged users may set or modify this list. Once it is empty, it may
|
||||
not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be set
|
||||
to nil and the object is considered as initialized and visible to
|
||||
all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with the
|
||||
StatusReason failure. Not all StatusReasons may provide detailed
|
||||
causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the error.
|
||||
If this value is empty there is no information available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the status
|
||||
StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the status
|
||||
StatusReason. On some operations may differ from the requested
|
||||
resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the status
|
||||
StatusReason (when there is a single name which can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should
|
||||
be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource which
|
||||
can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the
|
||||
system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until this
|
||||
reference is removed. Defaults to false. To set this field, a user
|
||||
needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
spec:
|
||||
description:
|
||||
- Spec defines the behavior of the Namespace.
|
||||
type: complex
|
||||
contains:
|
||||
finalizers:
|
||||
description:
|
||||
- Finalizers is an opaque list of values that must be empty to permanently
|
||||
remove object from storage.
|
||||
type: list
|
||||
contains: str
|
||||
status:
|
||||
description:
|
||||
- Status describes the current status of a Namespace.
|
||||
type: complex
|
||||
contains:
|
||||
phase:
|
||||
description:
|
||||
- Phase is the current lifecycle phase of the namespace.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -86,7 +86,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -94,8 +94,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
namespace_list:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -127,336 +127,14 @@ namespace_list:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource
|
||||
will be deleted. This field is set by the server when a graceful deletion
|
||||
is requested by the user, and is not directly settable by a client.
|
||||
The resource is expected to be deleted (no longer visible from resource
|
||||
lists, and not reachable by name) after the time in this field. Once
|
||||
set, this value may not be unset or be set further into the future,
|
||||
although it may be shortened or the resource may be deleted prior
|
||||
to this time. For example, a user may request that a pod is deleted
|
||||
in 30 seconds. The Kubelet will react by sending a graceful termination
|
||||
signal to the containers in the pod. After that 30 seconds, the Kubelet
|
||||
will send a hard termination signal (SIGKILL) to the container and
|
||||
after cleanup, remove the pod from the API. In the presence of network
|
||||
partitions, this object may still exist after this timestamp, until
|
||||
an administrator or automated process can determine the resource is
|
||||
fully terminated. If not set, graceful deletion of the object has
|
||||
not been requested. Populated by the system when a graceful deletion
|
||||
is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired
|
||||
state. Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant
|
||||
at object creation time. This field is a list of initializers that
|
||||
have not yet acted on this object. If nil or empty, this object has
|
||||
been completely initialized. Otherwise, the object is considered uninitialized
|
||||
and is hidden (in list/watch and get calls) from clients that haven't
|
||||
explicitly asked to observe uninitialized objects. When an object
|
||||
is created, the system will populate this list with the current set
|
||||
of initializers. Only privileged users may set or modify this list.
|
||||
Once it is empty, it may not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be
|
||||
set to nil and the object is considered as initialized and visible
|
||||
to all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with
|
||||
the StatusReason failure. Not all StatusReasons may provide
|
||||
detailed causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the
|
||||
error. If this value is empty there is no information
|
||||
available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the
|
||||
status StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the
|
||||
status StatusReason. On some operations may differ from
|
||||
the requested resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the
|
||||
status StatusReason (when there is a single name which
|
||||
can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation
|
||||
should be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource
|
||||
which can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated
|
||||
by the system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until
|
||||
this reference is removed. Defaults to false. To set this field,
|
||||
a user needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system.
|
||||
Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
spec:
|
||||
description:
|
||||
- Spec defines the behavior of the Namespace.
|
||||
type: complex
|
||||
contains:
|
||||
finalizers:
|
||||
description:
|
||||
- Finalizers is an opaque list of values that must be empty to permanently
|
||||
remove object from storage.
|
||||
type: list
|
||||
contains: str
|
||||
status:
|
||||
description:
|
||||
- Status describes the current status of a Namespace.
|
||||
type: complex
|
||||
contains:
|
||||
phase:
|
||||
description:
|
||||
- Phase is the current lifecycle phase of the namespace.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- Kind is a string value representing the REST resource this object represents.
|
||||
@@ -467,18 +145,6 @@ namespace_list:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -77,6 +77,18 @@ options:
|
||||
- Provide the YAML definition for the object, bypassing any modules parameters
|
||||
intended to define object attributes.
|
||||
type: dict
|
||||
spec_egress:
|
||||
description:
|
||||
- List of egress rules to be applied to the selected pods. Outgoing traffic is
|
||||
allowed if there are no NetworkPolicies selecting the pod (and cluster policy
|
||||
otherwise allows the traffic), OR if the traffic matches at least one egress
|
||||
rule across all of the NetworkPolicy objects whose podSelector matches the pod.
|
||||
If this field is empty then this NetworkPolicy limits all outgoing traffic (and
|
||||
serves solely to ensure that the pods it selects are isolated by default). This
|
||||
field is beta-level in 1.8
|
||||
aliases:
|
||||
- egress
|
||||
type: list
|
||||
spec_ingress:
|
||||
description:
|
||||
- List of ingress rules to be applied to the selected pods. Traffic is allowed
|
||||
@@ -105,6 +117,21 @@ options:
|
||||
aliases:
|
||||
- pod_selector_match_labels
|
||||
type: dict
|
||||
spec_policy_types:
|
||||
description:
|
||||
- List of rule types that the NetworkPolicy relates to. Valid options are Ingress,
|
||||
Egress, or Ingress,Egress. If this field is not specified, it will default based
|
||||
on the existence of Ingress or Egress rules; policies that contain an Egress
|
||||
section are assumed to affect Egress, and all policies (whether or not they
|
||||
contain an Ingress section) are assumed to affect Ingress. If you want to write
|
||||
an egress-only policy, you must explicitly specify policyTypes [ "Egress" ].
|
||||
Likewise, if you want to write a policy that specifies that no egress is allowed,
|
||||
you must specify a policyTypes value that include "Egress" (since such a policy
|
||||
would not include an Egress section and would otherwise default to just [ "Ingress"
|
||||
]). This field is beta-level in 1.8
|
||||
aliases:
|
||||
- policy_types
|
||||
type: list
|
||||
src:
|
||||
description:
|
||||
- Provide a path to a file containing the YAML definition of the object. Mutually
|
||||
@@ -136,7 +163,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -144,8 +171,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
network_policy:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -166,474 +193,10 @@ network_policy:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource will
|
||||
be deleted. This field is set by the server when a graceful deletion is
|
||||
requested by the user, and is not directly settable by a client. The resource
|
||||
is expected to be deleted (no longer visible from resource lists, and
|
||||
not reachable by name) after the time in this field. Once set, this value
|
||||
may not be unset or be set further into the future, although it may be
|
||||
shortened or the resource may be deleted prior to this time. For example,
|
||||
a user may request that a pod is deleted in 30 seconds. The Kubelet will
|
||||
react by sending a graceful termination signal to the containers in the
|
||||
pod. After that 30 seconds, the Kubelet will send a hard termination signal
|
||||
(SIGKILL) to the container and after cleanup, remove the pod from the
|
||||
API. In the presence of network partitions, this object may still exist
|
||||
after this timestamp, until an administrator or automated process can
|
||||
determine the resource is fully terminated. If not set, graceful deletion
|
||||
of the object has not been requested. Populated by the system when a graceful
|
||||
deletion is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired state.
|
||||
Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant at
|
||||
object creation time. This field is a list of initializers that have not
|
||||
yet acted on this object. If nil or empty, this object has been completely
|
||||
initialized. Otherwise, the object is considered uninitialized and is
|
||||
hidden (in list/watch and get calls) from clients that haven't explicitly
|
||||
asked to observe uninitialized objects. When an object is created, the
|
||||
system will populate this list with the current set of initializers. Only
|
||||
privileged users may set or modify this list. Once it is empty, it may
|
||||
not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be set
|
||||
to nil and the object is considered as initialized and visible to
|
||||
all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with the
|
||||
StatusReason failure. Not all StatusReasons may provide detailed
|
||||
causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the error.
|
||||
If this value is empty there is no information available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the status
|
||||
StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the status
|
||||
StatusReason. On some operations may differ from the requested
|
||||
resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the status
|
||||
StatusReason (when there is a single name which can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should
|
||||
be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource which
|
||||
can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the
|
||||
system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until this
|
||||
reference is removed. Defaults to false. To set this field, a user
|
||||
needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
spec:
|
||||
description:
|
||||
- Specification of the desired behavior for this NetworkPolicy.
|
||||
type: complex
|
||||
contains:
|
||||
ingress:
|
||||
description:
|
||||
- List of ingress rules to be applied to the selected pods. Traffic is allowed
|
||||
to a pod if there are no NetworkPolicies selecting the pod (and cluster
|
||||
policy otherwise allows the traffic), OR if the traffic source is the
|
||||
pod's local node, OR if the traffic matches at least one ingress rule
|
||||
across all of the NetworkPolicy objects whose podSelector matches the
|
||||
pod. If this field is empty then this NetworkPolicy does not allow any
|
||||
traffic (and serves solely to ensure that the pods it selects are isolated
|
||||
by default)
|
||||
type: list
|
||||
contains:
|
||||
_from:
|
||||
description:
|
||||
- List of sources which should be able to access the pods selected for
|
||||
this rule. Items in this list are combined using a logical OR operation.
|
||||
If this field is empty or missing, this rule matches all sources (traffic
|
||||
not restricted by source). If this field is present and contains at
|
||||
least on item, this rule allows traffic only if the traffic matches
|
||||
at least one item in the from list.
|
||||
type: list
|
||||
contains:
|
||||
namespace_selector:
|
||||
description:
|
||||
- Selects Namespaces using cluster scoped-labels. This matches all
|
||||
pods in all namespaces selected by this label selector. This field
|
||||
follows standard label selector semantics. If present but empty,
|
||||
this selector selects all namespaces.
|
||||
type: complex
|
||||
contains:
|
||||
match_expressions:
|
||||
description:
|
||||
- matchExpressions is a list of label selector requirements.
|
||||
The requirements are ANDed.
|
||||
type: list
|
||||
contains:
|
||||
key:
|
||||
description:
|
||||
- key is the label key that the selector applies to.
|
||||
type: str
|
||||
operator:
|
||||
description:
|
||||
- operator represents a key's relationship to a set of values.
|
||||
Valid operators ard In, NotIn, Exists and DoesNotExist.
|
||||
type: str
|
||||
values:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
match_labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
pod_selector:
|
||||
description:
|
||||
- This is a label selector which selects Pods in this namespace.
|
||||
This field follows standard label selector semantics. If present
|
||||
but empty, this selector selects all pods in this namespace.
|
||||
type: complex
|
||||
contains:
|
||||
match_expressions:
|
||||
description:
|
||||
- matchExpressions is a list of label selector requirements.
|
||||
The requirements are ANDed.
|
||||
type: list
|
||||
contains:
|
||||
key:
|
||||
description:
|
||||
- key is the label key that the selector applies to.
|
||||
type: str
|
||||
operator:
|
||||
description:
|
||||
- operator represents a key's relationship to a set of values.
|
||||
Valid operators ard In, NotIn, Exists and DoesNotExist.
|
||||
type: str
|
||||
values:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
match_labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
ports:
|
||||
description:
|
||||
- List of ports which should be made accessible on the pods selected
|
||||
for this rule. Each item in this list is combined using a logical
|
||||
OR. If this field is empty or missing, this rule matches all ports
|
||||
(traffic not restricted by port). If this field is present and contains
|
||||
at least one item, then this rule allows traffic only if the traffic
|
||||
matches at least one port in the list.
|
||||
type: list
|
||||
contains:
|
||||
port:
|
||||
description:
|
||||
- The port on the given protocol. This can either be a numerical
|
||||
or named port on a pod. If this field is not provided, this matches
|
||||
all port names and numbers.
|
||||
type: str
|
||||
protocol:
|
||||
description:
|
||||
- The protocol (TCP or UDP) which traffic must match. If not specified,
|
||||
this field defaults to TCP.
|
||||
type: str
|
||||
pod_selector:
|
||||
description:
|
||||
- Selects the pods to which this NetworkPolicy object applies. The array
|
||||
of ingress rules is applied to any pods selected by this field. Multiple
|
||||
network policies can select the same set of pods. In this case, the ingress
|
||||
rules for each are combined additively. This field is NOT optional and
|
||||
follows standard label selector semantics. An empty podSelector matches
|
||||
all pods in this namespace.
|
||||
type: complex
|
||||
contains:
|
||||
match_expressions:
|
||||
description:
|
||||
- matchExpressions is a list of label selector requirements. The requirements
|
||||
are ANDed.
|
||||
type: list
|
||||
contains:
|
||||
key:
|
||||
description:
|
||||
- key is the label key that the selector applies to.
|
||||
type: str
|
||||
operator:
|
||||
description:
|
||||
- operator represents a key's relationship to a set of values. Valid
|
||||
operators ard In, NotIn, Exists and DoesNotExist.
|
||||
type: str
|
||||
values:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
match_labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -86,7 +86,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -94,8 +94,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
network_policy_list:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -127,488 +127,10 @@ network_policy_list:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource
|
||||
will be deleted. This field is set by the server when a graceful deletion
|
||||
is requested by the user, and is not directly settable by a client.
|
||||
The resource is expected to be deleted (no longer visible from resource
|
||||
lists, and not reachable by name) after the time in this field. Once
|
||||
set, this value may not be unset or be set further into the future,
|
||||
although it may be shortened or the resource may be deleted prior
|
||||
to this time. For example, a user may request that a pod is deleted
|
||||
in 30 seconds. The Kubelet will react by sending a graceful termination
|
||||
signal to the containers in the pod. After that 30 seconds, the Kubelet
|
||||
will send a hard termination signal (SIGKILL) to the container and
|
||||
after cleanup, remove the pod from the API. In the presence of network
|
||||
partitions, this object may still exist after this timestamp, until
|
||||
an administrator or automated process can determine the resource is
|
||||
fully terminated. If not set, graceful deletion of the object has
|
||||
not been requested. Populated by the system when a graceful deletion
|
||||
is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired
|
||||
state. Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant
|
||||
at object creation time. This field is a list of initializers that
|
||||
have not yet acted on this object. If nil or empty, this object has
|
||||
been completely initialized. Otherwise, the object is considered uninitialized
|
||||
and is hidden (in list/watch and get calls) from clients that haven't
|
||||
explicitly asked to observe uninitialized objects. When an object
|
||||
is created, the system will populate this list with the current set
|
||||
of initializers. Only privileged users may set or modify this list.
|
||||
Once it is empty, it may not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be
|
||||
set to nil and the object is considered as initialized and visible
|
||||
to all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with
|
||||
the StatusReason failure. Not all StatusReasons may provide
|
||||
detailed causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the
|
||||
error. If this value is empty there is no information
|
||||
available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the
|
||||
status StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the
|
||||
status StatusReason. On some operations may differ from
|
||||
the requested resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the
|
||||
status StatusReason (when there is a single name which
|
||||
can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation
|
||||
should be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource
|
||||
which can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated
|
||||
by the system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until
|
||||
this reference is removed. Defaults to false. To set this field,
|
||||
a user needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system.
|
||||
Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
spec:
|
||||
description:
|
||||
- Specification of the desired behavior for this NetworkPolicy.
|
||||
type: complex
|
||||
contains:
|
||||
ingress:
|
||||
description:
|
||||
- List of ingress rules to be applied to the selected pods. Traffic
|
||||
is allowed to a pod if there are no NetworkPolicies selecting the
|
||||
pod (and cluster policy otherwise allows the traffic), OR if the traffic
|
||||
source is the pod's local node, OR if the traffic matches at least
|
||||
one ingress rule across all of the NetworkPolicy objects whose podSelector
|
||||
matches the pod. If this field is empty then this NetworkPolicy does
|
||||
not allow any traffic (and serves solely to ensure that the pods it
|
||||
selects are isolated by default)
|
||||
type: list
|
||||
contains:
|
||||
_from:
|
||||
description:
|
||||
- List of sources which should be able to access the pods selected
|
||||
for this rule. Items in this list are combined using a logical
|
||||
OR operation. If this field is empty or missing, this rule matches
|
||||
all sources (traffic not restricted by source). If this field
|
||||
is present and contains at least on item, this rule allows traffic
|
||||
only if the traffic matches at least one item in the from list.
|
||||
type: list
|
||||
contains:
|
||||
namespace_selector:
|
||||
description:
|
||||
- Selects Namespaces using cluster scoped-labels. This matches
|
||||
all pods in all namespaces selected by this label selector.
|
||||
This field follows standard label selector semantics. If present
|
||||
but empty, this selector selects all namespaces.
|
||||
type: complex
|
||||
contains:
|
||||
match_expressions:
|
||||
description:
|
||||
- matchExpressions is a list of label selector requirements.
|
||||
The requirements are ANDed.
|
||||
type: list
|
||||
contains:
|
||||
key:
|
||||
description:
|
||||
- key is the label key that the selector applies to.
|
||||
type: str
|
||||
operator:
|
||||
description:
|
||||
- operator represents a key's relationship to a set
|
||||
of values. Valid operators ard In, NotIn, Exists and
|
||||
DoesNotExist.
|
||||
type: str
|
||||
values:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
match_labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
pod_selector:
|
||||
description:
|
||||
- This is a label selector which selects Pods in this namespace.
|
||||
This field follows standard label selector semantics. If present
|
||||
but empty, this selector selects all pods in this namespace.
|
||||
type: complex
|
||||
contains:
|
||||
match_expressions:
|
||||
description:
|
||||
- matchExpressions is a list of label selector requirements.
|
||||
The requirements are ANDed.
|
||||
type: list
|
||||
contains:
|
||||
key:
|
||||
description:
|
||||
- key is the label key that the selector applies to.
|
||||
type: str
|
||||
operator:
|
||||
description:
|
||||
- operator represents a key's relationship to a set
|
||||
of values. Valid operators ard In, NotIn, Exists and
|
||||
DoesNotExist.
|
||||
type: str
|
||||
values:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
match_labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
ports:
|
||||
description:
|
||||
- List of ports which should be made accessible on the pods selected
|
||||
for this rule. Each item in this list is combined using a logical
|
||||
OR. If this field is empty or missing, this rule matches all ports
|
||||
(traffic not restricted by port). If this field is present and
|
||||
contains at least one item, then this rule allows traffic only
|
||||
if the traffic matches at least one port in the list.
|
||||
type: list
|
||||
contains:
|
||||
port:
|
||||
description:
|
||||
- The port on the given protocol. This can either be a numerical
|
||||
or named port on a pod. If this field is not provided, this
|
||||
matches all port names and numbers.
|
||||
type: str
|
||||
protocol:
|
||||
description:
|
||||
- The protocol (TCP or UDP) which traffic must match. If not
|
||||
specified, this field defaults to TCP.
|
||||
type: str
|
||||
pod_selector:
|
||||
description:
|
||||
- Selects the pods to which this NetworkPolicy object applies. The array
|
||||
of ingress rules is applied to any pods selected by this field. Multiple
|
||||
network policies can select the same set of pods. In this case, the
|
||||
ingress rules for each are combined additively. This field is NOT
|
||||
optional and follows standard label selector semantics. An empty podSelector
|
||||
matches all pods in this namespace.
|
||||
type: complex
|
||||
contains:
|
||||
match_expressions:
|
||||
description:
|
||||
- matchExpressions is a list of label selector requirements. The
|
||||
requirements are ANDed.
|
||||
type: list
|
||||
contains:
|
||||
key:
|
||||
description:
|
||||
- key is the label key that the selector applies to.
|
||||
type: str
|
||||
operator:
|
||||
description:
|
||||
- operator represents a key's relationship to a set of values.
|
||||
Valid operators ard In, NotIn, Exists and DoesNotExist.
|
||||
type: str
|
||||
values:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
match_labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
kind:
|
||||
description:
|
||||
- Kind is a string value representing the REST resource this object represents.
|
||||
@@ -619,18 +141,6 @@ network_policy_list:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -77,6 +77,61 @@ options:
|
||||
- Provide the YAML definition for the object, bypassing any modules parameters
|
||||
intended to define object attributes.
|
||||
type: dict
|
||||
spec_config_source_api_version:
|
||||
description:
|
||||
- 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.
|
||||
aliases:
|
||||
- _source_api_version
|
||||
spec_config_source_config_map_ref_api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
aliases:
|
||||
- _source__map_ref_api_version
|
||||
spec_config_source_config_map_ref_field_path:
|
||||
description:
|
||||
- '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.'
|
||||
aliases:
|
||||
- _source__map_ref_field_path
|
||||
spec_config_source_config_map_ref_kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
aliases:
|
||||
- _source__map_ref_kind
|
||||
spec_config_source_config_map_ref_name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
aliases:
|
||||
- _source__map_ref_name
|
||||
spec_config_source_config_map_ref_namespace:
|
||||
description:
|
||||
- Namespace of the referent.
|
||||
aliases:
|
||||
- _source__map_ref_namespace
|
||||
spec_config_source_config_map_ref_resource_version:
|
||||
description:
|
||||
- Specific resourceVersion to which this reference is made, if any.
|
||||
aliases:
|
||||
- _source__map_ref_resource_version
|
||||
spec_config_source_config_map_ref_uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
aliases:
|
||||
- _source__map_ref_uid
|
||||
spec_config_source_kind:
|
||||
description:
|
||||
- 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.
|
||||
aliases:
|
||||
- _source_kind
|
||||
spec_external_id:
|
||||
description:
|
||||
- External ID of the node assigned by some machine database (e.g. a cloud provider).
|
||||
@@ -137,7 +192,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -145,8 +200,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
node:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -167,515 +222,14 @@ node:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource will
|
||||
be deleted. This field is set by the server when a graceful deletion is
|
||||
requested by the user, and is not directly settable by a client. The resource
|
||||
is expected to be deleted (no longer visible from resource lists, and
|
||||
not reachable by name) after the time in this field. Once set, this value
|
||||
may not be unset or be set further into the future, although it may be
|
||||
shortened or the resource may be deleted prior to this time. For example,
|
||||
a user may request that a pod is deleted in 30 seconds. The Kubelet will
|
||||
react by sending a graceful termination signal to the containers in the
|
||||
pod. After that 30 seconds, the Kubelet will send a hard termination signal
|
||||
(SIGKILL) to the container and after cleanup, remove the pod from the
|
||||
API. In the presence of network partitions, this object may still exist
|
||||
after this timestamp, until an administrator or automated process can
|
||||
determine the resource is fully terminated. If not set, graceful deletion
|
||||
of the object has not been requested. Populated by the system when a graceful
|
||||
deletion is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired state.
|
||||
Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant at
|
||||
object creation time. This field is a list of initializers that have not
|
||||
yet acted on this object. If nil or empty, this object has been completely
|
||||
initialized. Otherwise, the object is considered uninitialized and is
|
||||
hidden (in list/watch and get calls) from clients that haven't explicitly
|
||||
asked to observe uninitialized objects. When an object is created, the
|
||||
system will populate this list with the current set of initializers. Only
|
||||
privileged users may set or modify this list. Once it is empty, it may
|
||||
not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be set
|
||||
to nil and the object is considered as initialized and visible to
|
||||
all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with the
|
||||
StatusReason failure. Not all StatusReasons may provide detailed
|
||||
causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the error.
|
||||
If this value is empty there is no information available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the status
|
||||
StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the status
|
||||
StatusReason. On some operations may differ from the requested
|
||||
resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the status
|
||||
StatusReason (when there is a single name which can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should
|
||||
be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource which
|
||||
can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the
|
||||
system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until this
|
||||
reference is removed. Defaults to false. To set this field, a user
|
||||
needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
spec:
|
||||
description:
|
||||
- Spec defines the behavior of a node.
|
||||
type: complex
|
||||
contains:
|
||||
external_id:
|
||||
description:
|
||||
- External ID of the node assigned by some machine database (e.g. a cloud
|
||||
provider). Deprecated.
|
||||
type: str
|
||||
pod_cidr:
|
||||
description:
|
||||
- PodCIDR represents the pod IP range assigned to the node.
|
||||
type: str
|
||||
provider_id:
|
||||
description:
|
||||
- 'ID of the node assigned by the cloud provider in the format: <ProviderName>://<ProviderSpecificNodeID>'
|
||||
type: str
|
||||
taints:
|
||||
description:
|
||||
- If specified, the node's taints.
|
||||
type: list
|
||||
contains:
|
||||
effect:
|
||||
description:
|
||||
- Required. The effect of the taint on pods that do not tolerate the
|
||||
taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.
|
||||
type: str
|
||||
key:
|
||||
description:
|
||||
- Required. The taint key to be applied to a node.
|
||||
type: str
|
||||
time_added:
|
||||
description:
|
||||
- TimeAdded represents the time at which the taint was added. It is
|
||||
only written for NoExecute taints.
|
||||
type: complex
|
||||
contains: {}
|
||||
value:
|
||||
description:
|
||||
- Required. The taint value corresponding to the taint key.
|
||||
type: str
|
||||
unschedulable:
|
||||
description:
|
||||
- Unschedulable controls node schedulability of new pods. By default, node
|
||||
is schedulable.
|
||||
type: bool
|
||||
status:
|
||||
description:
|
||||
- Most recently observed status of the node. Populated by the system. Read-only.
|
||||
type: complex
|
||||
contains:
|
||||
addresses:
|
||||
description:
|
||||
- List of addresses reachable to the node. Queried from cloud provider,
|
||||
if available.
|
||||
type: list
|
||||
contains:
|
||||
address:
|
||||
description:
|
||||
- The node address.
|
||||
type: str
|
||||
type:
|
||||
description:
|
||||
- Node address type, one of Hostname, ExternalIP or InternalIP.
|
||||
type: str
|
||||
allocatable:
|
||||
description:
|
||||
- Allocatable represents the resources of a node that are available for
|
||||
scheduling. Defaults to Capacity.
|
||||
type: complex
|
||||
contains: str, str
|
||||
capacity:
|
||||
description:
|
||||
- Capacity represents the total resources of a node.
|
||||
type: complex
|
||||
contains: str, str
|
||||
conditions:
|
||||
description:
|
||||
- Conditions is an array of current observed node conditions.
|
||||
type: list
|
||||
contains:
|
||||
last_heartbeat_time:
|
||||
description:
|
||||
- Last time we got an update on a given condition.
|
||||
type: complex
|
||||
contains: {}
|
||||
last_transition_time:
|
||||
description:
|
||||
- Last time the condition transit from one status to another.
|
||||
type: complex
|
||||
contains: {}
|
||||
message:
|
||||
description:
|
||||
- Human readable message indicating details about last transition.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- (brief) reason for the condition's last transition.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- Status of the condition, one of True, False, Unknown.
|
||||
type: str
|
||||
type:
|
||||
description:
|
||||
- Type of node condition.
|
||||
type: str
|
||||
daemon_endpoints:
|
||||
description:
|
||||
- Endpoints of daemons running on the Node.
|
||||
type: complex
|
||||
contains:
|
||||
kubelet_endpoint:
|
||||
description:
|
||||
- Endpoint on which Kubelet is listening.
|
||||
type: complex
|
||||
contains:
|
||||
port:
|
||||
description:
|
||||
- Port number of the given endpoint.
|
||||
type: int
|
||||
images:
|
||||
description:
|
||||
- List of container images on this node
|
||||
type: list
|
||||
contains:
|
||||
names:
|
||||
description:
|
||||
- Names by which this image is known. e.g. ["gcr.io/google_containers/hyperkube:v1.0.7",
|
||||
"dockerhub.io/google_containers/hyperkube:v1.0.7"]
|
||||
type: list
|
||||
contains: str
|
||||
size_bytes:
|
||||
description:
|
||||
- The size of the image in bytes.
|
||||
type: int
|
||||
node_info:
|
||||
description:
|
||||
- Set of ids/uuids to uniquely identify the node.
|
||||
type: complex
|
||||
contains:
|
||||
architecture:
|
||||
description:
|
||||
- The Architecture reported by the node
|
||||
type: str
|
||||
boot_id:
|
||||
description:
|
||||
- Boot ID reported by the node.
|
||||
type: str
|
||||
container_runtime_version:
|
||||
description:
|
||||
- ContainerRuntime Version reported by the node through runtime remote
|
||||
API (e.g. docker://1.5.0).
|
||||
type: str
|
||||
kernel_version:
|
||||
description:
|
||||
- Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64).
|
||||
type: str
|
||||
kube_proxy_version:
|
||||
description:
|
||||
- KubeProxy Version reported by the node.
|
||||
type: str
|
||||
kubelet_version:
|
||||
description:
|
||||
- Kubelet Version reported by the node.
|
||||
type: str
|
||||
machine_id:
|
||||
description:
|
||||
- 'MachineID reported by the node. For unique machine identification
|
||||
in the cluster this field is preferred. Learn more from man(5) machine-id:
|
||||
http://man7.org/linux/man-pages/man5/machine-id.5.html'
|
||||
type: str
|
||||
operating_system:
|
||||
description:
|
||||
- The Operating System reported by the node
|
||||
type: str
|
||||
os_image:
|
||||
description:
|
||||
- OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux
|
||||
7 (wheezy)).
|
||||
type: str
|
||||
system_uuid:
|
||||
description:
|
||||
- SystemUUID reported by the node. For unique machine identification
|
||||
MachineID is preferred. This field is specific to Red Hat hosts
|
||||
type: str
|
||||
phase:
|
||||
description:
|
||||
- NodePhase is the recently observed lifecycle phase of the node.
|
||||
type: str
|
||||
volumes_attached:
|
||||
description:
|
||||
- List of volumes that are attached to the node.
|
||||
type: list
|
||||
contains:
|
||||
device_path:
|
||||
description:
|
||||
- DevicePath represents the device path where the volume should be available
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the attached volume
|
||||
type: str
|
||||
volumes_in_use:
|
||||
description:
|
||||
- List of attachable volumes in use (mounted) by the node.
|
||||
type: list
|
||||
contains: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -86,7 +86,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -94,8 +94,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
node_list:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -127,527 +127,14 @@ node_list:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource
|
||||
will be deleted. This field is set by the server when a graceful deletion
|
||||
is requested by the user, and is not directly settable by a client.
|
||||
The resource is expected to be deleted (no longer visible from resource
|
||||
lists, and not reachable by name) after the time in this field. Once
|
||||
set, this value may not be unset or be set further into the future,
|
||||
although it may be shortened or the resource may be deleted prior
|
||||
to this time. For example, a user may request that a pod is deleted
|
||||
in 30 seconds. The Kubelet will react by sending a graceful termination
|
||||
signal to the containers in the pod. After that 30 seconds, the Kubelet
|
||||
will send a hard termination signal (SIGKILL) to the container and
|
||||
after cleanup, remove the pod from the API. In the presence of network
|
||||
partitions, this object may still exist after this timestamp, until
|
||||
an administrator or automated process can determine the resource is
|
||||
fully terminated. If not set, graceful deletion of the object has
|
||||
not been requested. Populated by the system when a graceful deletion
|
||||
is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired
|
||||
state. Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant
|
||||
at object creation time. This field is a list of initializers that
|
||||
have not yet acted on this object. If nil or empty, this object has
|
||||
been completely initialized. Otherwise, the object is considered uninitialized
|
||||
and is hidden (in list/watch and get calls) from clients that haven't
|
||||
explicitly asked to observe uninitialized objects. When an object
|
||||
is created, the system will populate this list with the current set
|
||||
of initializers. Only privileged users may set or modify this list.
|
||||
Once it is empty, it may not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be
|
||||
set to nil and the object is considered as initialized and visible
|
||||
to all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with
|
||||
the StatusReason failure. Not all StatusReasons may provide
|
||||
detailed causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the
|
||||
error. If this value is empty there is no information
|
||||
available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the
|
||||
status StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the
|
||||
status StatusReason. On some operations may differ from
|
||||
the requested resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the
|
||||
status StatusReason (when there is a single name which
|
||||
can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation
|
||||
should be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource
|
||||
which can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated
|
||||
by the system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until
|
||||
this reference is removed. Defaults to false. To set this field,
|
||||
a user needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system.
|
||||
Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
spec:
|
||||
description:
|
||||
- Spec defines the behavior of a node.
|
||||
type: complex
|
||||
contains:
|
||||
external_id:
|
||||
description:
|
||||
- External ID of the node assigned by some machine database (e.g. a
|
||||
cloud provider). Deprecated.
|
||||
type: str
|
||||
pod_cidr:
|
||||
description:
|
||||
- PodCIDR represents the pod IP range assigned to the node.
|
||||
type: str
|
||||
provider_id:
|
||||
description:
|
||||
- 'ID of the node assigned by the cloud provider in the format: <ProviderName>://<ProviderSpecificNodeID>'
|
||||
type: str
|
||||
taints:
|
||||
description:
|
||||
- If specified, the node's taints.
|
||||
type: list
|
||||
contains:
|
||||
effect:
|
||||
description:
|
||||
- Required. The effect of the taint on pods that do not tolerate
|
||||
the taint. Valid effects are NoSchedule, PreferNoSchedule and
|
||||
NoExecute.
|
||||
type: str
|
||||
key:
|
||||
description:
|
||||
- Required. The taint key to be applied to a node.
|
||||
type: str
|
||||
time_added:
|
||||
description:
|
||||
- TimeAdded represents the time at which the taint was added. It
|
||||
is only written for NoExecute taints.
|
||||
type: complex
|
||||
contains: {}
|
||||
value:
|
||||
description:
|
||||
- Required. The taint value corresponding to the taint key.
|
||||
type: str
|
||||
unschedulable:
|
||||
description:
|
||||
- Unschedulable controls node schedulability of new pods. By default,
|
||||
node is schedulable.
|
||||
type: bool
|
||||
status:
|
||||
description:
|
||||
- Most recently observed status of the node. Populated by the system. Read-only.
|
||||
type: complex
|
||||
contains:
|
||||
addresses:
|
||||
description:
|
||||
- List of addresses reachable to the node. Queried from cloud provider,
|
||||
if available.
|
||||
type: list
|
||||
contains:
|
||||
address:
|
||||
description:
|
||||
- The node address.
|
||||
type: str
|
||||
type:
|
||||
description:
|
||||
- Node address type, one of Hostname, ExternalIP or InternalIP.
|
||||
type: str
|
||||
allocatable:
|
||||
description:
|
||||
- Allocatable represents the resources of a node that are available
|
||||
for scheduling. Defaults to Capacity.
|
||||
type: complex
|
||||
contains: str, str
|
||||
capacity:
|
||||
description:
|
||||
- Capacity represents the total resources of a node.
|
||||
type: complex
|
||||
contains: str, str
|
||||
conditions:
|
||||
description:
|
||||
- Conditions is an array of current observed node conditions.
|
||||
type: list
|
||||
contains:
|
||||
last_heartbeat_time:
|
||||
description:
|
||||
- Last time we got an update on a given condition.
|
||||
type: complex
|
||||
contains: {}
|
||||
last_transition_time:
|
||||
description:
|
||||
- Last time the condition transit from one status to another.
|
||||
type: complex
|
||||
contains: {}
|
||||
message:
|
||||
description:
|
||||
- Human readable message indicating details about last transition.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- (brief) reason for the condition's last transition.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- Status of the condition, one of True, False, Unknown.
|
||||
type: str
|
||||
type:
|
||||
description:
|
||||
- Type of node condition.
|
||||
type: str
|
||||
daemon_endpoints:
|
||||
description:
|
||||
- Endpoints of daemons running on the Node.
|
||||
type: complex
|
||||
contains:
|
||||
kubelet_endpoint:
|
||||
description:
|
||||
- Endpoint on which Kubelet is listening.
|
||||
type: complex
|
||||
contains:
|
||||
port:
|
||||
description:
|
||||
- Port number of the given endpoint.
|
||||
type: int
|
||||
images:
|
||||
description:
|
||||
- List of container images on this node
|
||||
type: list
|
||||
contains:
|
||||
names:
|
||||
description:
|
||||
- Names by which this image is known. e.g. ["gcr.io/google_containers/hyperkube:v1.0.7",
|
||||
"dockerhub.io/google_containers/hyperkube:v1.0.7"]
|
||||
type: list
|
||||
contains: str
|
||||
size_bytes:
|
||||
description:
|
||||
- The size of the image in bytes.
|
||||
type: int
|
||||
node_info:
|
||||
description:
|
||||
- Set of ids/uuids to uniquely identify the node.
|
||||
type: complex
|
||||
contains:
|
||||
architecture:
|
||||
description:
|
||||
- The Architecture reported by the node
|
||||
type: str
|
||||
boot_id:
|
||||
description:
|
||||
- Boot ID reported by the node.
|
||||
type: str
|
||||
container_runtime_version:
|
||||
description:
|
||||
- ContainerRuntime Version reported by the node through runtime
|
||||
remote API (e.g. docker://1.5.0).
|
||||
type: str
|
||||
kernel_version:
|
||||
description:
|
||||
- Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64).
|
||||
type: str
|
||||
kube_proxy_version:
|
||||
description:
|
||||
- KubeProxy Version reported by the node.
|
||||
type: str
|
||||
kubelet_version:
|
||||
description:
|
||||
- Kubelet Version reported by the node.
|
||||
type: str
|
||||
machine_id:
|
||||
description:
|
||||
- 'MachineID reported by the node. For unique machine identification
|
||||
in the cluster this field is preferred. Learn more from man(5)
|
||||
machine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html'
|
||||
type: str
|
||||
operating_system:
|
||||
description:
|
||||
- The Operating System reported by the node
|
||||
type: str
|
||||
os_image:
|
||||
description:
|
||||
- OS Image reported by the node from /etc/os-release (e.g. Debian
|
||||
GNU/Linux 7 (wheezy)).
|
||||
type: str
|
||||
system_uuid:
|
||||
description:
|
||||
- SystemUUID reported by the node. For unique machine identification
|
||||
MachineID is preferred. This field is specific to Red Hat hosts
|
||||
type: str
|
||||
phase:
|
||||
description:
|
||||
- NodePhase is the recently observed lifecycle phase of the node.
|
||||
type: str
|
||||
volumes_attached:
|
||||
description:
|
||||
- List of volumes that are attached to the node.
|
||||
type: list
|
||||
contains:
|
||||
device_path:
|
||||
description:
|
||||
- DevicePath represents the device path where the volume should
|
||||
be available
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the attached volume
|
||||
type: str
|
||||
volumes_in_use:
|
||||
description:
|
||||
- List of attachable volumes in use (mounted) by the node.
|
||||
type: list
|
||||
contains: str
|
||||
kind:
|
||||
description:
|
||||
- Kind is a string value representing the REST resource this object represents.
|
||||
@@ -658,18 +145,6 @@ node_list:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -154,7 +154,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -171,8 +171,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
persistent_volume_claim:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -193,399 +193,15 @@ persistent_volume_claim:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource will
|
||||
be deleted. This field is set by the server when a graceful deletion is
|
||||
requested by the user, and is not directly settable by a client. The resource
|
||||
is expected to be deleted (no longer visible from resource lists, and
|
||||
not reachable by name) after the time in this field. Once set, this value
|
||||
may not be unset or be set further into the future, although it may be
|
||||
shortened or the resource may be deleted prior to this time. For example,
|
||||
a user may request that a pod is deleted in 30 seconds. The Kubelet will
|
||||
react by sending a graceful termination signal to the containers in the
|
||||
pod. After that 30 seconds, the Kubelet will send a hard termination signal
|
||||
(SIGKILL) to the container and after cleanup, remove the pod from the
|
||||
API. In the presence of network partitions, this object may still exist
|
||||
after this timestamp, until an administrator or automated process can
|
||||
determine the resource is fully terminated. If not set, graceful deletion
|
||||
of the object has not been requested. Populated by the system when a graceful
|
||||
deletion is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired state.
|
||||
Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant at
|
||||
object creation time. This field is a list of initializers that have not
|
||||
yet acted on this object. If nil or empty, this object has been completely
|
||||
initialized. Otherwise, the object is considered uninitialized and is
|
||||
hidden (in list/watch and get calls) from clients that haven't explicitly
|
||||
asked to observe uninitialized objects. When an object is created, the
|
||||
system will populate this list with the current set of initializers. Only
|
||||
privileged users may set or modify this list. Once it is empty, it may
|
||||
not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be set
|
||||
to nil and the object is considered as initialized and visible to
|
||||
all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with the
|
||||
StatusReason failure. Not all StatusReasons may provide detailed
|
||||
causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the error.
|
||||
If this value is empty there is no information available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the status
|
||||
StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the status
|
||||
StatusReason. On some operations may differ from the requested
|
||||
resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the status
|
||||
StatusReason (when there is a single name which can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should
|
||||
be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource which
|
||||
can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the
|
||||
system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until this
|
||||
reference is removed. Defaults to false. To set this field, a user
|
||||
needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
spec:
|
||||
description:
|
||||
- Spec defines the desired characteristics of a volume requested by a pod author.
|
||||
type: complex
|
||||
contains:
|
||||
access_modes:
|
||||
description:
|
||||
- AccessModes contains the desired access modes the volume should have.
|
||||
type: list
|
||||
contains: str
|
||||
resources:
|
||||
description:
|
||||
- Resources represents the minimum resources the volume should have.
|
||||
type: complex
|
||||
contains:
|
||||
limits:
|
||||
description:
|
||||
- Limits describes the maximum amount of compute resources allowed.
|
||||
type: complex
|
||||
contains: str, str
|
||||
requests:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
selector:
|
||||
description:
|
||||
- A label query over volumes to consider for binding.
|
||||
type: complex
|
||||
contains:
|
||||
match_expressions:
|
||||
description:
|
||||
- matchExpressions is a list of label selector requirements. The requirements
|
||||
are ANDed.
|
||||
type: list
|
||||
contains:
|
||||
key:
|
||||
description:
|
||||
- key is the label key that the selector applies to.
|
||||
type: str
|
||||
operator:
|
||||
description:
|
||||
- operator represents a key's relationship to a set of values. Valid
|
||||
operators ard In, NotIn, Exists and DoesNotExist.
|
||||
type: str
|
||||
values:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
match_labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
storage_class_name:
|
||||
description:
|
||||
- Name of the StorageClass required by the claim.
|
||||
type: str
|
||||
volume_name:
|
||||
description:
|
||||
- VolumeName is the binding reference to the PersistentVolume backing this
|
||||
claim.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- Status represents the current information/status of a persistent volume claim.
|
||||
Read-only.
|
||||
type: complex
|
||||
contains:
|
||||
access_modes:
|
||||
description:
|
||||
- AccessModes contains the actual access modes the volume backing the PVC
|
||||
has.
|
||||
type: list
|
||||
contains: str
|
||||
capacity:
|
||||
description:
|
||||
- Represents the actual resources of the underlying volume.
|
||||
type: complex
|
||||
contains: str, str
|
||||
phase:
|
||||
description:
|
||||
- Phase represents the current phase of PersistentVolumeClaim.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -86,7 +86,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -94,8 +94,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
persistent_volume_claim_list:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -127,411 +127,16 @@ persistent_volume_claim_list:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource
|
||||
will be deleted. This field is set by the server when a graceful deletion
|
||||
is requested by the user, and is not directly settable by a client.
|
||||
The resource is expected to be deleted (no longer visible from resource
|
||||
lists, and not reachable by name) after the time in this field. Once
|
||||
set, this value may not be unset or be set further into the future,
|
||||
although it may be shortened or the resource may be deleted prior
|
||||
to this time. For example, a user may request that a pod is deleted
|
||||
in 30 seconds. The Kubelet will react by sending a graceful termination
|
||||
signal to the containers in the pod. After that 30 seconds, the Kubelet
|
||||
will send a hard termination signal (SIGKILL) to the container and
|
||||
after cleanup, remove the pod from the API. In the presence of network
|
||||
partitions, this object may still exist after this timestamp, until
|
||||
an administrator or automated process can determine the resource is
|
||||
fully terminated. If not set, graceful deletion of the object has
|
||||
not been requested. Populated by the system when a graceful deletion
|
||||
is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired
|
||||
state. Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant
|
||||
at object creation time. This field is a list of initializers that
|
||||
have not yet acted on this object. If nil or empty, this object has
|
||||
been completely initialized. Otherwise, the object is considered uninitialized
|
||||
and is hidden (in list/watch and get calls) from clients that haven't
|
||||
explicitly asked to observe uninitialized objects. When an object
|
||||
is created, the system will populate this list with the current set
|
||||
of initializers. Only privileged users may set or modify this list.
|
||||
Once it is empty, it may not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be
|
||||
set to nil and the object is considered as initialized and visible
|
||||
to all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with
|
||||
the StatusReason failure. Not all StatusReasons may provide
|
||||
detailed causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the
|
||||
error. If this value is empty there is no information
|
||||
available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the
|
||||
status StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the
|
||||
status StatusReason. On some operations may differ from
|
||||
the requested resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the
|
||||
status StatusReason (when there is a single name which
|
||||
can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation
|
||||
should be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource
|
||||
which can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated
|
||||
by the system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until
|
||||
this reference is removed. Defaults to false. To set this field,
|
||||
a user needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system.
|
||||
Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
spec:
|
||||
description:
|
||||
- Spec defines the desired characteristics of a volume requested by a pod
|
||||
author.
|
||||
type: complex
|
||||
contains:
|
||||
access_modes:
|
||||
description:
|
||||
- AccessModes contains the desired access modes the volume should have.
|
||||
type: list
|
||||
contains: str
|
||||
resources:
|
||||
description:
|
||||
- Resources represents the minimum resources the volume should have.
|
||||
type: complex
|
||||
contains:
|
||||
limits:
|
||||
description:
|
||||
- Limits describes the maximum amount of compute resources allowed.
|
||||
type: complex
|
||||
contains: str, str
|
||||
requests:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
selector:
|
||||
description:
|
||||
- A label query over volumes to consider for binding.
|
||||
type: complex
|
||||
contains:
|
||||
match_expressions:
|
||||
description:
|
||||
- matchExpressions is a list of label selector requirements. The
|
||||
requirements are ANDed.
|
||||
type: list
|
||||
contains:
|
||||
key:
|
||||
description:
|
||||
- key is the label key that the selector applies to.
|
||||
type: str
|
||||
operator:
|
||||
description:
|
||||
- operator represents a key's relationship to a set of values.
|
||||
Valid operators ard In, NotIn, Exists and DoesNotExist.
|
||||
type: str
|
||||
values:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
match_labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
storage_class_name:
|
||||
description:
|
||||
- Name of the StorageClass required by the claim.
|
||||
type: str
|
||||
volume_name:
|
||||
description:
|
||||
- VolumeName is the binding reference to the PersistentVolume backing
|
||||
this claim.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- Status represents the current information/status of a persistent volume
|
||||
claim. Read-only.
|
||||
type: complex
|
||||
contains:
|
||||
access_modes:
|
||||
description:
|
||||
- AccessModes contains the actual access modes the volume backing the
|
||||
PVC has.
|
||||
type: list
|
||||
contains: str
|
||||
capacity:
|
||||
description:
|
||||
- Represents the actual resources of the underlying volume.
|
||||
type: complex
|
||||
contains: str, str
|
||||
phase:
|
||||
description:
|
||||
- Phase represents the current phase of PersistentVolumeClaim.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- Kind is a string value representing the REST resource this object represents.
|
||||
@@ -542,18 +147,6 @@ persistent_volume_claim_list:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -121,7 +121,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -129,8 +129,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
resource_quota:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -151,337 +151,14 @@ resource_quota:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource will
|
||||
be deleted. This field is set by the server when a graceful deletion is
|
||||
requested by the user, and is not directly settable by a client. The resource
|
||||
is expected to be deleted (no longer visible from resource lists, and
|
||||
not reachable by name) after the time in this field. Once set, this value
|
||||
may not be unset or be set further into the future, although it may be
|
||||
shortened or the resource may be deleted prior to this time. For example,
|
||||
a user may request that a pod is deleted in 30 seconds. The Kubelet will
|
||||
react by sending a graceful termination signal to the containers in the
|
||||
pod. After that 30 seconds, the Kubelet will send a hard termination signal
|
||||
(SIGKILL) to the container and after cleanup, remove the pod from the
|
||||
API. In the presence of network partitions, this object may still exist
|
||||
after this timestamp, until an administrator or automated process can
|
||||
determine the resource is fully terminated. If not set, graceful deletion
|
||||
of the object has not been requested. Populated by the system when a graceful
|
||||
deletion is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired state.
|
||||
Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant at
|
||||
object creation time. This field is a list of initializers that have not
|
||||
yet acted on this object. If nil or empty, this object has been completely
|
||||
initialized. Otherwise, the object is considered uninitialized and is
|
||||
hidden (in list/watch and get calls) from clients that haven't explicitly
|
||||
asked to observe uninitialized objects. When an object is created, the
|
||||
system will populate this list with the current set of initializers. Only
|
||||
privileged users may set or modify this list. Once it is empty, it may
|
||||
not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be set
|
||||
to nil and the object is considered as initialized and visible to
|
||||
all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with the
|
||||
StatusReason failure. Not all StatusReasons may provide detailed
|
||||
causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the error.
|
||||
If this value is empty there is no information available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the status
|
||||
StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the status
|
||||
StatusReason. On some operations may differ from the requested
|
||||
resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the status
|
||||
StatusReason (when there is a single name which can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should
|
||||
be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource which
|
||||
can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the
|
||||
system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until this
|
||||
reference is removed. Defaults to false. To set this field, a user
|
||||
needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
spec:
|
||||
description:
|
||||
- Spec defines the desired quota.
|
||||
type: complex
|
||||
contains:
|
||||
hard:
|
||||
description:
|
||||
- Hard is the set of desired hard limits for each named resource.
|
||||
type: complex
|
||||
contains: str, str
|
||||
scopes:
|
||||
description:
|
||||
- A collection of filters that must match each object tracked by a quota.
|
||||
If not specified, the quota matches all objects.
|
||||
type: list
|
||||
contains: str
|
||||
status:
|
||||
description:
|
||||
- Status defines the actual enforced quota and its current usage.
|
||||
type: complex
|
||||
contains:
|
||||
hard:
|
||||
description:
|
||||
- Hard is the set of enforced hard limits for each named resource.
|
||||
type: complex
|
||||
contains: str, str
|
||||
used:
|
||||
description:
|
||||
- Used is the current observed total usage of the resource in the namespace.
|
||||
type: complex
|
||||
contains: str, str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -86,7 +86,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -94,8 +94,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
resource_quota_list:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -127,347 +127,14 @@ resource_quota_list:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource
|
||||
will be deleted. This field is set by the server when a graceful deletion
|
||||
is requested by the user, and is not directly settable by a client.
|
||||
The resource is expected to be deleted (no longer visible from resource
|
||||
lists, and not reachable by name) after the time in this field. Once
|
||||
set, this value may not be unset or be set further into the future,
|
||||
although it may be shortened or the resource may be deleted prior
|
||||
to this time. For example, a user may request that a pod is deleted
|
||||
in 30 seconds. The Kubelet will react by sending a graceful termination
|
||||
signal to the containers in the pod. After that 30 seconds, the Kubelet
|
||||
will send a hard termination signal (SIGKILL) to the container and
|
||||
after cleanup, remove the pod from the API. In the presence of network
|
||||
partitions, this object may still exist after this timestamp, until
|
||||
an administrator or automated process can determine the resource is
|
||||
fully terminated. If not set, graceful deletion of the object has
|
||||
not been requested. Populated by the system when a graceful deletion
|
||||
is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired
|
||||
state. Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant
|
||||
at object creation time. This field is a list of initializers that
|
||||
have not yet acted on this object. If nil or empty, this object has
|
||||
been completely initialized. Otherwise, the object is considered uninitialized
|
||||
and is hidden (in list/watch and get calls) from clients that haven't
|
||||
explicitly asked to observe uninitialized objects. When an object
|
||||
is created, the system will populate this list with the current set
|
||||
of initializers. Only privileged users may set or modify this list.
|
||||
Once it is empty, it may not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be
|
||||
set to nil and the object is considered as initialized and visible
|
||||
to all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with
|
||||
the StatusReason failure. Not all StatusReasons may provide
|
||||
detailed causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the
|
||||
error. If this value is empty there is no information
|
||||
available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the
|
||||
status StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the
|
||||
status StatusReason. On some operations may differ from
|
||||
the requested resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the
|
||||
status StatusReason (when there is a single name which
|
||||
can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation
|
||||
should be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource
|
||||
which can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated
|
||||
by the system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until
|
||||
this reference is removed. Defaults to false. To set this field,
|
||||
a user needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system.
|
||||
Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
spec:
|
||||
description:
|
||||
- Spec defines the desired quota.
|
||||
type: complex
|
||||
contains:
|
||||
hard:
|
||||
description:
|
||||
- Hard is the set of desired hard limits for each named resource.
|
||||
type: complex
|
||||
contains: str, str
|
||||
scopes:
|
||||
description:
|
||||
- A collection of filters that must match each object tracked by a quota.
|
||||
If not specified, the quota matches all objects.
|
||||
type: list
|
||||
contains: str
|
||||
status:
|
||||
description:
|
||||
- Status defines the actual enforced quota and its current usage.
|
||||
type: complex
|
||||
contains:
|
||||
hard:
|
||||
description:
|
||||
- Hard is the set of enforced hard limits for each named resource.
|
||||
type: complex
|
||||
contains: str, str
|
||||
used:
|
||||
description:
|
||||
- Used is the current observed total usage of the resource in the namespace.
|
||||
type: complex
|
||||
contains: str, str
|
||||
kind:
|
||||
description:
|
||||
- Kind is a string value representing the REST resource this object represents.
|
||||
@@ -478,18 +145,6 @@ resource_quota_list:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
202
library/k8s_v1_role.py
Normal file
202
library/k8s_v1_role.py
Normal file
@@ -0,0 +1,202 @@
|
||||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
from ansible.module_utils.k8s_common import KubernetesAnsibleModule, KubernetesAnsibleException
|
||||
|
||||
DOCUMENTATION = '''
|
||||
module: k8s_v1_role
|
||||
short_description: Kubernetes Role
|
||||
description:
|
||||
- Manage the lifecycle of a role object. Supports check mode, and attempts to to be
|
||||
idempotent.
|
||||
version_added: 2.3.0
|
||||
author: OpenShift (@openshift)
|
||||
options:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: dict
|
||||
api_key:
|
||||
description:
|
||||
- Token used to connect to the API.
|
||||
cert_file:
|
||||
description:
|
||||
- Path to a certificate used to authenticate with the API.
|
||||
type: path
|
||||
context:
|
||||
description:
|
||||
- The name of a context found in the Kubernetes config file.
|
||||
debug:
|
||||
description:
|
||||
- Enable debug output from the OpenShift helper. Logging info is written to KubeObjHelper.log
|
||||
default: false
|
||||
type: bool
|
||||
force:
|
||||
description:
|
||||
- If set to C(True), and I(state) is C(present), an existing object will updated,
|
||||
and lists will be replaced, rather than merged.
|
||||
default: false
|
||||
type: bool
|
||||
host:
|
||||
description:
|
||||
- Provide a URL for acessing the Kubernetes API.
|
||||
key_file:
|
||||
description:
|
||||
- Path to a key file used to authenticate with the API.
|
||||
type: path
|
||||
kubeconfig:
|
||||
description:
|
||||
- Path to an existing Kubernetes config file. If not provided, and no other connection
|
||||
options are provided, the openshift client will attempt to load the default
|
||||
configuration file from I(~/.kube/config.json).
|
||||
type: path
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: dict
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
password:
|
||||
description:
|
||||
- Provide a password for connecting to the API. Use in conjunction with I(username).
|
||||
resource_definition:
|
||||
description:
|
||||
- Provide the YAML definition for the object, bypassing any modules parameters
|
||||
intended to define object attributes.
|
||||
type: dict
|
||||
rules:
|
||||
description:
|
||||
- Rules holds all the PolicyRules for this Role
|
||||
type: list
|
||||
src:
|
||||
description:
|
||||
- Provide a path to a file containing the YAML definition of the object. Mutually
|
||||
exclusive with I(resource_definition).
|
||||
type: path
|
||||
ssl_ca_cert:
|
||||
description:
|
||||
- Path to a CA certificate used to authenticate with the API.
|
||||
type: path
|
||||
state:
|
||||
description:
|
||||
- Determines if an object should be created, patched, or deleted. When set to
|
||||
C(present), the object will be created, if it does not exist, or patched, if
|
||||
parameter values differ from the existing object's attributes, and deleted,
|
||||
if set to C(absent). A patch operation results in merging lists and updating
|
||||
dictionaries, with lists being merged into a unique set of values. If a list
|
||||
contains a dictionary with a I(name) or I(type) attribute, a strategic merge
|
||||
is performed, where individual elements with a matching I(name_) or I(type)
|
||||
are merged. To force the replacement of lists, set the I(force) option to C(True).
|
||||
default: present
|
||||
choices:
|
||||
- present
|
||||
- absent
|
||||
username:
|
||||
description:
|
||||
- Provide a username for connecting to the API.
|
||||
verify_ssl:
|
||||
description:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
description: Requested API version
|
||||
type: string
|
||||
role:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
rules:
|
||||
description:
|
||||
- Rules holds all the PolicyRules for this Role
|
||||
type: list
|
||||
contains:
|
||||
api_groups:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
non_resource_ur_ls:
|
||||
description:
|
||||
- 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 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.
|
||||
type: list
|
||||
contains: str
|
||||
resource_names:
|
||||
description:
|
||||
- ResourceNames is an optional white list of names that the rule applies
|
||||
to. An empty set means that everything is allowed.
|
||||
type: list
|
||||
contains: str
|
||||
resources:
|
||||
description:
|
||||
- Resources is a list of resources this rule applies to. ResourceAll represents
|
||||
all resources.
|
||||
type: list
|
||||
contains: str
|
||||
verbs:
|
||||
description:
|
||||
- Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions
|
||||
contained in this rule. VerbAll represents all kinds.
|
||||
type: list
|
||||
contains: str
|
||||
'''
|
||||
|
||||
|
||||
def main():
|
||||
try:
|
||||
module = KubernetesAnsibleModule('role', 'v1')
|
||||
except KubernetesAnsibleException as exc:
|
||||
# The helper failed to init, so there is no module object. All we can do is raise the error.
|
||||
raise Exception(exc.message)
|
||||
|
||||
try:
|
||||
module.execute_module()
|
||||
except KubernetesAnsibleException as exc:
|
||||
module.fail_json(msg="Module failed!", error=str(exc))
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
208
library/k8s_v1_role_binding.py
Normal file
208
library/k8s_v1_role_binding.py
Normal file
@@ -0,0 +1,208 @@
|
||||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
from ansible.module_utils.k8s_common import KubernetesAnsibleModule, KubernetesAnsibleException
|
||||
|
||||
DOCUMENTATION = '''
|
||||
module: k8s_v1_role_binding
|
||||
short_description: Kubernetes RoleBinding
|
||||
description:
|
||||
- Manage the lifecycle of a role_binding object. Supports check mode, and attempts
|
||||
to to be idempotent.
|
||||
version_added: 2.3.0
|
||||
author: OpenShift (@openshift)
|
||||
options:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: dict
|
||||
api_key:
|
||||
description:
|
||||
- Token used to connect to the API.
|
||||
cert_file:
|
||||
description:
|
||||
- Path to a certificate used to authenticate with the API.
|
||||
type: path
|
||||
context:
|
||||
description:
|
||||
- The name of a context found in the Kubernetes config file.
|
||||
debug:
|
||||
description:
|
||||
- Enable debug output from the OpenShift helper. Logging info is written to KubeObjHelper.log
|
||||
default: false
|
||||
type: bool
|
||||
force:
|
||||
description:
|
||||
- If set to C(True), and I(state) is C(present), an existing object will updated,
|
||||
and lists will be replaced, rather than merged.
|
||||
default: false
|
||||
type: bool
|
||||
host:
|
||||
description:
|
||||
- Provide a URL for acessing the Kubernetes API.
|
||||
key_file:
|
||||
description:
|
||||
- Path to a key file used to authenticate with the API.
|
||||
type: path
|
||||
kubeconfig:
|
||||
description:
|
||||
- Path to an existing Kubernetes config file. If not provided, and no other connection
|
||||
options are provided, the openshift client will attempt to load the default
|
||||
configuration file from I(~/.kube/config.json).
|
||||
type: path
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: dict
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
password:
|
||||
description:
|
||||
- Provide a password for connecting to the API. Use in conjunction with I(username).
|
||||
resource_definition:
|
||||
description:
|
||||
- Provide the YAML definition for the object, bypassing any modules parameters
|
||||
intended to define object attributes.
|
||||
type: dict
|
||||
role_ref_api_group:
|
||||
description:
|
||||
- APIGroup is the group for the resource being referenced
|
||||
aliases:
|
||||
- api_group
|
||||
role_ref_kind:
|
||||
description:
|
||||
- Kind is the type of resource being referenced
|
||||
aliases:
|
||||
- kind
|
||||
role_ref_name:
|
||||
description:
|
||||
- Name is the name of resource being referenced
|
||||
src:
|
||||
description:
|
||||
- Provide a path to a file containing the YAML definition of the object. Mutually
|
||||
exclusive with I(resource_definition).
|
||||
type: path
|
||||
ssl_ca_cert:
|
||||
description:
|
||||
- Path to a CA certificate used to authenticate with the API.
|
||||
type: path
|
||||
state:
|
||||
description:
|
||||
- Determines if an object should be created, patched, or deleted. When set to
|
||||
C(present), the object will be created, if it does not exist, or patched, if
|
||||
parameter values differ from the existing object's attributes, and deleted,
|
||||
if set to C(absent). A patch operation results in merging lists and updating
|
||||
dictionaries, with lists being merged into a unique set of values. If a list
|
||||
contains a dictionary with a I(name) or I(type) attribute, a strategic merge
|
||||
is performed, where individual elements with a matching I(name_) or I(type)
|
||||
are merged. To force the replacement of lists, set the I(force) option to C(True).
|
||||
default: present
|
||||
choices:
|
||||
- present
|
||||
- absent
|
||||
subjects:
|
||||
description:
|
||||
- Subjects holds references to the objects the role applies to.
|
||||
type: list
|
||||
username:
|
||||
description:
|
||||
- Provide a username for connecting to the API.
|
||||
verify_ssl:
|
||||
description:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
description: Requested API version
|
||||
type: string
|
||||
role_binding:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
role_ref:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
subjects:
|
||||
description:
|
||||
- Subjects holds references to the objects the role applies to.
|
||||
type: list
|
||||
contains:
|
||||
api_group:
|
||||
description:
|
||||
- APIGroup holds the API group of the referenced subject. Defaults to ""
|
||||
for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for
|
||||
User and Group subjects.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the object being referenced.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
def main():
|
||||
try:
|
||||
module = KubernetesAnsibleModule('role_binding', 'v1')
|
||||
except KubernetesAnsibleException as exc:
|
||||
# The helper failed to init, so there is no module object. All we can do is raise the error.
|
||||
raise Exception(exc.message)
|
||||
|
||||
try:
|
||||
module.execute_module()
|
||||
except KubernetesAnsibleException as exc:
|
||||
module.fail_json(msg="Module failed!", error=str(exc))
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
190
library/k8s_v1_role_binding_list.py
Normal file
190
library/k8s_v1_role_binding_list.py
Normal file
@@ -0,0 +1,190 @@
|
||||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
from ansible.module_utils.k8s_common import KubernetesAnsibleModule, KubernetesAnsibleException
|
||||
|
||||
DOCUMENTATION = '''
|
||||
module: k8s_v1_role_binding_list
|
||||
short_description: Kubernetes RoleBindingList
|
||||
description:
|
||||
- Retrieve a list of role_bindings. List operations provide a snapshot read of the
|
||||
underlying objects, returning a resource_version representing a consistent version
|
||||
of the listed objects.
|
||||
version_added: 2.3.0
|
||||
author: OpenShift (@openshift)
|
||||
options:
|
||||
api_key:
|
||||
description:
|
||||
- Token used to connect to the API.
|
||||
cert_file:
|
||||
description:
|
||||
- Path to a certificate used to authenticate with the API.
|
||||
type: path
|
||||
context:
|
||||
description:
|
||||
- The name of a context found in the Kubernetes config file.
|
||||
debug:
|
||||
description:
|
||||
- Enable debug output from the OpenShift helper. Logging info is written to KubeObjHelper.log
|
||||
default: false
|
||||
type: bool
|
||||
force:
|
||||
description:
|
||||
- If set to C(True), and I(state) is C(present), an existing object will updated,
|
||||
and lists will be replaced, rather than merged.
|
||||
default: false
|
||||
type: bool
|
||||
host:
|
||||
description:
|
||||
- Provide a URL for acessing the Kubernetes API.
|
||||
key_file:
|
||||
description:
|
||||
- Path to a key file used to authenticate with the API.
|
||||
type: path
|
||||
kubeconfig:
|
||||
description:
|
||||
- Path to an existing Kubernetes config file. If not provided, and no other connection
|
||||
options are provided, the openshift client will attempt to load the default
|
||||
configuration file from I(~/.kube/config.json).
|
||||
type: path
|
||||
password:
|
||||
description:
|
||||
- Provide a password for connecting to the API. Use in conjunction with I(username).
|
||||
resource_definition:
|
||||
description:
|
||||
- Provide the YAML definition for the object, bypassing any modules parameters
|
||||
intended to define object attributes.
|
||||
type: dict
|
||||
src:
|
||||
description:
|
||||
- Provide a path to a file containing the YAML definition of the object. Mutually
|
||||
exclusive with I(resource_definition).
|
||||
type: path
|
||||
ssl_ca_cert:
|
||||
description:
|
||||
- Path to a CA certificate used to authenticate with the API.
|
||||
type: path
|
||||
state:
|
||||
description:
|
||||
- Determines if an object should be created, patched, or deleted. When set to
|
||||
C(present), the object will be created, if it does not exist, or patched, if
|
||||
parameter values differ from the existing object's attributes, and deleted,
|
||||
if set to C(absent). A patch operation results in merging lists and updating
|
||||
dictionaries, with lists being merged into a unique set of values. If a list
|
||||
contains a dictionary with a I(name) or I(type) attribute, a strategic merge
|
||||
is performed, where individual elements with a matching I(name_) or I(type)
|
||||
are merged. To force the replacement of lists, set the I(force) option to C(True).
|
||||
default: present
|
||||
choices:
|
||||
- present
|
||||
- absent
|
||||
username:
|
||||
description:
|
||||
- Provide a username for connecting to the API.
|
||||
verify_ssl:
|
||||
description:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
description: Requested API version
|
||||
type: string
|
||||
role_binding_list:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
items:
|
||||
description:
|
||||
- Items is a list of RoleBindings
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
role_ref:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
subjects:
|
||||
description:
|
||||
- Subjects holds references to the objects the role applies to.
|
||||
type: list
|
||||
contains:
|
||||
api_group:
|
||||
description:
|
||||
- APIGroup holds the API group of the referenced subject. Defaults to
|
||||
"" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io"
|
||||
for User and Group subjects.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the object being referenced.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
'''
|
||||
|
||||
|
||||
def main():
|
||||
try:
|
||||
module = KubernetesAnsibleModule('role_binding_list', 'v1')
|
||||
except KubernetesAnsibleException as exc:
|
||||
# The helper failed to init, so there is no module object. All we can do is raise the error.
|
||||
raise Exception(exc.message)
|
||||
|
||||
try:
|
||||
module.execute_module()
|
||||
except KubernetesAnsibleException as exc:
|
||||
module.fail_json(msg="Module failed!", error=str(exc))
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
197
library/k8s_v1_role_list.py
Normal file
197
library/k8s_v1_role_list.py
Normal file
@@ -0,0 +1,197 @@
|
||||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
from ansible.module_utils.k8s_common import KubernetesAnsibleModule, KubernetesAnsibleException
|
||||
|
||||
DOCUMENTATION = '''
|
||||
module: k8s_v1_role_list
|
||||
short_description: Kubernetes RoleList
|
||||
description:
|
||||
- Retrieve a list of roles. List operations provide a snapshot read of the underlying
|
||||
objects, returning a resource_version representing a consistent version of the listed
|
||||
objects.
|
||||
version_added: 2.3.0
|
||||
author: OpenShift (@openshift)
|
||||
options:
|
||||
api_key:
|
||||
description:
|
||||
- Token used to connect to the API.
|
||||
cert_file:
|
||||
description:
|
||||
- Path to a certificate used to authenticate with the API.
|
||||
type: path
|
||||
context:
|
||||
description:
|
||||
- The name of a context found in the Kubernetes config file.
|
||||
debug:
|
||||
description:
|
||||
- Enable debug output from the OpenShift helper. Logging info is written to KubeObjHelper.log
|
||||
default: false
|
||||
type: bool
|
||||
force:
|
||||
description:
|
||||
- If set to C(True), and I(state) is C(present), an existing object will updated,
|
||||
and lists will be replaced, rather than merged.
|
||||
default: false
|
||||
type: bool
|
||||
host:
|
||||
description:
|
||||
- Provide a URL for acessing the Kubernetes API.
|
||||
key_file:
|
||||
description:
|
||||
- Path to a key file used to authenticate with the API.
|
||||
type: path
|
||||
kubeconfig:
|
||||
description:
|
||||
- Path to an existing Kubernetes config file. If not provided, and no other connection
|
||||
options are provided, the openshift client will attempt to load the default
|
||||
configuration file from I(~/.kube/config.json).
|
||||
type: path
|
||||
password:
|
||||
description:
|
||||
- Provide a password for connecting to the API. Use in conjunction with I(username).
|
||||
resource_definition:
|
||||
description:
|
||||
- Provide the YAML definition for the object, bypassing any modules parameters
|
||||
intended to define object attributes.
|
||||
type: dict
|
||||
src:
|
||||
description:
|
||||
- Provide a path to a file containing the YAML definition of the object. Mutually
|
||||
exclusive with I(resource_definition).
|
||||
type: path
|
||||
ssl_ca_cert:
|
||||
description:
|
||||
- Path to a CA certificate used to authenticate with the API.
|
||||
type: path
|
||||
state:
|
||||
description:
|
||||
- Determines if an object should be created, patched, or deleted. When set to
|
||||
C(present), the object will be created, if it does not exist, or patched, if
|
||||
parameter values differ from the existing object's attributes, and deleted,
|
||||
if set to C(absent). A patch operation results in merging lists and updating
|
||||
dictionaries, with lists being merged into a unique set of values. If a list
|
||||
contains a dictionary with a I(name) or I(type) attribute, a strategic merge
|
||||
is performed, where individual elements with a matching I(name_) or I(type)
|
||||
are merged. To force the replacement of lists, set the I(force) option to C(True).
|
||||
default: present
|
||||
choices:
|
||||
- present
|
||||
- absent
|
||||
username:
|
||||
description:
|
||||
- Provide a username for connecting to the API.
|
||||
verify_ssl:
|
||||
description:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
description: Requested API version
|
||||
type: string
|
||||
role_list:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
items:
|
||||
description:
|
||||
- Items is a list of Roles
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
rules:
|
||||
description:
|
||||
- Rules holds all the PolicyRules for this Role
|
||||
type: list
|
||||
contains:
|
||||
api_groups:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
non_resource_ur_ls:
|
||||
description:
|
||||
- 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 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.
|
||||
type: list
|
||||
contains: str
|
||||
resource_names:
|
||||
description:
|
||||
- ResourceNames is an optional white list of names that the rule applies
|
||||
to. An empty set means that everything is allowed.
|
||||
type: list
|
||||
contains: str
|
||||
resources:
|
||||
description:
|
||||
- Resources is a list of resources this rule applies to. ResourceAll
|
||||
represents all resources.
|
||||
type: list
|
||||
contains: str
|
||||
verbs:
|
||||
description:
|
||||
- Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions
|
||||
contained in this rule. VerbAll represents all kinds.
|
||||
type: list
|
||||
contains: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
'''
|
||||
|
||||
|
||||
def main():
|
||||
try:
|
||||
module = KubernetesAnsibleModule('role_list', 'v1')
|
||||
except KubernetesAnsibleException as exc:
|
||||
# The helper failed to init, so there is no module object. All we can do is raise the error.
|
||||
raise Exception(exc.message)
|
||||
|
||||
try:
|
||||
module.execute_module()
|
||||
except KubernetesAnsibleException as exc:
|
||||
module.fail_json(msg="Module failed!", error=str(exc))
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
@@ -90,7 +90,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -98,8 +98,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
scale:
|
||||
type: complex
|
||||
returned: on success
|
||||
@@ -120,331 +120,14 @@ scale:
|
||||
description:
|
||||
- Standard object metadata;
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource will
|
||||
be deleted. This field is set by the server when a graceful deletion is
|
||||
requested by the user, and is not directly settable by a client. The resource
|
||||
is expected to be deleted (no longer visible from resource lists, and
|
||||
not reachable by name) after the time in this field. Once set, this value
|
||||
may not be unset or be set further into the future, although it may be
|
||||
shortened or the resource may be deleted prior to this time. For example,
|
||||
a user may request that a pod is deleted in 30 seconds. The Kubelet will
|
||||
react by sending a graceful termination signal to the containers in the
|
||||
pod. After that 30 seconds, the Kubelet will send a hard termination signal
|
||||
(SIGKILL) to the container and after cleanup, remove the pod from the
|
||||
API. In the presence of network partitions, this object may still exist
|
||||
after this timestamp, until an administrator or automated process can
|
||||
determine the resource is fully terminated. If not set, graceful deletion
|
||||
of the object has not been requested. Populated by the system when a graceful
|
||||
deletion is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired state.
|
||||
Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant at
|
||||
object creation time. This field is a list of initializers that have not
|
||||
yet acted on this object. If nil or empty, this object has been completely
|
||||
initialized. Otherwise, the object is considered uninitialized and is
|
||||
hidden (in list/watch and get calls) from clients that haven't explicitly
|
||||
asked to observe uninitialized objects. When an object is created, the
|
||||
system will populate this list with the current set of initializers. Only
|
||||
privileged users may set or modify this list. Once it is empty, it may
|
||||
not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be set
|
||||
to nil and the object is considered as initialized and visible to
|
||||
all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with the
|
||||
StatusReason failure. Not all StatusReasons may provide detailed
|
||||
causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the error.
|
||||
If this value is empty there is no information available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the status
|
||||
StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the status
|
||||
StatusReason. On some operations may differ from the requested
|
||||
resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the status
|
||||
StatusReason (when there is a single name which can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should
|
||||
be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource which
|
||||
can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the
|
||||
system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until this
|
||||
reference is removed. Defaults to false. To set this field, a user
|
||||
needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
spec:
|
||||
description:
|
||||
- defines the behavior of the scale.
|
||||
type: complex
|
||||
contains:
|
||||
replicas:
|
||||
description:
|
||||
- desired number of instances for the scaled object.
|
||||
type: int
|
||||
status:
|
||||
description:
|
||||
- current status of the scale.
|
||||
type: complex
|
||||
contains:
|
||||
replicas:
|
||||
description:
|
||||
- actual number of observed instances of the scaled object.
|
||||
type: int
|
||||
selector:
|
||||
description:
|
||||
- 'label query over pods that should match the replicas count. This is same
|
||||
as the label selector but in the string format to avoid introspection
|
||||
by clients. The string will be in the same format as the query-param syntax.
|
||||
More info about label selectors: http://kubernetes.io/docs/user-guide/labels'
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -125,7 +125,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -133,8 +133,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
secret:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -163,306 +163,6 @@ secret:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource will
|
||||
be deleted. This field is set by the server when a graceful deletion is
|
||||
requested by the user, and is not directly settable by a client. The resource
|
||||
is expected to be deleted (no longer visible from resource lists, and
|
||||
not reachable by name) after the time in this field. Once set, this value
|
||||
may not be unset or be set further into the future, although it may be
|
||||
shortened or the resource may be deleted prior to this time. For example,
|
||||
a user may request that a pod is deleted in 30 seconds. The Kubelet will
|
||||
react by sending a graceful termination signal to the containers in the
|
||||
pod. After that 30 seconds, the Kubelet will send a hard termination signal
|
||||
(SIGKILL) to the container and after cleanup, remove the pod from the
|
||||
API. In the presence of network partitions, this object may still exist
|
||||
after this timestamp, until an administrator or automated process can
|
||||
determine the resource is fully terminated. If not set, graceful deletion
|
||||
of the object has not been requested. Populated by the system when a graceful
|
||||
deletion is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired state.
|
||||
Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant at
|
||||
object creation time. This field is a list of initializers that have not
|
||||
yet acted on this object. If nil or empty, this object has been completely
|
||||
initialized. Otherwise, the object is considered uninitialized and is
|
||||
hidden (in list/watch and get calls) from clients that haven't explicitly
|
||||
asked to observe uninitialized objects. When an object is created, the
|
||||
system will populate this list with the current set of initializers. Only
|
||||
privileged users may set or modify this list. Once it is empty, it may
|
||||
not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be set
|
||||
to nil and the object is considered as initialized and visible to
|
||||
all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with the
|
||||
StatusReason failure. Not all StatusReasons may provide detailed
|
||||
causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the error.
|
||||
If this value is empty there is no information available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the status
|
||||
StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the status
|
||||
StatusReason. On some operations may differ from the requested
|
||||
resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the status
|
||||
StatusReason (when there is a single name which can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should
|
||||
be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource which
|
||||
can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the
|
||||
system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until this
|
||||
reference is removed. Defaults to false. To set this field, a user
|
||||
needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
string_data:
|
||||
description:
|
||||
- stringData allows specifying non-binary secret data in string form. It is
|
||||
|
||||
@@ -86,7 +86,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -94,8 +94,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
secret_list:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -135,316 +135,6 @@ secret_list:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource
|
||||
will be deleted. This field is set by the server when a graceful deletion
|
||||
is requested by the user, and is not directly settable by a client.
|
||||
The resource is expected to be deleted (no longer visible from resource
|
||||
lists, and not reachable by name) after the time in this field. Once
|
||||
set, this value may not be unset or be set further into the future,
|
||||
although it may be shortened or the resource may be deleted prior
|
||||
to this time. For example, a user may request that a pod is deleted
|
||||
in 30 seconds. The Kubelet will react by sending a graceful termination
|
||||
signal to the containers in the pod. After that 30 seconds, the Kubelet
|
||||
will send a hard termination signal (SIGKILL) to the container and
|
||||
after cleanup, remove the pod from the API. In the presence of network
|
||||
partitions, this object may still exist after this timestamp, until
|
||||
an administrator or automated process can determine the resource is
|
||||
fully terminated. If not set, graceful deletion of the object has
|
||||
not been requested. Populated by the system when a graceful deletion
|
||||
is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired
|
||||
state. Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant
|
||||
at object creation time. This field is a list of initializers that
|
||||
have not yet acted on this object. If nil or empty, this object has
|
||||
been completely initialized. Otherwise, the object is considered uninitialized
|
||||
and is hidden (in list/watch and get calls) from clients that haven't
|
||||
explicitly asked to observe uninitialized objects. When an object
|
||||
is created, the system will populate this list with the current set
|
||||
of initializers. Only privileged users may set or modify this list.
|
||||
Once it is empty, it may not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be
|
||||
set to nil and the object is considered as initialized and visible
|
||||
to all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with
|
||||
the StatusReason failure. Not all StatusReasons may provide
|
||||
detailed causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the
|
||||
error. If this value is empty there is no information
|
||||
available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the
|
||||
status StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the
|
||||
status StatusReason. On some operations may differ from
|
||||
the requested resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the
|
||||
status StatusReason (when there is a single name which
|
||||
can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation
|
||||
should be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource
|
||||
which can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated
|
||||
by the system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until
|
||||
this reference is removed. Defaults to false. To set this field,
|
||||
a user needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system.
|
||||
Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
string_data:
|
||||
description:
|
||||
- stringData allows specifying non-binary secret data in string form. It
|
||||
@@ -467,18 +157,6 @@ secret_list:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -135,7 +135,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -143,8 +143,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
self_subject_access_review:
|
||||
type: complex
|
||||
returned: on success
|
||||
@@ -164,388 +164,16 @@ self_subject_access_review:
|
||||
metadata:
|
||||
description: []
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource will
|
||||
be deleted. This field is set by the server when a graceful deletion is
|
||||
requested by the user, and is not directly settable by a client. The resource
|
||||
is expected to be deleted (no longer visible from resource lists, and
|
||||
not reachable by name) after the time in this field. Once set, this value
|
||||
may not be unset or be set further into the future, although it may be
|
||||
shortened or the resource may be deleted prior to this time. For example,
|
||||
a user may request that a pod is deleted in 30 seconds. The Kubelet will
|
||||
react by sending a graceful termination signal to the containers in the
|
||||
pod. After that 30 seconds, the Kubelet will send a hard termination signal
|
||||
(SIGKILL) to the container and after cleanup, remove the pod from the
|
||||
API. In the presence of network partitions, this object may still exist
|
||||
after this timestamp, until an administrator or automated process can
|
||||
determine the resource is fully terminated. If not set, graceful deletion
|
||||
of the object has not been requested. Populated by the system when a graceful
|
||||
deletion is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired state.
|
||||
Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant at
|
||||
object creation time. This field is a list of initializers that have not
|
||||
yet acted on this object. If nil or empty, this object has been completely
|
||||
initialized. Otherwise, the object is considered uninitialized and is
|
||||
hidden (in list/watch and get calls) from clients that haven't explicitly
|
||||
asked to observe uninitialized objects. When an object is created, the
|
||||
system will populate this list with the current set of initializers. Only
|
||||
privileged users may set or modify this list. Once it is empty, it may
|
||||
not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be set
|
||||
to nil and the object is considered as initialized and visible to
|
||||
all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with the
|
||||
StatusReason failure. Not all StatusReasons may provide detailed
|
||||
causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the error.
|
||||
If this value is empty there is no information available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the status
|
||||
StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the status
|
||||
StatusReason. On some operations may differ from the requested
|
||||
resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the status
|
||||
StatusReason (when there is a single name which can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should
|
||||
be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource which
|
||||
can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the
|
||||
system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until this
|
||||
reference is removed. Defaults to false. To set this field, a user
|
||||
needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
spec:
|
||||
description:
|
||||
- Spec holds information about the request being evaluated. user and groups
|
||||
must be empty
|
||||
type: complex
|
||||
contains:
|
||||
non_resource_attributes:
|
||||
description:
|
||||
- NonResourceAttributes describes information for a non-resource access
|
||||
request
|
||||
type: complex
|
||||
contains:
|
||||
path:
|
||||
description:
|
||||
- Path is the URL path of the request
|
||||
type: str
|
||||
verb:
|
||||
description:
|
||||
- Verb is the standard HTTP verb
|
||||
type: str
|
||||
resource_attributes:
|
||||
description:
|
||||
- ResourceAuthorizationAttributes describes information for a resource access
|
||||
request
|
||||
type: complex
|
||||
contains:
|
||||
group:
|
||||
description:
|
||||
- Group is the API Group of the Resource. "*" means all.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name is the name of the resource being requested for a "get" or deleted
|
||||
for a "delete". "" (empty) means all.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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
|
||||
type: str
|
||||
resource:
|
||||
description:
|
||||
- Resource is one of the existing resource types. "*" means all.
|
||||
type: str
|
||||
subresource:
|
||||
description:
|
||||
- Subresource is one of the existing resource types. "" means none.
|
||||
type: str
|
||||
verb:
|
||||
description:
|
||||
- 'Verb is a kubernetes resource API verb, like: get, list, watch, create,
|
||||
update, delete, proxy. "*" means all.'
|
||||
type: str
|
||||
version:
|
||||
description:
|
||||
- Version is the API Version of the Resource. "*" means all.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- Status is filled in by the server and indicates whether the request is allowed
|
||||
or not
|
||||
type: complex
|
||||
contains:
|
||||
allowed:
|
||||
description:
|
||||
- Allowed is required. True if the action would be allowed, false otherwise.
|
||||
type: bool
|
||||
evaluation_error:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- Reason is optional. It indicates why a request was allowed or denied.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
145
library/k8s_v1_self_subject_rules_review.py
Normal file
145
library/k8s_v1_self_subject_rules_review.py
Normal file
@@ -0,0 +1,145 @@
|
||||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
from ansible.module_utils.k8s_common import KubernetesAnsibleModule, KubernetesAnsibleException
|
||||
|
||||
DOCUMENTATION = '''
|
||||
module: k8s_v1_self_subject_rules_review
|
||||
short_description: Kubernetes SelfSubjectRulesReview
|
||||
description:
|
||||
- Manage the lifecycle of a self_subject_rules_review object. Supports check mode,
|
||||
and attempts to to be idempotent.
|
||||
version_added: 2.3.0
|
||||
author: OpenShift (@openshift)
|
||||
options:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: dict
|
||||
api_key:
|
||||
description:
|
||||
- Token used to connect to the API.
|
||||
cert_file:
|
||||
description:
|
||||
- Path to a certificate used to authenticate with the API.
|
||||
type: path
|
||||
context:
|
||||
description:
|
||||
- The name of a context found in the Kubernetes config file.
|
||||
debug:
|
||||
description:
|
||||
- Enable debug output from the OpenShift helper. Logging info is written to KubeObjHelper.log
|
||||
default: false
|
||||
type: bool
|
||||
force:
|
||||
description:
|
||||
- If set to C(True), and I(state) is C(present), an existing object will updated,
|
||||
and lists will be replaced, rather than merged.
|
||||
default: false
|
||||
type: bool
|
||||
host:
|
||||
description:
|
||||
- Provide a URL for acessing the Kubernetes API.
|
||||
key_file:
|
||||
description:
|
||||
- Path to a key file used to authenticate with the API.
|
||||
type: path
|
||||
kubeconfig:
|
||||
description:
|
||||
- Path to an existing Kubernetes config file. If not provided, and no other connection
|
||||
options are provided, the openshift client will attempt to load the default
|
||||
configuration file from I(~/.kube/config.json).
|
||||
type: path
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: dict
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
password:
|
||||
description:
|
||||
- Provide a password for connecting to the API. Use in conjunction with I(username).
|
||||
spec_namespace:
|
||||
description:
|
||||
- Namespace to evaluate rules for. Required.
|
||||
ssl_ca_cert:
|
||||
description:
|
||||
- Path to a CA certificate used to authenticate with the API.
|
||||
type: path
|
||||
username:
|
||||
description:
|
||||
- Provide a username for connecting to the API.
|
||||
verify_ssl:
|
||||
description:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
description: Requested API version
|
||||
type: string
|
||||
self_subject_rules_review:
|
||||
type: complex
|
||||
returned: on success
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
metadata:
|
||||
description: []
|
||||
type: complex
|
||||
spec:
|
||||
description:
|
||||
- Spec holds information about the request being evaluated.
|
||||
type: complex
|
||||
status:
|
||||
description:
|
||||
- Status is filled in by the server and indicates the set of actions a user
|
||||
can perform.
|
||||
type: complex
|
||||
'''
|
||||
|
||||
|
||||
def main():
|
||||
try:
|
||||
module = KubernetesAnsibleModule('self_subject_rules_review', 'v1')
|
||||
except KubernetesAnsibleException as exc:
|
||||
# The helper failed to init, so there is no module object. All we can do is raise the error.
|
||||
raise Exception(exc.message)
|
||||
|
||||
try:
|
||||
module.execute_module()
|
||||
except KubernetesAnsibleException as exc:
|
||||
module.fail_json(msg="Module failed!", error=str(exc))
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
@@ -148,6 +148,19 @@ options:
|
||||
aliases:
|
||||
- ports
|
||||
type: list
|
||||
spec_publish_not_ready_addresses:
|
||||
description:
|
||||
- publishNotReadyAddresses, when set to true, indicates that DNS implementations
|
||||
must publish the notReadyAddresses of subsets for the Endpoints associated with
|
||||
the Service. The default value is false. The primary use case for setting this
|
||||
field is to use a StatefulSet's Headless Service to propagate SRV records for
|
||||
its Pods without respect to their readiness for purpose of peer discovery. This
|
||||
field will replace the service.alpha.kubernetes.io/tolerate-unready-endpoints
|
||||
when that annotation is deprecated and all clients have been converted to use
|
||||
this field.
|
||||
aliases:
|
||||
- publish_not_ready_addresses
|
||||
type: bool
|
||||
spec_selector:
|
||||
description:
|
||||
- Route service traffic to pods with label keys and values matching this selector.
|
||||
@@ -163,6 +176,14 @@ options:
|
||||
IP based session affinity. Must be ClientIP or None. Defaults to None.
|
||||
aliases:
|
||||
- session_affinity
|
||||
spec_session_affinity_config_client_ip_timeout_seconds:
|
||||
description:
|
||||
- timeoutSeconds specifies the seconds of ClientIP type session sticky time. The
|
||||
value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP". Default
|
||||
value is 10800(for 3 hours).
|
||||
aliases:
|
||||
- session_affinity__clientip_timeout_seconds
|
||||
type: int
|
||||
spec_type:
|
||||
description:
|
||||
- type determines how the Service is exposed. Defaults to ClusterIP. Valid options
|
||||
@@ -208,7 +229,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -289,8 +310,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
service:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -311,465 +332,14 @@ service:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource will
|
||||
be deleted. This field is set by the server when a graceful deletion is
|
||||
requested by the user, and is not directly settable by a client. The resource
|
||||
is expected to be deleted (no longer visible from resource lists, and
|
||||
not reachable by name) after the time in this field. Once set, this value
|
||||
may not be unset or be set further into the future, although it may be
|
||||
shortened or the resource may be deleted prior to this time. For example,
|
||||
a user may request that a pod is deleted in 30 seconds. The Kubelet will
|
||||
react by sending a graceful termination signal to the containers in the
|
||||
pod. After that 30 seconds, the Kubelet will send a hard termination signal
|
||||
(SIGKILL) to the container and after cleanup, remove the pod from the
|
||||
API. In the presence of network partitions, this object may still exist
|
||||
after this timestamp, until an administrator or automated process can
|
||||
determine the resource is fully terminated. If not set, graceful deletion
|
||||
of the object has not been requested. Populated by the system when a graceful
|
||||
deletion is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired state.
|
||||
Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant at
|
||||
object creation time. This field is a list of initializers that have not
|
||||
yet acted on this object. If nil or empty, this object has been completely
|
||||
initialized. Otherwise, the object is considered uninitialized and is
|
||||
hidden (in list/watch and get calls) from clients that haven't explicitly
|
||||
asked to observe uninitialized objects. When an object is created, the
|
||||
system will populate this list with the current set of initializers. Only
|
||||
privileged users may set or modify this list. Once it is empty, it may
|
||||
not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be set
|
||||
to nil and the object is considered as initialized and visible to
|
||||
all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with the
|
||||
StatusReason failure. Not all StatusReasons may provide detailed
|
||||
causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the error.
|
||||
If this value is empty there is no information available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the status
|
||||
StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the status
|
||||
StatusReason. On some operations may differ from the requested
|
||||
resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the status
|
||||
StatusReason (when there is a single name which can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should
|
||||
be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource which
|
||||
can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the
|
||||
system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until this
|
||||
reference is removed. Defaults to false. To set this field, a user
|
||||
needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
spec:
|
||||
description:
|
||||
- Spec defines the behavior of a service.
|
||||
type: complex
|
||||
contains:
|
||||
cluster_ip:
|
||||
description:
|
||||
- clusterIP is the IP address of the service and is usually assigned randomly
|
||||
by the master. If an address is specified manually and is not in use by
|
||||
others, it will be allocated to the service; otherwise, creation of the
|
||||
service will fail. This field can not be changed through updates. Valid
|
||||
values are "None", empty string (""), or a valid IP address. "None" can
|
||||
be specified for headless services when proxying is not required. Only
|
||||
applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type
|
||||
is ExternalName.
|
||||
type: str
|
||||
external_i_ps:
|
||||
description:
|
||||
- externalIPs is a list of IP addresses for which nodes in the cluster will
|
||||
also accept traffic for this service. These IPs are not managed by Kubernetes.
|
||||
The user is responsible for ensuring that traffic arrives at a node with
|
||||
this IP. A common example is external load-balancers that are not part
|
||||
of the Kubernetes system.
|
||||
type: list
|
||||
contains: str
|
||||
external_name:
|
||||
description:
|
||||
- externalName is the external reference that kubedns or equivalent will
|
||||
return as a CNAME record for this service. No proxying will be involved.
|
||||
Must be a valid DNS name and requires Type to be ExternalName.
|
||||
type: str
|
||||
external_traffic_policy:
|
||||
description:
|
||||
- externalTrafficPolicy denotes if this Service desires to route external
|
||||
traffic to node-local or cluster-wide endpoints. "Local" preserves the
|
||||
client source IP and avoids a second hop for LoadBalancer and Nodeport
|
||||
type services, but risks potentially imbalanced traffic spreading. "Cluster"
|
||||
obscures the client source IP and may cause a second hop to another node,
|
||||
but should have good overall load-spreading.
|
||||
type: str
|
||||
health_check_node_port:
|
||||
description:
|
||||
- healthCheckNodePort specifies the healthcheck nodePort for the service.
|
||||
If not specified, HealthCheckNodePort is created by the service api backend
|
||||
with the allocated nodePort. Will use user-specified nodePort value if
|
||||
specified by the client. Only effects when Type is set to LoadBalancer
|
||||
and ExternalTrafficPolicy is set to Local.
|
||||
type: int
|
||||
load_balancer_ip:
|
||||
description:
|
||||
- 'Only applies to Service Type: LoadBalancer LoadBalancer will get created
|
||||
with the IP specified in this field. This feature depends on whether the
|
||||
underlying cloud-provider supports specifying the loadBalancerIP when
|
||||
a load balancer is created. This field will be ignored if the cloud-provider
|
||||
does not support the feature.'
|
||||
type: str
|
||||
load_balancer_source_ranges:
|
||||
description:
|
||||
- If specified and supported by the platform, this will restrict traffic
|
||||
through the cloud-provider load-balancer will be restricted to the specified
|
||||
client IPs. This field will be ignored if the cloud-provider does not
|
||||
support the feature."
|
||||
type: list
|
||||
contains: str
|
||||
ports:
|
||||
description:
|
||||
- The list of ports that are exposed by this service.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- The name of this port within the service. This must be a DNS_LABEL.
|
||||
All ports within a ServiceSpec must have unique names. This maps to
|
||||
the 'Name' field in EndpointPort objects. Optional if only one ServicePort
|
||||
is defined on this service.
|
||||
type: str
|
||||
node_port:
|
||||
description:
|
||||
- The port on each node on which this service is exposed when type=NodePort
|
||||
or LoadBalancer. Usually assigned by the system. If specified, it
|
||||
will be allocated to the service if unused or else creation of the
|
||||
service will fail. Default is to auto-allocate a port if the ServiceType
|
||||
of this Service requires one.
|
||||
type: int
|
||||
port:
|
||||
description:
|
||||
- The port that will be exposed by this service.
|
||||
type: int
|
||||
protocol:
|
||||
description:
|
||||
- The IP protocol for this port. Supports "TCP" and "UDP". Default is
|
||||
TCP.
|
||||
type: str
|
||||
target_port:
|
||||
description:
|
||||
- Number or name of the port to access on the pods targeted by the service.
|
||||
Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
|
||||
If this is a string, it will be looked up as a named port in the target
|
||||
Pod's container ports. If this is not specified, the value of the
|
||||
'port' field is used (an identity map). This field is ignored for
|
||||
services with clusterIP=None, and should be omitted or set equal to
|
||||
the 'port' field.
|
||||
type: str
|
||||
selector:
|
||||
description:
|
||||
- Route service traffic to pods with label keys and values matching this
|
||||
selector. If empty or not present, the service is assumed to have an external
|
||||
process managing its endpoints, which Kubernetes will not modify. Only
|
||||
applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type
|
||||
is ExternalName.
|
||||
type: complex
|
||||
contains: str, str
|
||||
session_affinity:
|
||||
description:
|
||||
- Supports "ClientIP" and "None". Used to maintain session affinity. Enable
|
||||
client IP based session affinity. Must be ClientIP or None. Defaults to
|
||||
None.
|
||||
type: str
|
||||
type:
|
||||
description:
|
||||
- type determines how the Service is exposed. Defaults to ClusterIP. Valid
|
||||
options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ExternalName"
|
||||
maps to the specified externalName. "ClusterIP" allocates a cluster-internal
|
||||
IP address for load-balancing to endpoints. Endpoints are determined by
|
||||
the selector or if that is not specified, by manual construction of an
|
||||
Endpoints object. If clusterIP is "None", no virtual IP is allocated and
|
||||
the endpoints are published as a set of endpoints rather than a stable
|
||||
IP. "NodePort" builds on ClusterIP and allocates a port on every node
|
||||
which routes to the clusterIP. "LoadBalancer" builds on NodePort and creates
|
||||
an external load-balancer (if supported in the current cloud) which routes
|
||||
to the clusterIP.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- Most recently observed status of the service. Populated by the system. Read-only.
|
||||
type: complex
|
||||
contains:
|
||||
load_balancer:
|
||||
description:
|
||||
- LoadBalancer contains the current status of the load-balancer, if one
|
||||
is present.
|
||||
type: complex
|
||||
contains:
|
||||
ingress:
|
||||
description:
|
||||
- Ingress is a list containing ingress points for the load-balancer.
|
||||
Traffic intended for the service should be sent to these ingress points.
|
||||
type: list
|
||||
contains:
|
||||
hostname:
|
||||
description:
|
||||
- Hostname is set for load-balancer ingress points that are DNS
|
||||
based (typically AWS load-balancers)
|
||||
type: str
|
||||
ip:
|
||||
description:
|
||||
- IP is set for load-balancer ingress points that are IP based (typically
|
||||
GCE or OpenStack load-balancers)
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -126,7 +126,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -134,8 +134,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
service_account:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -174,306 +174,6 @@ service_account:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource will
|
||||
be deleted. This field is set by the server when a graceful deletion is
|
||||
requested by the user, and is not directly settable by a client. The resource
|
||||
is expected to be deleted (no longer visible from resource lists, and
|
||||
not reachable by name) after the time in this field. Once set, this value
|
||||
may not be unset or be set further into the future, although it may be
|
||||
shortened or the resource may be deleted prior to this time. For example,
|
||||
a user may request that a pod is deleted in 30 seconds. The Kubelet will
|
||||
react by sending a graceful termination signal to the containers in the
|
||||
pod. After that 30 seconds, the Kubelet will send a hard termination signal
|
||||
(SIGKILL) to the container and after cleanup, remove the pod from the
|
||||
API. In the presence of network partitions, this object may still exist
|
||||
after this timestamp, until an administrator or automated process can
|
||||
determine the resource is fully terminated. If not set, graceful deletion
|
||||
of the object has not been requested. Populated by the system when a graceful
|
||||
deletion is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired state.
|
||||
Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant at
|
||||
object creation time. This field is a list of initializers that have not
|
||||
yet acted on this object. If nil or empty, this object has been completely
|
||||
initialized. Otherwise, the object is considered uninitialized and is
|
||||
hidden (in list/watch and get calls) from clients that haven't explicitly
|
||||
asked to observe uninitialized objects. When an object is created, the
|
||||
system will populate this list with the current set of initializers. Only
|
||||
privileged users may set or modify this list. Once it is empty, it may
|
||||
not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be set
|
||||
to nil and the object is considered as initialized and visible to
|
||||
all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with the
|
||||
StatusReason failure. Not all StatusReasons may provide detailed
|
||||
causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the error.
|
||||
If this value is empty there is no information available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the status
|
||||
StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the status
|
||||
StatusReason. On some operations may differ from the requested
|
||||
resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the status
|
||||
StatusReason (when there is a single name which can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should
|
||||
be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource which
|
||||
can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the
|
||||
system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until this
|
||||
reference is removed. Defaults to false. To set this field, a user
|
||||
needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
secrets:
|
||||
description:
|
||||
- Secrets is the list of secrets allowed to be used by pods running using this
|
||||
|
||||
@@ -86,7 +86,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -94,8 +94,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
service_account_list:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -145,316 +145,6 @@ service_account_list:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource
|
||||
will be deleted. This field is set by the server when a graceful deletion
|
||||
is requested by the user, and is not directly settable by a client.
|
||||
The resource is expected to be deleted (no longer visible from resource
|
||||
lists, and not reachable by name) after the time in this field. Once
|
||||
set, this value may not be unset or be set further into the future,
|
||||
although it may be shortened or the resource may be deleted prior
|
||||
to this time. For example, a user may request that a pod is deleted
|
||||
in 30 seconds. The Kubelet will react by sending a graceful termination
|
||||
signal to the containers in the pod. After that 30 seconds, the Kubelet
|
||||
will send a hard termination signal (SIGKILL) to the container and
|
||||
after cleanup, remove the pod from the API. In the presence of network
|
||||
partitions, this object may still exist after this timestamp, until
|
||||
an administrator or automated process can determine the resource is
|
||||
fully terminated. If not set, graceful deletion of the object has
|
||||
not been requested. Populated by the system when a graceful deletion
|
||||
is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired
|
||||
state. Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant
|
||||
at object creation time. This field is a list of initializers that
|
||||
have not yet acted on this object. If nil or empty, this object has
|
||||
been completely initialized. Otherwise, the object is considered uninitialized
|
||||
and is hidden (in list/watch and get calls) from clients that haven't
|
||||
explicitly asked to observe uninitialized objects. When an object
|
||||
is created, the system will populate this list with the current set
|
||||
of initializers. Only privileged users may set or modify this list.
|
||||
Once it is empty, it may not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be
|
||||
set to nil and the object is considered as initialized and visible
|
||||
to all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with
|
||||
the StatusReason failure. Not all StatusReasons may provide
|
||||
detailed causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the
|
||||
error. If this value is empty there is no information
|
||||
available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the
|
||||
status StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the
|
||||
status StatusReason. On some operations may differ from
|
||||
the requested resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the
|
||||
status StatusReason (when there is a single name which
|
||||
can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation
|
||||
should be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource
|
||||
which can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated
|
||||
by the system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until
|
||||
this reference is removed. Defaults to false. To set this field,
|
||||
a user needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system.
|
||||
Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
secrets:
|
||||
description:
|
||||
- Secrets is the list of secrets allowed to be used by pods running using
|
||||
@@ -507,18 +197,6 @@ service_account_list:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -86,7 +86,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -94,8 +94,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
service_list:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -127,477 +127,15 @@ service_list:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource
|
||||
will be deleted. This field is set by the server when a graceful deletion
|
||||
is requested by the user, and is not directly settable by a client.
|
||||
The resource is expected to be deleted (no longer visible from resource
|
||||
lists, and not reachable by name) after the time in this field. Once
|
||||
set, this value may not be unset or be set further into the future,
|
||||
although it may be shortened or the resource may be deleted prior
|
||||
to this time. For example, a user may request that a pod is deleted
|
||||
in 30 seconds. The Kubelet will react by sending a graceful termination
|
||||
signal to the containers in the pod. After that 30 seconds, the Kubelet
|
||||
will send a hard termination signal (SIGKILL) to the container and
|
||||
after cleanup, remove the pod from the API. In the presence of network
|
||||
partitions, this object may still exist after this timestamp, until
|
||||
an administrator or automated process can determine the resource is
|
||||
fully terminated. If not set, graceful deletion of the object has
|
||||
not been requested. Populated by the system when a graceful deletion
|
||||
is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired
|
||||
state. Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant
|
||||
at object creation time. This field is a list of initializers that
|
||||
have not yet acted on this object. If nil or empty, this object has
|
||||
been completely initialized. Otherwise, the object is considered uninitialized
|
||||
and is hidden (in list/watch and get calls) from clients that haven't
|
||||
explicitly asked to observe uninitialized objects. When an object
|
||||
is created, the system will populate this list with the current set
|
||||
of initializers. Only privileged users may set or modify this list.
|
||||
Once it is empty, it may not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be
|
||||
set to nil and the object is considered as initialized and visible
|
||||
to all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with
|
||||
the StatusReason failure. Not all StatusReasons may provide
|
||||
detailed causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the
|
||||
error. If this value is empty there is no information
|
||||
available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the
|
||||
status StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the
|
||||
status StatusReason. On some operations may differ from
|
||||
the requested resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the
|
||||
status StatusReason (when there is a single name which
|
||||
can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation
|
||||
should be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource
|
||||
which can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated
|
||||
by the system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until
|
||||
this reference is removed. Defaults to false. To set this field,
|
||||
a user needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system.
|
||||
Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
spec:
|
||||
description:
|
||||
- Spec defines the behavior of a service.
|
||||
type: complex
|
||||
contains:
|
||||
cluster_ip:
|
||||
description:
|
||||
- clusterIP is the IP address of the service and is usually assigned
|
||||
randomly by the master. If an address is specified manually and is
|
||||
not in use by others, it will be allocated to the service; otherwise,
|
||||
creation of the service will fail. This field can not be changed through
|
||||
updates. Valid values are "None", empty string (""), or a valid IP
|
||||
address. "None" can be specified for headless services when proxying
|
||||
is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer.
|
||||
Ignored if type is ExternalName.
|
||||
type: str
|
||||
external_i_ps:
|
||||
description:
|
||||
- externalIPs is a list of IP addresses for which nodes in the cluster
|
||||
will also accept traffic for this service. These IPs are not managed
|
||||
by Kubernetes. The user is responsible for ensuring that traffic arrives
|
||||
at a node with this IP. A common example is external load-balancers
|
||||
that are not part of the Kubernetes system.
|
||||
type: list
|
||||
contains: str
|
||||
external_name:
|
||||
description:
|
||||
- externalName is the external reference that kubedns or equivalent
|
||||
will return as a CNAME record for this service. No proxying will be
|
||||
involved. Must be a valid DNS name and requires Type to be ExternalName.
|
||||
type: str
|
||||
external_traffic_policy:
|
||||
description:
|
||||
- externalTrafficPolicy denotes if this Service desires to route external
|
||||
traffic to node-local or cluster-wide endpoints. "Local" preserves
|
||||
the client source IP and avoids a second hop for LoadBalancer and
|
||||
Nodeport type services, but risks potentially imbalanced traffic spreading.
|
||||
"Cluster" obscures the client source IP and may cause a second hop
|
||||
to another node, but should have good overall load-spreading.
|
||||
type: str
|
||||
health_check_node_port:
|
||||
description:
|
||||
- healthCheckNodePort specifies the healthcheck nodePort for the service.
|
||||
If not specified, HealthCheckNodePort is created by the service api
|
||||
backend with the allocated nodePort. Will use user-specified nodePort
|
||||
value if specified by the client. Only effects when Type is set to
|
||||
LoadBalancer and ExternalTrafficPolicy is set to Local.
|
||||
type: int
|
||||
load_balancer_ip:
|
||||
description:
|
||||
- 'Only applies to Service Type: LoadBalancer LoadBalancer will get
|
||||
created with the IP specified in this field. This feature depends
|
||||
on whether the underlying cloud-provider supports specifying the loadBalancerIP
|
||||
when a load balancer is created. This field will be ignored if the
|
||||
cloud-provider does not support the feature.'
|
||||
type: str
|
||||
load_balancer_source_ranges:
|
||||
description:
|
||||
- If specified and supported by the platform, this will restrict traffic
|
||||
through the cloud-provider load-balancer will be restricted to the
|
||||
specified client IPs. This field will be ignored if the cloud-provider
|
||||
does not support the feature."
|
||||
type: list
|
||||
contains: str
|
||||
ports:
|
||||
description:
|
||||
- The list of ports that are exposed by this service.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- The name of this port within the service. This must be a DNS_LABEL.
|
||||
All ports within a ServiceSpec must have unique names. This maps
|
||||
to the 'Name' field in EndpointPort objects. Optional if only
|
||||
one ServicePort is defined on this service.
|
||||
type: str
|
||||
node_port:
|
||||
description:
|
||||
- The port on each node on which this service is exposed when type=NodePort
|
||||
or LoadBalancer. Usually assigned by the system. If specified,
|
||||
it will be allocated to the service if unused or else creation
|
||||
of the service will fail. Default is to auto-allocate a port if
|
||||
the ServiceType of this Service requires one.
|
||||
type: int
|
||||
port:
|
||||
description:
|
||||
- The port that will be exposed by this service.
|
||||
type: int
|
||||
protocol:
|
||||
description:
|
||||
- The IP protocol for this port. Supports "TCP" and "UDP". Default
|
||||
is TCP.
|
||||
type: str
|
||||
target_port:
|
||||
description:
|
||||
- Number or name of the port to access on the pods targeted by the
|
||||
service. Number must be in the range 1 to 65535. Name must be
|
||||
an IANA_SVC_NAME. If this is a string, it will be looked up as
|
||||
a named port in the target Pod's container ports. If this is not
|
||||
specified, the value of the 'port' field is used (an identity
|
||||
map). This field is ignored for services with clusterIP=None,
|
||||
and should be omitted or set equal to the 'port' field.
|
||||
type: str
|
||||
selector:
|
||||
description:
|
||||
- Route service traffic to pods with label keys and values matching
|
||||
this selector. If empty or not present, the service is assumed to
|
||||
have an external process managing its endpoints, which Kubernetes
|
||||
will not modify. Only applies to types ClusterIP, NodePort, and LoadBalancer.
|
||||
Ignored if type is ExternalName.
|
||||
type: complex
|
||||
contains: str, str
|
||||
session_affinity:
|
||||
description:
|
||||
- Supports "ClientIP" and "None". Used to maintain session affinity.
|
||||
Enable client IP based session affinity. Must be ClientIP or None.
|
||||
Defaults to None.
|
||||
type: str
|
||||
type:
|
||||
description:
|
||||
- type determines how the Service is exposed. Defaults to ClusterIP.
|
||||
Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer.
|
||||
"ExternalName" maps to the specified externalName. "ClusterIP" allocates
|
||||
a cluster-internal IP address for load-balancing to endpoints. Endpoints
|
||||
are determined by the selector or if that is not specified, by manual
|
||||
construction of an Endpoints object. If clusterIP is "None", no virtual
|
||||
IP is allocated and the endpoints are published as a set of endpoints
|
||||
rather than a stable IP. "NodePort" builds on ClusterIP and allocates
|
||||
a port on every node which routes to the clusterIP. "LoadBalancer"
|
||||
builds on NodePort and creates an external load-balancer (if supported
|
||||
in the current cloud) which routes to the clusterIP.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- Most recently observed status of the service. Populated by the system.
|
||||
Read-only.
|
||||
type: complex
|
||||
contains:
|
||||
load_balancer:
|
||||
description:
|
||||
- LoadBalancer contains the current status of the load-balancer, if
|
||||
one is present.
|
||||
type: complex
|
||||
contains:
|
||||
ingress:
|
||||
description:
|
||||
- Ingress is a list containing ingress points for the load-balancer.
|
||||
Traffic intended for the service should be sent to these ingress
|
||||
points.
|
||||
type: list
|
||||
contains:
|
||||
hostname:
|
||||
description:
|
||||
- Hostname is set for load-balancer ingress points that are
|
||||
DNS based (typically AWS load-balancers)
|
||||
type: str
|
||||
ip:
|
||||
description:
|
||||
- IP is set for load-balancer ingress points that are IP based
|
||||
(typically GCE or OpenStack load-balancers)
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- Kind is a string value representing the REST resource this object represents.
|
||||
@@ -608,18 +146,6 @@ service_list:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -57,7 +57,9 @@ options:
|
||||
- name
|
||||
details_retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should be retried.
|
||||
- If specified, the time in seconds before the operation should be retried. Some
|
||||
errors may indicate the client must take an alternate action - for those errors
|
||||
this field may indicate how long to wait before taking the alternate action.
|
||||
aliases:
|
||||
- retry_after_seconds
|
||||
type: int
|
||||
@@ -108,7 +110,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -116,8 +118,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
status:
|
||||
type: complex
|
||||
returned: on success
|
||||
@@ -138,54 +140,6 @@ status:
|
||||
details. This field is optional and the data returned is not guaranteed to
|
||||
conform to any schema except that defined by the reason type.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with the StatusReason
|
||||
failure. Not all StatusReasons may provide detailed causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error. This field
|
||||
may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the error. If this
|
||||
value is empty there is no information available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the status StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the status StatusReason.
|
||||
On some operations may differ from the requested resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the status StatusReason
|
||||
(when there is a single name which can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource which can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- Kind is a string value representing the REST resource this object represents.
|
||||
@@ -200,18 +154,6 @@ status:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of why this operation is in the "Failure" status.
|
||||
|
||||
@@ -12,6 +12,10 @@ description:
|
||||
version_added: 2.3.0
|
||||
author: OpenShift (@openshift)
|
||||
options:
|
||||
allow_volume_expansion:
|
||||
description:
|
||||
- AllowVolumeExpansion shows whether the storage class allow volume expand
|
||||
type: bool
|
||||
annotations:
|
||||
description:
|
||||
- Annotations is an unstructured key value map stored with a resource that may
|
||||
@@ -57,6 +61,12 @@ options:
|
||||
- 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.
|
||||
type: dict
|
||||
mount_options:
|
||||
description:
|
||||
- Dynamically provisioned PersistentVolumes of this storage class are created
|
||||
with these mountOptions, e.g. ["ro", "soft"]. Not validated - mount of the PVs
|
||||
will simply fail if one is invalid.
|
||||
type: list
|
||||
name:
|
||||
description:
|
||||
- Name must be unique within a namespace. Is required when creating resources,
|
||||
@@ -80,6 +90,10 @@ options:
|
||||
provisioner:
|
||||
description:
|
||||
- Provisioner indicates the type of the provisioner.
|
||||
reclaim_policy:
|
||||
description:
|
||||
- Dynamically provisioned PersistentVolumes of this storage class are created
|
||||
with this reclaimPolicy. Defaults to Delete.
|
||||
resource_definition:
|
||||
description:
|
||||
- Provide the YAML definition for the object, bypassing any modules parameters
|
||||
@@ -116,7 +130,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -124,12 +138,16 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
storage_class:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
contains:
|
||||
allow_volume_expansion:
|
||||
description:
|
||||
- AllowVolumeExpansion shows whether the storage class allow volume expand
|
||||
type: bool
|
||||
api_version:
|
||||
description:
|
||||
- APIVersion defines the versioned schema of this representation of an object.
|
||||
@@ -146,306 +164,13 @@ storage_class:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource will
|
||||
be deleted. This field is set by the server when a graceful deletion is
|
||||
requested by the user, and is not directly settable by a client. The resource
|
||||
is expected to be deleted (no longer visible from resource lists, and
|
||||
not reachable by name) after the time in this field. Once set, this value
|
||||
may not be unset or be set further into the future, although it may be
|
||||
shortened or the resource may be deleted prior to this time. For example,
|
||||
a user may request that a pod is deleted in 30 seconds. The Kubelet will
|
||||
react by sending a graceful termination signal to the containers in the
|
||||
pod. After that 30 seconds, the Kubelet will send a hard termination signal
|
||||
(SIGKILL) to the container and after cleanup, remove the pod from the
|
||||
API. In the presence of network partitions, this object may still exist
|
||||
after this timestamp, until an administrator or automated process can
|
||||
determine the resource is fully terminated. If not set, graceful deletion
|
||||
of the object has not been requested. Populated by the system when a graceful
|
||||
deletion is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired state.
|
||||
Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant at
|
||||
object creation time. This field is a list of initializers that have not
|
||||
yet acted on this object. If nil or empty, this object has been completely
|
||||
initialized. Otherwise, the object is considered uninitialized and is
|
||||
hidden (in list/watch and get calls) from clients that haven't explicitly
|
||||
asked to observe uninitialized objects. When an object is created, the
|
||||
system will populate this list with the current set of initializers. Only
|
||||
privileged users may set or modify this list. Once it is empty, it may
|
||||
not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be set
|
||||
to nil and the object is considered as initialized and visible to
|
||||
all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with the
|
||||
StatusReason failure. Not all StatusReasons may provide detailed
|
||||
causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the error.
|
||||
If this value is empty there is no information available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the status
|
||||
StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the status
|
||||
StatusReason. On some operations may differ from the requested
|
||||
resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the status
|
||||
StatusReason (when there is a single name which can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should
|
||||
be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource which
|
||||
can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the
|
||||
system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until this
|
||||
reference is removed. Defaults to false. To set this field, a user
|
||||
needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
mount_options:
|
||||
description:
|
||||
- Dynamically provisioned PersistentVolumes of this storage class are created
|
||||
with these mountOptions, e.g. ["ro", "soft"]. Not validated - mount of the
|
||||
PVs will simply fail if one is invalid.
|
||||
type: list
|
||||
contains: str
|
||||
parameters:
|
||||
description:
|
||||
- Parameters holds the parameters for the provisioner that should create volumes
|
||||
@@ -456,6 +181,11 @@ storage_class:
|
||||
description:
|
||||
- Provisioner indicates the type of the provisioner.
|
||||
type: str
|
||||
reclaim_policy:
|
||||
description:
|
||||
- Dynamically provisioned PersistentVolumes of this storage class are created
|
||||
with this reclaimPolicy. Defaults to Delete.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -86,7 +86,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -94,8 +94,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
storage_class_list:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -111,6 +111,10 @@ storage_class_list:
|
||||
- Items is the list of StorageClasses
|
||||
type: list
|
||||
contains:
|
||||
allow_volume_expansion:
|
||||
description:
|
||||
- AllowVolumeExpansion shows whether the storage class allow volume expand
|
||||
type: bool
|
||||
api_version:
|
||||
description:
|
||||
- APIVersion defines the versioned schema of this representation of an object.
|
||||
@@ -127,316 +131,13 @@ storage_class_list:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource
|
||||
will be deleted. This field is set by the server when a graceful deletion
|
||||
is requested by the user, and is not directly settable by a client.
|
||||
The resource is expected to be deleted (no longer visible from resource
|
||||
lists, and not reachable by name) after the time in this field. Once
|
||||
set, this value may not be unset or be set further into the future,
|
||||
although it may be shortened or the resource may be deleted prior
|
||||
to this time. For example, a user may request that a pod is deleted
|
||||
in 30 seconds. The Kubelet will react by sending a graceful termination
|
||||
signal to the containers in the pod. After that 30 seconds, the Kubelet
|
||||
will send a hard termination signal (SIGKILL) to the container and
|
||||
after cleanup, remove the pod from the API. In the presence of network
|
||||
partitions, this object may still exist after this timestamp, until
|
||||
an administrator or automated process can determine the resource is
|
||||
fully terminated. If not set, graceful deletion of the object has
|
||||
not been requested. Populated by the system when a graceful deletion
|
||||
is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired
|
||||
state. Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant
|
||||
at object creation time. This field is a list of initializers that
|
||||
have not yet acted on this object. If nil or empty, this object has
|
||||
been completely initialized. Otherwise, the object is considered uninitialized
|
||||
and is hidden (in list/watch and get calls) from clients that haven't
|
||||
explicitly asked to observe uninitialized objects. When an object
|
||||
is created, the system will populate this list with the current set
|
||||
of initializers. Only privileged users may set or modify this list.
|
||||
Once it is empty, it may not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be
|
||||
set to nil and the object is considered as initialized and visible
|
||||
to all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with
|
||||
the StatusReason failure. Not all StatusReasons may provide
|
||||
detailed causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the
|
||||
error. If this value is empty there is no information
|
||||
available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the
|
||||
status StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the
|
||||
status StatusReason. On some operations may differ from
|
||||
the requested resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the
|
||||
status StatusReason (when there is a single name which
|
||||
can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation
|
||||
should be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource
|
||||
which can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated
|
||||
by the system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until
|
||||
this reference is removed. Defaults to false. To set this field,
|
||||
a user needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system.
|
||||
Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
mount_options:
|
||||
description:
|
||||
- Dynamically provisioned PersistentVolumes of this storage class are created
|
||||
with these mountOptions, e.g. ["ro", "soft"]. Not validated - mount of
|
||||
the PVs will simply fail if one is invalid.
|
||||
type: list
|
||||
contains: str
|
||||
parameters:
|
||||
description:
|
||||
- Parameters holds the parameters for the provisioner that should create
|
||||
@@ -447,6 +148,11 @@ storage_class_list:
|
||||
description:
|
||||
- Provisioner indicates the type of the provisioner.
|
||||
type: str
|
||||
reclaim_policy:
|
||||
description:
|
||||
- Dynamically provisioned PersistentVolumes of this storage class are created
|
||||
with this reclaimPolicy. Defaults to Delete.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- Kind is a string value representing the REST resource this object represents.
|
||||
@@ -457,18 +163,6 @@ storage_class_list:
|
||||
description:
|
||||
- Standard list metadata
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -136,6 +136,11 @@ options:
|
||||
- Version is the API Version of the Resource. "*" means all.
|
||||
aliases:
|
||||
- resource_attributes_version
|
||||
spec_uid:
|
||||
description:
|
||||
- UID information about the requesting user.
|
||||
aliases:
|
||||
- uid
|
||||
spec_user:
|
||||
description:
|
||||
- User is the user you're testing for. If you specify "User" but not "Groups",
|
||||
@@ -154,7 +159,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -162,8 +167,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
subject_access_review:
|
||||
type: complex
|
||||
returned: on success
|
||||
@@ -183,403 +188,15 @@ subject_access_review:
|
||||
metadata:
|
||||
description: []
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource will
|
||||
be deleted. This field is set by the server when a graceful deletion is
|
||||
requested by the user, and is not directly settable by a client. The resource
|
||||
is expected to be deleted (no longer visible from resource lists, and
|
||||
not reachable by name) after the time in this field. Once set, this value
|
||||
may not be unset or be set further into the future, although it may be
|
||||
shortened or the resource may be deleted prior to this time. For example,
|
||||
a user may request that a pod is deleted in 30 seconds. The Kubelet will
|
||||
react by sending a graceful termination signal to the containers in the
|
||||
pod. After that 30 seconds, the Kubelet will send a hard termination signal
|
||||
(SIGKILL) to the container and after cleanup, remove the pod from the
|
||||
API. In the presence of network partitions, this object may still exist
|
||||
after this timestamp, until an administrator or automated process can
|
||||
determine the resource is fully terminated. If not set, graceful deletion
|
||||
of the object has not been requested. Populated by the system when a graceful
|
||||
deletion is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired state.
|
||||
Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant at
|
||||
object creation time. This field is a list of initializers that have not
|
||||
yet acted on this object. If nil or empty, this object has been completely
|
||||
initialized. Otherwise, the object is considered uninitialized and is
|
||||
hidden (in list/watch and get calls) from clients that haven't explicitly
|
||||
asked to observe uninitialized objects. When an object is created, the
|
||||
system will populate this list with the current set of initializers. Only
|
||||
privileged users may set or modify this list. Once it is empty, it may
|
||||
not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be set
|
||||
to nil and the object is considered as initialized and visible to
|
||||
all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with the
|
||||
StatusReason failure. Not all StatusReasons may provide detailed
|
||||
causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the error.
|
||||
If this value is empty there is no information available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the status
|
||||
StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the status
|
||||
StatusReason. On some operations may differ from the requested
|
||||
resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the status
|
||||
StatusReason (when there is a single name which can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should
|
||||
be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource which
|
||||
can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the
|
||||
system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until this
|
||||
reference is removed. Defaults to false. To set this field, a user
|
||||
needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
spec:
|
||||
description:
|
||||
- Spec holds information about the request being evaluated
|
||||
type: complex
|
||||
contains:
|
||||
extra:
|
||||
description:
|
||||
- Extra corresponds to the user.Info.GetExtra() method from the authenticator.
|
||||
Since that is input to the authorizer it needs a reflection here.
|
||||
type: complex
|
||||
contains: str, list[str]
|
||||
groups:
|
||||
description:
|
||||
- Groups is the groups you're testing for.
|
||||
type: list
|
||||
contains: str
|
||||
non_resource_attributes:
|
||||
description:
|
||||
- NonResourceAttributes describes information for a non-resource access
|
||||
request
|
||||
type: complex
|
||||
contains:
|
||||
path:
|
||||
description:
|
||||
- Path is the URL path of the request
|
||||
type: str
|
||||
verb:
|
||||
description:
|
||||
- Verb is the standard HTTP verb
|
||||
type: str
|
||||
resource_attributes:
|
||||
description:
|
||||
- ResourceAuthorizationAttributes describes information for a resource access
|
||||
request
|
||||
type: complex
|
||||
contains:
|
||||
group:
|
||||
description:
|
||||
- Group is the API Group of the Resource. "*" means all.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name is the name of the resource being requested for a "get" or deleted
|
||||
for a "delete". "" (empty) means all.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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
|
||||
type: str
|
||||
resource:
|
||||
description:
|
||||
- Resource is one of the existing resource types. "*" means all.
|
||||
type: str
|
||||
subresource:
|
||||
description:
|
||||
- Subresource is one of the existing resource types. "" means none.
|
||||
type: str
|
||||
verb:
|
||||
description:
|
||||
- 'Verb is a kubernetes resource API verb, like: get, list, watch, create,
|
||||
update, delete, proxy. "*" means all.'
|
||||
type: str
|
||||
version:
|
||||
description:
|
||||
- Version is the API Version of the Resource. "*" means all.
|
||||
type: str
|
||||
user:
|
||||
description:
|
||||
- User is the user you're testing for. If you specify "User" but not "Groups",
|
||||
then is it interpreted as "What if User were not a member of any groups
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- Status is filled in by the server and indicates whether the request is allowed
|
||||
or not
|
||||
type: complex
|
||||
contains:
|
||||
allowed:
|
||||
description:
|
||||
- Allowed is required. True if the action would be allowed, false otherwise.
|
||||
type: bool
|
||||
evaluation_error:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- Reason is optional. It indicates why a request was allowed or denied.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -89,7 +89,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -97,8 +97,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
token_review:
|
||||
type: complex
|
||||
returned: on success
|
||||
@@ -118,354 +118,15 @@ token_review:
|
||||
metadata:
|
||||
description: []
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource will
|
||||
be deleted. This field is set by the server when a graceful deletion is
|
||||
requested by the user, and is not directly settable by a client. The resource
|
||||
is expected to be deleted (no longer visible from resource lists, and
|
||||
not reachable by name) after the time in this field. Once set, this value
|
||||
may not be unset or be set further into the future, although it may be
|
||||
shortened or the resource may be deleted prior to this time. For example,
|
||||
a user may request that a pod is deleted in 30 seconds. The Kubelet will
|
||||
react by sending a graceful termination signal to the containers in the
|
||||
pod. After that 30 seconds, the Kubelet will send a hard termination signal
|
||||
(SIGKILL) to the container and after cleanup, remove the pod from the
|
||||
API. In the presence of network partitions, this object may still exist
|
||||
after this timestamp, until an administrator or automated process can
|
||||
determine the resource is fully terminated. If not set, graceful deletion
|
||||
of the object has not been requested. Populated by the system when a graceful
|
||||
deletion is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired state.
|
||||
Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant at
|
||||
object creation time. This field is a list of initializers that have not
|
||||
yet acted on this object. If nil or empty, this object has been completely
|
||||
initialized. Otherwise, the object is considered uninitialized and is
|
||||
hidden (in list/watch and get calls) from clients that haven't explicitly
|
||||
asked to observe uninitialized objects. When an object is created, the
|
||||
system will populate this list with the current set of initializers. Only
|
||||
privileged users may set or modify this list. Once it is empty, it may
|
||||
not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be set
|
||||
to nil and the object is considered as initialized and visible to
|
||||
all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with the
|
||||
StatusReason failure. Not all StatusReasons may provide detailed
|
||||
causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the error.
|
||||
If this value is empty there is no information available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the status
|
||||
StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the status
|
||||
StatusReason. On some operations may differ from the requested
|
||||
resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the status
|
||||
StatusReason (when there is a single name which can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should
|
||||
be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource which
|
||||
can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the
|
||||
system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until this
|
||||
reference is removed. Defaults to false. To set this field, a user
|
||||
needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
spec:
|
||||
description:
|
||||
- Spec holds information about the request being evaluated
|
||||
type: complex
|
||||
contains:
|
||||
token:
|
||||
description:
|
||||
- Token is the opaque bearer token.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- Status is filled in by the server and indicates whether the request can be
|
||||
authenticated.
|
||||
type: complex
|
||||
contains:
|
||||
authenticated:
|
||||
description:
|
||||
- Authenticated indicates that the token was associated with a known user.
|
||||
type: bool
|
||||
error:
|
||||
description:
|
||||
- Error indicates that the token couldn't be checked
|
||||
type: str
|
||||
user:
|
||||
description:
|
||||
- User is the UserInfo associated with the provided token.
|
||||
type: complex
|
||||
contains:
|
||||
extra:
|
||||
description:
|
||||
- Any additional information provided by the authenticator.
|
||||
type: complex
|
||||
contains: str, list[str]
|
||||
groups:
|
||||
description:
|
||||
- The names of groups this user is a part of.
|
||||
type: list
|
||||
contains: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
username:
|
||||
description:
|
||||
- The name that uniquely identifies this user among all active users.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -112,7 +112,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -120,8 +120,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
cluster_role:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -142,306 +142,6 @@ cluster_role:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource will
|
||||
be deleted. This field is set by the server when a graceful deletion is
|
||||
requested by the user, and is not directly settable by a client. The resource
|
||||
is expected to be deleted (no longer visible from resource lists, and
|
||||
not reachable by name) after the time in this field. Once set, this value
|
||||
may not be unset or be set further into the future, although it may be
|
||||
shortened or the resource may be deleted prior to this time. For example,
|
||||
a user may request that a pod is deleted in 30 seconds. The Kubelet will
|
||||
react by sending a graceful termination signal to the containers in the
|
||||
pod. After that 30 seconds, the Kubelet will send a hard termination signal
|
||||
(SIGKILL) to the container and after cleanup, remove the pod from the
|
||||
API. In the presence of network partitions, this object may still exist
|
||||
after this timestamp, until an administrator or automated process can
|
||||
determine the resource is fully terminated. If not set, graceful deletion
|
||||
of the object has not been requested. Populated by the system when a graceful
|
||||
deletion is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired state.
|
||||
Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant at
|
||||
object creation time. This field is a list of initializers that have not
|
||||
yet acted on this object. If nil or empty, this object has been completely
|
||||
initialized. Otherwise, the object is considered uninitialized and is
|
||||
hidden (in list/watch and get calls) from clients that haven't explicitly
|
||||
asked to observe uninitialized objects. When an object is created, the
|
||||
system will populate this list with the current set of initializers. Only
|
||||
privileged users may set or modify this list. Once it is empty, it may
|
||||
not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be set
|
||||
to nil and the object is considered as initialized and visible to
|
||||
all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with the
|
||||
StatusReason failure. Not all StatusReasons may provide detailed
|
||||
causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the error.
|
||||
If this value is empty there is no information available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the status
|
||||
StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the status
|
||||
StatusReason. On some operations may differ from the requested
|
||||
resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the status
|
||||
StatusReason (when there is a single name which can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should
|
||||
be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource which
|
||||
can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the
|
||||
system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until this
|
||||
reference is removed. Defaults to false. To set this field, a user
|
||||
needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
rules:
|
||||
description:
|
||||
- Rules holds all the PolicyRules for this ClusterRole
|
||||
|
||||
@@ -90,8 +90,6 @@ options:
|
||||
role_ref_name:
|
||||
description:
|
||||
- Name is the name of resource being referenced
|
||||
aliases:
|
||||
- name
|
||||
src:
|
||||
description:
|
||||
- Provide a path to a file containing the YAML definition of the object. Mutually
|
||||
@@ -127,7 +125,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -135,8 +133,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
cluster_role_binding:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -157,324 +155,11 @@ cluster_role_binding:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource will
|
||||
be deleted. This field is set by the server when a graceful deletion is
|
||||
requested by the user, and is not directly settable by a client. The resource
|
||||
is expected to be deleted (no longer visible from resource lists, and
|
||||
not reachable by name) after the time in this field. Once set, this value
|
||||
may not be unset or be set further into the future, although it may be
|
||||
shortened or the resource may be deleted prior to this time. For example,
|
||||
a user may request that a pod is deleted in 30 seconds. The Kubelet will
|
||||
react by sending a graceful termination signal to the containers in the
|
||||
pod. After that 30 seconds, the Kubelet will send a hard termination signal
|
||||
(SIGKILL) to the container and after cleanup, remove the pod from the
|
||||
API. In the presence of network partitions, this object may still exist
|
||||
after this timestamp, until an administrator or automated process can
|
||||
determine the resource is fully terminated. If not set, graceful deletion
|
||||
of the object has not been requested. Populated by the system when a graceful
|
||||
deletion is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired state.
|
||||
Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant at
|
||||
object creation time. This field is a list of initializers that have not
|
||||
yet acted on this object. If nil or empty, this object has been completely
|
||||
initialized. Otherwise, the object is considered uninitialized and is
|
||||
hidden (in list/watch and get calls) from clients that haven't explicitly
|
||||
asked to observe uninitialized objects. When an object is created, the
|
||||
system will populate this list with the current set of initializers. Only
|
||||
privileged users may set or modify this list. Once it is empty, it may
|
||||
not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be set
|
||||
to nil and the object is considered as initialized and visible to
|
||||
all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with the
|
||||
StatusReason failure. Not all StatusReasons may provide detailed
|
||||
causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the error.
|
||||
If this value is empty there is no information available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the status
|
||||
StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the status
|
||||
StatusReason. On some operations may differ from the requested
|
||||
resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the status
|
||||
StatusReason (when there is a single name which can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should
|
||||
be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource which
|
||||
can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the
|
||||
system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until this
|
||||
reference is removed. Defaults to false. To set this field, a user
|
||||
needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
role_ref:
|
||||
description:
|
||||
- RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef
|
||||
cannot be resolved, the Authorizer must return an error.
|
||||
type: complex
|
||||
contains:
|
||||
api_group:
|
||||
description:
|
||||
- APIGroup is the group for the resource being referenced
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- Kind is the type of resource being referenced
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name is the name of resource being referenced
|
||||
type: str
|
||||
subjects:
|
||||
description:
|
||||
- Subjects holds references to the objects the role applies to.
|
||||
|
||||
@@ -86,7 +86,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -94,8 +94,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
cluster_role_binding_list:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -127,334 +127,11 @@ cluster_role_binding_list:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource
|
||||
will be deleted. This field is set by the server when a graceful deletion
|
||||
is requested by the user, and is not directly settable by a client.
|
||||
The resource is expected to be deleted (no longer visible from resource
|
||||
lists, and not reachable by name) after the time in this field. Once
|
||||
set, this value may not be unset or be set further into the future,
|
||||
although it may be shortened or the resource may be deleted prior
|
||||
to this time. For example, a user may request that a pod is deleted
|
||||
in 30 seconds. The Kubelet will react by sending a graceful termination
|
||||
signal to the containers in the pod. After that 30 seconds, the Kubelet
|
||||
will send a hard termination signal (SIGKILL) to the container and
|
||||
after cleanup, remove the pod from the API. In the presence of network
|
||||
partitions, this object may still exist after this timestamp, until
|
||||
an administrator or automated process can determine the resource is
|
||||
fully terminated. If not set, graceful deletion of the object has
|
||||
not been requested. Populated by the system when a graceful deletion
|
||||
is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired
|
||||
state. Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant
|
||||
at object creation time. This field is a list of initializers that
|
||||
have not yet acted on this object. If nil or empty, this object has
|
||||
been completely initialized. Otherwise, the object is considered uninitialized
|
||||
and is hidden (in list/watch and get calls) from clients that haven't
|
||||
explicitly asked to observe uninitialized objects. When an object
|
||||
is created, the system will populate this list with the current set
|
||||
of initializers. Only privileged users may set or modify this list.
|
||||
Once it is empty, it may not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be
|
||||
set to nil and the object is considered as initialized and visible
|
||||
to all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with
|
||||
the StatusReason failure. Not all StatusReasons may provide
|
||||
detailed causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the
|
||||
error. If this value is empty there is no information
|
||||
available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the
|
||||
status StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the
|
||||
status StatusReason. On some operations may differ from
|
||||
the requested resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the
|
||||
status StatusReason (when there is a single name which
|
||||
can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation
|
||||
should be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource
|
||||
which can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated
|
||||
by the system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until
|
||||
this reference is removed. Defaults to false. To set this field,
|
||||
a user needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system.
|
||||
Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
role_ref:
|
||||
description:
|
||||
- RoleRef can only reference a ClusterRole in the global namespace. If the
|
||||
RoleRef cannot be resolved, the Authorizer must return an error.
|
||||
type: complex
|
||||
contains:
|
||||
api_group:
|
||||
description:
|
||||
- APIGroup is the group for the resource being referenced
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- Kind is the type of resource being referenced
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name is the name of resource being referenced
|
||||
type: str
|
||||
subjects:
|
||||
description:
|
||||
- Subjects holds references to the objects the role applies to.
|
||||
@@ -492,18 +169,6 @@ cluster_role_binding_list:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -86,7 +86,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -94,8 +94,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
cluster_role_list:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -127,316 +127,6 @@ cluster_role_list:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource
|
||||
will be deleted. This field is set by the server when a graceful deletion
|
||||
is requested by the user, and is not directly settable by a client.
|
||||
The resource is expected to be deleted (no longer visible from resource
|
||||
lists, and not reachable by name) after the time in this field. Once
|
||||
set, this value may not be unset or be set further into the future,
|
||||
although it may be shortened or the resource may be deleted prior
|
||||
to this time. For example, a user may request that a pod is deleted
|
||||
in 30 seconds. The Kubelet will react by sending a graceful termination
|
||||
signal to the containers in the pod. After that 30 seconds, the Kubelet
|
||||
will send a hard termination signal (SIGKILL) to the container and
|
||||
after cleanup, remove the pod from the API. In the presence of network
|
||||
partitions, this object may still exist after this timestamp, until
|
||||
an administrator or automated process can determine the resource is
|
||||
fully terminated. If not set, graceful deletion of the object has
|
||||
not been requested. Populated by the system when a graceful deletion
|
||||
is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired
|
||||
state. Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant
|
||||
at object creation time. This field is a list of initializers that
|
||||
have not yet acted on this object. If nil or empty, this object has
|
||||
been completely initialized. Otherwise, the object is considered uninitialized
|
||||
and is hidden (in list/watch and get calls) from clients that haven't
|
||||
explicitly asked to observe uninitialized objects. When an object
|
||||
is created, the system will populate this list with the current set
|
||||
of initializers. Only privileged users may set or modify this list.
|
||||
Once it is empty, it may not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be
|
||||
set to nil and the object is considered as initialized and visible
|
||||
to all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with
|
||||
the StatusReason failure. Not all StatusReasons may provide
|
||||
detailed causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the
|
||||
error. If this value is empty there is no information
|
||||
available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the
|
||||
status StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the
|
||||
status StatusReason. On some operations may differ from
|
||||
the requested resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the
|
||||
status StatusReason (when there is a single name which
|
||||
can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation
|
||||
should be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource
|
||||
which can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated
|
||||
by the system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until
|
||||
this reference is removed. Defaults to false. To set this field,
|
||||
a user needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system.
|
||||
Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
rules:
|
||||
description:
|
||||
- Rules holds all the PolicyRules for this ClusterRole
|
||||
@@ -489,18 +179,6 @@ cluster_role_list:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -113,7 +113,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -121,8 +121,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
external_admission_hook_configuration:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -143,28 +143,6 @@ external_admission_hook_configuration:
|
||||
description:
|
||||
- ClientConfig defines how to communicate with the hook. Required
|
||||
type: complex
|
||||
contains:
|
||||
ca_bundle:
|
||||
description:
|
||||
- CABundle is a PEM encoded CA bundle which will be used to validate
|
||||
webhook's server certificate. Required
|
||||
type: str
|
||||
service:
|
||||
description:
|
||||
- Service is a reference to the service for this webhook. If there is
|
||||
only one port open for the service, that port will be used. If there
|
||||
are multiple ports open, port 443 will be used if it is open, otherwise
|
||||
it is an error. Required
|
||||
type: complex
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- Name is the name of the service Required
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- Namespace is the namespace of the service Required
|
||||
type: str
|
||||
failure_policy:
|
||||
description:
|
||||
- FailurePolicy defines how unrecognized errors from the admission endpoint
|
||||
@@ -225,306 +203,6 @@ external_admission_hook_configuration:
|
||||
description:
|
||||
- Standard object metadata;
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource will
|
||||
be deleted. This field is set by the server when a graceful deletion is
|
||||
requested by the user, and is not directly settable by a client. The resource
|
||||
is expected to be deleted (no longer visible from resource lists, and
|
||||
not reachable by name) after the time in this field. Once set, this value
|
||||
may not be unset or be set further into the future, although it may be
|
||||
shortened or the resource may be deleted prior to this time. For example,
|
||||
a user may request that a pod is deleted in 30 seconds. The Kubelet will
|
||||
react by sending a graceful termination signal to the containers in the
|
||||
pod. After that 30 seconds, the Kubelet will send a hard termination signal
|
||||
(SIGKILL) to the container and after cleanup, remove the pod from the
|
||||
API. In the presence of network partitions, this object may still exist
|
||||
after this timestamp, until an administrator or automated process can
|
||||
determine the resource is fully terminated. If not set, graceful deletion
|
||||
of the object has not been requested. Populated by the system when a graceful
|
||||
deletion is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired state.
|
||||
Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant at
|
||||
object creation time. This field is a list of initializers that have not
|
||||
yet acted on this object. If nil or empty, this object has been completely
|
||||
initialized. Otherwise, the object is considered uninitialized and is
|
||||
hidden (in list/watch and get calls) from clients that haven't explicitly
|
||||
asked to observe uninitialized objects. When an object is created, the
|
||||
system will populate this list with the current set of initializers. Only
|
||||
privileged users may set or modify this list. Once it is empty, it may
|
||||
not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be set
|
||||
to nil and the object is considered as initialized and visible to
|
||||
all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with the
|
||||
StatusReason failure. Not all StatusReasons may provide detailed
|
||||
causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the error.
|
||||
If this value is empty there is no information available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the status
|
||||
StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the status
|
||||
StatusReason. On some operations may differ from the requested
|
||||
resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the status
|
||||
StatusReason (when there is a single name which can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should
|
||||
be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource which
|
||||
can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the
|
||||
system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until this
|
||||
reference is removed. Defaults to false. To set this field, a user
|
||||
needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -86,7 +86,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -94,8 +94,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
external_admission_hook_configuration_list:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -127,28 +127,6 @@ external_admission_hook_configuration_list:
|
||||
description:
|
||||
- ClientConfig defines how to communicate with the hook. Required
|
||||
type: complex
|
||||
contains:
|
||||
ca_bundle:
|
||||
description:
|
||||
- CABundle is a PEM encoded CA bundle which will be used to validate
|
||||
webhook's server certificate. Required
|
||||
type: str
|
||||
service:
|
||||
description:
|
||||
- Service is a reference to the service for this webhook. If there
|
||||
is only one port open for the service, that port will be used.
|
||||
If there are multiple ports open, port 443 will be used if it
|
||||
is open, otherwise it is an error. Required
|
||||
type: complex
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- Name is the name of the service Required
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- Namespace is the namespace of the service Required
|
||||
type: str
|
||||
failure_policy:
|
||||
description:
|
||||
- FailurePolicy defines how unrecognized errors from the admission endpoint
|
||||
@@ -210,316 +188,6 @@ external_admission_hook_configuration_list:
|
||||
description:
|
||||
- Standard object metadata;
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource
|
||||
will be deleted. This field is set by the server when a graceful deletion
|
||||
is requested by the user, and is not directly settable by a client.
|
||||
The resource is expected to be deleted (no longer visible from resource
|
||||
lists, and not reachable by name) after the time in this field. Once
|
||||
set, this value may not be unset or be set further into the future,
|
||||
although it may be shortened or the resource may be deleted prior
|
||||
to this time. For example, a user may request that a pod is deleted
|
||||
in 30 seconds. The Kubelet will react by sending a graceful termination
|
||||
signal to the containers in the pod. After that 30 seconds, the Kubelet
|
||||
will send a hard termination signal (SIGKILL) to the container and
|
||||
after cleanup, remove the pod from the API. In the presence of network
|
||||
partitions, this object may still exist after this timestamp, until
|
||||
an administrator or automated process can determine the resource is
|
||||
fully terminated. If not set, graceful deletion of the object has
|
||||
not been requested. Populated by the system when a graceful deletion
|
||||
is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired
|
||||
state. Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant
|
||||
at object creation time. This field is a list of initializers that
|
||||
have not yet acted on this object. If nil or empty, this object has
|
||||
been completely initialized. Otherwise, the object is considered uninitialized
|
||||
and is hidden (in list/watch and get calls) from clients that haven't
|
||||
explicitly asked to observe uninitialized objects. When an object
|
||||
is created, the system will populate this list with the current set
|
||||
of initializers. Only privileged users may set or modify this list.
|
||||
Once it is empty, it may not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be
|
||||
set to nil and the object is considered as initialized and visible
|
||||
to all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with
|
||||
the StatusReason failure. Not all StatusReasons may provide
|
||||
detailed causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the
|
||||
error. If this value is empty there is no information
|
||||
available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the
|
||||
status StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the
|
||||
status StatusReason. On some operations may differ from
|
||||
the requested resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the
|
||||
status StatusReason (when there is a single name which
|
||||
can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation
|
||||
should be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource
|
||||
which can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated
|
||||
by the system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until
|
||||
this reference is removed. Defaults to false. To set this field,
|
||||
a user needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system.
|
||||
Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- Kind is a string value representing the REST resource this object represents.
|
||||
@@ -530,18 +198,6 @@ external_admission_hook_configuration_list:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -115,7 +115,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -123,8 +123,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
initializer_configuration:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -143,14 +143,6 @@ initializer_configuration:
|
||||
the order of the initializers from the same InitializerConfiguration is preserved.
|
||||
type: list
|
||||
contains:
|
||||
failure_policy:
|
||||
description:
|
||||
- FailurePolicy defines what happens if the responsible initializer controller
|
||||
fails to takes action. Allowed values are Ignore, or Fail. If "Ignore"
|
||||
is set, initializer is removed from the initializers list of an object
|
||||
if the timeout is reached; If "Fail" is set, admissionregistration returns
|
||||
timeout error if the timeout is reached.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name is the identifier of the initializer. It will be added to the object
|
||||
@@ -200,306 +192,6 @@ initializer_configuration:
|
||||
description:
|
||||
- Standard object metadata;
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource will
|
||||
be deleted. This field is set by the server when a graceful deletion is
|
||||
requested by the user, and is not directly settable by a client. The resource
|
||||
is expected to be deleted (no longer visible from resource lists, and
|
||||
not reachable by name) after the time in this field. Once set, this value
|
||||
may not be unset or be set further into the future, although it may be
|
||||
shortened or the resource may be deleted prior to this time. For example,
|
||||
a user may request that a pod is deleted in 30 seconds. The Kubelet will
|
||||
react by sending a graceful termination signal to the containers in the
|
||||
pod. After that 30 seconds, the Kubelet will send a hard termination signal
|
||||
(SIGKILL) to the container and after cleanup, remove the pod from the
|
||||
API. In the presence of network partitions, this object may still exist
|
||||
after this timestamp, until an administrator or automated process can
|
||||
determine the resource is fully terminated. If not set, graceful deletion
|
||||
of the object has not been requested. Populated by the system when a graceful
|
||||
deletion is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired state.
|
||||
Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant at
|
||||
object creation time. This field is a list of initializers that have not
|
||||
yet acted on this object. If nil or empty, this object has been completely
|
||||
initialized. Otherwise, the object is considered uninitialized and is
|
||||
hidden (in list/watch and get calls) from clients that haven't explicitly
|
||||
asked to observe uninitialized objects. When an object is created, the
|
||||
system will populate this list with the current set of initializers. Only
|
||||
privileged users may set or modify this list. Once it is empty, it may
|
||||
not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be set
|
||||
to nil and the object is considered as initialized and visible to
|
||||
all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with the
|
||||
StatusReason failure. Not all StatusReasons may provide detailed
|
||||
causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the error.
|
||||
If this value is empty there is no information available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the status
|
||||
StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the status
|
||||
StatusReason. On some operations may differ from the requested
|
||||
resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the status
|
||||
StatusReason (when there is a single name which can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should
|
||||
be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource which
|
||||
can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the
|
||||
system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until this
|
||||
reference is removed. Defaults to false. To set this field, a user
|
||||
needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -86,7 +86,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -94,8 +94,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
initializer_configuration_list:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -126,14 +126,6 @@ initializer_configuration_list:
|
||||
preserved.
|
||||
type: list
|
||||
contains:
|
||||
failure_policy:
|
||||
description:
|
||||
- FailurePolicy defines what happens if the responsible initializer
|
||||
controller fails to takes action. Allowed values are Ignore, or Fail.
|
||||
If "Ignore" is set, initializer is removed from the initializers list
|
||||
of an object if the timeout is reached; If "Fail" is set, admissionregistration
|
||||
returns timeout error if the timeout is reached.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name is the identifier of the initializer. It will be added to the
|
||||
@@ -185,316 +177,6 @@ initializer_configuration_list:
|
||||
description:
|
||||
- Standard object metadata;
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource
|
||||
will be deleted. This field is set by the server when a graceful deletion
|
||||
is requested by the user, and is not directly settable by a client.
|
||||
The resource is expected to be deleted (no longer visible from resource
|
||||
lists, and not reachable by name) after the time in this field. Once
|
||||
set, this value may not be unset or be set further into the future,
|
||||
although it may be shortened or the resource may be deleted prior
|
||||
to this time. For example, a user may request that a pod is deleted
|
||||
in 30 seconds. The Kubelet will react by sending a graceful termination
|
||||
signal to the containers in the pod. After that 30 seconds, the Kubelet
|
||||
will send a hard termination signal (SIGKILL) to the container and
|
||||
after cleanup, remove the pod from the API. In the presence of network
|
||||
partitions, this object may still exist after this timestamp, until
|
||||
an administrator or automated process can determine the resource is
|
||||
fully terminated. If not set, graceful deletion of the object has
|
||||
not been requested. Populated by the system when a graceful deletion
|
||||
is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired
|
||||
state. Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant
|
||||
at object creation time. This field is a list of initializers that
|
||||
have not yet acted on this object. If nil or empty, this object has
|
||||
been completely initialized. Otherwise, the object is considered uninitialized
|
||||
and is hidden (in list/watch and get calls) from clients that haven't
|
||||
explicitly asked to observe uninitialized objects. When an object
|
||||
is created, the system will populate this list with the current set
|
||||
of initializers. Only privileged users may set or modify this list.
|
||||
Once it is empty, it may not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be
|
||||
set to nil and the object is considered as initialized and visible
|
||||
to all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with
|
||||
the StatusReason failure. Not all StatusReasons may provide
|
||||
detailed causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the
|
||||
error. If this value is empty there is no information
|
||||
available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the
|
||||
status StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the
|
||||
status StatusReason. On some operations may differ from
|
||||
the requested resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the
|
||||
status StatusReason (when there is a single name which
|
||||
can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation
|
||||
should be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource
|
||||
which can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated
|
||||
by the system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until
|
||||
this reference is removed. Defaults to false. To set this field,
|
||||
a user needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system.
|
||||
Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- Kind is a string value representing the REST resource this object represents.
|
||||
@@ -505,18 +187,6 @@ initializer_configuration_list:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
187
library/k8s_v1alpha1_priority_class.py
Normal file
187
library/k8s_v1alpha1_priority_class.py
Normal file
@@ -0,0 +1,187 @@
|
||||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
from ansible.module_utils.k8s_common import KubernetesAnsibleModule, KubernetesAnsibleException
|
||||
|
||||
DOCUMENTATION = '''
|
||||
module: k8s_v1alpha1_priority_class
|
||||
short_description: Kubernetes PriorityClass
|
||||
description:
|
||||
- Manage the lifecycle of a priority_class object. Supports check mode, and attempts
|
||||
to to be idempotent.
|
||||
version_added: 2.3.0
|
||||
author: OpenShift (@openshift)
|
||||
options:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: dict
|
||||
api_key:
|
||||
description:
|
||||
- Token used to connect to the API.
|
||||
cert_file:
|
||||
description:
|
||||
- Path to a certificate used to authenticate with the API.
|
||||
type: path
|
||||
context:
|
||||
description:
|
||||
- The name of a context found in the Kubernetes config file.
|
||||
debug:
|
||||
description:
|
||||
- Enable debug output from the OpenShift helper. Logging info is written to KubeObjHelper.log
|
||||
default: false
|
||||
type: bool
|
||||
description:
|
||||
description:
|
||||
- description is an arbitrary string that usually provides guidelines on when
|
||||
this priority class should be used.
|
||||
force:
|
||||
description:
|
||||
- If set to C(True), and I(state) is C(present), an existing object will updated,
|
||||
and lists will be replaced, rather than merged.
|
||||
default: false
|
||||
type: bool
|
||||
global_default:
|
||||
description:
|
||||
- globalDefault specifies whether this PriorityClass should be considered as the
|
||||
default priority for pods that do not have any priority class.
|
||||
type: bool
|
||||
host:
|
||||
description:
|
||||
- Provide a URL for acessing the Kubernetes API.
|
||||
key_file:
|
||||
description:
|
||||
- Path to a key file used to authenticate with the API.
|
||||
type: path
|
||||
kubeconfig:
|
||||
description:
|
||||
- Path to an existing Kubernetes config file. If not provided, and no other connection
|
||||
options are provided, the openshift client will attempt to load the default
|
||||
configuration file from I(~/.kube/config.json).
|
||||
type: path
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: dict
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
password:
|
||||
description:
|
||||
- Provide a password for connecting to the API. Use in conjunction with I(username).
|
||||
resource_definition:
|
||||
description:
|
||||
- Provide the YAML definition for the object, bypassing any modules parameters
|
||||
intended to define object attributes.
|
||||
type: dict
|
||||
src:
|
||||
description:
|
||||
- Provide a path to a file containing the YAML definition of the object. Mutually
|
||||
exclusive with I(resource_definition).
|
||||
type: path
|
||||
ssl_ca_cert:
|
||||
description:
|
||||
- Path to a CA certificate used to authenticate with the API.
|
||||
type: path
|
||||
state:
|
||||
description:
|
||||
- Determines if an object should be created, patched, or deleted. When set to
|
||||
C(present), the object will be created, if it does not exist, or patched, if
|
||||
parameter values differ from the existing object's attributes, and deleted,
|
||||
if set to C(absent). A patch operation results in merging lists and updating
|
||||
dictionaries, with lists being merged into a unique set of values. If a list
|
||||
contains a dictionary with a I(name) or I(type) attribute, a strategic merge
|
||||
is performed, where individual elements with a matching I(name_) or I(type)
|
||||
are merged. To force the replacement of lists, set the I(force) option to C(True).
|
||||
default: present
|
||||
choices:
|
||||
- present
|
||||
- absent
|
||||
username:
|
||||
description:
|
||||
- Provide a username for connecting to the API.
|
||||
value:
|
||||
description:
|
||||
- The value of this priority class. This is the actual priority that pods receive
|
||||
when they have the name of this class in their pod spec.
|
||||
type: int
|
||||
verify_ssl:
|
||||
description:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
description: Requested API version
|
||||
type: string
|
||||
priority_class:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
description:
|
||||
description:
|
||||
- description is an arbitrary string that usually provides guidelines on when
|
||||
this priority class should be used.
|
||||
type: str
|
||||
global_default:
|
||||
description:
|
||||
- globalDefault specifies whether this PriorityClass should be considered as
|
||||
the default priority for pods that do not have any priority class.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
value:
|
||||
description:
|
||||
- The value of this priority class. This is the actual priority that pods receive
|
||||
when they have the name of this class in their pod spec.
|
||||
type: int
|
||||
'''
|
||||
|
||||
|
||||
def main():
|
||||
try:
|
||||
module = KubernetesAnsibleModule('priority_class', 'v1alpha1')
|
||||
except KubernetesAnsibleException as exc:
|
||||
# The helper failed to init, so there is no module object. All we can do is raise the error.
|
||||
raise Exception(exc.message)
|
||||
|
||||
try:
|
||||
module.execute_module()
|
||||
except KubernetesAnsibleException as exc:
|
||||
module.fail_json(msg="Module failed!", error=str(exc))
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
172
library/k8s_v1alpha1_priority_class_list.py
Normal file
172
library/k8s_v1alpha1_priority_class_list.py
Normal file
@@ -0,0 +1,172 @@
|
||||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
from ansible.module_utils.k8s_common import KubernetesAnsibleModule, KubernetesAnsibleException
|
||||
|
||||
DOCUMENTATION = '''
|
||||
module: k8s_v1alpha1_priority_class_list
|
||||
short_description: Kubernetes PriorityClassList
|
||||
description:
|
||||
- Retrieve a list of priority_class. List operations provide a snapshot read of the
|
||||
underlying objects, returning a resource_version representing a consistent version
|
||||
of the listed objects.
|
||||
version_added: 2.3.0
|
||||
author: OpenShift (@openshift)
|
||||
options:
|
||||
api_key:
|
||||
description:
|
||||
- Token used to connect to the API.
|
||||
cert_file:
|
||||
description:
|
||||
- Path to a certificate used to authenticate with the API.
|
||||
type: path
|
||||
context:
|
||||
description:
|
||||
- The name of a context found in the Kubernetes config file.
|
||||
debug:
|
||||
description:
|
||||
- Enable debug output from the OpenShift helper. Logging info is written to KubeObjHelper.log
|
||||
default: false
|
||||
type: bool
|
||||
force:
|
||||
description:
|
||||
- If set to C(True), and I(state) is C(present), an existing object will updated,
|
||||
and lists will be replaced, rather than merged.
|
||||
default: false
|
||||
type: bool
|
||||
host:
|
||||
description:
|
||||
- Provide a URL for acessing the Kubernetes API.
|
||||
key_file:
|
||||
description:
|
||||
- Path to a key file used to authenticate with the API.
|
||||
type: path
|
||||
kubeconfig:
|
||||
description:
|
||||
- Path to an existing Kubernetes config file. If not provided, and no other connection
|
||||
options are provided, the openshift client will attempt to load the default
|
||||
configuration file from I(~/.kube/config.json).
|
||||
type: path
|
||||
password:
|
||||
description:
|
||||
- Provide a password for connecting to the API. Use in conjunction with I(username).
|
||||
resource_definition:
|
||||
description:
|
||||
- Provide the YAML definition for the object, bypassing any modules parameters
|
||||
intended to define object attributes.
|
||||
type: dict
|
||||
src:
|
||||
description:
|
||||
- Provide a path to a file containing the YAML definition of the object. Mutually
|
||||
exclusive with I(resource_definition).
|
||||
type: path
|
||||
ssl_ca_cert:
|
||||
description:
|
||||
- Path to a CA certificate used to authenticate with the API.
|
||||
type: path
|
||||
state:
|
||||
description:
|
||||
- Determines if an object should be created, patched, or deleted. When set to
|
||||
C(present), the object will be created, if it does not exist, or patched, if
|
||||
parameter values differ from the existing object's attributes, and deleted,
|
||||
if set to C(absent). A patch operation results in merging lists and updating
|
||||
dictionaries, with lists being merged into a unique set of values. If a list
|
||||
contains a dictionary with a I(name) or I(type) attribute, a strategic merge
|
||||
is performed, where individual elements with a matching I(name_) or I(type)
|
||||
are merged. To force the replacement of lists, set the I(force) option to C(True).
|
||||
default: present
|
||||
choices:
|
||||
- present
|
||||
- absent
|
||||
username:
|
||||
description:
|
||||
- Provide a username for connecting to the API.
|
||||
verify_ssl:
|
||||
description:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
description: Requested API version
|
||||
type: string
|
||||
priority_class_list:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
items:
|
||||
description:
|
||||
- items is the list of PriorityClasses
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
description:
|
||||
description:
|
||||
- description is an arbitrary string that usually provides guidelines on
|
||||
when this priority class should be used.
|
||||
type: str
|
||||
global_default:
|
||||
description:
|
||||
- globalDefault specifies whether this PriorityClass should be considered
|
||||
as the default priority for pods that do not have any priority class.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
value:
|
||||
description:
|
||||
- The value of this priority class. This is the actual priority that pods
|
||||
receive when they have the name of this class in their pod spec.
|
||||
type: int
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata
|
||||
type: complex
|
||||
'''
|
||||
|
||||
|
||||
def main():
|
||||
try:
|
||||
module = KubernetesAnsibleModule('priority_class_list', 'v1alpha1')
|
||||
except KubernetesAnsibleException as exc:
|
||||
# The helper failed to init, so there is no module object. All we can do is raise the error.
|
||||
raise Exception(exc.message)
|
||||
|
||||
try:
|
||||
module.execute_module()
|
||||
except KubernetesAnsibleException as exc:
|
||||
module.fail_json(msg="Module failed!", error=str(exc))
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
@@ -112,7 +112,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -120,8 +120,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
role:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -142,306 +142,6 @@ role:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource will
|
||||
be deleted. This field is set by the server when a graceful deletion is
|
||||
requested by the user, and is not directly settable by a client. The resource
|
||||
is expected to be deleted (no longer visible from resource lists, and
|
||||
not reachable by name) after the time in this field. Once set, this value
|
||||
may not be unset or be set further into the future, although it may be
|
||||
shortened or the resource may be deleted prior to this time. For example,
|
||||
a user may request that a pod is deleted in 30 seconds. The Kubelet will
|
||||
react by sending a graceful termination signal to the containers in the
|
||||
pod. After that 30 seconds, the Kubelet will send a hard termination signal
|
||||
(SIGKILL) to the container and after cleanup, remove the pod from the
|
||||
API. In the presence of network partitions, this object may still exist
|
||||
after this timestamp, until an administrator or automated process can
|
||||
determine the resource is fully terminated. If not set, graceful deletion
|
||||
of the object has not been requested. Populated by the system when a graceful
|
||||
deletion is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired state.
|
||||
Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant at
|
||||
object creation time. This field is a list of initializers that have not
|
||||
yet acted on this object. If nil or empty, this object has been completely
|
||||
initialized. Otherwise, the object is considered uninitialized and is
|
||||
hidden (in list/watch and get calls) from clients that haven't explicitly
|
||||
asked to observe uninitialized objects. When an object is created, the
|
||||
system will populate this list with the current set of initializers. Only
|
||||
privileged users may set or modify this list. Once it is empty, it may
|
||||
not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be set
|
||||
to nil and the object is considered as initialized and visible to
|
||||
all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with the
|
||||
StatusReason failure. Not all StatusReasons may provide detailed
|
||||
causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the error.
|
||||
If this value is empty there is no information available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the status
|
||||
StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the status
|
||||
StatusReason. On some operations may differ from the requested
|
||||
resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the status
|
||||
StatusReason (when there is a single name which can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should
|
||||
be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource which
|
||||
can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the
|
||||
system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until this
|
||||
reference is removed. Defaults to false. To set this field, a user
|
||||
needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
rules:
|
||||
description:
|
||||
- Rules holds all the PolicyRules for this Role
|
||||
|
||||
@@ -90,8 +90,6 @@ options:
|
||||
role_ref_name:
|
||||
description:
|
||||
- Name is the name of resource being referenced
|
||||
aliases:
|
||||
- name
|
||||
src:
|
||||
description:
|
||||
- Provide a path to a file containing the YAML definition of the object. Mutually
|
||||
@@ -127,7 +125,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -135,8 +133,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
role_binding:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -157,325 +155,12 @@ role_binding:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource will
|
||||
be deleted. This field is set by the server when a graceful deletion is
|
||||
requested by the user, and is not directly settable by a client. The resource
|
||||
is expected to be deleted (no longer visible from resource lists, and
|
||||
not reachable by name) after the time in this field. Once set, this value
|
||||
may not be unset or be set further into the future, although it may be
|
||||
shortened or the resource may be deleted prior to this time. For example,
|
||||
a user may request that a pod is deleted in 30 seconds. The Kubelet will
|
||||
react by sending a graceful termination signal to the containers in the
|
||||
pod. After that 30 seconds, the Kubelet will send a hard termination signal
|
||||
(SIGKILL) to the container and after cleanup, remove the pod from the
|
||||
API. In the presence of network partitions, this object may still exist
|
||||
after this timestamp, until an administrator or automated process can
|
||||
determine the resource is fully terminated. If not set, graceful deletion
|
||||
of the object has not been requested. Populated by the system when a graceful
|
||||
deletion is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired state.
|
||||
Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant at
|
||||
object creation time. This field is a list of initializers that have not
|
||||
yet acted on this object. If nil or empty, this object has been completely
|
||||
initialized. Otherwise, the object is considered uninitialized and is
|
||||
hidden (in list/watch and get calls) from clients that haven't explicitly
|
||||
asked to observe uninitialized objects. When an object is created, the
|
||||
system will populate this list with the current set of initializers. Only
|
||||
privileged users may set or modify this list. Once it is empty, it may
|
||||
not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be set
|
||||
to nil and the object is considered as initialized and visible to
|
||||
all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with the
|
||||
StatusReason failure. Not all StatusReasons may provide detailed
|
||||
causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the error.
|
||||
If this value is empty there is no information available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the status
|
||||
StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the status
|
||||
StatusReason. On some operations may differ from the requested
|
||||
resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the status
|
||||
StatusReason (when there is a single name which can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should
|
||||
be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource which
|
||||
can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the
|
||||
system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until this
|
||||
reference is removed. Defaults to false. To set this field, a user
|
||||
needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
role_ref:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
api_group:
|
||||
description:
|
||||
- APIGroup is the group for the resource being referenced
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- Kind is the type of resource being referenced
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name is the name of resource being referenced
|
||||
type: str
|
||||
subjects:
|
||||
description:
|
||||
- Subjects holds references to the objects the role applies to.
|
||||
|
||||
@@ -86,7 +86,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -94,8 +94,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
role_binding_list:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -127,335 +127,12 @@ role_binding_list:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource
|
||||
will be deleted. This field is set by the server when a graceful deletion
|
||||
is requested by the user, and is not directly settable by a client.
|
||||
The resource is expected to be deleted (no longer visible from resource
|
||||
lists, and not reachable by name) after the time in this field. Once
|
||||
set, this value may not be unset or be set further into the future,
|
||||
although it may be shortened or the resource may be deleted prior
|
||||
to this time. For example, a user may request that a pod is deleted
|
||||
in 30 seconds. The Kubelet will react by sending a graceful termination
|
||||
signal to the containers in the pod. After that 30 seconds, the Kubelet
|
||||
will send a hard termination signal (SIGKILL) to the container and
|
||||
after cleanup, remove the pod from the API. In the presence of network
|
||||
partitions, this object may still exist after this timestamp, until
|
||||
an administrator or automated process can determine the resource is
|
||||
fully terminated. If not set, graceful deletion of the object has
|
||||
not been requested. Populated by the system when a graceful deletion
|
||||
is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired
|
||||
state. Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant
|
||||
at object creation time. This field is a list of initializers that
|
||||
have not yet acted on this object. If nil or empty, this object has
|
||||
been completely initialized. Otherwise, the object is considered uninitialized
|
||||
and is hidden (in list/watch and get calls) from clients that haven't
|
||||
explicitly asked to observe uninitialized objects. When an object
|
||||
is created, the system will populate this list with the current set
|
||||
of initializers. Only privileged users may set or modify this list.
|
||||
Once it is empty, it may not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be
|
||||
set to nil and the object is considered as initialized and visible
|
||||
to all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with
|
||||
the StatusReason failure. Not all StatusReasons may provide
|
||||
detailed causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the
|
||||
error. If this value is empty there is no information
|
||||
available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the
|
||||
status StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the
|
||||
status StatusReason. On some operations may differ from
|
||||
the requested resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the
|
||||
status StatusReason (when there is a single name which
|
||||
can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation
|
||||
should be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource
|
||||
which can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated
|
||||
by the system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until
|
||||
this reference is removed. Defaults to false. To set this field,
|
||||
a user needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system.
|
||||
Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
role_ref:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
api_group:
|
||||
description:
|
||||
- APIGroup is the group for the resource being referenced
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- Kind is the type of resource being referenced
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name is the name of resource being referenced
|
||||
type: str
|
||||
subjects:
|
||||
description:
|
||||
- Subjects holds references to the objects the role applies to.
|
||||
@@ -493,18 +170,6 @@ role_binding_list:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -86,7 +86,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -94,8 +94,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
role_list:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -127,316 +127,6 @@ role_list:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource
|
||||
will be deleted. This field is set by the server when a graceful deletion
|
||||
is requested by the user, and is not directly settable by a client.
|
||||
The resource is expected to be deleted (no longer visible from resource
|
||||
lists, and not reachable by name) after the time in this field. Once
|
||||
set, this value may not be unset or be set further into the future,
|
||||
although it may be shortened or the resource may be deleted prior
|
||||
to this time. For example, a user may request that a pod is deleted
|
||||
in 30 seconds. The Kubelet will react by sending a graceful termination
|
||||
signal to the containers in the pod. After that 30 seconds, the Kubelet
|
||||
will send a hard termination signal (SIGKILL) to the container and
|
||||
after cleanup, remove the pod from the API. In the presence of network
|
||||
partitions, this object may still exist after this timestamp, until
|
||||
an administrator or automated process can determine the resource is
|
||||
fully terminated. If not set, graceful deletion of the object has
|
||||
not been requested. Populated by the system when a graceful deletion
|
||||
is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired
|
||||
state. Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant
|
||||
at object creation time. This field is a list of initializers that
|
||||
have not yet acted on this object. If nil or empty, this object has
|
||||
been completely initialized. Otherwise, the object is considered uninitialized
|
||||
and is hidden (in list/watch and get calls) from clients that haven't
|
||||
explicitly asked to observe uninitialized objects. When an object
|
||||
is created, the system will populate this list with the current set
|
||||
of initializers. Only privileged users may set or modify this list.
|
||||
Once it is empty, it may not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be
|
||||
set to nil and the object is considered as initialized and visible
|
||||
to all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with
|
||||
the StatusReason failure. Not all StatusReasons may provide
|
||||
detailed causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the
|
||||
error. If this value is empty there is no information
|
||||
available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the
|
||||
status StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the
|
||||
status StatusReason. On some operations may differ from
|
||||
the requested resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the
|
||||
status StatusReason (when there is a single name which
|
||||
can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation
|
||||
should be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource
|
||||
which can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated
|
||||
by the system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until
|
||||
this reference is removed. Defaults to false. To set this field,
|
||||
a user needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system.
|
||||
Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
rules:
|
||||
description:
|
||||
- Rules holds all the PolicyRules for this Role
|
||||
@@ -489,18 +179,6 @@ role_list:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -166,7 +166,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -174,8 +174,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
api_service:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -195,398 +195,14 @@ api_service:
|
||||
metadata:
|
||||
description: []
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource will
|
||||
be deleted. This field is set by the server when a graceful deletion is
|
||||
requested by the user, and is not directly settable by a client. The resource
|
||||
is expected to be deleted (no longer visible from resource lists, and
|
||||
not reachable by name) after the time in this field. Once set, this value
|
||||
may not be unset or be set further into the future, although it may be
|
||||
shortened or the resource may be deleted prior to this time. For example,
|
||||
a user may request that a pod is deleted in 30 seconds. The Kubelet will
|
||||
react by sending a graceful termination signal to the containers in the
|
||||
pod. After that 30 seconds, the Kubelet will send a hard termination signal
|
||||
(SIGKILL) to the container and after cleanup, remove the pod from the
|
||||
API. In the presence of network partitions, this object may still exist
|
||||
after this timestamp, until an administrator or automated process can
|
||||
determine the resource is fully terminated. If not set, graceful deletion
|
||||
of the object has not been requested. Populated by the system when a graceful
|
||||
deletion is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired state.
|
||||
Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant at
|
||||
object creation time. This field is a list of initializers that have not
|
||||
yet acted on this object. If nil or empty, this object has been completely
|
||||
initialized. Otherwise, the object is considered uninitialized and is
|
||||
hidden (in list/watch and get calls) from clients that haven't explicitly
|
||||
asked to observe uninitialized objects. When an object is created, the
|
||||
system will populate this list with the current set of initializers. Only
|
||||
privileged users may set or modify this list. Once it is empty, it may
|
||||
not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be set
|
||||
to nil and the object is considered as initialized and visible to
|
||||
all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with the
|
||||
StatusReason failure. Not all StatusReasons may provide detailed
|
||||
causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the error.
|
||||
If this value is empty there is no information available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the status
|
||||
StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the status
|
||||
StatusReason. On some operations may differ from the requested
|
||||
resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the status
|
||||
StatusReason (when there is a single name which can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should
|
||||
be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource which
|
||||
can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the
|
||||
system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until this
|
||||
reference is removed. Defaults to false. To set this field, a user
|
||||
needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
spec:
|
||||
description:
|
||||
- Spec contains information for locating and communicating with a server
|
||||
type: complex
|
||||
contains:
|
||||
ca_bundle:
|
||||
description:
|
||||
- CABundle is a PEM encoded CA bundle which will be used to validate an
|
||||
API server's serving certificate.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- Group is the API group name this server hosts
|
||||
type: str
|
||||
group_priority_minimum:
|
||||
description:
|
||||
- "GroupPriorityMininum is the priority this group should have at least.\
|
||||
\ Higher priority means that the group is prefered by clients over lower\
|
||||
\ priority ones. Note that other versions of this group might specify\
|
||||
\ even higher GroupPriorityMininum values such that the whole group gets\
|
||||
\ a higher priority. The primary sort is based on GroupPriorityMinimum,\
|
||||
\ ordered highest number to lowest (20 before 10). The secondary sort\
|
||||
\ is based on the alphabetical comparison of the name of the object. (v1.bar\
|
||||
\ before v1.foo) We'd recommend something like: *.k8s.io (except extensions)\
|
||||
\ at 18000 and PaaSes (OpenShift, Deis) are recommended to be in the 2000s"
|
||||
type: int
|
||||
insecure_skip_tls_verify:
|
||||
description:
|
||||
- InsecureSkipTLSVerify disables TLS certificate verification when communicating
|
||||
with this server. This is strongly discouraged. You should use the CABundle
|
||||
instead.
|
||||
type: bool
|
||||
service:
|
||||
description:
|
||||
- Service is a reference to the service for this API server. It must communicate
|
||||
on port 443 If the Service is nil, that means the handling for the API
|
||||
groupversion is handled locally on this server. The call will simply delegate
|
||||
to the normal handler chain to be fulfilled.
|
||||
type: complex
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- Name is the name of the service
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- Namespace is the namespace of the service
|
||||
type: str
|
||||
version:
|
||||
description:
|
||||
- Version is the API version this server hosts. For example, "v1"
|
||||
type: str
|
||||
version_priority:
|
||||
description:
|
||||
- VersionPriority controls the ordering of this API version inside of its
|
||||
group. Must be greater than zero. The primary sort is based on VersionPriority,
|
||||
ordered highest to lowest (20 before 10). The secondary sort is based
|
||||
on the alphabetical comparison of the name of the object. (v1.bar before
|
||||
v1.foo) Since it's inside of a group, the number can be small, probably
|
||||
in the 10s.
|
||||
type: int
|
||||
status:
|
||||
description:
|
||||
- Status contains derived information about an API server
|
||||
type: complex
|
||||
contains:
|
||||
conditions:
|
||||
description:
|
||||
- Current service state of apiService.
|
||||
type: list
|
||||
contains:
|
||||
last_transition_time:
|
||||
description:
|
||||
- Last time the condition transitioned from one status to another.
|
||||
type: complex
|
||||
contains: {}
|
||||
message:
|
||||
description:
|
||||
- Human-readable message indicating details about last transition.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- Unique, one-word, CamelCase reason for the condition's last transition.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- Status is the status of the condition. Can be True, False, Unknown.
|
||||
type: str
|
||||
type:
|
||||
description:
|
||||
- Type is the type of the condition.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -86,7 +86,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -94,8 +94,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
api_service_list:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -125,409 +125,14 @@ api_service_list:
|
||||
metadata:
|
||||
description: []
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource
|
||||
will be deleted. This field is set by the server when a graceful deletion
|
||||
is requested by the user, and is not directly settable by a client.
|
||||
The resource is expected to be deleted (no longer visible from resource
|
||||
lists, and not reachable by name) after the time in this field. Once
|
||||
set, this value may not be unset or be set further into the future,
|
||||
although it may be shortened or the resource may be deleted prior
|
||||
to this time. For example, a user may request that a pod is deleted
|
||||
in 30 seconds. The Kubelet will react by sending a graceful termination
|
||||
signal to the containers in the pod. After that 30 seconds, the Kubelet
|
||||
will send a hard termination signal (SIGKILL) to the container and
|
||||
after cleanup, remove the pod from the API. In the presence of network
|
||||
partitions, this object may still exist after this timestamp, until
|
||||
an administrator or automated process can determine the resource is
|
||||
fully terminated. If not set, graceful deletion of the object has
|
||||
not been requested. Populated by the system when a graceful deletion
|
||||
is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired
|
||||
state. Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant
|
||||
at object creation time. This field is a list of initializers that
|
||||
have not yet acted on this object. If nil or empty, this object has
|
||||
been completely initialized. Otherwise, the object is considered uninitialized
|
||||
and is hidden (in list/watch and get calls) from clients that haven't
|
||||
explicitly asked to observe uninitialized objects. When an object
|
||||
is created, the system will populate this list with the current set
|
||||
of initializers. Only privileged users may set or modify this list.
|
||||
Once it is empty, it may not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be
|
||||
set to nil and the object is considered as initialized and visible
|
||||
to all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with
|
||||
the StatusReason failure. Not all StatusReasons may provide
|
||||
detailed causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the
|
||||
error. If this value is empty there is no information
|
||||
available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the
|
||||
status StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the
|
||||
status StatusReason. On some operations may differ from
|
||||
the requested resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the
|
||||
status StatusReason (when there is a single name which
|
||||
can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation
|
||||
should be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource
|
||||
which can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated
|
||||
by the system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until
|
||||
this reference is removed. Defaults to false. To set this field,
|
||||
a user needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system.
|
||||
Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
spec:
|
||||
description:
|
||||
- Spec contains information for locating and communicating with a server
|
||||
type: complex
|
||||
contains:
|
||||
ca_bundle:
|
||||
description:
|
||||
- CABundle is a PEM encoded CA bundle which will be used to validate
|
||||
an API server's serving certificate.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- Group is the API group name this server hosts
|
||||
type: str
|
||||
group_priority_minimum:
|
||||
description:
|
||||
- "GroupPriorityMininum is the priority this group should have at least.\
|
||||
\ Higher priority means that the group is prefered by clients over\
|
||||
\ lower priority ones. Note that other versions of this group might\
|
||||
\ specify even higher GroupPriorityMininum values such that the whole\
|
||||
\ group gets a higher priority. The primary sort is based on GroupPriorityMinimum,\
|
||||
\ ordered highest number to lowest (20 before 10). The secondary sort\
|
||||
\ is based on the alphabetical comparison of the name of the object.\
|
||||
\ (v1.bar before v1.foo) We'd recommend something like: *.k8s.io (except\
|
||||
\ extensions) at 18000 and PaaSes (OpenShift, Deis) are recommended\
|
||||
\ to be in the 2000s"
|
||||
type: int
|
||||
insecure_skip_tls_verify:
|
||||
description:
|
||||
- InsecureSkipTLSVerify disables TLS certificate verification when communicating
|
||||
with this server. This is strongly discouraged. You should use the
|
||||
CABundle instead.
|
||||
type: bool
|
||||
service:
|
||||
description:
|
||||
- Service is a reference to the service for this API server. It must
|
||||
communicate on port 443 If the Service is nil, that means the handling
|
||||
for the API groupversion is handled locally on this server. The call
|
||||
will simply delegate to the normal handler chain to be fulfilled.
|
||||
type: complex
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- Name is the name of the service
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- Namespace is the namespace of the service
|
||||
type: str
|
||||
version:
|
||||
description:
|
||||
- Version is the API version this server hosts. For example, "v1"
|
||||
type: str
|
||||
version_priority:
|
||||
description:
|
||||
- VersionPriority controls the ordering of this API version inside of
|
||||
its group. Must be greater than zero. The primary sort is based on
|
||||
VersionPriority, ordered highest to lowest (20 before 10). The secondary
|
||||
sort is based on the alphabetical comparison of the name of the object.
|
||||
(v1.bar before v1.foo) Since it's inside of a group, the number can
|
||||
be small, probably in the 10s.
|
||||
type: int
|
||||
status:
|
||||
description:
|
||||
- Status contains derived information about an API server
|
||||
type: complex
|
||||
contains:
|
||||
conditions:
|
||||
description:
|
||||
- Current service state of apiService.
|
||||
type: list
|
||||
contains:
|
||||
last_transition_time:
|
||||
description:
|
||||
- Last time the condition transitioned from one status to another.
|
||||
type: complex
|
||||
contains: {}
|
||||
message:
|
||||
description:
|
||||
- Human-readable message indicating details about last transition.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- Unique, one-word, CamelCase reason for the condition's last transition.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- Status is the status of the condition. Can be True, False, Unknown.
|
||||
type: str
|
||||
type:
|
||||
description:
|
||||
- Type is the type of the condition.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- Kind is a string value representing the REST resource this object represents.
|
||||
@@ -537,18 +142,6 @@ api_service_list:
|
||||
metadata:
|
||||
description: []
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -109,8 +109,6 @@ options:
|
||||
spec_username:
|
||||
description:
|
||||
- Information about the requesting user. See user.Info interface for details.
|
||||
aliases:
|
||||
- username
|
||||
src:
|
||||
description:
|
||||
- Provide a path to a file containing the YAML definition of the object. Mutually
|
||||
@@ -142,7 +140,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -150,8 +148,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
certificate_signing_request:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -171,374 +169,14 @@ certificate_signing_request:
|
||||
metadata:
|
||||
description: []
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource will
|
||||
be deleted. This field is set by the server when a graceful deletion is
|
||||
requested by the user, and is not directly settable by a client. The resource
|
||||
is expected to be deleted (no longer visible from resource lists, and
|
||||
not reachable by name) after the time in this field. Once set, this value
|
||||
may not be unset or be set further into the future, although it may be
|
||||
shortened or the resource may be deleted prior to this time. For example,
|
||||
a user may request that a pod is deleted in 30 seconds. The Kubelet will
|
||||
react by sending a graceful termination signal to the containers in the
|
||||
pod. After that 30 seconds, the Kubelet will send a hard termination signal
|
||||
(SIGKILL) to the container and after cleanup, remove the pod from the
|
||||
API. In the presence of network partitions, this object may still exist
|
||||
after this timestamp, until an administrator or automated process can
|
||||
determine the resource is fully terminated. If not set, graceful deletion
|
||||
of the object has not been requested. Populated by the system when a graceful
|
||||
deletion is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired state.
|
||||
Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant at
|
||||
object creation time. This field is a list of initializers that have not
|
||||
yet acted on this object. If nil or empty, this object has been completely
|
||||
initialized. Otherwise, the object is considered uninitialized and is
|
||||
hidden (in list/watch and get calls) from clients that haven't explicitly
|
||||
asked to observe uninitialized objects. When an object is created, the
|
||||
system will populate this list with the current set of initializers. Only
|
||||
privileged users may set or modify this list. Once it is empty, it may
|
||||
not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be set
|
||||
to nil and the object is considered as initialized and visible to
|
||||
all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with the
|
||||
StatusReason failure. Not all StatusReasons may provide detailed
|
||||
causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the error.
|
||||
If this value is empty there is no information available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the status
|
||||
StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the status
|
||||
StatusReason. On some operations may differ from the requested
|
||||
resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the status
|
||||
StatusReason (when there is a single name which can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should
|
||||
be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource which
|
||||
can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the
|
||||
system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until this
|
||||
reference is removed. Defaults to false. To set this field, a user
|
||||
needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
spec:
|
||||
description:
|
||||
- The certificate request itself and any additional information.
|
||||
type: complex
|
||||
contains:
|
||||
extra:
|
||||
description:
|
||||
- Extra information about the requesting user. See user.Info interface for
|
||||
details.
|
||||
type: complex
|
||||
contains: str, list[str]
|
||||
groups:
|
||||
description:
|
||||
- Group information about the requesting user. See user.Info interface for
|
||||
details.
|
||||
type: list
|
||||
contains: str
|
||||
request:
|
||||
description:
|
||||
- Base64-encoded PKCS
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID information about the requesting user. See user.Info interface for
|
||||
details.
|
||||
type: str
|
||||
usages:
|
||||
description:
|
||||
- 'allowedUsages specifies a set of usage contexts the key will be valid
|
||||
for. See:'
|
||||
type: list
|
||||
contains: str
|
||||
username:
|
||||
description:
|
||||
- Information about the requesting user. See user.Info interface for details.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- Derived information about the request.
|
||||
type: complex
|
||||
contains:
|
||||
certificate:
|
||||
description:
|
||||
- If request was approved, the controller will place the issued certificate
|
||||
here.
|
||||
type: str
|
||||
conditions:
|
||||
description:
|
||||
- Conditions applied to the request, such as approval or denial.
|
||||
type: list
|
||||
contains:
|
||||
last_update_time:
|
||||
description:
|
||||
- timestamp for the last update to this condition
|
||||
type: complex
|
||||
contains: {}
|
||||
message:
|
||||
description:
|
||||
- human readable message with details about the request state
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- brief reason for the request state
|
||||
type: str
|
||||
type:
|
||||
description:
|
||||
- request approval state, currently Approved or Denied.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -86,7 +86,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -94,8 +94,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
certificate_signing_request_list:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -125,385 +125,14 @@ certificate_signing_request_list:
|
||||
metadata:
|
||||
description: []
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource
|
||||
will be deleted. This field is set by the server when a graceful deletion
|
||||
is requested by the user, and is not directly settable by a client.
|
||||
The resource is expected to be deleted (no longer visible from resource
|
||||
lists, and not reachable by name) after the time in this field. Once
|
||||
set, this value may not be unset or be set further into the future,
|
||||
although it may be shortened or the resource may be deleted prior
|
||||
to this time. For example, a user may request that a pod is deleted
|
||||
in 30 seconds. The Kubelet will react by sending a graceful termination
|
||||
signal to the containers in the pod. After that 30 seconds, the Kubelet
|
||||
will send a hard termination signal (SIGKILL) to the container and
|
||||
after cleanup, remove the pod from the API. In the presence of network
|
||||
partitions, this object may still exist after this timestamp, until
|
||||
an administrator or automated process can determine the resource is
|
||||
fully terminated. If not set, graceful deletion of the object has
|
||||
not been requested. Populated by the system when a graceful deletion
|
||||
is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired
|
||||
state. Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant
|
||||
at object creation time. This field is a list of initializers that
|
||||
have not yet acted on this object. If nil or empty, this object has
|
||||
been completely initialized. Otherwise, the object is considered uninitialized
|
||||
and is hidden (in list/watch and get calls) from clients that haven't
|
||||
explicitly asked to observe uninitialized objects. When an object
|
||||
is created, the system will populate this list with the current set
|
||||
of initializers. Only privileged users may set or modify this list.
|
||||
Once it is empty, it may not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be
|
||||
set to nil and the object is considered as initialized and visible
|
||||
to all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with
|
||||
the StatusReason failure. Not all StatusReasons may provide
|
||||
detailed causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the
|
||||
error. If this value is empty there is no information
|
||||
available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the
|
||||
status StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the
|
||||
status StatusReason. On some operations may differ from
|
||||
the requested resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the
|
||||
status StatusReason (when there is a single name which
|
||||
can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation
|
||||
should be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource
|
||||
which can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated
|
||||
by the system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until
|
||||
this reference is removed. Defaults to false. To set this field,
|
||||
a user needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system.
|
||||
Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
spec:
|
||||
description:
|
||||
- The certificate request itself and any additional information.
|
||||
type: complex
|
||||
contains:
|
||||
extra:
|
||||
description:
|
||||
- Extra information about the requesting user. See user.Info interface
|
||||
for details.
|
||||
type: complex
|
||||
contains: str, list[str]
|
||||
groups:
|
||||
description:
|
||||
- Group information about the requesting user. See user.Info interface
|
||||
for details.
|
||||
type: list
|
||||
contains: str
|
||||
request:
|
||||
description:
|
||||
- Base64-encoded PKCS
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID information about the requesting user. See user.Info interface
|
||||
for details.
|
||||
type: str
|
||||
usages:
|
||||
description:
|
||||
- 'allowedUsages specifies a set of usage contexts the key will be valid
|
||||
for. See:'
|
||||
type: list
|
||||
contains: str
|
||||
username:
|
||||
description:
|
||||
- Information about the requesting user. See user.Info interface for
|
||||
details.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- Derived information about the request.
|
||||
type: complex
|
||||
contains:
|
||||
certificate:
|
||||
description:
|
||||
- If request was approved, the controller will place the issued certificate
|
||||
here.
|
||||
type: str
|
||||
conditions:
|
||||
description:
|
||||
- Conditions applied to the request, such as approval or denial.
|
||||
type: list
|
||||
contains:
|
||||
last_update_time:
|
||||
description:
|
||||
- timestamp for the last update to this condition
|
||||
type: complex
|
||||
contains: {}
|
||||
message:
|
||||
description:
|
||||
- human readable message with details about the request state
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- brief reason for the request state
|
||||
type: str
|
||||
type:
|
||||
description:
|
||||
- request approval state, currently Approved or Denied.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- Kind is a string value representing the REST resource this object represents.
|
||||
@@ -513,18 +142,6 @@ certificate_signing_request_list:
|
||||
metadata:
|
||||
description: []
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -112,7 +112,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -120,8 +120,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
cluster_role:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -142,306 +142,6 @@ cluster_role:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource will
|
||||
be deleted. This field is set by the server when a graceful deletion is
|
||||
requested by the user, and is not directly settable by a client. The resource
|
||||
is expected to be deleted (no longer visible from resource lists, and
|
||||
not reachable by name) after the time in this field. Once set, this value
|
||||
may not be unset or be set further into the future, although it may be
|
||||
shortened or the resource may be deleted prior to this time. For example,
|
||||
a user may request that a pod is deleted in 30 seconds. The Kubelet will
|
||||
react by sending a graceful termination signal to the containers in the
|
||||
pod. After that 30 seconds, the Kubelet will send a hard termination signal
|
||||
(SIGKILL) to the container and after cleanup, remove the pod from the
|
||||
API. In the presence of network partitions, this object may still exist
|
||||
after this timestamp, until an administrator or automated process can
|
||||
determine the resource is fully terminated. If not set, graceful deletion
|
||||
of the object has not been requested. Populated by the system when a graceful
|
||||
deletion is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired state.
|
||||
Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant at
|
||||
object creation time. This field is a list of initializers that have not
|
||||
yet acted on this object. If nil or empty, this object has been completely
|
||||
initialized. Otherwise, the object is considered uninitialized and is
|
||||
hidden (in list/watch and get calls) from clients that haven't explicitly
|
||||
asked to observe uninitialized objects. When an object is created, the
|
||||
system will populate this list with the current set of initializers. Only
|
||||
privileged users may set or modify this list. Once it is empty, it may
|
||||
not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be set
|
||||
to nil and the object is considered as initialized and visible to
|
||||
all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with the
|
||||
StatusReason failure. Not all StatusReasons may provide detailed
|
||||
causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the error.
|
||||
If this value is empty there is no information available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the status
|
||||
StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the status
|
||||
StatusReason. On some operations may differ from the requested
|
||||
resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the status
|
||||
StatusReason (when there is a single name which can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should
|
||||
be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource which
|
||||
can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the
|
||||
system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until this
|
||||
reference is removed. Defaults to false. To set this field, a user
|
||||
needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
rules:
|
||||
description:
|
||||
- Rules holds all the PolicyRules for this ClusterRole
|
||||
|
||||
@@ -90,8 +90,6 @@ options:
|
||||
role_ref_name:
|
||||
description:
|
||||
- Name is the name of resource being referenced
|
||||
aliases:
|
||||
- name
|
||||
src:
|
||||
description:
|
||||
- Provide a path to a file containing the YAML definition of the object. Mutually
|
||||
@@ -127,7 +125,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -135,8 +133,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
cluster_role_binding:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -157,324 +155,11 @@ cluster_role_binding:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource will
|
||||
be deleted. This field is set by the server when a graceful deletion is
|
||||
requested by the user, and is not directly settable by a client. The resource
|
||||
is expected to be deleted (no longer visible from resource lists, and
|
||||
not reachable by name) after the time in this field. Once set, this value
|
||||
may not be unset or be set further into the future, although it may be
|
||||
shortened or the resource may be deleted prior to this time. For example,
|
||||
a user may request that a pod is deleted in 30 seconds. The Kubelet will
|
||||
react by sending a graceful termination signal to the containers in the
|
||||
pod. After that 30 seconds, the Kubelet will send a hard termination signal
|
||||
(SIGKILL) to the container and after cleanup, remove the pod from the
|
||||
API. In the presence of network partitions, this object may still exist
|
||||
after this timestamp, until an administrator or automated process can
|
||||
determine the resource is fully terminated. If not set, graceful deletion
|
||||
of the object has not been requested. Populated by the system when a graceful
|
||||
deletion is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired state.
|
||||
Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant at
|
||||
object creation time. This field is a list of initializers that have not
|
||||
yet acted on this object. If nil or empty, this object has been completely
|
||||
initialized. Otherwise, the object is considered uninitialized and is
|
||||
hidden (in list/watch and get calls) from clients that haven't explicitly
|
||||
asked to observe uninitialized objects. When an object is created, the
|
||||
system will populate this list with the current set of initializers. Only
|
||||
privileged users may set or modify this list. Once it is empty, it may
|
||||
not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be set
|
||||
to nil and the object is considered as initialized and visible to
|
||||
all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with the
|
||||
StatusReason failure. Not all StatusReasons may provide detailed
|
||||
causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the error.
|
||||
If this value is empty there is no information available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the status
|
||||
StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the status
|
||||
StatusReason. On some operations may differ from the requested
|
||||
resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the status
|
||||
StatusReason (when there is a single name which can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should
|
||||
be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource which
|
||||
can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the
|
||||
system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until this
|
||||
reference is removed. Defaults to false. To set this field, a user
|
||||
needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
role_ref:
|
||||
description:
|
||||
- RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef
|
||||
cannot be resolved, the Authorizer must return an error.
|
||||
type: complex
|
||||
contains:
|
||||
api_group:
|
||||
description:
|
||||
- APIGroup is the group for the resource being referenced
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- Kind is the type of resource being referenced
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name is the name of resource being referenced
|
||||
type: str
|
||||
subjects:
|
||||
description:
|
||||
- Subjects holds references to the objects the role applies to.
|
||||
|
||||
@@ -86,7 +86,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -94,8 +94,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
cluster_role_binding_list:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -127,334 +127,11 @@ cluster_role_binding_list:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource
|
||||
will be deleted. This field is set by the server when a graceful deletion
|
||||
is requested by the user, and is not directly settable by a client.
|
||||
The resource is expected to be deleted (no longer visible from resource
|
||||
lists, and not reachable by name) after the time in this field. Once
|
||||
set, this value may not be unset or be set further into the future,
|
||||
although it may be shortened or the resource may be deleted prior
|
||||
to this time. For example, a user may request that a pod is deleted
|
||||
in 30 seconds. The Kubelet will react by sending a graceful termination
|
||||
signal to the containers in the pod. After that 30 seconds, the Kubelet
|
||||
will send a hard termination signal (SIGKILL) to the container and
|
||||
after cleanup, remove the pod from the API. In the presence of network
|
||||
partitions, this object may still exist after this timestamp, until
|
||||
an administrator or automated process can determine the resource is
|
||||
fully terminated. If not set, graceful deletion of the object has
|
||||
not been requested. Populated by the system when a graceful deletion
|
||||
is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired
|
||||
state. Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant
|
||||
at object creation time. This field is a list of initializers that
|
||||
have not yet acted on this object. If nil or empty, this object has
|
||||
been completely initialized. Otherwise, the object is considered uninitialized
|
||||
and is hidden (in list/watch and get calls) from clients that haven't
|
||||
explicitly asked to observe uninitialized objects. When an object
|
||||
is created, the system will populate this list with the current set
|
||||
of initializers. Only privileged users may set or modify this list.
|
||||
Once it is empty, it may not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be
|
||||
set to nil and the object is considered as initialized and visible
|
||||
to all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with
|
||||
the StatusReason failure. Not all StatusReasons may provide
|
||||
detailed causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the
|
||||
error. If this value is empty there is no information
|
||||
available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the
|
||||
status StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the
|
||||
status StatusReason. On some operations may differ from
|
||||
the requested resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the
|
||||
status StatusReason (when there is a single name which
|
||||
can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation
|
||||
should be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource
|
||||
which can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated
|
||||
by the system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until
|
||||
this reference is removed. Defaults to false. To set this field,
|
||||
a user needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system.
|
||||
Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
role_ref:
|
||||
description:
|
||||
- RoleRef can only reference a ClusterRole in the global namespace. If the
|
||||
RoleRef cannot be resolved, the Authorizer must return an error.
|
||||
type: complex
|
||||
contains:
|
||||
api_group:
|
||||
description:
|
||||
- APIGroup is the group for the resource being referenced
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- Kind is the type of resource being referenced
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name is the name of resource being referenced
|
||||
type: str
|
||||
subjects:
|
||||
description:
|
||||
- Subjects holds references to the objects the role applies to.
|
||||
@@ -492,18 +169,6 @@ cluster_role_binding_list:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -86,7 +86,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -94,8 +94,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
cluster_role_list:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -127,316 +127,6 @@ cluster_role_list:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource
|
||||
will be deleted. This field is set by the server when a graceful deletion
|
||||
is requested by the user, and is not directly settable by a client.
|
||||
The resource is expected to be deleted (no longer visible from resource
|
||||
lists, and not reachable by name) after the time in this field. Once
|
||||
set, this value may not be unset or be set further into the future,
|
||||
although it may be shortened or the resource may be deleted prior
|
||||
to this time. For example, a user may request that a pod is deleted
|
||||
in 30 seconds. The Kubelet will react by sending a graceful termination
|
||||
signal to the containers in the pod. After that 30 seconds, the Kubelet
|
||||
will send a hard termination signal (SIGKILL) to the container and
|
||||
after cleanup, remove the pod from the API. In the presence of network
|
||||
partitions, this object may still exist after this timestamp, until
|
||||
an administrator or automated process can determine the resource is
|
||||
fully terminated. If not set, graceful deletion of the object has
|
||||
not been requested. Populated by the system when a graceful deletion
|
||||
is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired
|
||||
state. Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant
|
||||
at object creation time. This field is a list of initializers that
|
||||
have not yet acted on this object. If nil or empty, this object has
|
||||
been completely initialized. Otherwise, the object is considered uninitialized
|
||||
and is hidden (in list/watch and get calls) from clients that haven't
|
||||
explicitly asked to observe uninitialized objects. When an object
|
||||
is created, the system will populate this list with the current set
|
||||
of initializers. Only privileged users may set or modify this list.
|
||||
Once it is empty, it may not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be
|
||||
set to nil and the object is considered as initialized and visible
|
||||
to all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with
|
||||
the StatusReason failure. Not all StatusReasons may provide
|
||||
detailed causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the
|
||||
error. If this value is empty there is no information
|
||||
available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the
|
||||
status StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the
|
||||
status StatusReason. On some operations may differ from
|
||||
the requested resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the
|
||||
status StatusReason (when there is a single name which
|
||||
can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation
|
||||
should be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource
|
||||
which can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated
|
||||
by the system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until
|
||||
this reference is removed. Defaults to false. To set this field,
|
||||
a user needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system.
|
||||
Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
rules:
|
||||
description:
|
||||
- Rules holds all the PolicyRules for this ClusterRole
|
||||
@@ -487,18 +177,6 @@ cluster_role_list:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -117,7 +117,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -125,8 +125,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
controller_revision:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -141,11 +141,6 @@ controller_revision:
|
||||
description:
|
||||
- Data is the serialized representation of the state.
|
||||
type: complex
|
||||
contains:
|
||||
raw:
|
||||
description:
|
||||
- Raw is the underlying serialization of this object.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- Kind is a string value representing the REST resource this object represents.
|
||||
@@ -156,306 +151,6 @@ controller_revision:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource will
|
||||
be deleted. This field is set by the server when a graceful deletion is
|
||||
requested by the user, and is not directly settable by a client. The resource
|
||||
is expected to be deleted (no longer visible from resource lists, and
|
||||
not reachable by name) after the time in this field. Once set, this value
|
||||
may not be unset or be set further into the future, although it may be
|
||||
shortened or the resource may be deleted prior to this time. For example,
|
||||
a user may request that a pod is deleted in 30 seconds. The Kubelet will
|
||||
react by sending a graceful termination signal to the containers in the
|
||||
pod. After that 30 seconds, the Kubelet will send a hard termination signal
|
||||
(SIGKILL) to the container and after cleanup, remove the pod from the
|
||||
API. In the presence of network partitions, this object may still exist
|
||||
after this timestamp, until an administrator or automated process can
|
||||
determine the resource is fully terminated. If not set, graceful deletion
|
||||
of the object has not been requested. Populated by the system when a graceful
|
||||
deletion is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired state.
|
||||
Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant at
|
||||
object creation time. This field is a list of initializers that have not
|
||||
yet acted on this object. If nil or empty, this object has been completely
|
||||
initialized. Otherwise, the object is considered uninitialized and is
|
||||
hidden (in list/watch and get calls) from clients that haven't explicitly
|
||||
asked to observe uninitialized objects. When an object is created, the
|
||||
system will populate this list with the current set of initializers. Only
|
||||
privileged users may set or modify this list. Once it is empty, it may
|
||||
not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be set
|
||||
to nil and the object is considered as initialized and visible to
|
||||
all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with the
|
||||
StatusReason failure. Not all StatusReasons may provide detailed
|
||||
causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the error.
|
||||
If this value is empty there is no information available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the status
|
||||
StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the status
|
||||
StatusReason. On some operations may differ from the requested
|
||||
resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the status
|
||||
StatusReason (when there is a single name which can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should
|
||||
be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource which
|
||||
can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the
|
||||
system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until this
|
||||
reference is removed. Defaults to false. To set this field, a user
|
||||
needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
revision:
|
||||
description:
|
||||
- Revision indicates the revision of the state represented by Data.
|
||||
|
||||
@@ -86,7 +86,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -94,8 +94,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
controller_revision_list:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -121,11 +121,6 @@ controller_revision_list:
|
||||
description:
|
||||
- Data is the serialized representation of the state.
|
||||
type: complex
|
||||
contains:
|
||||
raw:
|
||||
description:
|
||||
- Raw is the underlying serialization of this object.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- Kind is a string value representing the REST resource this object represents.
|
||||
@@ -136,316 +131,6 @@ controller_revision_list:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource
|
||||
will be deleted. This field is set by the server when a graceful deletion
|
||||
is requested by the user, and is not directly settable by a client.
|
||||
The resource is expected to be deleted (no longer visible from resource
|
||||
lists, and not reachable by name) after the time in this field. Once
|
||||
set, this value may not be unset or be set further into the future,
|
||||
although it may be shortened or the resource may be deleted prior
|
||||
to this time. For example, a user may request that a pod is deleted
|
||||
in 30 seconds. The Kubelet will react by sending a graceful termination
|
||||
signal to the containers in the pod. After that 30 seconds, the Kubelet
|
||||
will send a hard termination signal (SIGKILL) to the container and
|
||||
after cleanup, remove the pod from the API. In the presence of network
|
||||
partitions, this object may still exist after this timestamp, until
|
||||
an administrator or automated process can determine the resource is
|
||||
fully terminated. If not set, graceful deletion of the object has
|
||||
not been requested. Populated by the system when a graceful deletion
|
||||
is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired
|
||||
state. Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant
|
||||
at object creation time. This field is a list of initializers that
|
||||
have not yet acted on this object. If nil or empty, this object has
|
||||
been completely initialized. Otherwise, the object is considered uninitialized
|
||||
and is hidden (in list/watch and get calls) from clients that haven't
|
||||
explicitly asked to observe uninitialized objects. When an object
|
||||
is created, the system will populate this list with the current set
|
||||
of initializers. Only privileged users may set or modify this list.
|
||||
Once it is empty, it may not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be
|
||||
set to nil and the object is considered as initialized and visible
|
||||
to all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with
|
||||
the StatusReason failure. Not all StatusReasons may provide
|
||||
detailed causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the
|
||||
error. If this value is empty there is no information
|
||||
available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the
|
||||
status StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the
|
||||
status StatusReason. On some operations may differ from
|
||||
the requested resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the
|
||||
status StatusReason (when there is a single name which
|
||||
can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation
|
||||
should be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource
|
||||
which can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated
|
||||
by the system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until
|
||||
this reference is removed. Defaults to false. To set this field,
|
||||
a user needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system.
|
||||
Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
revision:
|
||||
description:
|
||||
- Revision indicates the revision of the state represented by Data.
|
||||
@@ -460,18 +145,6 @@ controller_revision_list:
|
||||
description:
|
||||
- ''
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
616
library/k8s_v1beta1_cron_job.py
Normal file
616
library/k8s_v1beta1_cron_job.py
Normal file
@@ -0,0 +1,616 @@
|
||||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
from ansible.module_utils.k8s_common import KubernetesAnsibleModule, KubernetesAnsibleException
|
||||
|
||||
DOCUMENTATION = '''
|
||||
module: k8s_v1beta1_cron_job
|
||||
short_description: Kubernetes CronJob
|
||||
description:
|
||||
- Manage the lifecycle of a cron_job object. Supports check mode, and attempts to
|
||||
to be idempotent.
|
||||
version_added: 2.3.0
|
||||
author: OpenShift (@openshift)
|
||||
options:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: dict
|
||||
api_key:
|
||||
description:
|
||||
- Token used to connect to the API.
|
||||
cert_file:
|
||||
description:
|
||||
- Path to a certificate used to authenticate with the API.
|
||||
type: path
|
||||
context:
|
||||
description:
|
||||
- The name of a context found in the Kubernetes config file.
|
||||
debug:
|
||||
description:
|
||||
- Enable debug output from the OpenShift helper. Logging info is written to KubeObjHelper.log
|
||||
default: false
|
||||
type: bool
|
||||
force:
|
||||
description:
|
||||
- If set to C(True), and I(state) is C(present), an existing object will updated,
|
||||
and lists will be replaced, rather than merged.
|
||||
default: false
|
||||
type: bool
|
||||
host:
|
||||
description:
|
||||
- Provide a URL for acessing the Kubernetes API.
|
||||
key_file:
|
||||
description:
|
||||
- Path to a key file used to authenticate with the API.
|
||||
type: path
|
||||
kubeconfig:
|
||||
description:
|
||||
- Path to an existing Kubernetes config file. If not provided, and no other connection
|
||||
options are provided, the openshift client will attempt to load the default
|
||||
configuration file from I(~/.kube/config.json).
|
||||
type: path
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: dict
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
password:
|
||||
description:
|
||||
- Provide a password for connecting to the API. Use in conjunction with I(username).
|
||||
resource_definition:
|
||||
description:
|
||||
- Provide the YAML definition for the object, bypassing any modules parameters
|
||||
intended to define object attributes.
|
||||
type: dict
|
||||
spec_concurrency_policy:
|
||||
description:
|
||||
- Specifies how to treat concurrent executions of a Job. Defaults to Allow.
|
||||
aliases:
|
||||
- concurrency_policy
|
||||
spec_failed_jobs_history_limit:
|
||||
description:
|
||||
- The number of failed finished jobs to retain. This is a pointer to distinguish
|
||||
between explicit zero and not specified. Defaults to 1.
|
||||
aliases:
|
||||
- failed_jobs_history_limit
|
||||
type: int
|
||||
spec_job_template_metadata_annotations:
|
||||
description:
|
||||
- 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.
|
||||
aliases:
|
||||
- job__metadata_annotations
|
||||
type: dict
|
||||
spec_job_template_metadata_labels:
|
||||
description:
|
||||
- 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.
|
||||
aliases:
|
||||
- job__metadata_labels
|
||||
type: dict
|
||||
spec_job_template_metadata_name:
|
||||
description:
|
||||
- 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.
|
||||
aliases:
|
||||
- job__metadata_name
|
||||
spec_job_template_metadata_namespace:
|
||||
description:
|
||||
- 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.
|
||||
aliases:
|
||||
- job__metadata_namespace
|
||||
spec_job_template_spec_active_deadline_seconds:
|
||||
description:
|
||||
- Specifies the duration in seconds relative to the startTime that the job may
|
||||
be active before the system tries to terminate it; value must be positive integer
|
||||
aliases:
|
||||
- job__active_deadline_seconds
|
||||
type: int
|
||||
spec_job_template_spec_backoff_limit:
|
||||
description:
|
||||
- Specifies the number of retries before marking this job failed. Defaults to
|
||||
6
|
||||
aliases:
|
||||
- job__backoff_limit
|
||||
type: int
|
||||
spec_job_template_spec_completions:
|
||||
description:
|
||||
- Specifies the desired number of successfully finished pods the job should be
|
||||
run with. Setting to nil means that the success of any pod signals the success
|
||||
of all pods, and allows parallelism to have any positive value. Setting to 1
|
||||
means that parallelism is limited to 1 and the success of that pod signals the
|
||||
success of the job.
|
||||
aliases:
|
||||
- job__completions
|
||||
type: int
|
||||
spec_job_template_spec_manual_selector:
|
||||
description:
|
||||
- manualSelector controls generation of pod labels and pod selectors. Leave `manualSelector`
|
||||
unset unless you are certain what you are doing. When false or unset, the system
|
||||
pick labels unique to this job and appends those labels to the pod template.
|
||||
When true, the user is responsible for picking unique labels and specifying
|
||||
the selector. Failure to pick a unique label may cause this and other jobs to
|
||||
not function correctly. However, You may see `manualSelector=true` in jobs that
|
||||
were created with the old `extensions/v1beta1` API.
|
||||
aliases:
|
||||
- job__manual_selector
|
||||
type: bool
|
||||
spec_job_template_spec_parallelism:
|
||||
description:
|
||||
- Specifies the maximum desired number of pods the job should run at any given
|
||||
time. The actual number of pods running in steady state will be less than this
|
||||
number when ((.spec.completions - .status.successful) < .spec.parallelism),
|
||||
i.e. when the work left to do is less than max parallelism.
|
||||
aliases:
|
||||
- job__parallelism
|
||||
type: int
|
||||
spec_job_template_spec_selector_match_expressions:
|
||||
description:
|
||||
- matchExpressions is a list of label selector requirements. The requirements
|
||||
are ANDed.
|
||||
aliases:
|
||||
- job__selector_match_expressions
|
||||
type: list
|
||||
spec_job_template_spec_selector_match_labels:
|
||||
description:
|
||||
- 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.
|
||||
aliases:
|
||||
- job__selector_match_labels
|
||||
type: dict
|
||||
spec_job_template_spec_template_metadata_annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: dict
|
||||
spec_job_template_spec_template_metadata_labels:
|
||||
description:
|
||||
- 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.
|
||||
type: dict
|
||||
spec_job_template_spec_template_metadata_name:
|
||||
description:
|
||||
- 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.
|
||||
spec_job_template_spec_template_metadata_namespace:
|
||||
description:
|
||||
- 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.
|
||||
spec_job_template_spec_template_spec_active_deadline_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
spec_job_template_spec_template_spec_affinity_node_affinity_preferred_during_scheduling_ignored_during_execution:
|
||||
description:
|
||||
- The scheduler will prefer to schedule pods to nodes that satisfy the affinity
|
||||
expressions specified by this field, but it may choose a node that violates
|
||||
one or more of the expressions. The node that is most preferred is the one with
|
||||
the greatest sum of weights, i.e. for each node that meets all of the scheduling
|
||||
requirements (resource request, requiredDuringScheduling affinity expressions,
|
||||
etc.), compute a sum by iterating through the elements of this field and adding
|
||||
"weight" to the sum if the node matches the corresponding matchExpressions;
|
||||
the node(s) with the highest sum are the most preferred.
|
||||
aliases:
|
||||
- job__affinity_node_affinity_preferred_during_scheduling_ignored_during_execution
|
||||
type: list
|
||||
? spec_job_template_spec_template_spec_affinity_node_affinity_required_during_scheduling_ignored_during_execution_node_selector_terms
|
||||
: description:
|
||||
- Required. A list of node selector terms. The terms are ORed.
|
||||
aliases:
|
||||
- job__affinity_node_affinity_required_during_scheduling_ignored_during_execution_node_selector_terms
|
||||
type: list
|
||||
spec_job_template_spec_template_spec_affinity_pod_affinity_preferred_during_scheduling_ignored_during_execution:
|
||||
description:
|
||||
- The scheduler will prefer to schedule pods to nodes that satisfy the affinity
|
||||
expressions specified by this field, but it may choose a node that violates
|
||||
one or more of the expressions. The node that is most preferred is the one with
|
||||
the greatest sum of weights, i.e. for each node that meets all of the scheduling
|
||||
requirements (resource request, requiredDuringScheduling affinity expressions,
|
||||
etc.), compute a sum by iterating through the elements of this field and adding
|
||||
"weight" to the sum if the node has pods which matches the corresponding podAffinityTerm;
|
||||
the node(s) with the highest sum are the most preferred.
|
||||
aliases:
|
||||
- job__affinity_pod_affinity_preferred_during_scheduling_ignored_during_execution
|
||||
type: list
|
||||
spec_job_template_spec_template_spec_affinity_pod_affinity_required_during_scheduling_ignored_during_execution:
|
||||
description:
|
||||
- If the affinity requirements specified by this field are not met at scheduling
|
||||
time, the pod will not be scheduled onto the node. If the affinity requirements
|
||||
specified by this field cease to be met at some point during pod execution (e.g.
|
||||
due to a pod label update), the system may or may not try to eventually evict
|
||||
the pod from its node. When there are multiple elements, the lists of nodes
|
||||
corresponding to each podAffinityTerm are intersected, i.e. all terms must be
|
||||
satisfied.
|
||||
aliases:
|
||||
- job__affinity_pod_affinity_required_during_scheduling_ignored_during_execution
|
||||
type: list
|
||||
spec_job_template_spec_template_spec_affinity_pod_anti_affinity_preferred_during_scheduling_ignored_during_execution:
|
||||
description:
|
||||
- The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity
|
||||
expressions specified by this field, but it may choose a node that violates
|
||||
one or more of the expressions. The node that is most preferred is the one with
|
||||
the greatest sum of weights, i.e. for each node that meets all of the scheduling
|
||||
requirements (resource request, requiredDuringScheduling anti-affinity expressions,
|
||||
etc.), compute a sum by iterating through the elements of this field and adding
|
||||
"weight" to the sum if the node has pods which matches the corresponding podAffinityTerm;
|
||||
the node(s) with the highest sum are the most preferred.
|
||||
aliases:
|
||||
- job__affinity_pod_anti_affinity_preferred_during_scheduling_ignored_during_execution
|
||||
type: list
|
||||
spec_job_template_spec_template_spec_affinity_pod_anti_affinity_required_during_scheduling_ignored_during_execution:
|
||||
description:
|
||||
- If the anti-affinity requirements specified by this field are not met at scheduling
|
||||
time, the pod will not be scheduled onto the node. If the anti-affinity requirements
|
||||
specified by this field cease to be met at some point during pod execution (e.g.
|
||||
due to a pod label update), the system may or may not try to eventually evict
|
||||
the pod from its node. When there are multiple elements, the lists of nodes
|
||||
corresponding to each podAffinityTerm are intersected, i.e. all terms must be
|
||||
satisfied.
|
||||
aliases:
|
||||
- job__affinity_pod_anti_affinity_required_during_scheduling_ignored_during_execution
|
||||
type: list
|
||||
spec_job_template_spec_template_spec_automount_service_account_token:
|
||||
description:
|
||||
- AutomountServiceAccountToken indicates whether a service account token should
|
||||
be automatically mounted.
|
||||
aliases:
|
||||
- job__automount_service_account_token
|
||||
type: bool
|
||||
spec_job_template_spec_template_spec_containers:
|
||||
description:
|
||||
- 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.
|
||||
aliases:
|
||||
- job__containers
|
||||
type: list
|
||||
spec_job_template_spec_template_spec_dns_policy:
|
||||
description:
|
||||
- Set DNS policy for containers within the pod. One of 'ClusterFirstWithHostNet',
|
||||
'ClusterFirst' or 'Default'. Defaults to "ClusterFirst". To have DNS options
|
||||
set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.
|
||||
aliases:
|
||||
- job__dns_policy
|
||||
spec_job_template_spec_template_spec_host_aliases:
|
||||
description:
|
||||
- HostAliases is an optional list of hosts and IPs that will be injected into
|
||||
the pod's hosts file if specified. This is only valid for non-hostNetwork pods.
|
||||
aliases:
|
||||
- job__host_aliases
|
||||
type: list
|
||||
spec_job_template_spec_template_spec_host_ipc:
|
||||
description:
|
||||
- "Use the host's ipc namespace. Optional: Default to false."
|
||||
aliases:
|
||||
- job__host_ipc
|
||||
type: bool
|
||||
spec_job_template_spec_template_spec_host_network:
|
||||
description:
|
||||
- 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.
|
||||
aliases:
|
||||
- job__host_network
|
||||
type: bool
|
||||
spec_job_template_spec_template_spec_host_pid:
|
||||
description:
|
||||
- "Use the host's pid namespace. Optional: Default to false."
|
||||
aliases:
|
||||
- job__host_pid
|
||||
type: bool
|
||||
spec_job_template_spec_template_spec_hostname:
|
||||
description:
|
||||
- Specifies the hostname of the Pod If not specified, the pod's hostname will
|
||||
be set to a system-defined value.
|
||||
aliases:
|
||||
- job__hostname
|
||||
spec_job_template_spec_template_spec_image_pull_secrets:
|
||||
description:
|
||||
- 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.
|
||||
aliases:
|
||||
- job__image_pull_secrets
|
||||
type: list
|
||||
spec_job_template_spec_template_spec_init_containers:
|
||||
description:
|
||||
- List of initialization containers belonging to the pod. Init containers are
|
||||
executed in order prior to containers being started. If any init container fails,
|
||||
the pod is considered to have failed and is handled according to its restartPolicy.
|
||||
The name for an init container or normal container must be unique among all
|
||||
containers. Init containers may not have Lifecycle actions, Readiness probes,
|
||||
or Liveness probes. The resourceRequirements of an init container are taken
|
||||
into account during scheduling by finding the highest request/limit for each
|
||||
resource type, and then using the max of of that value or the sum of the normal
|
||||
containers. Limits are applied to init containers in a similar fashion. Init
|
||||
containers cannot currently be added or removed. Cannot be updated.
|
||||
aliases:
|
||||
- job__init_containers
|
||||
type: list
|
||||
spec_job_template_spec_template_spec_node_name:
|
||||
description:
|
||||
- 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.
|
||||
aliases:
|
||||
- job__node_name
|
||||
spec_job_template_spec_template_spec_node_selector:
|
||||
description:
|
||||
- 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.
|
||||
aliases:
|
||||
- job__node_selector
|
||||
type: dict
|
||||
spec_job_template_spec_template_spec_priority:
|
||||
description:
|
||||
- The priority value. Various system components use this field to find the priority
|
||||
of the pod. When Priority Admission Controller is enabled, it prevents users
|
||||
from setting this field. The admission controller populates this field from
|
||||
PriorityClassName. The higher the value, the higher the priority.
|
||||
aliases:
|
||||
- job__priority
|
||||
type: int
|
||||
spec_job_template_spec_template_spec_priority_class_name:
|
||||
description:
|
||||
- If specified, indicates the pod's priority. "SYSTEM" is a special keyword which
|
||||
indicates the highest priority. Any other name must be defined by creating a
|
||||
PriorityClass object with that name. If not specified, the pod priority will
|
||||
be default or zero if there is no default.
|
||||
aliases:
|
||||
- job__priority_class_name
|
||||
spec_job_template_spec_template_spec_restart_policy:
|
||||
description:
|
||||
- Restart policy for all containers within the pod. One of Always, OnFailure,
|
||||
Never. Default to Always.
|
||||
aliases:
|
||||
- job__restart_policy
|
||||
spec_job_template_spec_template_spec_scheduler_name:
|
||||
description:
|
||||
- If specified, the pod will be dispatched by specified scheduler. If not specified,
|
||||
the pod will be dispatched by default scheduler.
|
||||
aliases:
|
||||
- job__scheduler_name
|
||||
spec_job_template_spec_template_spec_security_context_fs_group:
|
||||
description:
|
||||
- "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---- If unset, the Kubelet will not modify the ownership\
|
||||
\ and permissions of any volume."
|
||||
aliases:
|
||||
- job__securitycontext_fs_group
|
||||
type: int
|
||||
spec_job_template_spec_template_spec_security_context_run_as_non_root:
|
||||
description:
|
||||
- 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.
|
||||
aliases:
|
||||
- job__securitycontext_run_as_non_root
|
||||
type: bool
|
||||
spec_job_template_spec_template_spec_security_context_run_as_user:
|
||||
description:
|
||||
- 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.
|
||||
aliases:
|
||||
- job__securitycontext_run_as_user
|
||||
type: int
|
||||
spec_job_template_spec_template_spec_security_context_se_linux_options_level:
|
||||
description:
|
||||
- Level is SELinux level label that applies to the container.
|
||||
aliases:
|
||||
- job__securitycontext_se_linux_options_level
|
||||
spec_job_template_spec_template_spec_security_context_se_linux_options_role:
|
||||
description:
|
||||
- Role is a SELinux role label that applies to the container.
|
||||
aliases:
|
||||
- job__securitycontext_se_linux_options_role
|
||||
spec_job_template_spec_template_spec_security_context_se_linux_options_type:
|
||||
description:
|
||||
- Type is a SELinux type label that applies to the container.
|
||||
aliases:
|
||||
- job__securitycontext_se_linux_options_type
|
||||
spec_job_template_spec_template_spec_security_context_se_linux_options_user:
|
||||
description:
|
||||
- User is a SELinux user label that applies to the container.
|
||||
aliases:
|
||||
- job__securitycontext_se_linux_options_user
|
||||
spec_job_template_spec_template_spec_security_context_supplemental_groups:
|
||||
description:
|
||||
- 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.
|
||||
aliases:
|
||||
- job__securitycontext_supplemental_groups
|
||||
type: list
|
||||
spec_job_template_spec_template_spec_service_account:
|
||||
description:
|
||||
- 'DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated:
|
||||
Use serviceAccountName instead.'
|
||||
aliases:
|
||||
- job__service_account
|
||||
spec_job_template_spec_template_spec_service_account_name:
|
||||
description:
|
||||
- ServiceAccountName is the name of the ServiceAccount to use to run this pod.
|
||||
aliases:
|
||||
- job__service_account_name
|
||||
spec_job_template_spec_template_spec_subdomain:
|
||||
description:
|
||||
- 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.
|
||||
aliases:
|
||||
- job__subdomain
|
||||
spec_job_template_spec_template_spec_termination_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
aliases:
|
||||
- job__termination_grace_period_seconds
|
||||
type: int
|
||||
spec_job_template_spec_template_spec_tolerations:
|
||||
description:
|
||||
- If specified, the pod's tolerations.
|
||||
aliases:
|
||||
- job__tolerations
|
||||
type: list
|
||||
spec_job_template_spec_template_spec_volumes:
|
||||
description:
|
||||
- List of volumes that can be mounted by containers belonging to the pod.
|
||||
aliases:
|
||||
- job__volumes
|
||||
type: list
|
||||
spec_schedule:
|
||||
description:
|
||||
- The schedule in Cron format, see
|
||||
aliases:
|
||||
- schedule
|
||||
spec_starting_deadline_seconds:
|
||||
description:
|
||||
- Optional deadline in seconds for starting the job if it misses scheduled time
|
||||
for any reason. Missed jobs executions will be counted as failed ones.
|
||||
aliases:
|
||||
- starting_deadline_seconds
|
||||
type: int
|
||||
spec_successful_jobs_history_limit:
|
||||
description:
|
||||
- The number of successful finished jobs to retain. This is a pointer to distinguish
|
||||
between explicit zero and not specified. Defaults to 3.
|
||||
aliases:
|
||||
- successful_jobs_history_limit
|
||||
type: int
|
||||
spec_suspend:
|
||||
description:
|
||||
- This flag tells the controller to suspend subsequent executions, it does not
|
||||
apply to already started executions. Defaults to false.
|
||||
aliases:
|
||||
- suspend
|
||||
type: bool
|
||||
src:
|
||||
description:
|
||||
- Provide a path to a file containing the YAML definition of the object. Mutually
|
||||
exclusive with I(resource_definition).
|
||||
type: path
|
||||
ssl_ca_cert:
|
||||
description:
|
||||
- Path to a CA certificate used to authenticate with the API.
|
||||
type: path
|
||||
state:
|
||||
description:
|
||||
- Determines if an object should be created, patched, or deleted. When set to
|
||||
C(present), the object will be created, if it does not exist, or patched, if
|
||||
parameter values differ from the existing object's attributes, and deleted,
|
||||
if set to C(absent). A patch operation results in merging lists and updating
|
||||
dictionaries, with lists being merged into a unique set of values. If a list
|
||||
contains a dictionary with a I(name) or I(type) attribute, a strategic merge
|
||||
is performed, where individual elements with a matching I(name_) or I(type)
|
||||
are merged. To force the replacement of lists, set the I(force) option to C(True).
|
||||
default: present
|
||||
choices:
|
||||
- present
|
||||
- absent
|
||||
username:
|
||||
description:
|
||||
- Provide a username for connecting to the API.
|
||||
verify_ssl:
|
||||
description:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
description: Requested API version
|
||||
type: string
|
||||
cron_job:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
spec:
|
||||
description:
|
||||
- Specification of the desired behavior of a cron job, including the schedule.
|
||||
type: complex
|
||||
status:
|
||||
description:
|
||||
- Current status of a cron job.
|
||||
type: complex
|
||||
'''
|
||||
|
||||
|
||||
def main():
|
||||
try:
|
||||
module = KubernetesAnsibleModule('cron_job', 'v1beta1')
|
||||
except KubernetesAnsibleException as exc:
|
||||
# The helper failed to init, so there is no module object. All we can do is raise the error.
|
||||
raise Exception(exc.message)
|
||||
|
||||
try:
|
||||
module.execute_module()
|
||||
except KubernetesAnsibleException as exc:
|
||||
module.fail_json(msg="Module failed!", error=str(exc))
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
165
library/k8s_v1beta1_cron_job_list.py
Normal file
165
library/k8s_v1beta1_cron_job_list.py
Normal file
@@ -0,0 +1,165 @@
|
||||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
from ansible.module_utils.k8s_common import KubernetesAnsibleModule, KubernetesAnsibleException
|
||||
|
||||
DOCUMENTATION = '''
|
||||
module: k8s_v1beta1_cron_job_list
|
||||
short_description: Kubernetes CronJobList
|
||||
description:
|
||||
- Retrieve a list of cron_jobs. List operations provide a snapshot read of the underlying
|
||||
objects, returning a resource_version representing a consistent version of the listed
|
||||
objects.
|
||||
version_added: 2.3.0
|
||||
author: OpenShift (@openshift)
|
||||
options:
|
||||
api_key:
|
||||
description:
|
||||
- Token used to connect to the API.
|
||||
cert_file:
|
||||
description:
|
||||
- Path to a certificate used to authenticate with the API.
|
||||
type: path
|
||||
context:
|
||||
description:
|
||||
- The name of a context found in the Kubernetes config file.
|
||||
debug:
|
||||
description:
|
||||
- Enable debug output from the OpenShift helper. Logging info is written to KubeObjHelper.log
|
||||
default: false
|
||||
type: bool
|
||||
force:
|
||||
description:
|
||||
- If set to C(True), and I(state) is C(present), an existing object will updated,
|
||||
and lists will be replaced, rather than merged.
|
||||
default: false
|
||||
type: bool
|
||||
host:
|
||||
description:
|
||||
- Provide a URL for acessing the Kubernetes API.
|
||||
key_file:
|
||||
description:
|
||||
- Path to a key file used to authenticate with the API.
|
||||
type: path
|
||||
kubeconfig:
|
||||
description:
|
||||
- Path to an existing Kubernetes config file. If not provided, and no other connection
|
||||
options are provided, the openshift client will attempt to load the default
|
||||
configuration file from I(~/.kube/config.json).
|
||||
type: path
|
||||
password:
|
||||
description:
|
||||
- Provide a password for connecting to the API. Use in conjunction with I(username).
|
||||
resource_definition:
|
||||
description:
|
||||
- Provide the YAML definition for the object, bypassing any modules parameters
|
||||
intended to define object attributes.
|
||||
type: dict
|
||||
src:
|
||||
description:
|
||||
- Provide a path to a file containing the YAML definition of the object. Mutually
|
||||
exclusive with I(resource_definition).
|
||||
type: path
|
||||
ssl_ca_cert:
|
||||
description:
|
||||
- Path to a CA certificate used to authenticate with the API.
|
||||
type: path
|
||||
state:
|
||||
description:
|
||||
- Determines if an object should be created, patched, or deleted. When set to
|
||||
C(present), the object will be created, if it does not exist, or patched, if
|
||||
parameter values differ from the existing object's attributes, and deleted,
|
||||
if set to C(absent). A patch operation results in merging lists and updating
|
||||
dictionaries, with lists being merged into a unique set of values. If a list
|
||||
contains a dictionary with a I(name) or I(type) attribute, a strategic merge
|
||||
is performed, where individual elements with a matching I(name_) or I(type)
|
||||
are merged. To force the replacement of lists, set the I(force) option to C(True).
|
||||
default: present
|
||||
choices:
|
||||
- present
|
||||
- absent
|
||||
username:
|
||||
description:
|
||||
- Provide a username for connecting to the API.
|
||||
verify_ssl:
|
||||
description:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
description: Requested API version
|
||||
type: string
|
||||
cron_job_list:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
items:
|
||||
description:
|
||||
- items is the list of CronJobs.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
spec:
|
||||
description:
|
||||
- Specification of the desired behavior of a cron job, including the schedule.
|
||||
type: complex
|
||||
status:
|
||||
description:
|
||||
- Current status of a cron job.
|
||||
type: complex
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
'''
|
||||
|
||||
|
||||
def main():
|
||||
try:
|
||||
module = KubernetesAnsibleModule('cron_job_list', 'v1beta1')
|
||||
except KubernetesAnsibleException as exc:
|
||||
# The helper failed to init, so there is no module object. All we can do is raise the error.
|
||||
raise Exception(exc.message)
|
||||
|
||||
try:
|
||||
module.execute_module()
|
||||
except KubernetesAnsibleException as exc:
|
||||
module.fail_json(msg="Module failed!", error=str(exc))
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
339
library/k8s_v1beta1_custom_resource_definition.py
Normal file
339
library/k8s_v1beta1_custom_resource_definition.py
Normal file
@@ -0,0 +1,339 @@
|
||||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
from ansible.module_utils.k8s_common import KubernetesAnsibleModule, KubernetesAnsibleException
|
||||
|
||||
DOCUMENTATION = '''
|
||||
module: k8s_v1beta1_custom_resource_definition
|
||||
short_description: Kubernetes CustomResourceDefinition
|
||||
description:
|
||||
- Manage the lifecycle of a custom_resource_definition object. Supports check mode,
|
||||
and attempts to to be idempotent.
|
||||
version_added: 2.3.0
|
||||
author: OpenShift (@openshift)
|
||||
options:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: dict
|
||||
api_key:
|
||||
description:
|
||||
- Token used to connect to the API.
|
||||
cert_file:
|
||||
description:
|
||||
- Path to a certificate used to authenticate with the API.
|
||||
type: path
|
||||
context:
|
||||
description:
|
||||
- The name of a context found in the Kubernetes config file.
|
||||
debug:
|
||||
description:
|
||||
- Enable debug output from the OpenShift helper. Logging info is written to KubeObjHelper.log
|
||||
default: false
|
||||
type: bool
|
||||
force:
|
||||
description:
|
||||
- If set to C(True), and I(state) is C(present), an existing object will updated,
|
||||
and lists will be replaced, rather than merged.
|
||||
default: false
|
||||
type: bool
|
||||
host:
|
||||
description:
|
||||
- Provide a URL for acessing the Kubernetes API.
|
||||
key_file:
|
||||
description:
|
||||
- Path to a key file used to authenticate with the API.
|
||||
type: path
|
||||
kubeconfig:
|
||||
description:
|
||||
- Path to an existing Kubernetes config file. If not provided, and no other connection
|
||||
options are provided, the openshift client will attempt to load the default
|
||||
configuration file from I(~/.kube/config.json).
|
||||
type: path
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: dict
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
password:
|
||||
description:
|
||||
- Provide a password for connecting to the API. Use in conjunction with I(username).
|
||||
resource_definition:
|
||||
description:
|
||||
- Provide the YAML definition for the object, bypassing any modules parameters
|
||||
intended to define object attributes.
|
||||
type: dict
|
||||
spec_group:
|
||||
description:
|
||||
- Group is the group this resource belongs in
|
||||
aliases:
|
||||
- group
|
||||
spec_names_kind:
|
||||
description:
|
||||
- Kind is the serialized kind of the resource. It is normally CamelCase and singular.
|
||||
aliases:
|
||||
- names_kind
|
||||
spec_names_list_kind:
|
||||
description:
|
||||
- ListKind is the serialized kind of the list for this resource. Defaults to <kind>List.
|
||||
aliases:
|
||||
- names_list_kind
|
||||
spec_names_plural:
|
||||
description:
|
||||
- 'Plural is the plural name of the resource to serve. It must match the name
|
||||
of the CustomResourceDefinition-registration too: plural.group and it must be
|
||||
all lowercase.'
|
||||
aliases:
|
||||
- names_plural
|
||||
spec_names_short_names:
|
||||
description:
|
||||
- ShortNames are short names for the resource. It must be all lowercase.
|
||||
aliases:
|
||||
- names_short_names
|
||||
type: list
|
||||
spec_names_singular:
|
||||
description:
|
||||
- Singular is the singular name of the resource. It must be all lowercase Defaults
|
||||
to lowercased <kind>
|
||||
aliases:
|
||||
- names_singular
|
||||
spec_scope:
|
||||
description:
|
||||
- Scope indicates whether this resource is cluster or namespace scoped. Default
|
||||
is namespaced
|
||||
aliases:
|
||||
- scope
|
||||
spec_validation_open_apiv3_schema_additional_items_allows:
|
||||
aliases:
|
||||
- validation_open_apiv3_schema_additional_items_allows
|
||||
type: bool
|
||||
spec_validation_open_apiv3_schema_additional_properties_allows:
|
||||
aliases:
|
||||
- validation_open_apiv3_schema_additional_properties_allows
|
||||
type: bool
|
||||
spec_validation_open_apiv3_schema_all_of:
|
||||
aliases:
|
||||
- validation_open_apiv3_schema_all_of
|
||||
type: list
|
||||
spec_validation_open_apiv3_schema_any_of:
|
||||
aliases:
|
||||
- validation_open_apiv3_schema_any_of
|
||||
type: list
|
||||
spec_validation_open_apiv3_schema_default_raw:
|
||||
aliases:
|
||||
- validation_open_apiv3_schema_default_raw
|
||||
spec_validation_open_apiv3_schema_definitions:
|
||||
aliases:
|
||||
- validation_open_apiv3_schema_definitions
|
||||
type: dict
|
||||
spec_validation_open_apiv3_schema_dependencies:
|
||||
aliases:
|
||||
- validation_open_apiv3_schema_dependencies
|
||||
type: dict
|
||||
spec_validation_open_apiv3_schema_description:
|
||||
aliases:
|
||||
- validation_open_apiv3_schema_description
|
||||
spec_validation_open_apiv3_schema_enum:
|
||||
aliases:
|
||||
- validation_open_apiv3_schema_enum
|
||||
type: list
|
||||
spec_validation_open_apiv3_schema_example_raw:
|
||||
aliases:
|
||||
- validation_open_apiv3_schema_example_raw
|
||||
spec_validation_open_apiv3_schema_exclusive_maximum:
|
||||
aliases:
|
||||
- validation_open_apiv3_schema_exclusive_maximum
|
||||
type: bool
|
||||
spec_validation_open_apiv3_schema_exclusive_minimum:
|
||||
aliases:
|
||||
- validation_open_apiv3_schema_exclusive_minimum
|
||||
type: bool
|
||||
spec_validation_open_apiv3_schema_external_docs_description:
|
||||
aliases:
|
||||
- validation_open_apiv3_schema_external_docs_description
|
||||
spec_validation_open_apiv3_schema_external_docs_url:
|
||||
aliases:
|
||||
- validation_open_apiv3_schema_external_docs_url
|
||||
spec_validation_open_apiv3_schema_format:
|
||||
aliases:
|
||||
- validation_open_apiv3_schema_format
|
||||
spec_validation_open_apiv3_schema_id:
|
||||
aliases:
|
||||
- validation_open_apiv3_schema_id
|
||||
spec_validation_open_apiv3_schema_items_json_schemas:
|
||||
aliases:
|
||||
- validation_open_apiv3_schema_items_json_schemas
|
||||
type: list
|
||||
spec_validation_open_apiv3_schema_max_items:
|
||||
aliases:
|
||||
- validation_open_apiv3_schema_max_items
|
||||
type: int
|
||||
spec_validation_open_apiv3_schema_max_length:
|
||||
aliases:
|
||||
- validation_open_apiv3_schema_max_length
|
||||
type: int
|
||||
spec_validation_open_apiv3_schema_max_properties:
|
||||
aliases:
|
||||
- validation_open_apiv3_schema_max_properties
|
||||
type: int
|
||||
spec_validation_open_apiv3_schema_maximum:
|
||||
aliases:
|
||||
- validation_open_apiv3_schema_maximum
|
||||
type: float
|
||||
spec_validation_open_apiv3_schema_min_items:
|
||||
aliases:
|
||||
- validation_open_apiv3_schema_min_items
|
||||
type: int
|
||||
spec_validation_open_apiv3_schema_min_length:
|
||||
aliases:
|
||||
- validation_open_apiv3_schema_min_length
|
||||
type: int
|
||||
spec_validation_open_apiv3_schema_min_properties:
|
||||
aliases:
|
||||
- validation_open_apiv3_schema_min_properties
|
||||
type: int
|
||||
spec_validation_open_apiv3_schema_minimum:
|
||||
aliases:
|
||||
- validation_open_apiv3_schema_minimum
|
||||
type: float
|
||||
spec_validation_open_apiv3_schema_multiple_of:
|
||||
aliases:
|
||||
- validation_open_apiv3_schema_multiple_of
|
||||
type: float
|
||||
spec_validation_open_apiv3_schema_one_of:
|
||||
aliases:
|
||||
- validation_open_apiv3_schema_one_of
|
||||
type: list
|
||||
spec_validation_open_apiv3_schema_pattern:
|
||||
aliases:
|
||||
- validation_open_apiv3_schema_pattern
|
||||
spec_validation_open_apiv3_schema_pattern_properties:
|
||||
aliases:
|
||||
- validation_open_apiv3_schema_pattern_properties
|
||||
type: dict
|
||||
spec_validation_open_apiv3_schema_properties:
|
||||
aliases:
|
||||
- validation_open_apiv3_schema_properties
|
||||
type: dict
|
||||
spec_validation_open_apiv3_schema_ref:
|
||||
aliases:
|
||||
- validation_open_apiv3_schema_ref
|
||||
spec_validation_open_apiv3_schema_required:
|
||||
aliases:
|
||||
- validation_open_apiv3_schema_required
|
||||
type: list
|
||||
spec_validation_open_apiv3_schema_schema:
|
||||
aliases:
|
||||
- validation_open_apiv3_schema_schema
|
||||
spec_validation_open_apiv3_schema_type:
|
||||
aliases:
|
||||
- validation_open_apiv3_schema_type
|
||||
spec_validation_open_apiv3_schema_unique_items:
|
||||
aliases:
|
||||
- validation_open_apiv3_schema_unique_items
|
||||
type: bool
|
||||
spec_version:
|
||||
description:
|
||||
- Version is the version this resource belongs in
|
||||
aliases:
|
||||
- version
|
||||
src:
|
||||
description:
|
||||
- Provide a path to a file containing the YAML definition of the object. Mutually
|
||||
exclusive with I(resource_definition).
|
||||
type: path
|
||||
ssl_ca_cert:
|
||||
description:
|
||||
- Path to a CA certificate used to authenticate with the API.
|
||||
type: path
|
||||
state:
|
||||
description:
|
||||
- Determines if an object should be created, patched, or deleted. When set to
|
||||
C(present), the object will be created, if it does not exist, or patched, if
|
||||
parameter values differ from the existing object's attributes, and deleted,
|
||||
if set to C(absent). A patch operation results in merging lists and updating
|
||||
dictionaries, with lists being merged into a unique set of values. If a list
|
||||
contains a dictionary with a I(name) or I(type) attribute, a strategic merge
|
||||
is performed, where individual elements with a matching I(name_) or I(type)
|
||||
are merged. To force the replacement of lists, set the I(force) option to C(True).
|
||||
default: present
|
||||
choices:
|
||||
- present
|
||||
- absent
|
||||
username:
|
||||
description:
|
||||
- Provide a username for connecting to the API.
|
||||
verify_ssl:
|
||||
description:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
description: Requested API version
|
||||
type: string
|
||||
custom_resource_definition:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
metadata:
|
||||
description: []
|
||||
type: complex
|
||||
spec:
|
||||
description:
|
||||
- Spec describes how the user wants the resources to appear
|
||||
type: complex
|
||||
status:
|
||||
description:
|
||||
- Status indicates the actual state of the CustomResourceDefinition
|
||||
type: complex
|
||||
'''
|
||||
|
||||
|
||||
def main():
|
||||
try:
|
||||
module = KubernetesAnsibleModule('custom_resource_definition', 'v1beta1')
|
||||
except KubernetesAnsibleException as exc:
|
||||
# The helper failed to init, so there is no module object. All we can do is raise the error.
|
||||
raise Exception(exc.message)
|
||||
|
||||
try:
|
||||
module.execute_module()
|
||||
except KubernetesAnsibleException as exc:
|
||||
module.fail_json(msg="Module failed!", error=str(exc))
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
163
library/k8s_v1beta1_custom_resource_definition_list.py
Normal file
163
library/k8s_v1beta1_custom_resource_definition_list.py
Normal file
@@ -0,0 +1,163 @@
|
||||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
from ansible.module_utils.k8s_common import KubernetesAnsibleModule, KubernetesAnsibleException
|
||||
|
||||
DOCUMENTATION = '''
|
||||
module: k8s_v1beta1_custom_resource_definition_list
|
||||
short_description: Kubernetes CustomResourceDefinitionList
|
||||
description:
|
||||
- Retrieve a list of custom_resource_definitions. List operations provide a snapshot
|
||||
read of the underlying objects, returning a resource_version representing a consistent
|
||||
version of the listed objects.
|
||||
version_added: 2.3.0
|
||||
author: OpenShift (@openshift)
|
||||
options:
|
||||
api_key:
|
||||
description:
|
||||
- Token used to connect to the API.
|
||||
cert_file:
|
||||
description:
|
||||
- Path to a certificate used to authenticate with the API.
|
||||
type: path
|
||||
context:
|
||||
description:
|
||||
- The name of a context found in the Kubernetes config file.
|
||||
debug:
|
||||
description:
|
||||
- Enable debug output from the OpenShift helper. Logging info is written to KubeObjHelper.log
|
||||
default: false
|
||||
type: bool
|
||||
force:
|
||||
description:
|
||||
- If set to C(True), and I(state) is C(present), an existing object will updated,
|
||||
and lists will be replaced, rather than merged.
|
||||
default: false
|
||||
type: bool
|
||||
host:
|
||||
description:
|
||||
- Provide a URL for acessing the Kubernetes API.
|
||||
key_file:
|
||||
description:
|
||||
- Path to a key file used to authenticate with the API.
|
||||
type: path
|
||||
kubeconfig:
|
||||
description:
|
||||
- Path to an existing Kubernetes config file. If not provided, and no other connection
|
||||
options are provided, the openshift client will attempt to load the default
|
||||
configuration file from I(~/.kube/config.json).
|
||||
type: path
|
||||
password:
|
||||
description:
|
||||
- Provide a password for connecting to the API. Use in conjunction with I(username).
|
||||
resource_definition:
|
||||
description:
|
||||
- Provide the YAML definition for the object, bypassing any modules parameters
|
||||
intended to define object attributes.
|
||||
type: dict
|
||||
src:
|
||||
description:
|
||||
- Provide a path to a file containing the YAML definition of the object. Mutually
|
||||
exclusive with I(resource_definition).
|
||||
type: path
|
||||
ssl_ca_cert:
|
||||
description:
|
||||
- Path to a CA certificate used to authenticate with the API.
|
||||
type: path
|
||||
state:
|
||||
description:
|
||||
- Determines if an object should be created, patched, or deleted. When set to
|
||||
C(present), the object will be created, if it does not exist, or patched, if
|
||||
parameter values differ from the existing object's attributes, and deleted,
|
||||
if set to C(absent). A patch operation results in merging lists and updating
|
||||
dictionaries, with lists being merged into a unique set of values. If a list
|
||||
contains a dictionary with a I(name) or I(type) attribute, a strategic merge
|
||||
is performed, where individual elements with a matching I(name_) or I(type)
|
||||
are merged. To force the replacement of lists, set the I(force) option to C(True).
|
||||
default: present
|
||||
choices:
|
||||
- present
|
||||
- absent
|
||||
username:
|
||||
description:
|
||||
- Provide a username for connecting to the API.
|
||||
verify_ssl:
|
||||
description:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
description: Requested API version
|
||||
type: string
|
||||
custom_resource_definition_list:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
items:
|
||||
description:
|
||||
- Items individual CustomResourceDefinitions
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
metadata:
|
||||
description: []
|
||||
type: complex
|
||||
spec:
|
||||
description:
|
||||
- Spec describes how the user wants the resources to appear
|
||||
type: complex
|
||||
status:
|
||||
description:
|
||||
- Status indicates the actual state of the CustomResourceDefinition
|
||||
type: complex
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
metadata:
|
||||
description: []
|
||||
type: complex
|
||||
'''
|
||||
|
||||
|
||||
def main():
|
||||
try:
|
||||
module = KubernetesAnsibleModule('custom_resource_definition_list', 'v1beta1')
|
||||
except KubernetesAnsibleException as exc:
|
||||
# The helper failed to init, so there is no module object. All we can do is raise the error.
|
||||
raise Exception(exc.message)
|
||||
|
||||
try:
|
||||
module.execute_module()
|
||||
except KubernetesAnsibleException as exc:
|
||||
module.fail_json(msg="Module failed!", error=str(exc))
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -128,7 +128,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -136,8 +136,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
eviction:
|
||||
type: complex
|
||||
returned: on success
|
||||
@@ -152,51 +152,6 @@ eviction:
|
||||
description:
|
||||
- DeleteOptions may be provided
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
orphan_dependents:
|
||||
description:
|
||||
- "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."
|
||||
type: bool
|
||||
preconditions:
|
||||
description:
|
||||
- Must be fulfilled before a deletion is carried out. If not possible, a
|
||||
409 Conflict status will be returned.
|
||||
type: complex
|
||||
contains:
|
||||
uid:
|
||||
description:
|
||||
- Specifies the target UID.
|
||||
type: str
|
||||
propagation_policy:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- Kind is a string value representing the REST resource this object represents.
|
||||
@@ -207,306 +162,6 @@ eviction:
|
||||
description:
|
||||
- ObjectMeta describes the pod that is being evicted.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource will
|
||||
be deleted. This field is set by the server when a graceful deletion is
|
||||
requested by the user, and is not directly settable by a client. The resource
|
||||
is expected to be deleted (no longer visible from resource lists, and
|
||||
not reachable by name) after the time in this field. Once set, this value
|
||||
may not be unset or be set further into the future, although it may be
|
||||
shortened or the resource may be deleted prior to this time. For example,
|
||||
a user may request that a pod is deleted in 30 seconds. The Kubelet will
|
||||
react by sending a graceful termination signal to the containers in the
|
||||
pod. After that 30 seconds, the Kubelet will send a hard termination signal
|
||||
(SIGKILL) to the container and after cleanup, remove the pod from the
|
||||
API. In the presence of network partitions, this object may still exist
|
||||
after this timestamp, until an administrator or automated process can
|
||||
determine the resource is fully terminated. If not set, graceful deletion
|
||||
of the object has not been requested. Populated by the system when a graceful
|
||||
deletion is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired state.
|
||||
Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant at
|
||||
object creation time. This field is a list of initializers that have not
|
||||
yet acted on this object. If nil or empty, this object has been completely
|
||||
initialized. Otherwise, the object is considered uninitialized and is
|
||||
hidden (in list/watch and get calls) from clients that haven't explicitly
|
||||
asked to observe uninitialized objects. When an object is created, the
|
||||
system will populate this list with the current set of initializers. Only
|
||||
privileged users may set or modify this list. Once it is empty, it may
|
||||
not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be set
|
||||
to nil and the object is considered as initialized and visible to
|
||||
all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with the
|
||||
StatusReason failure. Not all StatusReasons may provide detailed
|
||||
causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the error.
|
||||
If this value is empty there is no information available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the status
|
||||
StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the status
|
||||
StatusReason. On some operations may differ from the requested
|
||||
resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the status
|
||||
StatusReason (when there is a single name which can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should
|
||||
be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource which
|
||||
can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the
|
||||
system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until this
|
||||
reference is removed. Defaults to false. To set this field, a user
|
||||
needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -87,6 +87,7 @@ options:
|
||||
- Specifies the port of the referenced service.
|
||||
aliases:
|
||||
- backend_service_port
|
||||
type: object
|
||||
spec_rules:
|
||||
description:
|
||||
- A list of host rules used to configure the Ingress. If unspecified, or no rule
|
||||
@@ -134,7 +135,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -142,8 +143,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
ingress:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -164,430 +165,14 @@ ingress:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource will
|
||||
be deleted. This field is set by the server when a graceful deletion is
|
||||
requested by the user, and is not directly settable by a client. The resource
|
||||
is expected to be deleted (no longer visible from resource lists, and
|
||||
not reachable by name) after the time in this field. Once set, this value
|
||||
may not be unset or be set further into the future, although it may be
|
||||
shortened or the resource may be deleted prior to this time. For example,
|
||||
a user may request that a pod is deleted in 30 seconds. The Kubelet will
|
||||
react by sending a graceful termination signal to the containers in the
|
||||
pod. After that 30 seconds, the Kubelet will send a hard termination signal
|
||||
(SIGKILL) to the container and after cleanup, remove the pod from the
|
||||
API. In the presence of network partitions, this object may still exist
|
||||
after this timestamp, until an administrator or automated process can
|
||||
determine the resource is fully terminated. If not set, graceful deletion
|
||||
of the object has not been requested. Populated by the system when a graceful
|
||||
deletion is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired state.
|
||||
Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant at
|
||||
object creation time. This field is a list of initializers that have not
|
||||
yet acted on this object. If nil or empty, this object has been completely
|
||||
initialized. Otherwise, the object is considered uninitialized and is
|
||||
hidden (in list/watch and get calls) from clients that haven't explicitly
|
||||
asked to observe uninitialized objects. When an object is created, the
|
||||
system will populate this list with the current set of initializers. Only
|
||||
privileged users may set or modify this list. Once it is empty, it may
|
||||
not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be set
|
||||
to nil and the object is considered as initialized and visible to
|
||||
all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with the
|
||||
StatusReason failure. Not all StatusReasons may provide detailed
|
||||
causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the error.
|
||||
If this value is empty there is no information available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the status
|
||||
StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the status
|
||||
StatusReason. On some operations may differ from the requested
|
||||
resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the status
|
||||
StatusReason (when there is a single name which can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should
|
||||
be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource which
|
||||
can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the
|
||||
system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until this
|
||||
reference is removed. Defaults to false. To set this field, a user
|
||||
needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
spec:
|
||||
description:
|
||||
- Spec is the desired state of the Ingress.
|
||||
type: complex
|
||||
contains:
|
||||
backend:
|
||||
description:
|
||||
- A default backend capable of servicing requests that don't match any rule.
|
||||
At least one of 'backend' or 'rules' must be specified. This field is
|
||||
optional to allow the loadbalancer controller or defaulting logic to specify
|
||||
a global default.
|
||||
type: complex
|
||||
contains:
|
||||
service_name:
|
||||
description:
|
||||
- Specifies the name of the referenced service.
|
||||
type: str
|
||||
service_port:
|
||||
description:
|
||||
- Specifies the port of the referenced service.
|
||||
type: str
|
||||
rules:
|
||||
description:
|
||||
- A list of host rules used to configure the Ingress. If unspecified, or
|
||||
no rule matches, all traffic is sent to the default backend.
|
||||
type: list
|
||||
contains:
|
||||
host:
|
||||
description:
|
||||
- 'Host is the fully qualified domain name of a network host, as defined
|
||||
by RFC 3986. Note the following deviations from the "host" part of
|
||||
the URI as defined in the RFC: 1. IPs are not allowed. Currently an
|
||||
IngressRuleValue can only apply to the IP in the Spec of the parent
|
||||
Ingress. 2. The `:` delimiter is not respected because ports are not
|
||||
allowed. Currently the port of an Ingress is implicitly :80 for http
|
||||
and :443 for https. Both these may change in the future. Incoming
|
||||
requests are matched against the host before the IngressRuleValue.
|
||||
If the host is unspecified, the Ingress routes all traffic based on
|
||||
the specified IngressRuleValue.'
|
||||
type: str
|
||||
http:
|
||||
description: []
|
||||
type: complex
|
||||
contains:
|
||||
paths:
|
||||
description:
|
||||
- A collection of paths that map requests to backends.
|
||||
type: list
|
||||
contains:
|
||||
backend:
|
||||
description:
|
||||
- Backend defines the referenced service endpoint to which the
|
||||
traffic will be forwarded to.
|
||||
type: complex
|
||||
contains:
|
||||
service_name:
|
||||
description:
|
||||
- Specifies the name of the referenced service.
|
||||
type: str
|
||||
service_port:
|
||||
description:
|
||||
- Specifies the port of the referenced service.
|
||||
type: str
|
||||
path:
|
||||
description:
|
||||
- Path is an extended POSIX regex as defined by IEEE Std 1003.1,
|
||||
(i.e this follows the egrep/unix syntax, not the perl syntax)
|
||||
matched against the path of an incoming request. Currently
|
||||
it can contain characters disallowed from the conventional
|
||||
"path" part of a URL as defined by RFC 3986. Paths must begin
|
||||
with a '/'. If unspecified, the path defaults to a catch all
|
||||
sending traffic to the backend.
|
||||
type: str
|
||||
tls:
|
||||
description:
|
||||
- TLS configuration. Currently the Ingress only supports a single TLS port,
|
||||
443. If multiple members of this list specify different hosts, they will
|
||||
be multiplexed on the same port according to the hostname specified through
|
||||
the SNI TLS extension, if the ingress controller fulfilling the ingress
|
||||
supports SNI.
|
||||
type: list
|
||||
contains:
|
||||
hosts:
|
||||
description:
|
||||
- Hosts are a list of hosts included in the TLS certificate. The values
|
||||
in this list must match the name/s used in the tlsSecret. Defaults
|
||||
to the wildcard host setting for the loadbalancer controller fulfilling
|
||||
this Ingress, if left unspecified.
|
||||
type: list
|
||||
contains: str
|
||||
secret_name:
|
||||
description:
|
||||
- SecretName is the name of the secret used to terminate SSL traffic
|
||||
on 443. Field is left optional to allow SSL routing based on SNI hostname
|
||||
alone. If the SNI host in a listener conflicts with the "Host" header
|
||||
field used by an IngressRule, the SNI host is used for termination
|
||||
and value of the Host header is used for routing.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- Status is the current state of the Ingress.
|
||||
type: complex
|
||||
contains:
|
||||
load_balancer:
|
||||
description:
|
||||
- LoadBalancer contains the current status of the load-balancer.
|
||||
type: complex
|
||||
contains:
|
||||
ingress:
|
||||
description:
|
||||
- Ingress is a list containing ingress points for the load-balancer.
|
||||
Traffic intended for the service should be sent to these ingress points.
|
||||
type: list
|
||||
contains:
|
||||
hostname:
|
||||
description:
|
||||
- Hostname is set for load-balancer ingress points that are DNS
|
||||
based (typically AWS load-balancers)
|
||||
type: str
|
||||
ip:
|
||||
description:
|
||||
- IP is set for load-balancer ingress points that are IP based (typically
|
||||
GCE or OpenStack load-balancers)
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -86,7 +86,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -94,8 +94,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
ingress_list:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -127,441 +127,14 @@ ingress_list:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource
|
||||
will be deleted. This field is set by the server when a graceful deletion
|
||||
is requested by the user, and is not directly settable by a client.
|
||||
The resource is expected to be deleted (no longer visible from resource
|
||||
lists, and not reachable by name) after the time in this field. Once
|
||||
set, this value may not be unset or be set further into the future,
|
||||
although it may be shortened or the resource may be deleted prior
|
||||
to this time. For example, a user may request that a pod is deleted
|
||||
in 30 seconds. The Kubelet will react by sending a graceful termination
|
||||
signal to the containers in the pod. After that 30 seconds, the Kubelet
|
||||
will send a hard termination signal (SIGKILL) to the container and
|
||||
after cleanup, remove the pod from the API. In the presence of network
|
||||
partitions, this object may still exist after this timestamp, until
|
||||
an administrator or automated process can determine the resource is
|
||||
fully terminated. If not set, graceful deletion of the object has
|
||||
not been requested. Populated by the system when a graceful deletion
|
||||
is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired
|
||||
state. Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant
|
||||
at object creation time. This field is a list of initializers that
|
||||
have not yet acted on this object. If nil or empty, this object has
|
||||
been completely initialized. Otherwise, the object is considered uninitialized
|
||||
and is hidden (in list/watch and get calls) from clients that haven't
|
||||
explicitly asked to observe uninitialized objects. When an object
|
||||
is created, the system will populate this list with the current set
|
||||
of initializers. Only privileged users may set or modify this list.
|
||||
Once it is empty, it may not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be
|
||||
set to nil and the object is considered as initialized and visible
|
||||
to all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with
|
||||
the StatusReason failure. Not all StatusReasons may provide
|
||||
detailed causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the
|
||||
error. If this value is empty there is no information
|
||||
available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the
|
||||
status StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the
|
||||
status StatusReason. On some operations may differ from
|
||||
the requested resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the
|
||||
status StatusReason (when there is a single name which
|
||||
can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation
|
||||
should be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource
|
||||
which can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated
|
||||
by the system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until
|
||||
this reference is removed. Defaults to false. To set this field,
|
||||
a user needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system.
|
||||
Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
spec:
|
||||
description:
|
||||
- Spec is the desired state of the Ingress.
|
||||
type: complex
|
||||
contains:
|
||||
backend:
|
||||
description:
|
||||
- A default backend capable of servicing requests that don't match any
|
||||
rule. At least one of 'backend' or 'rules' must be specified. This
|
||||
field is optional to allow the loadbalancer controller or defaulting
|
||||
logic to specify a global default.
|
||||
type: complex
|
||||
contains:
|
||||
service_name:
|
||||
description:
|
||||
- Specifies the name of the referenced service.
|
||||
type: str
|
||||
service_port:
|
||||
description:
|
||||
- Specifies the port of the referenced service.
|
||||
type: str
|
||||
rules:
|
||||
description:
|
||||
- A list of host rules used to configure the Ingress. If unspecified,
|
||||
or no rule matches, all traffic is sent to the default backend.
|
||||
type: list
|
||||
contains:
|
||||
host:
|
||||
description:
|
||||
- 'Host is the fully qualified domain name of a network host, as
|
||||
defined by RFC 3986. Note the following deviations from the "host"
|
||||
part of the URI as defined in the RFC: 1. IPs are not allowed.
|
||||
Currently an IngressRuleValue can only apply to the IP in the
|
||||
Spec of the parent Ingress. 2. The `:` delimiter is not respected
|
||||
because ports are not allowed. Currently the port of an Ingress
|
||||
is implicitly :80 for http and :443 for https. Both these may
|
||||
change in the future. Incoming requests are matched against the
|
||||
host before the IngressRuleValue. If the host is unspecified,
|
||||
the Ingress routes all traffic based on the specified IngressRuleValue.'
|
||||
type: str
|
||||
http:
|
||||
description: []
|
||||
type: complex
|
||||
contains:
|
||||
paths:
|
||||
description:
|
||||
- A collection of paths that map requests to backends.
|
||||
type: list
|
||||
contains:
|
||||
backend:
|
||||
description:
|
||||
- Backend defines the referenced service endpoint to which
|
||||
the traffic will be forwarded to.
|
||||
type: complex
|
||||
contains:
|
||||
service_name:
|
||||
description:
|
||||
- Specifies the name of the referenced service.
|
||||
type: str
|
||||
service_port:
|
||||
description:
|
||||
- Specifies the port of the referenced service.
|
||||
type: str
|
||||
path:
|
||||
description:
|
||||
- Path is an extended POSIX regex as defined by IEEE Std
|
||||
1003.1, (i.e this follows the egrep/unix syntax, not the
|
||||
perl syntax) matched against the path of an incoming request.
|
||||
Currently it can contain characters disallowed from the
|
||||
conventional "path" part of a URL as defined by RFC 3986.
|
||||
Paths must begin with a '/'. If unspecified, the path
|
||||
defaults to a catch all sending traffic to the backend.
|
||||
type: str
|
||||
tls:
|
||||
description:
|
||||
- TLS configuration. Currently the Ingress only supports a single TLS
|
||||
port, 443. If multiple members of this list specify different hosts,
|
||||
they will be multiplexed on the same port according to the hostname
|
||||
specified through the SNI TLS extension, if the ingress controller
|
||||
fulfilling the ingress supports SNI.
|
||||
type: list
|
||||
contains:
|
||||
hosts:
|
||||
description:
|
||||
- Hosts are a list of hosts included in the TLS certificate. The
|
||||
values in this list must match the name/s used in the tlsSecret.
|
||||
Defaults to the wildcard host setting for the loadbalancer controller
|
||||
fulfilling this Ingress, if left unspecified.
|
||||
type: list
|
||||
contains: str
|
||||
secret_name:
|
||||
description:
|
||||
- SecretName is the name of the secret used to terminate SSL traffic
|
||||
on 443. Field is left optional to allow SSL routing based on SNI
|
||||
hostname alone. If the SNI host in a listener conflicts with the
|
||||
"Host" header field used by an IngressRule, the SNI host is used
|
||||
for termination and value of the Host header is used for routing.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- Status is the current state of the Ingress.
|
||||
type: complex
|
||||
contains:
|
||||
load_balancer:
|
||||
description:
|
||||
- LoadBalancer contains the current status of the load-balancer.
|
||||
type: complex
|
||||
contains:
|
||||
ingress:
|
||||
description:
|
||||
- Ingress is a list containing ingress points for the load-balancer.
|
||||
Traffic intended for the service should be sent to these ingress
|
||||
points.
|
||||
type: list
|
||||
contains:
|
||||
hostname:
|
||||
description:
|
||||
- Hostname is set for load-balancer ingress points that are
|
||||
DNS based (typically AWS load-balancers)
|
||||
type: str
|
||||
ip:
|
||||
description:
|
||||
- IP is set for load-balancer ingress points that are IP based
|
||||
(typically GCE or OpenStack load-balancers)
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- Kind is a string value representing the REST resource this object represents.
|
||||
@@ -572,18 +145,6 @@ ingress_list:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -136,6 +136,11 @@ options:
|
||||
- Version is the API Version of the Resource. "*" means all.
|
||||
aliases:
|
||||
- resource_attributes_version
|
||||
spec_uid:
|
||||
description:
|
||||
- UID information about the requesting user.
|
||||
aliases:
|
||||
- uid
|
||||
spec_user:
|
||||
description:
|
||||
- User is the user you're testing for. If you specify "User" but not "Group",
|
||||
@@ -154,7 +159,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -162,8 +167,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
local_subject_access_review:
|
||||
type: complex
|
||||
returned: on success
|
||||
@@ -183,404 +188,16 @@ local_subject_access_review:
|
||||
metadata:
|
||||
description: []
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource will
|
||||
be deleted. This field is set by the server when a graceful deletion is
|
||||
requested by the user, and is not directly settable by a client. The resource
|
||||
is expected to be deleted (no longer visible from resource lists, and
|
||||
not reachable by name) after the time in this field. Once set, this value
|
||||
may not be unset or be set further into the future, although it may be
|
||||
shortened or the resource may be deleted prior to this time. For example,
|
||||
a user may request that a pod is deleted in 30 seconds. The Kubelet will
|
||||
react by sending a graceful termination signal to the containers in the
|
||||
pod. After that 30 seconds, the Kubelet will send a hard termination signal
|
||||
(SIGKILL) to the container and after cleanup, remove the pod from the
|
||||
API. In the presence of network partitions, this object may still exist
|
||||
after this timestamp, until an administrator or automated process can
|
||||
determine the resource is fully terminated. If not set, graceful deletion
|
||||
of the object has not been requested. Populated by the system when a graceful
|
||||
deletion is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired state.
|
||||
Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant at
|
||||
object creation time. This field is a list of initializers that have not
|
||||
yet acted on this object. If nil or empty, this object has been completely
|
||||
initialized. Otherwise, the object is considered uninitialized and is
|
||||
hidden (in list/watch and get calls) from clients that haven't explicitly
|
||||
asked to observe uninitialized objects. When an object is created, the
|
||||
system will populate this list with the current set of initializers. Only
|
||||
privileged users may set or modify this list. Once it is empty, it may
|
||||
not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be set
|
||||
to nil and the object is considered as initialized and visible to
|
||||
all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with the
|
||||
StatusReason failure. Not all StatusReasons may provide detailed
|
||||
causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the error.
|
||||
If this value is empty there is no information available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the status
|
||||
StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the status
|
||||
StatusReason. On some operations may differ from the requested
|
||||
resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the status
|
||||
StatusReason (when there is a single name which can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should
|
||||
be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource which
|
||||
can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the
|
||||
system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until this
|
||||
reference is removed. Defaults to false. To set this field, a user
|
||||
needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
spec:
|
||||
description:
|
||||
- Spec holds information about the request being evaluated. spec.namespace must
|
||||
be equal to the namespace you made the request against. If empty, it is defaulted.
|
||||
type: complex
|
||||
contains:
|
||||
extra:
|
||||
description:
|
||||
- Extra corresponds to the user.Info.GetExtra() method from the authenticator.
|
||||
Since that is input to the authorizer it needs a reflection here.
|
||||
type: complex
|
||||
contains: str, list[str]
|
||||
group:
|
||||
description:
|
||||
- Groups is the groups you're testing for.
|
||||
type: list
|
||||
contains: str
|
||||
non_resource_attributes:
|
||||
description:
|
||||
- NonResourceAttributes describes information for a non-resource access
|
||||
request
|
||||
type: complex
|
||||
contains:
|
||||
path:
|
||||
description:
|
||||
- Path is the URL path of the request
|
||||
type: str
|
||||
verb:
|
||||
description:
|
||||
- Verb is the standard HTTP verb
|
||||
type: str
|
||||
resource_attributes:
|
||||
description:
|
||||
- ResourceAuthorizationAttributes describes information for a resource access
|
||||
request
|
||||
type: complex
|
||||
contains:
|
||||
group:
|
||||
description:
|
||||
- Group is the API Group of the Resource. "*" means all.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name is the name of the resource being requested for a "get" or deleted
|
||||
for a "delete". "" (empty) means all.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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
|
||||
type: str
|
||||
resource:
|
||||
description:
|
||||
- Resource is one of the existing resource types. "*" means all.
|
||||
type: str
|
||||
subresource:
|
||||
description:
|
||||
- Subresource is one of the existing resource types. "" means none.
|
||||
type: str
|
||||
verb:
|
||||
description:
|
||||
- 'Verb is a kubernetes resource API verb, like: get, list, watch, create,
|
||||
update, delete, proxy. "*" means all.'
|
||||
type: str
|
||||
version:
|
||||
description:
|
||||
- Version is the API Version of the Resource. "*" means all.
|
||||
type: str
|
||||
user:
|
||||
description:
|
||||
- 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
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- Status is filled in by the server and indicates whether the request is allowed
|
||||
or not
|
||||
type: complex
|
||||
contains:
|
||||
allowed:
|
||||
description:
|
||||
- Allowed is required. True if the action would be allowed, false otherwise.
|
||||
type: bool
|
||||
evaluation_error:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- Reason is optional. It indicates why a request was allowed or denied.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -77,6 +77,18 @@ options:
|
||||
- Provide the YAML definition for the object, bypassing any modules parameters
|
||||
intended to define object attributes.
|
||||
type: dict
|
||||
spec_egress:
|
||||
description:
|
||||
- List of egress rules to be applied to the selected pods. Outgoing traffic is
|
||||
allowed if there are no NetworkPolicies selecting the pod (and cluster policy
|
||||
otherwise allows the traffic), OR if the traffic matches at least one egress
|
||||
rule across all of the NetworkPolicy objects whose podSelector matches the pod.
|
||||
If this field is empty then this NetworkPolicy limits all outgoing traffic (and
|
||||
serves solely to ensure that the pods it selects are isolated by default). This
|
||||
field is beta-level in 1.8
|
||||
aliases:
|
||||
- egress
|
||||
type: list
|
||||
spec_ingress:
|
||||
description:
|
||||
- List of ingress rules to be applied to the selected pods. Traffic is allowed
|
||||
@@ -104,6 +116,21 @@ options:
|
||||
aliases:
|
||||
- pod_selector_match_labels
|
||||
type: dict
|
||||
spec_policy_types:
|
||||
description:
|
||||
- List of rule types that the NetworkPolicy relates to. Valid options are Ingress,
|
||||
Egress, or Ingress,Egress. If this field is not specified, it will default based
|
||||
on the existence of Ingress or Egress rules; policies that contain an Egress
|
||||
section are assumed to affect Egress, and all policies (whether or not they
|
||||
contain an Ingress section) are assumed to affect Ingress. If you want to write
|
||||
an egress-only policy, you must explicitly specify policyTypes [ "Egress" ].
|
||||
Likewise, if you want to write a policy that specifies that no egress is allowed,
|
||||
you must specify a policyTypes value that include "Egress" (since such a policy
|
||||
would not include an Egress section and would otherwise default to just [ "Ingress"
|
||||
]). This field is beta-level in 1.8
|
||||
aliases:
|
||||
- policy_types
|
||||
type: list
|
||||
src:
|
||||
description:
|
||||
- Provide a path to a file containing the YAML definition of the object. Mutually
|
||||
@@ -135,7 +162,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -143,8 +170,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
network_policy:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -165,474 +192,10 @@ network_policy:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource will
|
||||
be deleted. This field is set by the server when a graceful deletion is
|
||||
requested by the user, and is not directly settable by a client. The resource
|
||||
is expected to be deleted (no longer visible from resource lists, and
|
||||
not reachable by name) after the time in this field. Once set, this value
|
||||
may not be unset or be set further into the future, although it may be
|
||||
shortened or the resource may be deleted prior to this time. For example,
|
||||
a user may request that a pod is deleted in 30 seconds. The Kubelet will
|
||||
react by sending a graceful termination signal to the containers in the
|
||||
pod. After that 30 seconds, the Kubelet will send a hard termination signal
|
||||
(SIGKILL) to the container and after cleanup, remove the pod from the
|
||||
API. In the presence of network partitions, this object may still exist
|
||||
after this timestamp, until an administrator or automated process can
|
||||
determine the resource is fully terminated. If not set, graceful deletion
|
||||
of the object has not been requested. Populated by the system when a graceful
|
||||
deletion is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired state.
|
||||
Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant at
|
||||
object creation time. This field is a list of initializers that have not
|
||||
yet acted on this object. If nil or empty, this object has been completely
|
||||
initialized. Otherwise, the object is considered uninitialized and is
|
||||
hidden (in list/watch and get calls) from clients that haven't explicitly
|
||||
asked to observe uninitialized objects. When an object is created, the
|
||||
system will populate this list with the current set of initializers. Only
|
||||
privileged users may set or modify this list. Once it is empty, it may
|
||||
not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be set
|
||||
to nil and the object is considered as initialized and visible to
|
||||
all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with the
|
||||
StatusReason failure. Not all StatusReasons may provide detailed
|
||||
causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the error.
|
||||
If this value is empty there is no information available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the status
|
||||
StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the status
|
||||
StatusReason. On some operations may differ from the requested
|
||||
resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the status
|
||||
StatusReason (when there is a single name which can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation should
|
||||
be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource which
|
||||
can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the
|
||||
system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until this
|
||||
reference is removed. Defaults to false. To set this field, a user
|
||||
needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
spec:
|
||||
description:
|
||||
- Specification of the desired behavior for this NetworkPolicy.
|
||||
type: complex
|
||||
contains:
|
||||
ingress:
|
||||
description:
|
||||
- List of ingress rules to be applied to the selected pods. Traffic is allowed
|
||||
to a pod if there are no NetworkPolicies selecting the pod OR if the traffic
|
||||
source is the pod's local node, OR if the traffic matches at least one
|
||||
ingress rule across all of the NetworkPolicy objects whose podSelector
|
||||
matches the pod. If this field is empty then this NetworkPolicy does not
|
||||
allow any traffic (and serves solely to ensure that the pods it selects
|
||||
are isolated by default).
|
||||
type: list
|
||||
contains:
|
||||
_from:
|
||||
description:
|
||||
- List of sources which should be able to access the pods selected for
|
||||
this rule. Items in this list are combined using a logical OR operation.
|
||||
If this field is empty or missing, this rule matches all sources (traffic
|
||||
not restricted by source). If this field is present and contains at
|
||||
least on item, this rule allows traffic only if the traffic matches
|
||||
at least one item in the from list.
|
||||
type: list
|
||||
contains:
|
||||
namespace_selector:
|
||||
description:
|
||||
- Selects Namespaces using cluster scoped-labels. This matches all
|
||||
pods in all namespaces selected by this label selector. This field
|
||||
follows standard label selector semantics. If present but empty,
|
||||
this selector selects all namespaces.
|
||||
type: complex
|
||||
contains:
|
||||
match_expressions:
|
||||
description:
|
||||
- matchExpressions is a list of label selector requirements.
|
||||
The requirements are ANDed.
|
||||
type: list
|
||||
contains:
|
||||
key:
|
||||
description:
|
||||
- key is the label key that the selector applies to.
|
||||
type: str
|
||||
operator:
|
||||
description:
|
||||
- operator represents a key's relationship to a set of values.
|
||||
Valid operators ard In, NotIn, Exists and DoesNotExist.
|
||||
type: str
|
||||
values:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
match_labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
pod_selector:
|
||||
description:
|
||||
- This is a label selector which selects Pods in this namespace.
|
||||
This field follows standard label selector semantics. If present
|
||||
but empty, this selector selects all pods in this namespace.
|
||||
type: complex
|
||||
contains:
|
||||
match_expressions:
|
||||
description:
|
||||
- matchExpressions is a list of label selector requirements.
|
||||
The requirements are ANDed.
|
||||
type: list
|
||||
contains:
|
||||
key:
|
||||
description:
|
||||
- key is the label key that the selector applies to.
|
||||
type: str
|
||||
operator:
|
||||
description:
|
||||
- operator represents a key's relationship to a set of values.
|
||||
Valid operators ard In, NotIn, Exists and DoesNotExist.
|
||||
type: str
|
||||
values:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
match_labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
ports:
|
||||
description:
|
||||
- List of ports which should be made accessible on the pods selected
|
||||
for this rule. Each item in this list is combined using a logical
|
||||
OR. If this field is empty or missing, this rule matches all ports
|
||||
(traffic not restricted by port). If this field is present and contains
|
||||
at least one item, then this rule allows traffic only if the traffic
|
||||
matches at least one port in the list.
|
||||
type: list
|
||||
contains:
|
||||
port:
|
||||
description:
|
||||
- If specified, the port on the given protocol. This can either
|
||||
be a numerical or named port on a pod. If this field is not provided,
|
||||
this matches all port names and numbers. If present, only traffic
|
||||
on the specified protocol AND port will be matched.
|
||||
type: str
|
||||
protocol:
|
||||
description:
|
||||
- Optional. The protocol (TCP or UDP) which traffic must match.
|
||||
If not specified, this field defaults to TCP.
|
||||
type: str
|
||||
pod_selector:
|
||||
description:
|
||||
- Selects the pods to which this NetworkPolicy object applies. The array
|
||||
of ingress rules is applied to any pods selected by this field. Multiple
|
||||
network policies can select the same set of pods. In this case, the ingress
|
||||
rules for each are combined additively. This field is NOT optional and
|
||||
follows standard label selector semantics. An empty podSelector matches
|
||||
all pods in this namespace.
|
||||
type: complex
|
||||
contains:
|
||||
match_expressions:
|
||||
description:
|
||||
- matchExpressions is a list of label selector requirements. The requirements
|
||||
are ANDed.
|
||||
type: list
|
||||
contains:
|
||||
key:
|
||||
description:
|
||||
- key is the label key that the selector applies to.
|
||||
type: str
|
||||
operator:
|
||||
description:
|
||||
- operator represents a key's relationship to a set of values. Valid
|
||||
operators ard In, NotIn, Exists and DoesNotExist.
|
||||
type: str
|
||||
values:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
match_labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
@@ -86,7 +86,7 @@ options:
|
||||
- Whether or not to verify the API server's SSL certificates.
|
||||
type: bool
|
||||
requirements:
|
||||
- kubernetes == 3.0.0
|
||||
- kubernetes == 4.0.0
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
@@ -94,8 +94,8 @@ EXAMPLES = '''
|
||||
|
||||
RETURN = '''
|
||||
api_version:
|
||||
type: string
|
||||
description: Requested API version
|
||||
type: string
|
||||
network_policy_list:
|
||||
type: complex
|
||||
returned: when I(state) = C(present)
|
||||
@@ -127,488 +127,10 @@ network_policy_list:
|
||||
description:
|
||||
- Standard object's metadata.
|
||||
type: complex
|
||||
contains:
|
||||
annotations:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
cluster_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
creation_timestamp:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: {}
|
||||
deletion_grace_period_seconds:
|
||||
description:
|
||||
- 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.
|
||||
type: int
|
||||
deletion_timestamp:
|
||||
description:
|
||||
- DeletionTimestamp is RFC 3339 date and time at which this resource
|
||||
will be deleted. This field is set by the server when a graceful deletion
|
||||
is requested by the user, and is not directly settable by a client.
|
||||
The resource is expected to be deleted (no longer visible from resource
|
||||
lists, and not reachable by name) after the time in this field. Once
|
||||
set, this value may not be unset or be set further into the future,
|
||||
although it may be shortened or the resource may be deleted prior
|
||||
to this time. For example, a user may request that a pod is deleted
|
||||
in 30 seconds. The Kubelet will react by sending a graceful termination
|
||||
signal to the containers in the pod. After that 30 seconds, the Kubelet
|
||||
will send a hard termination signal (SIGKILL) to the container and
|
||||
after cleanup, remove the pod from the API. In the presence of network
|
||||
partitions, this object may still exist after this timestamp, until
|
||||
an administrator or automated process can determine the resource is
|
||||
fully terminated. If not set, graceful deletion of the object has
|
||||
not been requested. Populated by the system when a graceful deletion
|
||||
is requested. Read-only.
|
||||
type: complex
|
||||
contains: {}
|
||||
finalizers:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
generate_name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
generation:
|
||||
description:
|
||||
- A sequence number representing a specific generation of the desired
|
||||
state. Populated by the system. Read-only.
|
||||
type: int
|
||||
initializers:
|
||||
description:
|
||||
- An initializer is a controller which enforces some system invariant
|
||||
at object creation time. This field is a list of initializers that
|
||||
have not yet acted on this object. If nil or empty, this object has
|
||||
been completely initialized. Otherwise, the object is considered uninitialized
|
||||
and is hidden (in list/watch and get calls) from clients that haven't
|
||||
explicitly asked to observe uninitialized objects. When an object
|
||||
is created, the system will populate this list with the current set
|
||||
of initializers. Only privileged users may set or modify this list.
|
||||
Once it is empty, it may not be modified further by any user.
|
||||
type: complex
|
||||
contains:
|
||||
pending:
|
||||
description:
|
||||
- Pending is a list of initializers that must execute in order before
|
||||
this object is visible. When the last pending initializer is removed,
|
||||
and no failing result is set, the initializers struct will be
|
||||
set to nil and the object is considered as initialized and visible
|
||||
to all clients.
|
||||
type: list
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- name of the process that is responsible for initializing this
|
||||
object.
|
||||
type: str
|
||||
result:
|
||||
description:
|
||||
- If result is set with the Failure field, the object will be persisted
|
||||
to storage and then deleted, ensuring that other clients can observe
|
||||
the deletion.
|
||||
type: complex
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
code:
|
||||
description:
|
||||
- Suggested HTTP return code for this status, 0 if not set.
|
||||
type: int
|
||||
details:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains:
|
||||
causes:
|
||||
description:
|
||||
- The Causes array includes more details associated with
|
||||
the StatusReason failure. Not all StatusReasons may provide
|
||||
detailed causes.
|
||||
type: list
|
||||
contains:
|
||||
field:
|
||||
description:
|
||||
- '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"'
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the cause of the error.
|
||||
This field may be presented as-is to a reader.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- A machine-readable description of the cause of the
|
||||
error. If this value is empty there is no information
|
||||
available.
|
||||
type: str
|
||||
group:
|
||||
description:
|
||||
- The group attribute of the resource associated with the
|
||||
status StatusReason.
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- The kind attribute of the resource associated with the
|
||||
status StatusReason. On some operations may differ from
|
||||
the requested resource Kind.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- The name attribute of the resource associated with the
|
||||
status StatusReason (when there is a single name which
|
||||
can be described).
|
||||
type: str
|
||||
retry_after_seconds:
|
||||
description:
|
||||
- If specified, the time in seconds before the operation
|
||||
should be retried.
|
||||
type: int
|
||||
uid:
|
||||
description:
|
||||
- UID of the resource. (when there is a single resource
|
||||
which can be described).
|
||||
type: str
|
||||
kind:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
message:
|
||||
description:
|
||||
- A human-readable description of the status of this operation.
|
||||
type: str
|
||||
metadata:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated
|
||||
by the system. Read-only.
|
||||
type: str
|
||||
reason:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
status:
|
||||
description:
|
||||
- 'Status of the operation. One of: "Success" or "Failure".'
|
||||
type: str
|
||||
labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
namespace:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
owner_references:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains:
|
||||
api_version:
|
||||
description:
|
||||
- API version of the referent.
|
||||
type: str
|
||||
block_owner_deletion:
|
||||
description:
|
||||
- If true, AND if the owner has the "foregroundDeletion" finalizer,
|
||||
then the owner cannot be deleted from the key-value store until
|
||||
this reference is removed. Defaults to false. To set this field,
|
||||
a user needs "delete" permission of the owner, otherwise 422 (Unprocessable
|
||||
Entity) will be returned.
|
||||
type: bool
|
||||
controller:
|
||||
description:
|
||||
- If true, this reference points to the managing controller.
|
||||
type: bool
|
||||
kind:
|
||||
description:
|
||||
- Kind of the referent.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name of the referent.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- UID of the referent.
|
||||
type: str
|
||||
resource_version:
|
||||
description:
|
||||
- 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 .
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system.
|
||||
Read-only.
|
||||
type: str
|
||||
uid:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
spec:
|
||||
description:
|
||||
- Specification of the desired behavior for this NetworkPolicy.
|
||||
type: complex
|
||||
contains:
|
||||
ingress:
|
||||
description:
|
||||
- List of ingress rules to be applied to the selected pods. Traffic
|
||||
is allowed to a pod if there are no NetworkPolicies selecting the
|
||||
pod OR if the traffic source is the pod's local node, OR if the traffic
|
||||
matches at least one ingress rule across all of the NetworkPolicy
|
||||
objects whose podSelector matches the pod. If this field is empty
|
||||
then this NetworkPolicy does not allow any traffic (and serves solely
|
||||
to ensure that the pods it selects are isolated by default).
|
||||
type: list
|
||||
contains:
|
||||
_from:
|
||||
description:
|
||||
- List of sources which should be able to access the pods selected
|
||||
for this rule. Items in this list are combined using a logical
|
||||
OR operation. If this field is empty or missing, this rule matches
|
||||
all sources (traffic not restricted by source). If this field
|
||||
is present and contains at least on item, this rule allows traffic
|
||||
only if the traffic matches at least one item in the from list.
|
||||
type: list
|
||||
contains:
|
||||
namespace_selector:
|
||||
description:
|
||||
- Selects Namespaces using cluster scoped-labels. This matches
|
||||
all pods in all namespaces selected by this label selector.
|
||||
This field follows standard label selector semantics. If present
|
||||
but empty, this selector selects all namespaces.
|
||||
type: complex
|
||||
contains:
|
||||
match_expressions:
|
||||
description:
|
||||
- matchExpressions is a list of label selector requirements.
|
||||
The requirements are ANDed.
|
||||
type: list
|
||||
contains:
|
||||
key:
|
||||
description:
|
||||
- key is the label key that the selector applies to.
|
||||
type: str
|
||||
operator:
|
||||
description:
|
||||
- operator represents a key's relationship to a set
|
||||
of values. Valid operators ard In, NotIn, Exists and
|
||||
DoesNotExist.
|
||||
type: str
|
||||
values:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
match_labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
pod_selector:
|
||||
description:
|
||||
- This is a label selector which selects Pods in this namespace.
|
||||
This field follows standard label selector semantics. If present
|
||||
but empty, this selector selects all pods in this namespace.
|
||||
type: complex
|
||||
contains:
|
||||
match_expressions:
|
||||
description:
|
||||
- matchExpressions is a list of label selector requirements.
|
||||
The requirements are ANDed.
|
||||
type: list
|
||||
contains:
|
||||
key:
|
||||
description:
|
||||
- key is the label key that the selector applies to.
|
||||
type: str
|
||||
operator:
|
||||
description:
|
||||
- operator represents a key's relationship to a set
|
||||
of values. Valid operators ard In, NotIn, Exists and
|
||||
DoesNotExist.
|
||||
type: str
|
||||
values:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
match_labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
ports:
|
||||
description:
|
||||
- List of ports which should be made accessible on the pods selected
|
||||
for this rule. Each item in this list is combined using a logical
|
||||
OR. If this field is empty or missing, this rule matches all ports
|
||||
(traffic not restricted by port). If this field is present and
|
||||
contains at least one item, then this rule allows traffic only
|
||||
if the traffic matches at least one port in the list.
|
||||
type: list
|
||||
contains:
|
||||
port:
|
||||
description:
|
||||
- If specified, the port on the given protocol. This can either
|
||||
be a numerical or named port on a pod. If this field is not
|
||||
provided, this matches all port names and numbers. If present,
|
||||
only traffic on the specified protocol AND port will be matched.
|
||||
type: str
|
||||
protocol:
|
||||
description:
|
||||
- Optional. The protocol (TCP or UDP) which traffic must match.
|
||||
If not specified, this field defaults to TCP.
|
||||
type: str
|
||||
pod_selector:
|
||||
description:
|
||||
- Selects the pods to which this NetworkPolicy object applies. The array
|
||||
of ingress rules is applied to any pods selected by this field. Multiple
|
||||
network policies can select the same set of pods. In this case, the
|
||||
ingress rules for each are combined additively. This field is NOT
|
||||
optional and follows standard label selector semantics. An empty podSelector
|
||||
matches all pods in this namespace.
|
||||
type: complex
|
||||
contains:
|
||||
match_expressions:
|
||||
description:
|
||||
- matchExpressions is a list of label selector requirements. The
|
||||
requirements are ANDed.
|
||||
type: list
|
||||
contains:
|
||||
key:
|
||||
description:
|
||||
- key is the label key that the selector applies to.
|
||||
type: str
|
||||
operator:
|
||||
description:
|
||||
- operator represents a key's relationship to a set of values.
|
||||
Valid operators ard In, NotIn, Exists and DoesNotExist.
|
||||
type: str
|
||||
values:
|
||||
description:
|
||||
- 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.
|
||||
type: list
|
||||
contains: str
|
||||
match_labels:
|
||||
description:
|
||||
- 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.
|
||||
type: complex
|
||||
contains: str, str
|
||||
kind:
|
||||
description:
|
||||
- Kind is a string value representing the REST resource this object represents.
|
||||
@@ -619,18 +141,6 @@ network_policy_list:
|
||||
description:
|
||||
- Standard list metadata.
|
||||
type: complex
|
||||
contains:
|
||||
resource_version:
|
||||
description:
|
||||
- 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.
|
||||
type: str
|
||||
self_link:
|
||||
description:
|
||||
- SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
type: str
|
||||
'''
|
||||
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user