feat: add new tail_lines parameter to k8s_log module (#488) #489

kurokobo · 2022-07-17T19:27:37Z

SUMMARY

Add new tail_lines parameter to k8s_log module to limit the number of lines to be retrieved from the end of the logs.

Closes #488.

ISSUE TYPE

Feature Pull Request

COMPONENT NAME

kubernetes.core.k8s_log

ADDITIONAL INFORMATION

Thanks for useful collection 😃
This is the first time to send PR to this collection, so please let me know if I'm on the wrong way.

The version_added is set to 2.4.0, but I'm not aware of the roadmap for this collection, so I'd like to know this is the right version to specify.
Changelog and simple integration test is also added.
It seems that the end of log_lines always contains an empty element, so if tail_lines is set to 5, the length of log_lines will be 6, as noted in the comment in the test. I've considered that truncating the trailing empty element, but decided not to for the following reasons.
- It is inconsistent and unnatural to remove trailing empty elements only when tail_lines is specified.
- Removing trailing empty elements always with or without tail_lines is a destructive change and should not be done because it would break backward compatibility.

Example tasks in playbook:

  tasks: 
    - name: create a job that has 10 lines of log
      kubernetes.core.k8s:
        state: present
        wait: yes
        wait_timeout: "{{ k8s_wait_timeout | default(omit) }}"
        wait_condition:
          type: Complete
          status: 'True'
        definition:
          apiVersion: batch/v1
          kind: Job
          metadata:
            name: multiline-log
            namespace: test
          spec:
            template:
              spec:
                containers:
                  - name: busybox
                    image: busybox
                    command: ['sh']
                    args: ['-c', 'for i in $(seq 0 9); do echo $i; done']
                restartPolicy: Never
            backoffLimit: 4

    - name: retrieve all logs from the job
      kubernetes.core.k8s_log:
        api_version: batch/v1
        kind: Job
        namespace: test
        name: multiline-log
      register: full_log

    - name: retrieve last 5 lines of log from the job
      kubernetes.core.k8s_log:
        api_version: batch/v1
        kind: Job
        namespace: test
        name: multiline-log
        tail_lines: 5
      register: tailed_log

    - ansible.builtin.debug:
        var: full_log.log_lines

    - ansible.builtin.debug:
        var: tailed_log.log_lines

Example output:

TASK [create a job that has 10 lines of log] *****************************************************************************************
ok: [localhost]

TASK [retrieve all logs from the job] ************************************************************************************************
ok: [localhost]

TASK [retrieve last 5 lines of log from the job] *************************************************************************************
ok: [localhost]

TASK [ansible.builtin.debug] *********************************************************************************************************
ok: [localhost] => 
  full_log.log_lines:
  - '0'
  - '1'
  - '2'
  - '3'
  - '4'
  - '5'
  - '6'
  - '7'
  - '8'
  - '9'
  - ''

TASK [ansible.builtin.debug] *********************************************************************************************************
ok: [localhost] => 
  tailed_log.log_lines:
  - '5'
  - '6'
  - '7'
  - '8'
  - '9'
  - ''

PLAY RECAP ***************************************************************************************************************************
localhost                  : ok=5    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0

…ions#488)

softwarefactory-project-zuul · 2022-07-17T19:43:13Z

Build succeeded.

kurokobo · 2022-07-17T19:57:12Z

The cause of the two FAILUREs both appear to be kubernetes.core.kubectl connection plugin and appear to totally be unrelated to the changes made in my PR 🤔

abikouo · 2022-07-18T13:12:04Z

Thanks, @kurokobo for contributing to this collection.
The code and tests look good to me.

gravesm

Thanks for the PR. The failures are for known issues in development versions of ansible, so nothing to worry about.

softwarefactory-project-zuul · 2022-07-25T19:03:48Z

Build succeeded (gate pipeline).

feat: add new tail_lines parameter to k8s_log module (ansible-collect…

0a7a968

…ions#488)

abikouo approved these changes Jul 18, 2022

View reviewed changes

gravesm approved these changes Jul 25, 2022

View reviewed changes

gravesm added the mergeit label Jul 25, 2022

softwarefactory-project-zuul bot merged commit 58cbbf6 into ansible-collections:main Jul 25, 2022

kurokobo deleted the k8s_log/tail_lines branch July 26, 2022 00:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add new tail_lines parameter to k8s_log module (#488) #489

feat: add new tail_lines parameter to k8s_log module (#488) #489

kurokobo commented Jul 17, 2022

softwarefactory-project-zuul bot commented Jul 17, 2022

kurokobo commented Jul 17, 2022

abikouo commented Jul 18, 2022

gravesm left a comment

softwarefactory-project-zuul bot commented Jul 25, 2022

feat: add new tail_lines parameter to k8s_log module (#488) #489

feat: add new tail_lines parameter to k8s_log module (#488) #489

Conversation

kurokobo commented Jul 17, 2022

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

softwarefactory-project-zuul bot commented Jul 17, 2022

kurokobo commented Jul 17, 2022

abikouo commented Jul 18, 2022

gravesm left a comment

Choose a reason for hiding this comment

softwarefactory-project-zuul bot commented Jul 25, 2022