mirror of
https://github.com/ansible-collections/kubernetes.core.git
synced 2026-11-21 22:50:20 +00:00
k8s_cp - wait for remote tar to finish before closing the stream (#1217)
* fix(k8s_cp): wait for remote tar to finish before closing the stream The module closed the exec connection right after writing the last chunk, killing tar mid-extract, and never checked its exit status, so a partial or failed copy was reported as success (#776). The v4 exec protocol cannot half-close stdin, and busybox tar blocks for EOF rather than stopping at the end-of-archive marker, so bound the stream with `head -c N | tar ...`. tar then gets a clean EOF, exits on its own, and its status is read from the error channel. Containers without /bin/sh and head keep the previous behaviour and get a warning. Also add copy_timeout (default 300s, #621) and stream the archive from the temp file instead of buffering every chunk in memory. * test(k8s_cp): split combined assert into separate statements Addresses review feedback on #1217. * chore(changelog): link the PR and use single-line fragment entries * fix(linter): reformat with black * fix(linter): sort imports in test_copy.py isort --profile black puts ansible_collections in the same third-party section as pytest, so the blank line between them is a failure. * fix(k8s_cp): report what tar said when the copy fails early An early close or a stall is the symptom; tar has usually already written the cause (a read-only mount, a missing directory) to stderr, and drain() has it. Discarding it left only the generic truncation or timeout message. * refactor(k8s_cp): move the stderr suffix into _fail The nested fail() helper added a branch inside a closure, which counts double for nesting and took _stream_tar_to_pod over Sonar's cognitive complexity limit (14 -> 16). _fail already had the response; give it the stderr too. * test(k8s_cp): tempfile for the repeated-copy test directory Co-authored-by: Bikouo Aubin <79859644+abikouo@users.noreply.github.com> --------- Co-authored-by: Bikouo Aubin <79859644+abikouo@users.noreply.github.com>
This commit is contained in:
co-authored by
Bikouo Aubin
parent
031bc475fa
commit
8a9dd54fe7
@@ -76,9 +76,21 @@ options:
|
||||
- This option is ignored when I(content) is set or when I(state) is set to C(from_pod).
|
||||
type: bool
|
||||
default: False
|
||||
copy_timeout:
|
||||
description:
|
||||
- Maximum time in seconds to spend streaming the archive to the pod and waiting for the remote
|
||||
C(tar) process to finish extracting it.
|
||||
- Raise this when copying large files over a slow connection.
|
||||
- This option is ignored when I(state) is set to C(from_pod).
|
||||
type: int
|
||||
default: 300
|
||||
version_added: 6.6.0
|
||||
|
||||
notes:
|
||||
- the tar binary is required on the container when copying from local filesystem to pod.
|
||||
- a POSIX shell at C(/bin/sh) and C(head) are also used, when present, to bound the archive
|
||||
sent to the container so that the module can confirm the copy finished. Without them the
|
||||
copy still runs but completion cannot be verified, and a warning is emitted.
|
||||
- the (init) container has to be started before you copy files or directories to it.
|
||||
"""
|
||||
|
||||
@@ -180,6 +192,7 @@ def argspec():
|
||||
"choices": ["to_pod", "from_pod"],
|
||||
}
|
||||
argument_spec["no_preserve"] = {"type": "bool", "default": False}
|
||||
argument_spec["copy_timeout"] = {"type": "int", "default": 300}
|
||||
return argument_spec
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user