Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Don't wait on *List resources for info module #253

Merged
merged 3 commits into from
Nov 8, 2021

Conversation

gravesm
Copy link
Member

@gravesm gravesm commented Oct 4, 2021

SUMMARY

We can't use the same wait logic on *List resources because they lack
the same metadata that other resources have. We should ensure that we
are waiting on the items in the list, but not the list itself. Waiting
on the list itself results in unexpected behavior.

This fixes the waiting logic when waiting on a list to wait until the
list being queried contains one or more items, or the wait timeout has
been reached. Each item in the list can then be waited on with the usual
wait logic.

ISSUE TYPE
  • Bugfix Pull Request
COMPONENT NAME
ADDITIONAL INFORMATION

@gravesm
Copy link
Member Author

gravesm commented Oct 5, 2021

recheck

1 similar comment
@gravesm
Copy link
Member Author

gravesm commented Oct 5, 2021

recheck

Copy link
Contributor

@abikouo abikouo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!!

We can't use the same wait logic on *List resources because they lack
the same metadata that other resources have. We should ensure that we
are waiting on the items in the list, but not the list itself. Waiting
on the list itself results in unexpected behavior.

This fixes the waiting logic when waiting on a list to wait until the
list being queried contains one or more items, or the wait timeout has
been reached. Each item in the list can then be waited on with the usual
wait logic.
Copy link

@ansible-zuul ansible-zuul bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@ansible-zuul ansible-zuul bot merged commit bf26f5a into ansible-collections:main Nov 8, 2021
@gravesm gravesm deleted the fix-podlist-wait branch November 9, 2021 15:34
gravesm added a commit to gravesm/kubernetes.core that referenced this pull request Jan 13, 2022
Don't wait on *List resources for info module

SUMMARY

We can't use the same wait logic on *List resources because they lack
the same metadata that other resources have. We should ensure that we
are waiting on the items in the list, but not the list itself. Waiting
on the list itself results in unexpected behavior.
This fixes the waiting logic when waiting on a list to wait until the
list being queried contains one or more items, or the wait timeout has
been reached. Each item in the list can then be waited on with the usual
wait logic.

ISSUE TYPE

Bugfix Pull Request

COMPONENT NAME

ADDITIONAL INFORMATION

Reviewed-by: None <None>
Reviewed-by: Alina Buzachis <None>
Reviewed-by: None <None>
(cherry picked from commit bf26f5a)
StinkyBenji pushed a commit to StinkyBenji/ansible-tekton-demo that referenced this pull request Nov 1, 2023
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
|
[kubernetes.core](https://github.com/ansible-collections/kubernetes.core)
| galaxy-collection | minor | `2.2.3` -> `2.4.0` |

---

### Release Notes

<details>
<summary>ansible-collections/kubernetes.core (kubernetes.core)</summary>

###
[`v2.4.0`](https://github.com/ansible-collections/kubernetes.core/blob/HEAD/CHANGELOG.rst#v240)

[Compare
Source](https://github.com/ansible-collections/kubernetes.core/compare/2.3.2...2.4.0)

\======

## Major Changes

- refactor K8sAnsibleMixin into module_utils/k8s/
([ansible-collections/kubernetes.core#481).

## Minor Changes

- Adjust k8s_user_impersonation tests to be compatible with Kubernetes
1.24
([ansible-collections/kubernetes.core#520).
- add support for dry run with kubernetes client version >=18.20
([ansible-collections/kubernetes.core#245).
-   added ignore.txt for Ansible 2.14 devel branch.
- fixed module_defaults by removing routing hacks from runtime.yml
([ansible-collections/kubernetes.core#347).
- helm - add support for -set-file, -set-json, -set and -set-string
options when running helm install
([ansible-collections/kubernetes.core#533).
- helm - add support for helm dependency update
([ansible-collections/kubernetes.core#208).
- helm - add support for post-renderer flag
([ansible-collections/kubernetes.core#30).
- helm - add support for timeout cli parameter to allow setting Helm
timeout independent of wait
([ansible-collections/kubernetes.core#67).
- helm - add support for wait parameter for helm uninstall command.
(https://github.com/ansible-collections/kubernetes/core/issues/33).
- helm - support repo location for helm diff
([ansible-collections/kubernetes.core#174).
- helm - when ansible is executed in check mode, return the diff between
what's deployed and what will be deployed.
- helm, helm_plugin, helm_info, helm_plugin_info, kubectl - add support
for in-memory kubeconfig.
([ansible-collections/kubernetes.core#492).
- helm_info - add hooks, notes and manifest as part of returned
information
([ansible-collections/kubernetes.core#546).
- helm_info - add release state as a module argument
([ansible-collections/kubernetes.core#377).
- helm_info - added possibility to get all values by adding
get_all_values parameter
([ansible-collections/kubernetes.core#531).
- helm_plugin - Add plugin_version parameter to the helm_plugin module
([ansible-collections/kubernetes.core#157).
-   helm_plugin - Add support for helm plugin update using state=update.
- helm_repository - Ability to replace (overwrite) the repo if it
already exists by forcing
([ansible-collections/kubernetes.core#491).
- helm_repository - add support for pass-credentials cli parameter
([ansible-collections/kubernetes.core#282).
- helm_repository - added support for `host`, `api_key`,
`validate_certs`, and `ca_cert`.
- helm_repository - mark `pass_credentials` as no_log=True to silence
false warning
([ansible-collections/kubernetes.core#412).
- helm_template - add name (NAME of release) and disable_hook as
optional module arguments
([ansible-collections/kubernetes.core#313).
- helm_template - add show_only and release_namespace as module
arguments
([ansible-collections/kubernetes.core#313).
- helm_template - add support for -set-file, -set-json, -set and
-set-string options when running helm template
([ansible-collections/kubernetes.core#546).
- k8s - add no_proxy support to k8s\*
[ansible-collections/kubernetes.core#272).
- k8s - add support for server_side_apply.
([ansible-collections/kubernetes.core#87).
- k8s - add support for user impersonation.
(https://github.com/ansible-collections/kubernetes/core/issues/40).
- k8s - allow resource definition using metadata.generateName
([ansible-collections/kubernetes.core#35).
- k8s lookup plugin - Enable turbo mode via environment variable
([ansible-collections/kubernetes.core#291).
- k8s, k8s_scale, k8s_service - add support for resource definition as
manifest via.
([ansible-collections/kubernetes.core#451).
- k8s_cp - remove dependency with 'find' executable on remote pod when
state=from_pod
([ansible-collections/kubernetes.core#486).
- k8s_drain - Adds `delete_emptydir_data` option to
`k8s_drain.delete_options` to evict pods with an `emptyDir` volume
attached
([ansible-collections/kubernetes.core#322).
- k8s_exec - select first container from the pod if none specified
([ansible-collections/kubernetes.core#358).
- k8s_exec - update deprecation warning for `return_code`
([ansible-collections/kubernetes.core#417).
- k8s_json_patch - minor typo fix in the example section
([ansible-collections/kubernetes.core#411).
- k8s_log - add the `all_containers` for retrieving all containers' logs
in the pod(s).
- k8s_log - added the `previous` parameter for retrieving the previously
terminated pod logs
([ansible-collections/kubernetes.core#437).
- k8s_log - added the `tail_lines` parameter to limit the number of
lines to be retrieved from the end of the logs
([ansible-collections/kubernetes.core#488).
- k8s_rollback - add support for check_mode.
(https://github.com/ansible-collections/kubernetes/core/issues/243).
- k8s_scale - add support for check_mode.
(https://github.com/ansible-collections/kubernetes/core/issues/244).
- kubectl - wait for dd command to complete before proceeding
([ansible-collections/kubernetes.core#321).
- kubectl.py - replace distutils.spawn.find_executable with shutil.which
in the kubectl connection plugin
([ansible-collections/kubernetes.core#456).

## Bugfixes

- Fix dry_run logic - Pass the value dry_run=All instead of dry_run=True
to the client, add conditional check on kubernetes client version as
this feature is supported only for kubernetes >= 18.20.0
([ansible-collections/kubernetes.core#561).
- Fix kubeconfig parameter when multiple config files are provided
([ansible-collections/kubernetes.core#435).
- Helm - Fix issue with alternative kubeconfig provided with
validate_certs=False
([ansible-collections/kubernetes.core#538).
- Various modules and plugins - use vendored version of
`distutils.version` instead of the deprecated Python standard library
`distutils`
([ansible-collections/kubernetes.core#314).
- add missing documentation for filter plugin
kubernetes.core.k8s_config_resource_name
([ansible-collections/kubernetes.core#558).
- common - Ensure the label_selectors parameter of \_wait_for method is
optional.
-   common - handle `aliases` passed from inventory and lookup plugins.
- helm_template - evaluate release_values after values_files, insuring
highest precedence (now same behavior as in helm module).
([ansible-collections/kubernetes.core#348)
-   import exception from `kubernetes.client.rest`.
- k8s - Fix issue with check_mode when using server side apply
([ansible-collections/kubernetes.core#547).
- k8s - Fix issue with server side apply with kubernetes release
'25.3.0'
([ansible-collections/kubernetes.core#548).
- k8s_cp - add support for check_mode
([ansible-collections/kubernetes.core#380).
- k8s_drain - fix error caused by accessing an undefined variable when
pods have local storage
([ansible-collections/kubernetes.core#292).
- k8s_info - don't wait on empty List resources
([ansible-collections/kubernetes.core#253).
- k8s_info - fix issue when module returns successful true after the
resource cache has been established during periods where communication
to the api-server is not possible
([ansible-collections/kubernetes.core#508).
- k8s_log - Fix module traceback when no resource found
([ansible-collections/kubernetes.core#479).
- k8s_log - fix exception raised when the name is not provided for
resources requiring.
([ansible-collections/kubernetes.core#514)
- k8s_scale - fix waiting on statefulset when scaled down to 0 replicas
([ansible-collections/kubernetes.core#203).
- module_utils.common - change default opening mode to read-bytes to
avoid bad interpretation of non ascii characters and strings, often
present in 3rd party manifests.
- module_utils/k8s/client.py - fix issue when trying to authenticate
with host, client_cert and client_key parameters only.
- remove binary file from k8s_cp test suite
([ansible-collections/kubernetes.core#298).
- use resource prefix when finding resource and apiVersion is v1
([ansible-collections/kubernetes.core#351).

## New Modules

- helm_pull - download a chart from a repository and (optionally) unpack
it in local directory.

###
[`v2.3.2`](https://github.com/ansible-collections/kubernetes.core/compare/2.3.1...2.3.2)

[Compare
Source](https://github.com/ansible-collections/kubernetes.core/compare/2.3.1...2.3.2)

###
[`v2.3.1`](https://github.com/ansible-collections/kubernetes.core/blob/HEAD/CHANGELOG.rst#v231)

[Compare
Source](https://github.com/ansible-collections/kubernetes.core/compare/2.3.0...2.3.1)

\======

## Bugfixes

- Catch exception raised when the process is waiting for resources
([ansible-collections/kubernetes.core#407).
- Remove `omit` placeholder when defining resource using template
parameter
([ansible-collections/kubernetes.core#431).
- k8s - fix the issue when trying to delete resources using
label_selectors options
([ansible-collections/kubernetes.core#433).
- k8s_cp - fix issue when using parameter local_path with file on
managed node.
([ansible-collections/kubernetes.core#421).
- k8s_drain - fix error occurring when trying to drain node with
disable_eviction set to yes
([ansible-collections/kubernetes.core#416).

###
[`v2.3.0`](https://github.com/ansible-collections/kubernetes.core/blob/HEAD/CHANGELOG.rst#v230)

[Compare
Source](https://github.com/ansible-collections/kubernetes.core/compare/2.2.3...2.3.0)

\======

## Minor Changes

- add support for dry run with kubernetes client version >=18.20
([ansible-collections/kubernetes.core#245).
- fixed module_defaults by removing routing hacks from runtime.yml
([ansible-collections/kubernetes.core#347).
- helm - add support for timeout cli parameter to allow setting Helm
timeout independent of wait
([ansible-collections/kubernetes.core#67).
- helm - add support for wait parameter for helm uninstall command.
(https://github.com/ansible-collections/kubernetes/core/issues/33).
- helm - support repo location for helm diff
([ansible-collections/kubernetes.core#174).
- helm - when ansible is executed in check mode, return the diff between
what's deployed and what will be deployed.
- helm_info - add release state as a module argument
([ansible-collections/kubernetes.core#377).
- helm_plugin - Add plugin_version parameter to the helm_plugin module
([ansible-collections/kubernetes.core#157).
-   helm_plugin - Add support for helm plugin update using state=update.
- helm_repository - add support for pass-credentials cli parameter
([ansible-collections/kubernetes.core#282).
- helm_repository - added support for `host`, `api_key`,
`validate_certs`, and `ca_cert`.
- helm_template - add show_only and release_namespace as module
arguments
([ansible-collections/kubernetes.core#313).
- k8s - add no_proxy support to k8s\*
[ansible-collections/kubernetes.core#272).
- k8s - add support for server_side_apply.
([ansible-collections/kubernetes.core#87).
- k8s - add support for user impersonation.
(https://github.com/ansible-collections/kubernetes/core/issues/40).
- k8s - allow resource definition using metadata.generateName
([ansible-collections/kubernetes.core#35).
- k8s lookup plugin - Enable turbo mode via environment variable
([ansible-collections/kubernetes.core#291).
- k8s_drain - Adds `delete_emptydir_data` option to
`k8s_drain.delete_options` to evict pods with an `emptyDir` volume
attached
([ansible-collections/kubernetes.core#322).
- k8s_exec - select first container from the pod if none specified
([ansible-collections/kubernetes.core#358).
- k8s_rollback - add support for check_mode.
(https://github.com/ansible-collections/kubernetes/core/issues/243).
- k8s_scale - add support for check_mode.
(https://github.com/ansible-collections/kubernetes/core/issues/244).
- kubectl - wait for dd command to complete before proceeding
([ansible-collections/kubernetes.core#321).

## Bugfixes

- Various modules and plugins - use vendored version of
`distutils.version` instead of the deprecated Python standard library
`distutils`
([ansible-collections/kubernetes.core#314).
- common - Ensure the label_selectors parameter of \_wait_for method is
optional.
- helm_template - evaluate release_values after values_files, insuring
highest precedence (now same behavior as in helm module).
([ansible-collections/kubernetes.core#348)
-   import exception from `kubernetes.client.rest`.
- k8s_drain - fix error caused by accessing an undefined variable when
pods have local storage
([ansible-collections/kubernetes.core#292).
- k8s_info - don't wait on empty List resources
([ansible-collections/kubernetes.core#253).
- k8s_scale - fix waiting on statefulset when scaled down to 0 replicas
([ansible-collections/kubernetes.core#203).
- module_utils.common - change default opening mode to read-bytes to
avoid bad interpretation of non ascii characters and strings, often
present in 3rd party manifests.
- remove binary file from k8s_cp test suite
([ansible-collections/kubernetes.core#298).
- use resource prefix when finding resource and apiVersion is v1
([ansible-collections/kubernetes.core#351).

## New Modules

-   k8s_taint - Taint a node in a Kubernetes/OpenShift cluster

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/StinkyBenji/ansible-tekton-demo).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zMS41IiwidXBkYXRlZEluVmVyIjoiMzcuMzEuNSIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants