[3.2.0] Not Compatible with https://github.com/kubernetes-client/python/releases/tag/v31.0.0

[hswong3i]

SUMMARY

https://github.com/kubernetes-client/python/releases/tag/v31.0.0 released on 2024-09-19, and now officially available from https://pypi.org/project/kubernetes/31.0.0/

When running following playbook with v30.1.0 everything looks good (see https://github.com/alvistack/ansible-collection-kubernetes/blob/8d0e953/playbooks/70-kube_csi_cephfs-verify.yml#L40-L57):

    - name: setup csi-cephfs as default storageclass
      vars:
        ansible_python_interpreter: python3
      kubernetes.core.k8s:
        state: present
        wait: true
        definition:
          apiVersion: storage.k8s.io/v1
          kind: StorageClass
          metadata:
            name: csi-cephfs
            annotations:
              storageclass.kubernetes.io/is-default-class: "true"
      when: inventory_hostname == groups['kube_master'][0]
      register: result
      until: result is succeeded
      changed_when: result is not succeeded
      retries: 60

But it is totally failed when running with v31.0.0; once rolling back to v30.1.0 problem get solved.

ISSUE TYPE

• Bug Report

COMPONENT NAME

ANSIBLE VERSION

$ ansible --version
ansible [core 2.17.5]
  config file = /home/hswong3i/Documents/alvistack/ansible-collection-kubernetes/ansible.cfg
  configured module search path = ['/home/hswong3i/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /usr/lib/python3/dist-packages/ansible
  ansible collection location = /home/hswong3i/.ansible/collections:/usr/share/ansible/collections
  executable location = /usr/bin/ansible
  python version = 3.12.7 (main, Oct  3 2024, 15:15:22) [GCC 14.2.0] (/usr/bin/python3)
  jinja version = 3.1.4
  libyaml = True

COLLECTION VERSION

$ ansible-galaxy collection list kubernetes.core

# /usr/lib/python3/dist-packages/ansible_collections
Collection      Version
--------------- -------
kubernetes.core 3.2.0  

# /usr/share/ansible/collections/ansible_collections
Collection      Version
--------------- -------
kubernetes.core 3.2.0

CONFIGURATION

$ ansible-config dump --only-changed
ANSIBLE_FORCE_COLOR(env: ANSIBLE_FORCE_COLOR) = True
ANSIBLE_NOCOWS(/home/hswong3i/Documents/alvistack/ansible-collection-kubernetes/ansible.cfg) = True
CONFIG_FILE() = /home/hswong3i/Documents/alvistack/ansible-collection-kubernetes/ansible.cfg
DEFAULT_FORKS(/home/hswong3i/Documents/alvistack/ansible-collection-kubernetes/ansible.cfg) = 20
DEFAULT_MANAGED_STR(/home/hswong3i/Documents/alvistack/ansible-collection-kubernetes/ansible.cfg) = Ansible managed: Do NOT edit this file manually!
HOST_KEY_CHECKING(/home/hswong3i/Documents/alvistack/ansible-collection-kubernetes/ansible.cfg) = False
INTERPRETER_PYTHON(/home/hswong3i/Documents/alvistack/ansible-collection-kubernetes/ansible.cfg) = auto
RETRY_FILES_ENABLED(/home/hswong3i/Documents/alvistack/ansible-collection-kubernetes/ansible.cfg) = False

OS / ENVIRONMENT

$ cat /etc/os-release 
PRETTY_NAME="Ubuntu 24.10"
NAME="Ubuntu"
VERSION_ID="24.10"
VERSION="24.10 (Oracular Oriole)"
VERSION_CODENAME=oracular
ID=ubuntu
ID_LIKE=debian
HOME_URL="https://www.ubuntu.com/"
SUPPORT_URL="https://help.ubuntu.com/"
BUG_REPORT_URL="https://bugs.launchpad.net/ubuntu/"
PRIVACY_POLICY_URL="https://www.ubuntu.com/legal/terms-and-policies/privacy-policy"
UBUNTU_CODENAME=oracular
LOGO=ubuntu-logo

STEPS TO REPRODUCE

EXPECTED RESULTS

ACTUAL RESULTS

[hswong3i]

Even if manually swap the bundled kubenetes.core from 3.2.0 to main as below (see alvistack/ansible-community-ansible-build-data@04b9ac4), it still only working with v30.1.0:

    wget -c -O /tmp/kubernetes.core-main.tar.gz https://github.com/ansible-collections/kubernetes.core/archive/refs/heads/main.tar.gz
    rm -rf ansible_collections/kubernetes/core/*
    tar zxvf /tmp/kubernetes.core-main.tar.gz --strip-components=1 -C ansible_collections/kubernetes/core/

After swapping to main:

# ansible-galaxy collection list kubernetes.core

# /usr/lib/python3/dist-packages/ansible_collections
Collection      Version
--------------- -------
kubernetes.core 5.0.0  

# /usr/share/ansible/collections/ansible_collections
Collection      Version
--------------- -------
kubernetes.core 5.0.0

[yurnov]

Hi @hswong3i,

I'd checked the changelog of kubernetes python client and didn't find anything that may break compatibility with kubernetes.core, but probably your issue is related to compatibility between the python and your cluster. So, version 31,x.y is based in Kubernetes API v.1.31, version 30.x.y for 1.30, and so on, and normally Kubernetes have compatibility for N-2 ...N...N+1 version, which means that kubernetes==31.0.0 may not support Kubernetes version lower than 1.29, and as result the kubernetes.core may work incorrectly, regardless of version of collection.

Could you please check it in your side.

My teammate tested modules k8s, k8s_info, k8s_cp, k8s_scale, k8s_exec, helm, helm_info (and probably something else, I didn't check whole code) from kubernetes.core:=3.2.0 with kuberneres==31.0.0 and that test was successful.

In case you still considering this as the bug, please provide a step to reproduce with the expected result and actual result.

BR/Yuriy

[yurnov]

Hi @hswong3i

any update from your side? I'm checking on my own and kubernetes.core:=3.2.0 is works as expected with kuberneres==31.0.0, so, it seems that this issue is not valid.

[hswong3i]

I'd checked the changelog of kubernetes python client and didn't find anything that may break compatibility with kubernetes.core, but probably your issue is related to compatibility between the python and your cluster. So, version 31,x.y is based in Kubernetes API v.1.31, version 30.x.y for 1.30, and so on, and normally Kubernetes have compatibility for N-2 ...N...N+1 version, which means that kubernetes==31.0.0 may not support Kubernetes version lower than 1.29, and as result the kubernetes.core may work incorrectly, regardless of version of collection.

I am using Kuberentes 1.31.2 + kubernetes python client 31.0.0 + kubernetes.core 3.2.0 + Ubuntu 24.04...

[yurnov]

I am using Kuberentes 1.31.2 + kubernetes python client 31.0.0 + kubernetes.core 3.2.0 + Ubuntu 24.04...

Could you please provide an error output (better with the -vvvv key) to help us understand what goes wrong? Also, provide a step to reproduce.

[hswong3i]

@yurnov I should find the main reason: v31.0.0 newly add a dependency with durationpy>=0.7 (see kubernetes-client/python#2261), which you may not find in any standard Linux distro (see https://pkgs.org/search/?q=durationpy).

I am now packaging https://build.opensuse.org/package/show/home:alvistack/icholy-durationpy-0.9 for my own OBS repo, and so most likely problem now being solved.