diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 1bd9deb..b86a7c4 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -5,6 +5,21 @@ OKD Collection Release Notes .. contents:: Topics +v2.3.0 +====== + +Bugfixes +-------- + +- openshift_adm_groups_sync - initialize OpenshiftGroupSync attributes early to avoid Attribute error (https://github.com/openshift/community.okd/issues/155). +- openshift_auth - Review the way the discard process is working, add openshift algorithm to convert token to resource object name (https://github.com/openshift/community.okd/issues/176). + +New Modules +----------- + +- openshift_adm_prune_builds - Prune old completed and failed builds +- openshift_build - Start a new build or Cancel running, pending, or new builds. + v2.2.0 ====== diff --git a/Makefile b/Makefile index 34cbac4..7990f84 100644 --- a/Makefile +++ b/Makefile @@ -1,7 +1,7 @@ .PHONY: molecule # Also needs to be updated in galaxy.yml -VERSION = 2.2.0 +VERSION = 2.3.0 SANITY_TEST_ARGS ?= --docker --color UNITS_TEST_ARGS ?= --docker --color diff --git a/README.md b/README.md index af8eb8d..f3e1bba 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,8 @@ The collection includes a variety of Ansible content to help automate the manage This collection has been tested against following Ansible versions: **>=2.9.17**. -For collections that support Ansible 2.9, please ensure you update your `network_os` to use the -fully qualified collection name (for example, `cisco.ios.ios`). +For collections that support Ansible 2.9, please ensure you update your `network_os` to use the +fully qualified collection name (for example, `cisco.ios.ios`). Plugins and modules within a collection may be tested with only specific Ansible versions. A collection may contain metadata that identifies these versions. PEP440 is the schema used to describe the versions of Ansible. @@ -49,9 +49,11 @@ Name | Description [community.okd.openshift_adm_groups_sync](https://github.com/openshift/community.okd/blob/main/docs/community.okd.openshift_adm_groups_sync_module.rst)|Sync OpenShift Groups with records from an external provider. [community.okd.openshift_adm_migrate_template_instances](https://github.com/openshift/community.okd/blob/main/docs/community.okd.openshift_adm_migrate_template_instances_module.rst)|Update TemplateInstances to point to the latest group-version-kinds [community.okd.openshift_adm_prune_auth](https://github.com/openshift/community.okd/blob/main/docs/community.okd.openshift_adm_prune_auth_module.rst)|Removes references to the specified roles, clusterroles, users, and groups +[community.okd.openshift_adm_prune_builds](https://github.com/openshift/community.okd/blob/main/docs/community.okd.openshift_adm_prune_builds_module.rst)|Prune old completed and failed builds [community.okd.openshift_adm_prune_deployments](https://github.com/openshift/community.okd/blob/main/docs/community.okd.openshift_adm_prune_deployments_module.rst)|Remove old completed and failed deployment configs [community.okd.openshift_adm_prune_images](https://github.com/openshift/community.okd/blob/main/docs/community.okd.openshift_adm_prune_images_module.rst)|Remove unreferenced images [community.okd.openshift_auth](https://github.com/openshift/community.okd/blob/main/docs/community.okd.openshift_auth_module.rst)|Authenticate to OpenShift clusters which require an explicit login step +[community.okd.openshift_build](https://github.com/openshift/community.okd/blob/main/docs/community.okd.openshift_build_module.rst)|Start a new build or Cancel running, pending, or new builds. [community.okd.openshift_import_image](https://github.com/openshift/community.okd/blob/main/docs/community.okd.openshift_import_image_module.rst)|Import the latest image information from a tag in a container image registry. [community.okd.openshift_process](https://github.com/openshift/community.okd/blob/main/docs/community.okd.openshift_process_module.rst)|Process an OpenShift template.openshift.io/v1 Template [community.okd.openshift_registry_info](https://github.com/openshift/community.okd/blob/main/docs/community.okd.openshift_registry_info_module.rst)|Display information about the integrated registry. @@ -75,7 +77,7 @@ You can also include it in a `requirements.yml` file and install it via `ansible --- collections: - name: community.okd - version: 2.2.0 + version: 2.3.0 ``` ### Installing the Kubernetes Python Library diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index f41436f..12184d7 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -180,3 +180,22 @@ releases: name: openshift_registry_info namespace: '' release_date: '2022-05-05' + 2.3.0: + changes: + bugfixes: + - openshift_adm_groups_sync - initialize OpenshiftGroupSync attributes early + to avoid Attribute error (https://github.com/openshift/community.okd/issues/155). + - openshift_auth - Review the way the discard process is working, add openshift + algorithm to convert token to resource object name (https://github.com/openshift/community.okd/issues/176). + fragments: + - 165-initialize-attributes-early.yml + - 178-openshift_auth-fix-revoke-token.yml + - 180-default-values-doc.yml + modules: + - description: Prune old completed and failed builds + name: openshift_adm_prune_builds + namespace: '' + - description: Start a new build or Cancel running, pending, or new builds. + name: openshift_build + namespace: '' + release_date: '2023-02-03' diff --git a/changelogs/fragments/165-initialize-attributes-early.yml b/changelogs/fragments/165-initialize-attributes-early.yml deleted file mode 100644 index 0dd2b05..0000000 --- a/changelogs/fragments/165-initialize-attributes-early.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: - - openshift_adm_groups_sync - initialize OpenshiftGroupSync attributes early to avoid Attribute error (https://github.com/openshift/community.okd/issues/155). diff --git a/changelogs/fragments/178-openshift_auth-fix-revoke-token.yml b/changelogs/fragments/178-openshift_auth-fix-revoke-token.yml deleted file mode 100644 index a136af0..0000000 --- a/changelogs/fragments/178-openshift_auth-fix-revoke-token.yml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: - - openshift_auth - Review the way the discard process is working, add openshift algorithm to convert token to resource object name (https://github.com/openshift/community.okd/issues/176). diff --git a/changelogs/fragments/180-default-values-doc.yml b/changelogs/fragments/180-default-values-doc.yml deleted file mode 100644 index cd2d858..0000000 --- a/changelogs/fragments/180-default-values-doc.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -trivial: - - add missing default values to docstrings (https://github.com/openshift/community.okd/pull/180). diff --git a/ci/downstream.sh b/ci/downstream.sh index fbdd609..001959c 100755 --- a/ci/downstream.sh +++ b/ci/downstream.sh @@ -9,7 +9,7 @@ # - All functions are prefixed with f_ so it's obvious where they come # from when in use throughout the script -DOWNSTREAM_VERSION="2.2.0" +DOWNSTREAM_VERSION="2.3.0" KEEP_DOWNSTREAM_TMPDIR="${KEEP_DOWNSTREAM_TMPDIR:-''}" INSTALL_DOWNSTREAM_COLLECTION_PATH="${INSTALL_DOWNSTREAM_COLLECTION_PATH:-}" _build_dir="" diff --git a/docs/community.okd.openshift_adm_prune_builds_module.rst b/docs/community.okd.openshift_adm_prune_builds_module.rst new file mode 100644 index 0000000..6fb9443 --- /dev/null +++ b/docs/community.okd.openshift_adm_prune_builds_module.rst @@ -0,0 +1,571 @@ +.. _community.okd.openshift_adm_prune_builds_module: + + +**************************************** +community.okd.openshift_adm_prune_builds +**************************************** + +**Prune old completed and failed builds** + + +Version added: 2.3.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module allow administrators to delete old completed and failed builds. +- Analogous to ``oc adm prune builds``. + + + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- python >= 3.6 +- kubernetes >= 12.0.0 + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ api_key + +
+ string +
+ 		+ +
Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment variable.
+
+
+ ca_cert + +
+ path +
+ 		+ +
Path to a CA certificate used to authenticate with the API. The full certificate chain must be provided to avoid certificate validation errors. Can also be specified via K8S_AUTH_SSL_CA_CERT environment variable.
+

aliases: ssl_ca_cert
+
+
+ client_cert + +
+ path +
+ 		+ +
Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment variable.
+

aliases: cert_file
+
+
+ client_key + +
+ path +
+ 		+ +
Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_FILE environment variable.
+

aliases: key_file
+
+
+ context + +
+ string +
+ 		+ +
The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable.
+
+
+ host + +
+ string +
+ 		+ +
Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
+
+
+ impersonate_groups + +
+ list + / elements=string +
+
added in 2.3.0
+ 		+ +
Group(s) to impersonate for the operation.
+
Can also be specified via K8S_AUTH_IMPERSONATE_GROUPS environment. Example: Group1,Group2
+
+
+ impersonate_user + +
+ string +
+
added in 2.3.0
+ 		+ +
Username to impersonate for the operation.
+
Can also be specified via K8S_AUTH_IMPERSONATE_USER environment.
+
+
+ keep_younger_than + +
+ integer +
+ 		+ +
Specify the minimum age (in minutes) of a Build for it to be considered a candidate for pruning.
+
+
+ kubeconfig + +
+ raw +
+ 		+ +
Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the Kubernetes client will attempt to load the default configuration file from ~/.kube/config. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.
+
Multiple Kubernetes config file can be provided using separator ';' for Windows platform or ':' for others platforms.
+
The kubernetes configuration can be provided as dictionary. This feature requires a python kubernetes client version >= 17.17.0. Added in version 2.2.0.
+
+
+ namespace + +
+ string +
+ 		+ +
Use to specify namespace for builds to be deleted.
+
+
+ no_proxy + +
+ string +
+
added in 2.3.0
+ 		+ +
The comma separated list of hosts/domains/IP/CIDR that shouldn't go through proxy. Can also be specified via K8S_AUTH_NO_PROXY environment variable.
+
Please note that this module does not pick up typical proxy settings from the environment (e.g. NO_PROXY).
+
This feature requires kubernetes>=19.15.0. When kubernetes library is less than 19.15.0, it fails even no_proxy set in correct.
+
example value is "localhost,.local,.example.com,127.0.0.1,127.0.0.0/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16"
+
+
+ orphans + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
If true, prune all builds whose associated BuildConfig no longer exists and whose status is complete, failed, error, or cancelled.
+
+
+ password + +
+ string +
+ 		+ +
Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD environment variable.
+
Please read the description of the username option for a discussion of when this option is applicable.
+
+
+ persist_config + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Whether or not to save the kube config refresh tokens. Can also be specified via K8S_AUTH_PERSIST_CONFIG environment variable.
+
When the k8s context is using a user credentials with refresh tokens (like oidc or gke/gcloud auth), the token is refreshed by the k8s python client library but not saved by default. So the old refresh token can expire and the next auth might fail. Setting this flag to true will tell the k8s python client to save the new refresh token to the kube config file.
+
Default to false.
+
Please note that the current version of the k8s python client library does not support setting this flag to True yet.
+
The fix for this k8s python library is here: https://github.com/kubernetes-client/python-base/pull/169
+
+
+ proxy + +
+ string +
+ 		+ +
The URL of an HTTP proxy to use for the connection. Can also be specified via K8S_AUTH_PROXY environment variable.
+
Please note that this module does not pick up typical proxy settings from the environment (e.g. HTTP_PROXY).
+
+
+ proxy_headers + +
+ dictionary +
+
added in 2.0.0
+ 		+ +
The Header used for the HTTP proxy.
+
Documentation can be found here https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html?highlight=proxy_headers#urllib3.util.make_headers.
+
+
+ basic_auth + +
+ string +
+ 		+ +
Colon-separated username:password for basic authentication header.
+
Can also be specified via K8S_AUTH_PROXY_HEADERS_BASIC_AUTH environment.
+
+
+ proxy_basic_auth + +
+ string +
+ 		+ +
Colon-separated username:password for proxy basic authentication header.
+
Can also be specified via K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH environment.
+
+
+ user_agent + +
+ string +
+ 		+ +
String representing the user-agent you want, such as foo/1.0.
+
Can also be specified via K8S_AUTH_PROXY_HEADERS_USER_AGENT environment.
+
+
+ username + +
+ string +
+ 		+ +
Provide a username for authenticating with the API. Can also be specified via K8S_AUTH_USERNAME environment variable.
+
Please note that this only works with clusters configured to use HTTP Basic Auth. If your cluster has a different form of authentication (e.g. OAuth2 in OpenShift), this option will not work as expected and you should look into the community.okd.k8s_auth module, as that might do what you need.
+
+
+ validate_certs + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Whether or not to verify the API server's SSL certificates. Can also be specified via K8S_AUTH_VERIFY_SSL environment variable.
+

aliases: verify_ssl
+
+
+ + +Notes +----- + +.. note:: + - To avoid SSL certificate validation errors when ``validate_certs`` is *True*, the full certificate chain for the API server must be provided via ``ca_cert`` or in the kubeconfig file. + + + +Examples +-------- + +.. code-block:: yaml + + # Run deleting older completed and failed builds and also including + # all builds whose associated BuildConfig no longer exists + - name: Run delete orphan Builds + community.okd.openshift_adm_prune_builds: + orphans: True + + # Run deleting older completed and failed builds keep younger than 2hours + - name: Run delete builds, keep younger than 2h + community.okd.openshift_adm_prune_builds: + keep_younger_than: 120 + + # Run deleting builds from specific namespace + - name: Run delete builds from namespace + community.okd.openshift_adm_prune_builds: + namespace: testing_namespace + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ builds + +
+ complex +
+ 		success +
The builds that were deleted
+
+
  +
+ api_version + +
+ string +
+ 		success +
The versioned schema of this representation of an object.
+
+
  +
+ kind + +
+ string +
+ 		success +
Represents the REST resource this object represents.
+
+
  +
+ metadata + +
+ dictionary +
+ 		success +
Standard object metadata. Includes name, namespace, annotations, labels, etc.
+
+
  +
+ spec + +
+ dictionary +
+ 		success +
Specific attributes of the object. Will vary based on the api_version and kind.
+
+
  +
+ status + +
+ dictionary +
+ 		success +
Current status details for the object.
+
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Aubin Bikouo (@abikouo) diff --git a/docs/community.okd.openshift_build_module.rst b/docs/community.okd.openshift_build_module.rst new file mode 100644 index 0000000..dc177be --- /dev/null +++ b/docs/community.okd.openshift_build_module.rst @@ -0,0 +1,844 @@ +.. _community.okd.openshift_build_module: + + +***************************** +community.okd.openshift_build +***************************** + +**Start a new build or Cancel running, pending, or new builds.** + + +Version added: 2.3.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This module starts a new build from the provided build config or build name. +- This module also cancel a new, pending or running build by requesting a graceful shutdown of the build. There may be a delay between requesting the build and the time the build is terminated. +- This can also restart a new build when the current is cancelled. +- Analogous to ``oc cancel-build`` and ``oc start-build``. + + + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- python >= 3.6 +- kubernetes >= 12.0.0 + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ api_key + +
+ string +
+ 		+ +
Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment variable.
+
+
+ build_args + +
+ list + / elements=dictionary +
+ 		+ +
Specify a list of key-value pair to pass to Docker during the build.
+
+
+ name + +
+ string + / required +
+ 		+ +
docker build argument name.
+
+
+ value + +
+ string + / required +
+ 		+ +
docker build argument value.
+
+
+ build_config_name + +
+ string +
+ 		+ +
Specify the name of a build config from which a new build will be run.
+
Mutually exclusive with parameter build_name.
+
+
+ build_name + +
+ string +
+ 		+ +
Specify the name of a build which should be re-run.
+
Mutually exclusive with parameter build_config_name.
+
+
+ build_phases + +
+ list + / elements=string +
+ 		+
    Choices: +
  • New
    • +
  • Pending
    • +
  • Running
    • +
+ Default:
[]
+ 		+
List of state for build to cancel.
+
Ignored when state=started.
+
+
+ ca_cert + +
+ path +
+ 		+ +
Path to a CA certificate used to authenticate with the API. The full certificate chain must be provided to avoid certificate validation errors. Can also be specified via K8S_AUTH_SSL_CA_CERT environment variable.
+

aliases: ssl_ca_cert
+
+
+ client_cert + +
+ path +
+ 		+ +
Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment variable.
+

aliases: cert_file
+
+
+ client_key + +
+ path +
+ 		+ +
Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_FILE environment variable.
+

aliases: key_file
+
+
+ commit + +
+ string +
+ 		+ +
Specify the source code commit identifier the build should use; requires a build based on a Git repository.
+
+
+ context + +
+ string +
+ 		+ +
The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable.
+
+
+ env_vars + +
+ list + / elements=dictionary +
+ 		+ +
Specify a list of key-value pair for an environment variable to set for the build container.
+
+
+ name + +
+ string + / required +
+ 		+ +
Environment variable name.
+
+
+ value + +
+ string + / required +
+ 		+ +
Environment variable value.
+
+
+ host + +
+ string +
+ 		+ +
Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
+
+
+ impersonate_groups + +
+ list + / elements=string +
+
added in 2.3.0
+ 		+ +
Group(s) to impersonate for the operation.
+
Can also be specified via K8S_AUTH_IMPERSONATE_GROUPS environment. Example: Group1,Group2
+
+
+ impersonate_user + +
+ string +
+
added in 2.3.0
+ 		+ +
Username to impersonate for the operation.
+
Can also be specified via K8S_AUTH_IMPERSONATE_USER environment.
+
+
+ incremental + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Overrides the incremental setting in a source-strategy build, ignored if not specified.
+
+
+ kubeconfig + +
+ raw +
+ 		+ +
Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the Kubernetes client will attempt to load the default configuration file from ~/.kube/config. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.
+
Multiple Kubernetes config file can be provided using separator ';' for Windows platform or ':' for others platforms.
+
The kubernetes configuration can be provided as dictionary. This feature requires a python kubernetes client version >= 17.17.0. Added in version 2.2.0.
+
+
+ namespace + +
+ string + / required +
+ 		+ +
Specify the namespace for the build or the build config.
+
+
+ no_cache + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Overrides the noCache setting in a docker-strategy build, ignored if not specified.
+
+
+ no_proxy + +
+ string +
+
added in 2.3.0
+ 		+ +
The comma separated list of hosts/domains/IP/CIDR that shouldn't go through proxy. Can also be specified via K8S_AUTH_NO_PROXY environment variable.
+
Please note that this module does not pick up typical proxy settings from the environment (e.g. NO_PROXY).
+
This feature requires kubernetes>=19.15.0. When kubernetes library is less than 19.15.0, it fails even no_proxy set in correct.
+
example value is "localhost,.local,.example.com,127.0.0.1,127.0.0.0/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16"
+
+
+ password + +
+ string +
+ 		+ +
Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD environment variable.
+
Please read the description of the username option for a discussion of when this option is applicable.
+
+
+ persist_config + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Whether or not to save the kube config refresh tokens. Can also be specified via K8S_AUTH_PERSIST_CONFIG environment variable.
+
When the k8s context is using a user credentials with refresh tokens (like oidc or gke/gcloud auth), the token is refreshed by the k8s python client library but not saved by default. So the old refresh token can expire and the next auth might fail. Setting this flag to true will tell the k8s python client to save the new refresh token to the kube config file.
+
Default to false.
+
Please note that the current version of the k8s python client library does not support setting this flag to True yet.
+
The fix for this k8s python library is here: https://github.com/kubernetes-client/python-base/pull/169
+
+
+ proxy + +
+ string +
+ 		+ +
The URL of an HTTP proxy to use for the connection. Can also be specified via K8S_AUTH_PROXY environment variable.
+
Please note that this module does not pick up typical proxy settings from the environment (e.g. HTTP_PROXY).
+
+
+ proxy_headers + +
+ dictionary +
+
added in 2.0.0
+ 		+ +
The Header used for the HTTP proxy.
+ +
+
+ basic_auth + +
+ string +
+ 		+ +
Colon-separated username:password for basic authentication header.
+
Can also be specified via K8S_AUTH_PROXY_HEADERS_BASIC_AUTH environment.
+
+
+ proxy_basic_auth + +
+ string +
+ 		+ +
Colon-separated username:password for proxy basic authentication header.
+
Can also be specified via K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH environment.
+
+
+ user_agent + +
+ string +
+ 		+ +
String representing the user-agent you want, such as foo/1.0.
+
Can also be specified via K8S_AUTH_PROXY_HEADERS_USER_AGENT environment.
+
+
+ state + +
+ string +
+ 		+
    Choices: +
  • started ←
    • +
  • cancelled
    • +
  • restarted
    • +
+ 		+
Determines if a Build should be started ,cancelled or restarted.
+
When set to restarted a new build will be created after the current build is cancelled.
+
+
+ username + +
+ string +
+ 		+ +
Provide a username for authenticating with the API. Can also be specified via K8S_AUTH_USERNAME environment variable.
+
Please note that this only works with clusters configured to use HTTP Basic Auth. If your cluster has a different form of authentication (e.g. OAuth2 in OpenShift), this option will not work as expected and you should look into the community.okd.k8s_auth module, as that might do what you need.
+
+
+ validate_certs + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Whether or not to verify the API server's SSL certificates. Can also be specified via K8S_AUTH_VERIFY_SSL environment variable.
+

aliases: verify_ssl
+
+
+ wait + +
+ boolean +
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
When state=started, specify whether to wait for a build to complete and exit with a non-zero return code if the build fails.
+
When state=cancelled, specify whether to wait for a build phase to be Cancelled.
+
+
+ wait_sleep + +
+ integer +
+ 		+ Default:
5
+ 		+
Number of seconds to sleep between checks.
+
Ignored if wait=false.
+
+
+ wait_timeout + +
+ integer +
+ 		+ Default:
120
+ 		+
How long in seconds to wait for a build to complete.
+
Ignored if wait=false.
+
+
+ + +Notes +----- + +.. note:: + - To avoid SSL certificate validation errors when ``validate_certs`` is *True*, the full certificate chain for the API server must be provided via ``ca_cert`` or in the kubeconfig file. + + + +Examples +-------- + +.. code-block:: yaml + + # Starts build from build config default/hello-world + - name: Starts build from build config + community.okd.openshift_build: + namespace: default + build_config_name: hello-world + + # Starts build from a previous build "default/hello-world-1" + - name: Starts build from a previous build + community.okd.openshift_build: + namespace: default + build_name: hello-world-1 + + # Cancel the build with the given name + - name: Cancel build from default namespace + community.okd.openshift_build: + namespace: "default" + build_name: ruby-build-1 + state: cancelled + + # Cancel the named build and create a new one with the same parameters + - name: Cancel build from default namespace and create a new one + community.okd.openshift_build: + namespace: "default" + build_name: ruby-build-1 + state: restarted + + # Cancel all builds created from 'ruby-build' build configuration that are in 'new' state + - name: Cancel build from default namespace and create a new one + community.okd.openshift_build: + namespace: "default" + build_config_name: ruby-build + build_phases: + - New + state: cancelled + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyReturnedDescription
+
+ builds + +
+ complex +
+ 		success +
The builds that were started/cancelled.
+
+
  +
+ api_version + +
+ string +
+ 		success +
The versioned schema of this representation of an object.
+
+
  +
+ kind + +
+ string +
+ 		success +
Represents the REST resource this object represents.
+
+
  +
+ metadata + +
+ dictionary +
+ 		success +
Standard object metadata. Includes name, namespace, annotations, labels, etc.
+
+
  +
+ spec + +
+ dictionary +
+ 		success +
Specific attributes of the build.
+
+
  +
+ status + +
+ dictionary +
+ 		success +
Current status details for the object.
+
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Aubin Bikouo (@abikouo) diff --git a/galaxy.yml b/galaxy.yml index 886ca83..f3ea49d 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -24,4 +24,4 @@ tags: - okd - cluster # Also needs to be updated in the Makefile -version: 2.2.0 +version: 2.3.0 diff --git a/requirements.yml b/requirements.yml index 1ef9568..d7d4e6f 100644 --- a/requirements.yml +++ b/requirements.yml @@ -1,3 +1,3 @@ collections: - name: kubernetes.core - version: '>=2.1.0,<2.4.0' + version: '>=2.4.0'