mirror of
https://github.com/ansible-collections/kubernetes.core.git
synced 2026-06-10 02:26:09 +00:00
496 lines
21 KiB
Python
496 lines
21 KiB
Python
#!/usr/bin/env python
|
|
|
|
from ansible.module_utils.k8s_common import OpenShiftAnsibleModule, OpenShiftAnsibleException
|
|
|
|
DOCUMENTATION = '''
|
|
module: k8s_v1_image_stream
|
|
short_description: Kubernetes 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
|
|
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.
|
|
required: true
|
|
namespace:
|
|
description:
|
|
- Namespace defines the space within each name must be unique. An empty namespace
|
|
is equivalent to the "default" namespace, but "default" is the canonical representation.
|
|
Not all objects are required to be scoped to a namespace - the value of this
|
|
field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated.
|
|
password:
|
|
description:
|
|
- Provide a password for connecting to the API. Use in conjunction with I(username).
|
|
spec_docker_image_repository:
|
|
description:
|
|
- DockerImageRepository is optional, if specified this stream is backed by a Docker
|
|
repository on this server
|
|
aliases:
|
|
- docker_image_repository
|
|
spec_tags:
|
|
description:
|
|
- Tags map arbitrary string values to specific image locators
|
|
aliases:
|
|
- tags
|
|
type: list
|
|
ssl_ca_cert:
|
|
description:
|
|
- Path to a CA certificate used to authenticate with the API.
|
|
type: path
|
|
state:
|
|
description:
|
|
- Determines if the object should be created, patched, deleted or replaced. When
|
|
set to C(present), the object will be created, if it does not exist, or patched,
|
|
if requested parameters differ from existing object attributes. If set to C(absent),
|
|
an existing object will be deleted, and if set to C(replaced), an existing object
|
|
will be completely replaced with a new object created from the supplied parameters.
|
|
default: present
|
|
choices:
|
|
- present
|
|
- absent
|
|
- replaced
|
|
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 == 1.0.0-snapshot
|
|
'''
|
|
|
|
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
|
|
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
|
|
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
|
|
type: str
|
|
tags:
|
|
description:
|
|
- Tags map arbitrary string values to specific image locators
|
|
type: list
|
|
contains:
|
|
_from:
|
|
description:
|
|
- From is a reference to an image stream tag or image stream this tag
|
|
should track
|
|
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:
|
|
- Annotations associated with images using this tag
|
|
type: complex
|
|
contains: str, str
|
|
generation:
|
|
description:
|
|
- Generation is the image stream generation that updated this tag -
|
|
setting it to 0 is an indication that the generation must be updated.
|
|
Legacy clients will send this as nil, which means the client doesn't
|
|
know or care.
|
|
type: int
|
|
import_policy:
|
|
description:
|
|
- Import 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
|
|
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()
|
|
|