mirror of
https://github.com/ansible-collections/kubernetes.core.git
synced 2026-06-10 10:36:16 +00:00
Merge pull request #30 from fabianvf/update-modules-0.4.0.a1
regen modules
This commit is contained in:
Fabian von Feilitzsch
GitHub
@@ -133,17 +133,6 @@ options:
|
|||||||
aliases:
|
aliases:
|
||||||
- validation_open_apiv3_schema_any_of
|
- validation_open_apiv3_schema_any_of
|
||||||
type: list
|
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:
|
spec_validation_open_apiv3_schema_description:
|
||||||
aliases:
|
aliases:
|
||||||
- validation_open_apiv3_schema_description
|
- validation_open_apiv3_schema_description
|
||||||
@@ -151,37 +140,12 @@ options:
|
|||||||
aliases:
|
aliases:
|
||||||
- validation_open_apiv3_schema_enum
|
- validation_open_apiv3_schema_enum
|
||||||
type: list
|
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:
|
spec_validation_open_apiv3_schema_format:
|
||||||
aliases:
|
aliases:
|
||||||
- validation_open_apiv3_schema_format
|
- validation_open_apiv3_schema_format
|
||||||
spec_validation_open_apiv3_schema_id:
|
spec_validation_open_apiv3_schema_id:
|
||||||
aliases:
|
aliases:
|
||||||
- validation_open_apiv3_schema_id
|
- 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:
|
spec_validation_open_apiv3_schema_max_length:
|
||||||
aliases:
|
aliases:
|
||||||
- validation_open_apiv3_schema_max_length
|
- validation_open_apiv3_schema_max_length
|
||||||
@@ -190,18 +154,10 @@ options:
|
|||||||
aliases:
|
aliases:
|
||||||
- validation_open_apiv3_schema_max_properties
|
- validation_open_apiv3_schema_max_properties
|
||||||
type: int
|
type: int
|
||||||
spec_validation_open_apiv3_schema_maximum:
|
|
||||||
aliases:
|
|
||||||
- validation_open_apiv3_schema_maximum
|
|
||||||
type: float
|
|
||||||
spec_validation_open_apiv3_schema_min_items:
|
spec_validation_open_apiv3_schema_min_items:
|
||||||
aliases:
|
aliases:
|
||||||
- validation_open_apiv3_schema_min_items
|
- validation_open_apiv3_schema_min_items
|
||||||
type: int
|
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:
|
spec_validation_open_apiv3_schema_min_properties:
|
||||||
aliases:
|
aliases:
|
||||||
- validation_open_apiv3_schema_min_properties
|
- validation_open_apiv3_schema_min_properties
|
||||||
@@ -214,10 +170,6 @@ options:
|
|||||||
aliases:
|
aliases:
|
||||||
- validation_open_apiv3_schema_multiple_of
|
- validation_open_apiv3_schema_multiple_of
|
||||||
type: float
|
type: float
|
||||||
spec_validation_open_apiv3_schema_one_of:
|
|
||||||
aliases:
|
|
||||||
- validation_open_apiv3_schema_one_of
|
|
||||||
type: list
|
|
||||||
spec_validation_open_apiv3_schema_pattern:
|
spec_validation_open_apiv3_schema_pattern:
|
||||||
aliases:
|
aliases:
|
||||||
- validation_open_apiv3_schema_pattern
|
- validation_open_apiv3_schema_pattern
|
||||||
@@ -225,20 +177,12 @@ options:
|
|||||||
aliases:
|
aliases:
|
||||||
- validation_open_apiv3_schema_pattern_properties
|
- validation_open_apiv3_schema_pattern_properties
|
||||||
type: dict
|
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:
|
spec_validation_open_apiv3_schema_schema:
|
||||||
aliases:
|
aliases:
|
||||||
- validation_open_apiv3_schema_schema
|
- validation_open_apiv3_schema_schema
|
||||||
|
spec_validation_open_apiv3_schema_title:
|
||||||
|
aliases:
|
||||||
|
- validation_open_apiv3_schema_title
|
||||||
spec_validation_open_apiv3_schema_type:
|
spec_validation_open_apiv3_schema_type:
|
||||||
aliases:
|
aliases:
|
||||||
- validation_open_apiv3_schema_type
|
- validation_open_apiv3_schema_type
|
||||||
|
|||||||
@@ -1,478 +0,0 @@
|
|||||||
#!/usr/bin/python
|
|
||||||
# -*- coding: utf-8 -*-
|
|
||||||
|
|
||||||
from ansible.module_utils.k8s_common import KubernetesAnsibleModule, KubernetesAnsibleException
|
|
||||||
|
|
||||||
DOCUMENTATION = '''
|
|
||||||
module: k8s_v1beta1_third_party_resource
|
|
||||||
short_description: Kubernetes ThirdPartyResource
|
|
||||||
description:
|
|
||||||
- Manage the lifecycle of a third_party_resource 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 the description of this object.
|
|
||||||
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
|
|
||||||
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
|
|
||||||
versions:
|
|
||||||
description:
|
|
||||||
- Versions are versions for this third party object
|
|
||||||
type: list
|
|
||||||
requirements:
|
|
||||||
- kubernetes == 3.0.0
|
|
||||||
'''
|
|
||||||
|
|
||||||
EXAMPLES = '''
|
|
||||||
'''
|
|
||||||
|
|
||||||
RETURN = '''
|
|
||||||
api_version:
|
|
||||||
type: string
|
|
||||||
description: Requested API version
|
|
||||||
third_party_resource:
|
|
||||||
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 the description of this object.
|
|
||||||
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 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
|
|
||||||
versions:
|
|
||||||
description:
|
|
||||||
- Versions are versions for this third party object
|
|
||||||
type: list
|
|
||||||
contains:
|
|
||||||
name:
|
|
||||||
description:
|
|
||||||
- Name of this version (e.g. 'v1').
|
|
||||||
type: str
|
|
||||||
'''
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
|
||||||
try:
|
|
||||||
module = KubernetesAnsibleModule('third_party_resource', '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()
|
|
||||||
@@ -1,492 +0,0 @@
|
|||||||
#!/usr/bin/python
|
|
||||||
# -*- coding: utf-8 -*-
|
|
||||||
|
|
||||||
from ansible.module_utils.k8s_common import KubernetesAnsibleModule, KubernetesAnsibleException
|
|
||||||
|
|
||||||
DOCUMENTATION = '''
|
|
||||||
module: k8s_v1beta1_third_party_resource_list
|
|
||||||
short_description: Kubernetes ThirdPartyResourceList
|
|
||||||
description:
|
|
||||||
- Retrieve a list of third_party_resources. 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 == 3.0.0
|
|
||||||
'''
|
|
||||||
|
|
||||||
EXAMPLES = '''
|
|
||||||
'''
|
|
||||||
|
|
||||||
RETURN = '''
|
|
||||||
api_version:
|
|
||||||
type: string
|
|
||||||
description: Requested API version
|
|
||||||
third_party_resource_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 ThirdPartyResources.
|
|
||||||
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 the description of this object.
|
|
||||||
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 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
|
|
||||||
versions:
|
|
||||||
description:
|
|
||||||
- Versions are versions for this third party object
|
|
||||||
type: list
|
|
||||||
contains:
|
|
||||||
name:
|
|
||||||
description:
|
|
||||||
- Name of this version (e.g. 'v1').
|
|
||||||
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 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
|
|
||||||
'''
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
|
||||||
try:
|
|
||||||
module = KubernetesAnsibleModule('third_party_resource_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()
|
|
||||||
@@ -1,763 +0,0 @@
|
|||||||
#!/usr/bin/python
|
|
||||||
# -*- coding: utf-8 -*-
|
|
||||||
|
|
||||||
from ansible.module_utils.k8s_common import KubernetesAnsibleModule, KubernetesAnsibleException
|
|
||||||
|
|
||||||
DOCUMENTATION = '''
|
|
||||||
module: k8s_v2alpha1_horizontal_pod_autoscaler
|
|
||||||
short_description: Kubernetes HorizontalPodAutoscaler
|
|
||||||
description:
|
|
||||||
- Manage the lifecycle of a horizontal_pod_autoscaler 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_max_replicas:
|
|
||||||
description:
|
|
||||||
- maxReplicas is the upper limit for the number of replicas to which the autoscaler
|
|
||||||
can scale up. It cannot be less that minReplicas.
|
|
||||||
aliases:
|
|
||||||
- max_replicas
|
|
||||||
type: int
|
|
||||||
spec_metrics:
|
|
||||||
description:
|
|
||||||
- metrics contains the specifications for which to use to calculate the desired
|
|
||||||
replica count (the maximum replica count across all metrics will be used). The
|
|
||||||
desired replica count is calculated multiplying the ratio between the target
|
|
||||||
value and the current value by the current number of pods. Ergo, metrics used
|
|
||||||
must decrease as the pod count is increased, and vice-versa. See the individual
|
|
||||||
metric source types for more information about how each type of metric must
|
|
||||||
respond.
|
|
||||||
aliases:
|
|
||||||
- metrics
|
|
||||||
type: list
|
|
||||||
spec_min_replicas:
|
|
||||||
description:
|
|
||||||
- minReplicas is the lower limit for the number of replicas to which the autoscaler
|
|
||||||
can scale down. It defaults to 1 pod.
|
|
||||||
aliases:
|
|
||||||
- min_replicas
|
|
||||||
type: int
|
|
||||||
spec_scale_target_ref_api_version:
|
|
||||||
description:
|
|
||||||
- API version of the referent
|
|
||||||
aliases:
|
|
||||||
- scale_target_ref_api_version
|
|
||||||
spec_scale_target_ref_kind:
|
|
||||||
description:
|
|
||||||
- Kind of the referent;
|
|
||||||
aliases:
|
|
||||||
- scale_target_ref_kind
|
|
||||||
spec_scale_target_ref_name:
|
|
||||||
description:
|
|
||||||
- Name of the referent;
|
|
||||||
aliases:
|
|
||||||
- scale_target_ref_name
|
|
||||||
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 == 3.0.0
|
|
||||||
'''
|
|
||||||
|
|
||||||
EXAMPLES = '''
|
|
||||||
'''
|
|
||||||
|
|
||||||
RETURN = '''
|
|
||||||
api_version:
|
|
||||||
type: string
|
|
||||||
description: Requested API version
|
|
||||||
horizontal_pod_autoscaler:
|
|
||||||
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:
|
|
||||||
- metadata is the 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:
|
|
||||||
- spec is the specification for the behaviour of the autoscaler.
|
|
||||||
type: complex
|
|
||||||
contains:
|
|
||||||
max_replicas:
|
|
||||||
description:
|
|
||||||
- maxReplicas is the upper limit for the number of replicas to which the
|
|
||||||
autoscaler can scale up. It cannot be less that minReplicas.
|
|
||||||
type: int
|
|
||||||
metrics:
|
|
||||||
description:
|
|
||||||
- metrics contains the specifications for which to use to calculate the
|
|
||||||
desired replica count (the maximum replica count across all metrics will
|
|
||||||
be used). The desired replica count is calculated multiplying the ratio
|
|
||||||
between the target value and the current value by the current number of
|
|
||||||
pods. Ergo, metrics used must decrease as the pod count is increased,
|
|
||||||
and vice-versa. See the individual metric source types for more information
|
|
||||||
about how each type of metric must respond.
|
|
||||||
type: list
|
|
||||||
contains:
|
|
||||||
object:
|
|
||||||
description:
|
|
||||||
- object refers to a metric describing a single kubernetes object (for
|
|
||||||
example, hits-per-second on an Ingress object).
|
|
||||||
type: complex
|
|
||||||
contains:
|
|
||||||
metric_name:
|
|
||||||
description:
|
|
||||||
- metricName is the name of the metric in question.
|
|
||||||
type: str
|
|
||||||
target:
|
|
||||||
description:
|
|
||||||
- target is the described Kubernetes object.
|
|
||||||
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_value:
|
|
||||||
description:
|
|
||||||
- targetValue is the target value of the metric (as a quantity).
|
|
||||||
type: str
|
|
||||||
pods:
|
|
||||||
description:
|
|
||||||
- pods refers to a metric describing each pod in the current scale target
|
|
||||||
(for example, transactions-processed-per-second). The values will
|
|
||||||
be averaged together before being compared to the target value.
|
|
||||||
type: complex
|
|
||||||
contains:
|
|
||||||
metric_name:
|
|
||||||
description:
|
|
||||||
- metricName is the name of the metric in question
|
|
||||||
type: str
|
|
||||||
target_average_value:
|
|
||||||
description:
|
|
||||||
- targetAverageValue is the target value of the average of the metric
|
|
||||||
across all relevant pods (as a quantity)
|
|
||||||
type: str
|
|
||||||
resource:
|
|
||||||
description:
|
|
||||||
- resource refers to a resource metric (such as those specified in requests
|
|
||||||
and limits) known to Kubernetes describing each pod in the current
|
|
||||||
scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes,
|
|
||||||
and have special scaling options on top of those available to normal
|
|
||||||
per-pod metrics using the "pods" source.
|
|
||||||
type: complex
|
|
||||||
contains:
|
|
||||||
name:
|
|
||||||
description:
|
|
||||||
- name is the name of the resource in question.
|
|
||||||
type: str
|
|
||||||
target_average_utilization:
|
|
||||||
description:
|
|
||||||
- targetAverageUtilization is the target value of the average of
|
|
||||||
the resource metric across all relevant pods, represented as a
|
|
||||||
percentage of the requested value of the resource for the pods.
|
|
||||||
type: int
|
|
||||||
target_average_value:
|
|
||||||
description:
|
|
||||||
- targetAverageValue is the target value of the average of the resource
|
|
||||||
metric across all relevant pods, as a raw value (instead of as
|
|
||||||
a percentage of the request), similar to the "pods" metric source
|
|
||||||
type.
|
|
||||||
type: str
|
|
||||||
type:
|
|
||||||
description:
|
|
||||||
- type is the type of metric source. It should match one of the fields
|
|
||||||
below.
|
|
||||||
type: str
|
|
||||||
min_replicas:
|
|
||||||
description:
|
|
||||||
- minReplicas is the lower limit for the number of replicas to which the
|
|
||||||
autoscaler can scale down. It defaults to 1 pod.
|
|
||||||
type: int
|
|
||||||
scale_target_ref:
|
|
||||||
description:
|
|
||||||
- scaleTargetRef points to the target resource to scale, and is used to
|
|
||||||
the pods for which metrics should be collected, as well as to actually
|
|
||||||
change the replica count.
|
|
||||||
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
|
|
||||||
status:
|
|
||||||
description:
|
|
||||||
- status is the current information about the autoscaler.
|
|
||||||
type: complex
|
|
||||||
contains:
|
|
||||||
conditions:
|
|
||||||
description:
|
|
||||||
- conditions is the set of conditions required for this autoscaler to scale
|
|
||||||
its target, and indicates whether or not those conditions are met.
|
|
||||||
type: list
|
|
||||||
contains:
|
|
||||||
last_transition_time:
|
|
||||||
description:
|
|
||||||
- lastTransitionTime is the last time the condition transitioned from
|
|
||||||
one status to another
|
|
||||||
type: complex
|
|
||||||
contains: {}
|
|
||||||
message:
|
|
||||||
description:
|
|
||||||
- message is a human-readable explanation containing details about the
|
|
||||||
transition
|
|
||||||
type: str
|
|
||||||
reason:
|
|
||||||
description:
|
|
||||||
- reason is the reason for the condition's last transition.
|
|
||||||
type: str
|
|
||||||
status:
|
|
||||||
description:
|
|
||||||
- status is the status of the condition (True, False, Unknown)
|
|
||||||
type: str
|
|
||||||
type:
|
|
||||||
description:
|
|
||||||
- type describes the current condition
|
|
||||||
type: str
|
|
||||||
current_metrics:
|
|
||||||
description:
|
|
||||||
- currentMetrics is the last read state of the metrics used by this autoscaler.
|
|
||||||
type: list
|
|
||||||
contains:
|
|
||||||
object:
|
|
||||||
description:
|
|
||||||
- object refers to a metric describing a single kubernetes object (for
|
|
||||||
example, hits-per-second on an Ingress object).
|
|
||||||
type: complex
|
|
||||||
contains:
|
|
||||||
current_value:
|
|
||||||
description:
|
|
||||||
- currentValue is the current value of the metric (as a quantity).
|
|
||||||
type: str
|
|
||||||
metric_name:
|
|
||||||
description:
|
|
||||||
- metricName is the name of the metric in question.
|
|
||||||
type: str
|
|
||||||
target:
|
|
||||||
description:
|
|
||||||
- target is the described Kubernetes object.
|
|
||||||
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
|
|
||||||
pods:
|
|
||||||
description:
|
|
||||||
- pods refers to a metric describing each pod in the current scale target
|
|
||||||
(for example, transactions-processed-per-second). The values will
|
|
||||||
be averaged together before being compared to the target value.
|
|
||||||
type: complex
|
|
||||||
contains:
|
|
||||||
current_average_value:
|
|
||||||
description:
|
|
||||||
- currentAverageValue is the current value of the average of the
|
|
||||||
metric across all relevant pods (as a quantity)
|
|
||||||
type: str
|
|
||||||
metric_name:
|
|
||||||
description:
|
|
||||||
- metricName is the name of the metric in question
|
|
||||||
type: str
|
|
||||||
resource:
|
|
||||||
description:
|
|
||||||
- resource refers to a resource metric (such as those specified in requests
|
|
||||||
and limits) known to Kubernetes describing each pod in the current
|
|
||||||
scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes,
|
|
||||||
and have special scaling options on top of those available to normal
|
|
||||||
per-pod metrics using the "pods" source.
|
|
||||||
type: complex
|
|
||||||
contains:
|
|
||||||
current_average_utilization:
|
|
||||||
description:
|
|
||||||
- currentAverageUtilization is the current value of the average
|
|
||||||
of the resource metric across all relevant pods, represented as
|
|
||||||
a percentage of the requested value of the resource for the pods.
|
|
||||||
It will only be present if `targetAverageValue` was set in the
|
|
||||||
corresponding metric specification.
|
|
||||||
type: int
|
|
||||||
current_average_value:
|
|
||||||
description:
|
|
||||||
- currentAverageValue is the current value of the average of the
|
|
||||||
resource metric across all relevant pods, as a raw value (instead
|
|
||||||
of as a percentage of the request), similar to the "pods" metric
|
|
||||||
source type. It will always be set, regardless of the corresponding
|
|
||||||
metric specification.
|
|
||||||
type: str
|
|
||||||
name:
|
|
||||||
description:
|
|
||||||
- name is the name of the resource in question.
|
|
||||||
type: str
|
|
||||||
type:
|
|
||||||
description:
|
|
||||||
- type is the type of metric source. It will match one of the fields
|
|
||||||
below.
|
|
||||||
type: str
|
|
||||||
current_replicas:
|
|
||||||
description:
|
|
||||||
- currentReplicas is current number of replicas of pods managed by this
|
|
||||||
autoscaler, as last seen by the autoscaler.
|
|
||||||
type: int
|
|
||||||
desired_replicas:
|
|
||||||
description:
|
|
||||||
- desiredReplicas is the desired number of replicas of pods managed by this
|
|
||||||
autoscaler, as last calculated by the autoscaler.
|
|
||||||
type: int
|
|
||||||
last_scale_time:
|
|
||||||
description:
|
|
||||||
- lastScaleTime is the 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:
|
|
||||||
- observedGeneration is the most recent generation observed by this autoscaler.
|
|
||||||
type: int
|
|
||||||
'''
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
|
||||||
try:
|
|
||||||
module = KubernetesAnsibleModule('horizontal_pod_autoscaler', 'v2alpha1')
|
|
||||||
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()
|
|
||||||
@@ -1,751 +0,0 @@
|
|||||||
#!/usr/bin/python
|
|
||||||
# -*- coding: utf-8 -*-
|
|
||||||
|
|
||||||
from ansible.module_utils.k8s_common import KubernetesAnsibleModule, KubernetesAnsibleException
|
|
||||||
|
|
||||||
DOCUMENTATION = '''
|
|
||||||
module: k8s_v2alpha1_horizontal_pod_autoscaler_list
|
|
||||||
short_description: Kubernetes HorizontalPodAutoscalerList
|
|
||||||
description:
|
|
||||||
- Retrieve a list of horizontal_pod_autoscalers. 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 == 3.0.0
|
|
||||||
'''
|
|
||||||
|
|
||||||
EXAMPLES = '''
|
|
||||||
'''
|
|
||||||
|
|
||||||
RETURN = '''
|
|
||||||
api_version:
|
|
||||||
type: string
|
|
||||||
description: Requested API version
|
|
||||||
horizontal_pod_autoscaler_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 horizontal pod autoscaler objects.
|
|
||||||
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:
|
|
||||||
- metadata is the 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:
|
|
||||||
- spec is the specification for the behaviour of the autoscaler.
|
|
||||||
type: complex
|
|
||||||
contains:
|
|
||||||
max_replicas:
|
|
||||||
description:
|
|
||||||
- maxReplicas is the upper limit for the number of replicas to which
|
|
||||||
the autoscaler can scale up. It cannot be less that minReplicas.
|
|
||||||
type: int
|
|
||||||
metrics:
|
|
||||||
description:
|
|
||||||
- metrics contains the specifications for which to use to calculate
|
|
||||||
the desired replica count (the maximum replica count across all metrics
|
|
||||||
will be used). The desired replica count is calculated multiplying
|
|
||||||
the ratio between the target value and the current value by the current
|
|
||||||
number of pods. Ergo, metrics used must decrease as the pod count
|
|
||||||
is increased, and vice-versa. See the individual metric source types
|
|
||||||
for more information about how each type of metric must respond.
|
|
||||||
type: list
|
|
||||||
contains:
|
|
||||||
object:
|
|
||||||
description:
|
|
||||||
- object refers to a metric describing a single kubernetes object
|
|
||||||
(for example, hits-per-second on an Ingress object).
|
|
||||||
type: complex
|
|
||||||
contains:
|
|
||||||
metric_name:
|
|
||||||
description:
|
|
||||||
- metricName is the name of the metric in question.
|
|
||||||
type: str
|
|
||||||
target:
|
|
||||||
description:
|
|
||||||
- target is the described Kubernetes object.
|
|
||||||
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_value:
|
|
||||||
description:
|
|
||||||
- targetValue is the target value of the metric (as a quantity).
|
|
||||||
type: str
|
|
||||||
pods:
|
|
||||||
description:
|
|
||||||
- pods refers to a metric describing each pod in the current scale
|
|
||||||
target (for example, transactions-processed-per-second). The values
|
|
||||||
will be averaged together before being compared to the target
|
|
||||||
value.
|
|
||||||
type: complex
|
|
||||||
contains:
|
|
||||||
metric_name:
|
|
||||||
description:
|
|
||||||
- metricName is the name of the metric in question
|
|
||||||
type: str
|
|
||||||
target_average_value:
|
|
||||||
description:
|
|
||||||
- targetAverageValue is the target value of the average of the
|
|
||||||
metric across all relevant pods (as a quantity)
|
|
||||||
type: str
|
|
||||||
resource:
|
|
||||||
description:
|
|
||||||
- resource refers to a resource metric (such as those specified
|
|
||||||
in requests and limits) known to Kubernetes describing each pod
|
|
||||||
in the current scale target (e.g. CPU or memory). Such metrics
|
|
||||||
are built in to Kubernetes, and have special scaling options on
|
|
||||||
top of those available to normal per-pod metrics using the "pods"
|
|
||||||
source.
|
|
||||||
type: complex
|
|
||||||
contains:
|
|
||||||
name:
|
|
||||||
description:
|
|
||||||
- name is the name of the resource in question.
|
|
||||||
type: str
|
|
||||||
target_average_utilization:
|
|
||||||
description:
|
|
||||||
- targetAverageUtilization is the target value of the average
|
|
||||||
of the resource metric across all relevant pods, represented
|
|
||||||
as a percentage of the requested value of the resource for
|
|
||||||
the pods.
|
|
||||||
type: int
|
|
||||||
target_average_value:
|
|
||||||
description:
|
|
||||||
- targetAverageValue is the target value of the average of the
|
|
||||||
resource metric across all relevant pods, as a raw value (instead
|
|
||||||
of as a percentage of the request), similar to the "pods"
|
|
||||||
metric source type.
|
|
||||||
type: str
|
|
||||||
type:
|
|
||||||
description:
|
|
||||||
- type is the type of metric source. It should match one of the
|
|
||||||
fields below.
|
|
||||||
type: str
|
|
||||||
min_replicas:
|
|
||||||
description:
|
|
||||||
- minReplicas is the lower limit for the number of replicas to which
|
|
||||||
the autoscaler can scale down. It defaults to 1 pod.
|
|
||||||
type: int
|
|
||||||
scale_target_ref:
|
|
||||||
description:
|
|
||||||
- scaleTargetRef points to the target resource to scale, and is used
|
|
||||||
to the pods for which metrics should be collected, as well as to actually
|
|
||||||
change the replica count.
|
|
||||||
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
|
|
||||||
status:
|
|
||||||
description:
|
|
||||||
- status is the current information about the autoscaler.
|
|
||||||
type: complex
|
|
||||||
contains:
|
|
||||||
conditions:
|
|
||||||
description:
|
|
||||||
- conditions is the set of conditions required for this autoscaler to
|
|
||||||
scale its target, and indicates whether or not those conditions are
|
|
||||||
met.
|
|
||||||
type: list
|
|
||||||
contains:
|
|
||||||
last_transition_time:
|
|
||||||
description:
|
|
||||||
- lastTransitionTime is the last time the condition transitioned
|
|
||||||
from one status to another
|
|
||||||
type: complex
|
|
||||||
contains: {}
|
|
||||||
message:
|
|
||||||
description:
|
|
||||||
- message is a human-readable explanation containing details about
|
|
||||||
the transition
|
|
||||||
type: str
|
|
||||||
reason:
|
|
||||||
description:
|
|
||||||
- reason is the reason for the condition's last transition.
|
|
||||||
type: str
|
|
||||||
status:
|
|
||||||
description:
|
|
||||||
- status is the status of the condition (True, False, Unknown)
|
|
||||||
type: str
|
|
||||||
type:
|
|
||||||
description:
|
|
||||||
- type describes the current condition
|
|
||||||
type: str
|
|
||||||
current_metrics:
|
|
||||||
description:
|
|
||||||
- currentMetrics is the last read state of the metrics used by this
|
|
||||||
autoscaler.
|
|
||||||
type: list
|
|
||||||
contains:
|
|
||||||
object:
|
|
||||||
description:
|
|
||||||
- object refers to a metric describing a single kubernetes object
|
|
||||||
(for example, hits-per-second on an Ingress object).
|
|
||||||
type: complex
|
|
||||||
contains:
|
|
||||||
current_value:
|
|
||||||
description:
|
|
||||||
- currentValue is the current value of the metric (as a quantity).
|
|
||||||
type: str
|
|
||||||
metric_name:
|
|
||||||
description:
|
|
||||||
- metricName is the name of the metric in question.
|
|
||||||
type: str
|
|
||||||
target:
|
|
||||||
description:
|
|
||||||
- target is the described Kubernetes object.
|
|
||||||
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
|
|
||||||
pods:
|
|
||||||
description:
|
|
||||||
- pods refers to a metric describing each pod in the current scale
|
|
||||||
target (for example, transactions-processed-per-second). The values
|
|
||||||
will be averaged together before being compared to the target
|
|
||||||
value.
|
|
||||||
type: complex
|
|
||||||
contains:
|
|
||||||
current_average_value:
|
|
||||||
description:
|
|
||||||
- currentAverageValue is the current value of the average of
|
|
||||||
the metric across all relevant pods (as a quantity)
|
|
||||||
type: str
|
|
||||||
metric_name:
|
|
||||||
description:
|
|
||||||
- metricName is the name of the metric in question
|
|
||||||
type: str
|
|
||||||
resource:
|
|
||||||
description:
|
|
||||||
- resource refers to a resource metric (such as those specified
|
|
||||||
in requests and limits) known to Kubernetes describing each pod
|
|
||||||
in the current scale target (e.g. CPU or memory). Such metrics
|
|
||||||
are built in to Kubernetes, and have special scaling options on
|
|
||||||
top of those available to normal per-pod metrics using the "pods"
|
|
||||||
source.
|
|
||||||
type: complex
|
|
||||||
contains:
|
|
||||||
current_average_utilization:
|
|
||||||
description:
|
|
||||||
- currentAverageUtilization is the current value of the average
|
|
||||||
of the resource metric across all relevant pods, represented
|
|
||||||
as a percentage of the requested value of the resource for
|
|
||||||
the pods. It will only be present if `targetAverageValue`
|
|
||||||
was set in the corresponding metric specification.
|
|
||||||
type: int
|
|
||||||
current_average_value:
|
|
||||||
description:
|
|
||||||
- currentAverageValue is the current value of the average of
|
|
||||||
the resource metric across all relevant pods, as a raw value
|
|
||||||
(instead of as a percentage of the request), similar to the
|
|
||||||
"pods" metric source type. It will always be set, regardless
|
|
||||||
of the corresponding metric specification.
|
|
||||||
type: str
|
|
||||||
name:
|
|
||||||
description:
|
|
||||||
- name is the name of the resource in question.
|
|
||||||
type: str
|
|
||||||
type:
|
|
||||||
description:
|
|
||||||
- type is the type of metric source. It will match one of the fields
|
|
||||||
below.
|
|
||||||
type: str
|
|
||||||
current_replicas:
|
|
||||||
description:
|
|
||||||
- currentReplicas is current number of replicas of pods managed by this
|
|
||||||
autoscaler, as last seen by the autoscaler.
|
|
||||||
type: int
|
|
||||||
desired_replicas:
|
|
||||||
description:
|
|
||||||
- desiredReplicas is the desired number of replicas of pods managed
|
|
||||||
by this autoscaler, as last calculated by the autoscaler.
|
|
||||||
type: int
|
|
||||||
last_scale_time:
|
|
||||||
description:
|
|
||||||
- lastScaleTime is the 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:
|
|
||||||
- observedGeneration is the most recent generation observed by this
|
|
||||||
autoscaler.
|
|
||||||
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:
|
|
||||||
- metadata is the 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
|
|
||||||
'''
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
|
||||||
try:
|
|
||||||
module = KubernetesAnsibleModule('horizontal_pod_autoscaler_list', 'v2alpha1')
|
|
||||||
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()
|
|
||||||
@@ -119,7 +119,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -62,7 +62,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -197,7 +197,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -615,7 +615,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -637,7 +637,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -222,7 +222,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -129,7 +129,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -143,7 +143,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -12,6 +12,14 @@ description:
|
|||||||
version_added: 2.3.0
|
version_added: 2.3.0
|
||||||
author: OpenShift (@openshift)
|
author: OpenShift (@openshift)
|
||||||
options:
|
options:
|
||||||
|
aggregation_rule_cluster_role_selectors:
|
||||||
|
description:
|
||||||
|
- ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles
|
||||||
|
and create the rules. If any of the selectors match, then the ClusterRole's
|
||||||
|
permissions will be added
|
||||||
|
aliases:
|
||||||
|
- cluster_role_selectors
|
||||||
|
type: list
|
||||||
annotations:
|
annotations:
|
||||||
description:
|
description:
|
||||||
- Annotations is an unstructured key value map stored with a resource that may
|
- Annotations is an unstructured key value map stored with a resource that may
|
||||||
@@ -112,7 +120,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.3.4
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
@@ -120,12 +128,18 @@ EXAMPLES = '''
|
|||||||
|
|
||||||
RETURN = '''
|
RETURN = '''
|
||||||
api_version:
|
api_version:
|
||||||
type: string
|
|
||||||
description: Requested API version
|
description: Requested API version
|
||||||
|
type: string
|
||||||
cluster_role:
|
cluster_role:
|
||||||
type: complex
|
type: complex
|
||||||
returned: when I(state) = C(present)
|
returned: when I(state) = C(present)
|
||||||
contains:
|
contains:
|
||||||
|
aggregation_rule:
|
||||||
|
description:
|
||||||
|
- AggregationRule is an optional field that describes how to build the Rules
|
||||||
|
for this ClusterRole. If AggregationRule is set, then the Rules are controller
|
||||||
|
managed and direct changes to Rules will be stomped by the controller.
|
||||||
|
type: complex
|
||||||
api_version:
|
api_version:
|
||||||
description:
|
description:
|
||||||
- APIVersion defines the versioned schema of this representation of an object.
|
- APIVersion defines the versioned schema of this representation of an object.
|
||||||
@@ -142,306 +156,6 @@ cluster_role:
|
|||||||
description:
|
description:
|
||||||
- Standard object's metadata.
|
- Standard object's metadata.
|
||||||
type: complex
|
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:
|
rules:
|
||||||
description:
|
description:
|
||||||
- Rules holds all the PolicyRules for this ClusterRole
|
- Rules holds all the PolicyRules for this ClusterRole
|
||||||
@@ -462,11 +176,6 @@ cluster_role:
|
|||||||
pair supports. If the Authorizer does not recognize how to handle the
|
pair supports. If the Authorizer does not recognize how to handle the
|
||||||
AttributeRestrictions, the Authorizer should report an error.
|
AttributeRestrictions, the Authorizer should report an error.
|
||||||
type: complex
|
type: complex
|
||||||
contains:
|
|
||||||
raw:
|
|
||||||
description:
|
|
||||||
- Raw is the underlying serialization of this object.
|
|
||||||
type: str
|
|
||||||
non_resource_ur_ls:
|
non_resource_ur_ls:
|
||||||
description:
|
description:
|
||||||
- NonResourceURLsSlice is a set of partial urls that a user should have
|
- NonResourceURLsSlice is a set of partial urls that a user should have
|
||||||
|
|||||||
@@ -166,7 +166,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.3.4
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
@@ -174,8 +174,8 @@ EXAMPLES = '''
|
|||||||
|
|
||||||
RETURN = '''
|
RETURN = '''
|
||||||
api_version:
|
api_version:
|
||||||
type: string
|
|
||||||
description: Requested API version
|
description: Requested API version
|
||||||
|
type: string
|
||||||
cluster_role_binding:
|
cluster_role_binding:
|
||||||
type: complex
|
type: complex
|
||||||
returned: when I(state) = C(present)
|
returned: when I(state) = C(present)
|
||||||
@@ -203,348 +203,12 @@ cluster_role_binding:
|
|||||||
description:
|
description:
|
||||||
- Standard object's metadata.
|
- Standard object's metadata.
|
||||||
type: complex
|
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:
|
role_ref:
|
||||||
description:
|
description:
|
||||||
- RoleRef can only reference the current namespace and the global namespace.
|
- RoleRef can only reference the current namespace and the global namespace.
|
||||||
If the ClusterRoleRef cannot be resolved, the Authorizer must return an error.
|
If the ClusterRoleRef cannot be resolved, the Authorizer must return an error.
|
||||||
Since Policy is a singleton, this is sufficient knowledge to locate a role.
|
Since Policy is a singleton, this is sufficient knowledge to locate a role.
|
||||||
type: complex
|
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
|
|
||||||
subjects:
|
subjects:
|
||||||
description:
|
description:
|
||||||
- Subjects hold object references to authorize with this rule. This field is
|
- Subjects hold object references to authorize with this rule. This field is
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.3.4
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
@@ -94,8 +94,8 @@ EXAMPLES = '''
|
|||||||
|
|
||||||
RETURN = '''
|
RETURN = '''
|
||||||
api_version:
|
api_version:
|
||||||
type: string
|
|
||||||
description: Requested API version
|
description: Requested API version
|
||||||
|
type: string
|
||||||
cluster_role_binding_list:
|
cluster_role_binding_list:
|
||||||
type: complex
|
type: complex
|
||||||
returned: when I(state) = C(present)
|
returned: when I(state) = C(present)
|
||||||
@@ -134,316 +134,6 @@ cluster_role_binding_list:
|
|||||||
description:
|
description:
|
||||||
- Standard object's metadata.
|
- Standard object's metadata.
|
||||||
type: complex
|
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:
|
role_ref:
|
||||||
description:
|
description:
|
||||||
- RoleRef can only reference the current namespace and the global namespace.
|
- RoleRef can only reference the current namespace and the global namespace.
|
||||||
@@ -451,43 +141,6 @@ cluster_role_binding_list:
|
|||||||
error. Since Policy is a singleton, this is sufficient knowledge to locate
|
error. Since Policy is a singleton, this is sufficient knowledge to locate
|
||||||
a role.
|
a role.
|
||||||
type: complex
|
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
|
|
||||||
subjects:
|
subjects:
|
||||||
description:
|
description:
|
||||||
- Subjects hold object references to authorize with this rule. This field
|
- Subjects hold object references to authorize with this rule. This field
|
||||||
@@ -551,18 +204,6 @@ cluster_role_binding_list:
|
|||||||
description:
|
description:
|
||||||
- Standard object's metadata.
|
- Standard object's metadata.
|
||||||
type: complex
|
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.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.3.4
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
@@ -94,8 +94,8 @@ EXAMPLES = '''
|
|||||||
|
|
||||||
RETURN = '''
|
RETURN = '''
|
||||||
api_version:
|
api_version:
|
||||||
type: string
|
|
||||||
description: Requested API version
|
description: Requested API version
|
||||||
|
type: string
|
||||||
cluster_role_list:
|
cluster_role_list:
|
||||||
type: complex
|
type: complex
|
||||||
returned: when I(state) = C(present)
|
returned: when I(state) = C(present)
|
||||||
@@ -111,6 +111,12 @@ cluster_role_list:
|
|||||||
- Items is a list of ClusterRoles
|
- Items is a list of ClusterRoles
|
||||||
type: list
|
type: list
|
||||||
contains:
|
contains:
|
||||||
|
aggregation_rule:
|
||||||
|
description:
|
||||||
|
- AggregationRule is an optional field that describes how to build the Rules
|
||||||
|
for this ClusterRole. If AggregationRule is set, then the Rules are controller
|
||||||
|
managed and direct changes to Rules will be stomped by the controller.
|
||||||
|
type: complex
|
||||||
api_version:
|
api_version:
|
||||||
description:
|
description:
|
||||||
- APIVersion defines the versioned schema of this representation of an object.
|
- APIVersion defines the versioned schema of this representation of an object.
|
||||||
@@ -127,316 +133,6 @@ cluster_role_list:
|
|||||||
description:
|
description:
|
||||||
- Standard object's metadata.
|
- Standard object's metadata.
|
||||||
type: complex
|
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:
|
rules:
|
||||||
description:
|
description:
|
||||||
- Rules holds all the PolicyRules for this ClusterRole
|
- Rules holds all the PolicyRules for this ClusterRole
|
||||||
@@ -457,11 +153,6 @@ cluster_role_list:
|
|||||||
pair supports. If the Authorizer does not recognize how to handle
|
pair supports. If the Authorizer does not recognize how to handle
|
||||||
the AttributeRestrictions, the Authorizer should report an error.
|
the AttributeRestrictions, the Authorizer should report an error.
|
||||||
type: complex
|
type: complex
|
||||||
contains:
|
|
||||||
raw:
|
|
||||||
description:
|
|
||||||
- Raw is the underlying serialization of this object.
|
|
||||||
type: str
|
|
||||||
non_resource_ur_ls:
|
non_resource_ur_ls:
|
||||||
description:
|
description:
|
||||||
- NonResourceURLsSlice is a set of partial urls that a user should have
|
- NonResourceURLsSlice is a set of partial urls that a user should have
|
||||||
@@ -499,18 +190,6 @@ cluster_role_list:
|
|||||||
description:
|
description:
|
||||||
- Standard object's metadata.
|
- Standard object's metadata.
|
||||||
type: complex
|
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.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -483,7 +483,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -131,36 +131,68 @@ options:
|
|||||||
aliases:
|
aliases:
|
||||||
- selector_match_labels
|
- selector_match_labels
|
||||||
type: dict
|
type: dict
|
||||||
spec_strategy_rolling_update_max_surge:
|
spec_strategy_active_deadline_seconds:
|
||||||
description:
|
description:
|
||||||
- 'The maximum number of pods that can be scheduled above the desired number of
|
- ActiveDeadlineSeconds is the duration in seconds that the deployer pods for
|
||||||
pods. Value can be an absolute number (ex: 5) or a percentage of desired pods
|
this deployment config may be active on a node before the system actively tries
|
||||||
(ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated
|
to terminate them.
|
||||||
from percentage by rounding up. Defaults to 25%. Example: when this is set to
|
|
||||||
30%, the new RC can be scaled up immediately when the rolling update starts,
|
|
||||||
such that the total number of old and new pods do not exceed 130% of desired
|
|
||||||
pods. Once old pods have been killed, new RC can be scaled up further, ensuring
|
|
||||||
that total number of pods running at any time during the update is atmost 130%
|
|
||||||
of desired pods.'
|
|
||||||
aliases:
|
aliases:
|
||||||
- strategy_rolling_update_max_surge
|
- strategy_active_deadline_seconds
|
||||||
type: object
|
type: int
|
||||||
spec_strategy_rolling_update_max_unavailable:
|
spec_strategy_annotations:
|
||||||
description:
|
description:
|
||||||
- 'The maximum number of pods that can be unavailable during the update. Value
|
- Annotations is a set of key, value pairs added to custom deployer and lifecycle
|
||||||
can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
|
pre/post hook pods.
|
||||||
Absolute number is calculated from percentage by rounding down. This can not
|
|
||||||
be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the
|
|
||||||
old RC can be scaled down to 70% of desired pods immediately when the rolling
|
|
||||||
update starts. Once new pods are ready, old RC can be scaled down further, followed
|
|
||||||
by scaling up the new RC, ensuring that the total number of pods available at
|
|
||||||
all times during the update is at least 70% of desired pods.'
|
|
||||||
aliases:
|
aliases:
|
||||||
- strategy_rolling_update_max_unavailable
|
- strategy_annotations
|
||||||
type: object
|
type: dict
|
||||||
|
spec_strategy_custom_params:
|
||||||
|
description:
|
||||||
|
- When C(spec_strategy_type) is I(Custom), provide a mapping of 'key:value' settings.
|
||||||
|
aliases:
|
||||||
|
- strategy_custom_params
|
||||||
|
type: dict
|
||||||
|
spec_strategy_labels:
|
||||||
|
description:
|
||||||
|
- Labels is a set of key, value pairs added to custom deployer and lifecycle pre/post
|
||||||
|
hook pods.
|
||||||
|
aliases:
|
||||||
|
- strategy_labels
|
||||||
|
type: dict
|
||||||
|
spec_strategy_recreate_params:
|
||||||
|
description:
|
||||||
|
- When C(spec_strategy_type) is I(Recreate), provide a mapping of 'key:value'
|
||||||
|
settings.
|
||||||
|
aliases:
|
||||||
|
- strategy_recreate_params
|
||||||
|
type: dict
|
||||||
|
spec_strategy_resources_limits:
|
||||||
|
description:
|
||||||
|
- Limits describes the maximum amount of compute resources allowed.
|
||||||
|
aliases:
|
||||||
|
- strategy_resources_limits
|
||||||
|
type: dict
|
||||||
|
spec_strategy_resources_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.
|
||||||
|
aliases:
|
||||||
|
- strategy_resources_requests
|
||||||
|
type: dict
|
||||||
|
spec_strategy_rolling_params:
|
||||||
|
description:
|
||||||
|
- When C(spec_strategy_type) is I(Rolling), provide a mapping of 'key:value' settings.
|
||||||
|
aliases:
|
||||||
|
- strategy_rolling_params
|
||||||
|
type: dict
|
||||||
spec_strategy_type:
|
spec_strategy_type:
|
||||||
description:
|
description:
|
||||||
- Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.
|
- Type is the name of a deployment strategy.
|
||||||
|
choices:
|
||||||
|
- Rolling
|
||||||
|
- Custom
|
||||||
|
- Recreate
|
||||||
aliases:
|
aliases:
|
||||||
- strategy_type
|
- strategy_type
|
||||||
spec_template_metadata_annotations:
|
spec_template_metadata_annotations:
|
||||||
@@ -516,7 +548,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -114,36 +114,68 @@ options:
|
|||||||
aliases:
|
aliases:
|
||||||
- selector
|
- selector
|
||||||
type: dict
|
type: dict
|
||||||
spec_strategy_rolling_update_max_surge:
|
spec_strategy_active_deadline_seconds:
|
||||||
description:
|
description:
|
||||||
- 'The maximum number of pods that can be scheduled above the desired number of
|
- ActiveDeadlineSeconds is the duration in seconds that the deployer pods for
|
||||||
pods. Value can be an absolute number (ex: 5) or a percentage of desired pods
|
this deployment config may be active on a node before the system actively tries
|
||||||
(ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated
|
to terminate them.
|
||||||
from percentage by rounding up. Defaults to 25%. Example: when this is set to
|
|
||||||
30%, the new RC can be scaled up immediately when the rolling update starts,
|
|
||||||
such that the total number of old and new pods do not exceed 130% of desired
|
|
||||||
pods. Once old pods have been killed, new RC can be scaled up further, ensuring
|
|
||||||
that total number of pods running at any time during the update is atmost 130%
|
|
||||||
of desired pods.'
|
|
||||||
aliases:
|
aliases:
|
||||||
- strategy_rolling_update_max_surge
|
- strategy_active_deadline_seconds
|
||||||
type: object
|
type: int
|
||||||
spec_strategy_rolling_update_max_unavailable:
|
spec_strategy_annotations:
|
||||||
description:
|
description:
|
||||||
- 'The maximum number of pods that can be unavailable during the update. Value
|
- Annotations is a set of key, value pairs added to custom deployer and lifecycle
|
||||||
can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
|
pre/post hook pods.
|
||||||
Absolute number is calculated from percentage by rounding down. This can not
|
|
||||||
be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the
|
|
||||||
old RC can be scaled down to 70% of desired pods immediately when the rolling
|
|
||||||
update starts. Once new pods are ready, old RC can be scaled down further, followed
|
|
||||||
by scaling up the new RC, ensuring that the total number of pods available at
|
|
||||||
all times during the update is at least 70% of desired pods.'
|
|
||||||
aliases:
|
aliases:
|
||||||
- strategy_rolling_update_max_unavailable
|
- strategy_annotations
|
||||||
type: object
|
type: dict
|
||||||
|
spec_strategy_custom_params:
|
||||||
|
description:
|
||||||
|
- When C(spec_strategy_type) is I(Custom), provide a mapping of 'key:value' settings.
|
||||||
|
aliases:
|
||||||
|
- strategy_custom_params
|
||||||
|
type: dict
|
||||||
|
spec_strategy_labels:
|
||||||
|
description:
|
||||||
|
- Labels is a set of key, value pairs added to custom deployer and lifecycle pre/post
|
||||||
|
hook pods.
|
||||||
|
aliases:
|
||||||
|
- strategy_labels
|
||||||
|
type: dict
|
||||||
|
spec_strategy_recreate_params:
|
||||||
|
description:
|
||||||
|
- When C(spec_strategy_type) is I(Recreate), provide a mapping of 'key:value'
|
||||||
|
settings.
|
||||||
|
aliases:
|
||||||
|
- strategy_recreate_params
|
||||||
|
type: dict
|
||||||
|
spec_strategy_resources_limits:
|
||||||
|
description:
|
||||||
|
- Limits describes the maximum amount of compute resources allowed.
|
||||||
|
aliases:
|
||||||
|
- strategy_resources_limits
|
||||||
|
type: dict
|
||||||
|
spec_strategy_resources_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.
|
||||||
|
aliases:
|
||||||
|
- strategy_resources_requests
|
||||||
|
type: dict
|
||||||
|
spec_strategy_rolling_params:
|
||||||
|
description:
|
||||||
|
- When C(spec_strategy_type) is I(Rolling), provide a mapping of 'key:value' settings.
|
||||||
|
aliases:
|
||||||
|
- strategy_rolling_params
|
||||||
|
type: dict
|
||||||
spec_strategy_type:
|
spec_strategy_type:
|
||||||
description:
|
description:
|
||||||
- Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.
|
- Type is the name of a deployment strategy.
|
||||||
|
choices:
|
||||||
|
- Rolling
|
||||||
|
- Custom
|
||||||
|
- Recreate
|
||||||
aliases:
|
aliases:
|
||||||
- strategy_type
|
- strategy_type
|
||||||
spec_template_metadata_annotations:
|
spec_template_metadata_annotations:
|
||||||
@@ -518,7 +550,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -140,7 +140,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -114,7 +114,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -112,7 +112,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -122,7 +122,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -155,7 +155,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -145,7 +145,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -153,7 +153,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -132,7 +132,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -174,7 +174,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -173,7 +173,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -177,7 +177,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -306,7 +306,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -123,7 +123,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -140,7 +140,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -126,7 +126,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -156,7 +156,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -122,7 +122,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -392,7 +392,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -383,7 +383,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -397,7 +397,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -121,7 +121,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -461,7 +461,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -112,7 +112,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.3.4
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
@@ -120,8 +120,8 @@ EXAMPLES = '''
|
|||||||
|
|
||||||
RETURN = '''
|
RETURN = '''
|
||||||
api_version:
|
api_version:
|
||||||
type: string
|
|
||||||
description: Requested API version
|
description: Requested API version
|
||||||
|
type: string
|
||||||
role:
|
role:
|
||||||
type: complex
|
type: complex
|
||||||
returned: when I(state) = C(present)
|
returned: when I(state) = C(present)
|
||||||
@@ -142,306 +142,6 @@ role:
|
|||||||
description:
|
description:
|
||||||
- Standard object's metadata.
|
- Standard object's metadata.
|
||||||
type: complex
|
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:
|
rules:
|
||||||
description:
|
description:
|
||||||
- Rules holds all the PolicyRules for this Role
|
- Rules holds all the PolicyRules for this Role
|
||||||
@@ -462,11 +162,6 @@ role:
|
|||||||
pair supports. If the Authorizer does not recognize how to handle the
|
pair supports. If the Authorizer does not recognize how to handle the
|
||||||
AttributeRestrictions, the Authorizer should report an error.
|
AttributeRestrictions, the Authorizer should report an error.
|
||||||
type: complex
|
type: complex
|
||||||
contains:
|
|
||||||
raw:
|
|
||||||
description:
|
|
||||||
- Raw is the underlying serialization of this object.
|
|
||||||
type: str
|
|
||||||
non_resource_ur_ls:
|
non_resource_ur_ls:
|
||||||
description:
|
description:
|
||||||
- NonResourceURLsSlice is a set of partial urls that a user should have
|
- NonResourceURLsSlice is a set of partial urls that a user should have
|
||||||
|
|||||||
@@ -166,7 +166,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.3.4
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
@@ -174,8 +174,8 @@ EXAMPLES = '''
|
|||||||
|
|
||||||
RETURN = '''
|
RETURN = '''
|
||||||
api_version:
|
api_version:
|
||||||
type: string
|
|
||||||
description: Requested API version
|
description: Requested API version
|
||||||
|
type: string
|
||||||
role_binding:
|
role_binding:
|
||||||
type: complex
|
type: complex
|
||||||
returned: when I(state) = C(present)
|
returned: when I(state) = C(present)
|
||||||
@@ -203,348 +203,12 @@ role_binding:
|
|||||||
description:
|
description:
|
||||||
- Standard object's metadata.
|
- Standard object's metadata.
|
||||||
type: complex
|
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:
|
role_ref:
|
||||||
description:
|
description:
|
||||||
- RoleRef can only reference the current namespace and the global namespace.
|
- RoleRef can only reference the current namespace and the global namespace.
|
||||||
If the RoleRef cannot be resolved, the Authorizer must return an error. Since
|
If the RoleRef cannot be resolved, the Authorizer must return an error. Since
|
||||||
Policy is a singleton, this is sufficient knowledge to locate a role.
|
Policy is a singleton, this is sufficient knowledge to locate a role.
|
||||||
type: complex
|
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
|
|
||||||
subjects:
|
subjects:
|
||||||
description:
|
description:
|
||||||
- Subjects hold object references to authorize with this rule. This field is
|
- Subjects hold object references to authorize with this rule. This field is
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.3.4
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
@@ -94,8 +94,8 @@ EXAMPLES = '''
|
|||||||
|
|
||||||
RETURN = '''
|
RETURN = '''
|
||||||
api_version:
|
api_version:
|
||||||
type: string
|
|
||||||
description: Requested API version
|
description: Requested API version
|
||||||
|
type: string
|
||||||
role_binding_list:
|
role_binding_list:
|
||||||
type: complex
|
type: complex
|
||||||
returned: when I(state) = C(present)
|
returned: when I(state) = C(present)
|
||||||
@@ -134,316 +134,6 @@ role_binding_list:
|
|||||||
description:
|
description:
|
||||||
- Standard object's metadata.
|
- Standard object's metadata.
|
||||||
type: complex
|
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:
|
role_ref:
|
||||||
description:
|
description:
|
||||||
- RoleRef can only reference the current namespace and the global namespace.
|
- RoleRef can only reference the current namespace and the global namespace.
|
||||||
@@ -451,43 +141,6 @@ role_binding_list:
|
|||||||
Since Policy is a singleton, this is sufficient knowledge to locate a
|
Since Policy is a singleton, this is sufficient knowledge to locate a
|
||||||
role.
|
role.
|
||||||
type: complex
|
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
|
|
||||||
subjects:
|
subjects:
|
||||||
description:
|
description:
|
||||||
- Subjects hold object references to authorize with this rule. This field
|
- Subjects hold object references to authorize with this rule. This field
|
||||||
@@ -551,18 +204,6 @@ role_binding_list:
|
|||||||
description:
|
description:
|
||||||
- Standard object's metadata.
|
- Standard object's metadata.
|
||||||
type: complex
|
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
|
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -152,7 +152,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.3.4
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
@@ -94,8 +94,8 @@ EXAMPLES = '''
|
|||||||
|
|
||||||
RETURN = '''
|
RETURN = '''
|
||||||
api_version:
|
api_version:
|
||||||
type: string
|
|
||||||
description: Requested API version
|
description: Requested API version
|
||||||
|
type: string
|
||||||
role_list:
|
role_list:
|
||||||
type: complex
|
type: complex
|
||||||
returned: when I(state) = C(present)
|
returned: when I(state) = C(present)
|
||||||
@@ -127,316 +127,6 @@ role_list:
|
|||||||
description:
|
description:
|
||||||
- Standard object's metadata.
|
- Standard object's metadata.
|
||||||
type: complex
|
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:
|
rules:
|
||||||
description:
|
description:
|
||||||
- Rules holds all the PolicyRules for this Role
|
- Rules holds all the PolicyRules for this Role
|
||||||
@@ -457,11 +147,6 @@ role_list:
|
|||||||
pair supports. If the Authorizer does not recognize how to handle
|
pair supports. If the Authorizer does not recognize how to handle
|
||||||
the AttributeRestrictions, the Authorizer should report an error.
|
the AttributeRestrictions, the Authorizer should report an error.
|
||||||
type: complex
|
type: complex
|
||||||
contains:
|
|
||||||
raw:
|
|
||||||
description:
|
|
||||||
- Raw is the underlying serialization of this object.
|
|
||||||
type: str
|
|
||||||
non_resource_ur_ls:
|
non_resource_ur_ls:
|
||||||
description:
|
description:
|
||||||
- NonResourceURLsSlice is a set of partial urls that a user should have
|
- NonResourceURLsSlice is a set of partial urls that a user should have
|
||||||
@@ -499,18 +184,6 @@ role_list:
|
|||||||
description:
|
description:
|
||||||
- Standard object's metadata.
|
- Standard object's metadata.
|
||||||
type: complex
|
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
|
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -198,7 +198,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -263,7 +263,7 @@ options:
|
|||||||
allow all volumes you may use "*". To allow no volumes, set to ["none"].
|
allow all volumes you may use "*". To allow no volumes, set to ["none"].
|
||||||
type: list
|
type: list
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -68,7 +68,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.3.4
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
@@ -76,8 +76,8 @@ EXAMPLES = '''
|
|||||||
|
|
||||||
RETURN = '''
|
RETURN = '''
|
||||||
api_version:
|
api_version:
|
||||||
type: string
|
|
||||||
description: Requested API version
|
description: Requested API version
|
||||||
|
type: string
|
||||||
self_subject_rules_review:
|
self_subject_rules_review:
|
||||||
type: complex
|
type: complex
|
||||||
returned: on success
|
returned: on success
|
||||||
@@ -98,77 +98,10 @@ self_subject_rules_review:
|
|||||||
description:
|
description:
|
||||||
- Spec adds information about how to conduct the check
|
- Spec adds information about how to conduct the check
|
||||||
type: complex
|
type: complex
|
||||||
contains:
|
|
||||||
scopes:
|
|
||||||
description:
|
|
||||||
- Scopes to use for the evaluation. Empty means "use the unscoped (full)
|
|
||||||
permissions of the user/groups". Nil means "use the scopes on this request".
|
|
||||||
type: list
|
|
||||||
contains: str
|
|
||||||
status:
|
status:
|
||||||
description:
|
description:
|
||||||
- Status is completed by the server to tell which permissions you have
|
- Status is completed by the server to tell which permissions you have
|
||||||
type: complex
|
type: complex
|
||||||
contains:
|
|
||||||
evaluation_error:
|
|
||||||
description:
|
|
||||||
- EvaluationError can appear in combination with Rules. It means some error
|
|
||||||
happened during evaluation that may have prevented additional rules from
|
|
||||||
being populated.
|
|
||||||
type: str
|
|
||||||
rules:
|
|
||||||
description:
|
|
||||||
- Rules is the list of rules (no particular sort) that are allowed for the
|
|
||||||
subject
|
|
||||||
type: list
|
|
||||||
contains:
|
|
||||||
api_groups:
|
|
||||||
description:
|
|
||||||
- APIGroups is the name of the APIGroup that contains the resources.
|
|
||||||
If this field is empty, then both kubernetes and origin API groups
|
|
||||||
are assumed. That means that if an action is requested against one
|
|
||||||
of the enumerated resources in either the kubernetes or the origin
|
|
||||||
API group, the request will be allowed
|
|
||||||
type: list
|
|
||||||
contains: str
|
|
||||||
attribute_restrictions:
|
|
||||||
description:
|
|
||||||
- AttributeRestrictions will vary depending on what the Authorizer/AuthorizationAttributeBuilder
|
|
||||||
pair supports. If the Authorizer does not recognize how to handle
|
|
||||||
the AttributeRestrictions, the Authorizer should report an error.
|
|
||||||
type: complex
|
|
||||||
contains:
|
|
||||||
raw:
|
|
||||||
description:
|
|
||||||
- Raw is the underlying serialization of this object.
|
|
||||||
type: str
|
|
||||||
non_resource_ur_ls:
|
|
||||||
description:
|
|
||||||
- NonResourceURLsSlice is a set of partial urls that a user should have
|
|
||||||
access to. *s are allowed, but only as the full, final step in the
|
|
||||||
path This name is intentionally different than the internal type so
|
|
||||||
that the DefaultConvert works nicely and because the ordering may
|
|
||||||
be different.
|
|
||||||
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
|
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -506,7 +506,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -80,7 +80,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -54,8 +54,8 @@ options:
|
|||||||
type: path
|
type: path
|
||||||
labels:
|
labels:
|
||||||
description:
|
description:
|
||||||
- labels is a optional set of labels that are applied to every object during the
|
- Map of string keys and values that can be used to organize and categorize (scope
|
||||||
Template to Config transformation.
|
and select) objects. May match selectors of replication controllers and services.
|
||||||
type: dict
|
type: dict
|
||||||
message:
|
message:
|
||||||
description:
|
description:
|
||||||
@@ -128,7 +128,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -205,7 +205,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -121,7 +121,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -172,7 +172,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -227,7 +227,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -112,7 +112,7 @@ options:
|
|||||||
- Webhooks is a list of webhooks and the affected resources and operations.
|
- Webhooks is a list of webhooks and the affected resources and operations.
|
||||||
type: list
|
type: list
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -112,7 +112,7 @@ options:
|
|||||||
- Webhooks is a list of webhooks and the affected resources and operations.
|
- Webhooks is a list of webhooks and the affected resources and operations.
|
||||||
type: list
|
type: list
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ options:
|
|||||||
- Whether or not to verify the API server's SSL certificates.
|
- Whether or not to verify the API server's SSL certificates.
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- openshift == 0.4.0
|
- openshift == 0.4.0.a1
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|||||||
Reference in New Issue
Block a user