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

k8s_drain not working properly with 'state: drain' #292

Closed
felipe4334 opened this issue Nov 24, 2021 · 8 comments · Fixed by #295
Closed

k8s_drain not working properly with 'state: drain' #292

felipe4334 opened this issue Nov 24, 2021 · 8 comments · Fixed by #295
Assignees
Labels
has_pr type/bug Something isn't working

Comments

@felipe4334
Copy link

felipe4334 commented Nov 24, 2021

SUMMARY

when using module k8s_drain with state: drain it outputs an error of "local variable 'pod_names' referenced before assignment"

ISSUE TYPE
  • Bug Report
COMPONENT NAME

kubernetes.core.k8s_drain with option: "state: drain"

ANSIBLE VERSION
2.11.6 and on 2.9
COLLECTION VERSION
~/.ansible/collections/ansible_collections : 2.2.1
~/../lib/python3.8/site-packages/ansible_collections: 1.2.1
CONFIGURATION

OS / ENVIRONMENT

Cent OS 7

STEPS TO REPRODUCE
EXPECTED RESULTS

Try draining a node with module like this:

    - name: drain the old nodes
      kubernetes.core.k8s_drain: 
        context: "{{ k8_cluster_context }}"
        state: drain  
        name: "{{ item }}"
        delete_options:
          terminate_grace_period: 900
      loop: "{{ k8_nodepool_privateips }}"
      register: k8_node_drain_results
ACTUAL RESULTS
failed: [localhost] (item=10.50.133.187) => {"ansible_loop_var": "item", "changed": false, "item": "10.50.133.187", "msg": "Failed to list pod from node 10.50.133.187 due to: local variable 'pod_names' referenced before assignment"}
@felipe4334
Copy link
Author

felipe4334 commented Nov 24, 2021

state: cordon works as expected. Yes i did try remove state: drain as well and still same issue.

@Akasurde Akasurde added the type/bug Something isn't working label Nov 25, 2021
@Akasurde
Copy link
Member

I'm investigating.

@Akasurde
Copy link
Member

@gravesm Thanks for taking a look.

@felipe4334 Could you please check if PR #295 works for you and let us know? Thanks in advance.

@Akasurde
Copy link
Member

resolved_by_pr #295

ansible-zuul bot pushed a commit that referenced this issue Nov 30, 2021
Fix k8s_drain failing when pod has local storage

SUMMARY

The module fails to define the pod_names variable before using it for
pods with local storage.

Fixes #292
ISSUE TYPE


Bugfix Pull Request

COMPONENT NAME

k8s_drain
ADDITIONAL INFORMATION

Reviewed-by: Abhijeet Kasurde <None>
Reviewed-by: None <None>
Reviewed-by: None <None>
@TravisAbram
Copy link

TravisAbram commented Dec 17, 2021

I still have this issue with drain. (cordon/uncordon work as expected)

Collection Version: kubernetes.core 2.2.2

Error message

"msg": "Failed to list pod from node node_name due to: local variable 'pod_names' referenced before assignment"

Traceback shows an error on the same line

regardless of whether force is set to true or false.

Force: yes

      - name: Drain Node
        kubernetes.core.k8s_drain:
          name: "{{ inventory_hostname_short }}"
          state: drain
          delete_options:
            force: yes
The full traceback is:
  File "/tmp/ansible_kubernetes.core.k8s_drain_payload__uy247qv/ansible_kubernetes.core.k8s_drain_payload.zip/ansible_collections/kubernetes/core/plugins/modules/k8s_drain.py", line 303, in delete_or_evict_pods
  File "/tmp/ansible_kubernetes.core.k8s_drain_payload__uy247qv/ansible_kubernetes.core.k8s_drain_payload.zip/ansible_collections/kubernetes/core/plugins/modules/k8s_drain.py", line 186, in filter_pods
fatal: [node_fqdn]: FAILED! => {
    "changed": false,
    "invocation": {
        "module_args": {
            "api_key": null,
            "ca_cert": null,
            "client_cert": null,
            "client_key": null,
            "context": null,
            "delete_options": {
                "disable_eviction": false,
                "force": true,
                "ignore_daemonsets": false,
                "terminate_grace_period": null,
                "wait_sleep": 5,
                "wait_timeout": null
            },
            "host": null,
            "kubeconfig": null,
            "name": "node_name",
            "password": null,
            "persist_config": null,
            "proxy": null,
            "proxy_headers": null,
            "state": "drain",
            "username": null,
            "validate_certs": null
        }
    },
    "msg": "Failed to list pod from node node_name due to: local variable 'pod_names' referenced before assignment"
}

Force: no

      - name: Drain Node
        kubernetes.core.k8s_drain:
          name: "{{ inventory_hostname_short }}"
          state: drain
          delete_options:
            force: no
The full traceback is:
  File "/tmp/ansible_kubernetes.core.k8s_drain_payload_n2lqwj2t/ansible_kubernetes.core.k8s_drain_payload.zip/ansible_collections/kubernetes/core/plugins/modules/k8s_drain.py", line 303, in delete_or_evict_pods
  File "/tmp/ansible_kubernetes.core.k8s_drain_payload_n2lqwj2t/ansible_kubernetes.core.k8s_drain_payload.zip/ansible_collections/kubernetes/core/plugins/modules/k8s_drain.py", line 186, in filter_pods
fatal: [node_fqdn]: FAILED! => {
    "changed": false,
    "invocation": {
        "module_args": {
            "api_key": null,
            "ca_cert": null,
            "client_cert": null,
            "client_key": null,
            "context": null,
            "delete_options": {
                "disable_eviction": false,
                "force": false,
                "ignore_daemonsets": false,
                "terminate_grace_period": null,
                "wait_sleep": 5,
                "wait_timeout": null
            },
            "host": null,
            "kubeconfig": null,
            "name": "node_name",
            "password": null,
            "persist_config": null,
            "proxy": null,
            "proxy_headers": null,
            "state": "drain",
            "username": null,
            "validate_certs": null
        }
    },
    "msg": "Failed to list pod from node node_name due to: local variable 'pod_names' referenced before assignment"
}

@gravesm
Copy link
Member

gravesm commented Jan 4, 2022

Hi @TravisAbram, the traceback suggests you are not actually using version 2.2.2. The first line of the traceback: line 303, in delete_or_evict_pods. This does not line up for version 2.2.2, but does for previous versions.

@jorneilander
Copy link
Contributor

jorneilander commented Jan 5, 2022

Hi @TravisAbram, the traceback suggests you are not actually using version 2.2.2. The first line of the traceback: line 303, in delete_or_evict_pods. This does not line up for version 2.2.2, but does for previous versions.

This is incorrect, in 2.2.2 this is most definitely still an issue:

pods, warnings, errors = filter_pods(pod_list.items, force, ignore_daemonset)

It is however, fixed in main:

self._api_instance.create_namespaced_pod_eviction(

Reason for me saying this, is because I'm running into this exact issue...

Should anyone run into the same issue:

ansible-galaxy collection install git+https://github.com/ansible-collections/kubernetes.core.git,main

This will install the latest version from main, which is still tagged 2.2.0 in Ansible Galaxy oddly enough.

@gravesm
Copy link
Member

gravesm commented Jan 13, 2022

Sorry, you are correct. This change did not get backported to the 2.2 branch. I'll try to get a new 2.2 release out next week that includes this fix.

gravesm added a commit to gravesm/kubernetes.core that referenced this issue Jan 13, 2022
…#295)

Fix k8s_drain failing when pod has local storage

SUMMARY

The module fails to define the pod_names variable before using it for
pods with local storage.

Fixes ansible-collections#292
ISSUE TYPE

Bugfix Pull Request

COMPONENT NAME

k8s_drain
ADDITIONAL INFORMATION

Reviewed-by: Abhijeet Kasurde <None>
Reviewed-by: None <None>
Reviewed-by: None <None>
(cherry picked from commit ef46c35)
StinkyBenji pushed a commit to StinkyBenji/ansible-tekton-demo that referenced this issue 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
has_pr type/bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants