Files
kubernetes.core/library/openshift_v1_image_stream.py
Fabian von Feilitzsch 91484a7a22 update modules
2017-10-03 13:45:09 -04:00

708 lines
32 KiB
Python

#!/usr/bin/env python
from ansible.module_utils.openshift_common import OpenShiftAnsibleModule, OpenShiftAnsibleException
DOCUMENTATION = '''
module: openshift_v1_image_stream
short_description: OpenShift ImageStream
description:
- Manage the lifecycle of a image_stream 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_docker_image_repository:
description:
- 'dockerImageRepository is optional, if specified this stream is backed by a
Docker repository on this server Deprecated: This field is deprecated as of
v3.7 and will be removed in a future release. Specify the source for the tags
to be imported in each tag via the spec.tags.from reference instead.'
aliases:
- docker_image_repository
spec_lookup_policy_local:
description:
- local will change the docker short image references (like "mysql" or "php:latest")
on objects in this namespace to the image ID whenever they match this image
stream, instead of reaching out to a remote registry. The name will be fully
qualified to an image ID if found. The tag's referencePolicy is taken into account
on the replaced value. Only works within the current namespace.
aliases:
- lookup_policy_local
type: bool
spec_tags:
description:
- tags map arbitrary string values to specific image locators
aliases:
- tags
type: list
src:
description:
- Provide a path to a file containing the YAML definition of the object. Mutually
exclusive with I(resource_definition).
type: path
ssl_ca_cert:
description:
- Path to a CA certificate used to authenticate with the API.
type: path
state:
description:
- Determines if an object should be created, patched, or deleted. When set to
C(present), the object will be created, if it does not exist, or patched, if
parameter values differ from the existing object's attributes, and deleted,
if set to C(absent). A patch operation results in merging lists and updating
dictionaries, with lists being merged into a unique set of values. If a list
contains a dictionary with a I(name) or I(type) attribute, a strategic merge
is performed, where individual elements with a matching I(name_) or I(type)
are merged. To force the replacement of lists, set the I(force) option to C(True).
default: present
choices:
- present
- absent
username:
description:
- Provide a username for connecting to the API.
verify_ssl:
description:
- Whether or not to verify the API server's SSL certificates.
type: bool
requirements:
- openshift == 0.3.1
'''
EXAMPLES = '''
'''
RETURN = '''
api_version:
type: string
description: Requested API version
image_stream:
type: complex
returned: when I(state) = C(present)
contains:
api_version:
description:
- APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
type: str
kind:
description:
- Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to. Cannot
be updated. In CamelCase.
type: str
metadata:
description:
- Standard object's metadata.
type: complex
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 describes the desired state of this stream
type: complex
contains:
docker_image_repository:
description:
- 'dockerImageRepository is optional, if specified this stream is backed
by a Docker repository on this server Deprecated: This field is deprecated
as of v3.7 and will be removed in a future release. Specify the source
for the tags to be imported in each tag via the spec.tags.from reference
instead.'
type: str
lookup_policy:
description:
- lookupPolicy controls how other resources reference images within this
namespace.
type: complex
contains:
local:
description:
- local will change the docker short image references (like "mysql"
or "php:latest") on objects in this namespace to the image ID whenever
they match this image stream, instead of reaching out to a remote
registry. The name will be fully qualified to an image ID if found.
The tag's referencePolicy is taken into account on the replaced value.
Only works within the current namespace.
type: bool
tags:
description:
- tags map arbitrary string values to specific image locators
type: list
contains:
_from:
description:
- Optional; if specified, a reference to another image that this tag
should point to. Valid values are ImageStreamTag, ImageStreamImage,
and DockerImage.
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
annotations:
description:
- Optional; if specified, annotations that are applied to images retrieved
via ImageStreamTags.
type: complex
contains: str, str
generation:
description:
- Generation is a counter that tracks mutations to the spec tag (user
intent). When a tag reference is changed the generation is set to
match the current stream generation (which is incremented every time
spec is changed). Other processes in the system like the image importer
observe that the generation of spec tag is newer than the generation
recorded in the status and use that as a trigger to import the newest
remote tag. To trigger a new import, clients may set this value to
zero which will reset the generation to the latest stream generation.
Legacy clients will send this value as nil which will be merged with
the current tag generation.
type: int
import_policy:
description:
- ImportPolicy is information that controls how images may be imported
by the server.
type: complex
contains:
insecure:
description:
- Insecure is true if the server may bypass certificate verification
or connect directly over HTTP during image import.
type: bool
scheduled:
description:
- Scheduled indicates to the server that this tag should be periodically
checked to ensure it is up to date, and imported
type: bool
name:
description:
- Name of the tag
type: str
reference:
description:
- Reference states if the tag will be imported. Default value is false,
which means the tag will be imported.
type: bool
reference_policy:
description:
- ReferencePolicy defines how other components should consume the image.
type: complex
contains:
type:
description:
- Type determines how the image pull spec should be transformed
when the image stream tag is used in deployment config triggers
or new builds. The default value is `Source`, indicating the original
location of the image should be used (if imported). The user may
also specify `Local`, indicating that the pull spec should point
to the integrated Docker registry and leverage the registry's
ability to proxy the pull to an upstream registry. `Local` allows
the credentials used to pull this image to be managed from the
image stream's namespace, so others on the platform can access
a remote image but have no access to the remote secret. It also
allows the image layers to be mirrored into the local registry
which the images can still be pulled even if the upstream registry
is unavailable.
type: str
status:
description:
- Status describes the current state of this stream
type: complex
contains:
docker_image_repository:
description:
- DockerImageRepository represents the effective location this stream may
be accessed at. May be empty until the server determines where the repository
is located
type: str
public_docker_image_repository:
description:
- PublicDockerImageRepository represents the public location from where
the image can be pulled outside the cluster. This field may be empty if
the administrator has not exposed the integrated registry externally.
type: str
tags:
description:
- Tags are a historical record of images associated with each tag. The first
entry in the TagEvent array is the currently tagged image.
type: list
contains:
conditions:
description:
- Conditions is an array of conditions that apply to the tag event list.
type: list
contains:
generation:
description:
- Generation is the spec tag generation that this status corresponds
to
type: int
last_transition_time:
description:
- LastTransitionTIme is the time the condition transitioned from
one status to another.
type: complex
contains: {}
message:
description:
- Message is a human readable description of the details about last
transition, complementing reason.
type: str
reason:
description:
- Reason is a brief machine readable explanation for the condition's
last transition.
type: str
status:
description:
- Status of the condition, one of True, False, Unknown.
type: str
type:
description:
- Type of tag event condition, currently only ImportSuccess
type: str
items:
description:
- Standard object's metadata.
type: list
contains:
created:
description:
- Created holds the time the TagEvent was created
type: complex
contains: {}
docker_image_reference:
description:
- DockerImageReference is the string that can be used to pull this
image
type: str
generation:
description:
- Generation is the spec tag generation that resulted in this tag
being updated
type: int
image:
description:
- Image is the image
type: str
tag:
description:
- Tag is the tag for which the history is recorded
type: str
'''
def main():
try:
module = OpenShiftAnsibleModule('image_stream', 'V1')
except OpenShiftAnsibleException 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 OpenShiftAnsibleException as exc:
module.fail_json(msg="Module failed!", error=str(exc))
if __name__ == '__main__':
main()