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.

Sign up for GitHub

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

Ignore hotplug socket when collecting logs (SC-345) #985

Merged
merged 2 commits into from
Aug 19, 2021
Merged

Ignore hotplug socket when collecting logs (SC-345) #985

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3a3fe57
Ignore hotplug socket when collecting logs
TheRealFalcon Aug 17, 2021
d086c28
Merge branch 'main' into fix-collect-logs
blackboxsw Aug 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 16 additions & 8 deletions cloudinit/cmd/devel/logs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,15 @@ def get_parser(parser=None):
return parser


def _copytree_ignore_sensitive_files(curdir, files):
"""Return a list of files to ignore if we are non-root"""
if os.getuid() == 0:
return ()
return (INSTANCE_JSON_SENSITIVE_FILE,) # Ignore root-permissioned files
def _copytree_rundir_ignore_files(curdir, files):
"""Return a list of files to ignore for /run/cloud-init directory"""
ignored_files = [
'hook-hotplug-cmd', # named pipe for hotplug
]
if os.getuid() != 0:
# Ignore root-permissioned files
ignored_files.append(INSTANCE_JSON_SENSITIVE_FILE)
return ignored_files


def _write_command_output_to_file(cmd, filename, msg, verbosity):
Expand Down Expand Up @@ -123,9 +127,13 @@ def collect_logs(tarfile, include_userdata, verbosity=0):
run_dir = os.path.join(log_dir, 'run')
ensure_dir(run_dir)
if os.path.exists(CLOUDINIT_RUN_DIR):
shutil.copytree(CLOUDINIT_RUN_DIR,
os.path.join(run_dir, 'cloud-init'),
ignore=_copytree_ignore_sensitive_files)
try:
shutil.copytree(CLOUDINIT_RUN_DIR,
os.path.join(run_dir, 'cloud-init'),
ignore=_copytree_rundir_ignore_files)
except shutil.Error as e:
sys.stderr.write("Failed collecting file(s) due to error:\n")
sys.stderr.write(str(e) + '\n')
_debug("collected dir %s\n" % CLOUDINIT_RUN_DIR, 1, verbosity)
else:
_debug("directory '%s' did not exist\n" % CLOUDINIT_RUN_DIR, 1,
Expand Down