Skip to content

collect logs when ci-entrypoint.sh is used to run e2e tests #2043

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

Merged
k8s-ci-robot merged 2 commits into from
Feb 7, 2022
Merged

collect logs when ci-entrypoint.sh is used to run e2e tests #2043

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
04cba22
Wait for Windows nodes (if any) in ci-entrpoint.sh
marosset Feb 2, 2022
15704ac
Adding logic to get pod logs form windows nodes during ci-entrypoint.sh
marosset Feb 2, 2022
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
36 changes: 36 additions & 0 deletions hack/log/log-dump-daemonset-windows.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
apiVersion: apps/v1
kind: DaemonSet
metadata:
name: log-dump-node-windows
spec:
selector:
matchLabels:
app: log-dump-node-windows
template:
metadata:
labels:
app:
log-dump-node-windows
spec:
securityContext:
windowsOptions:
runAsUserName: ContainerAdministrator
containers:
- name: log-dump-node-windows
image: mcr.microsoft.com/oss/kubernetes/pause:3.6
volumeMounts:
- name: varlog
mountPath: /var/log
nodeSelector:
kubernetes.io/os: windows
tolerations:
- effect: NoExecute
operator: Exists
- effect: NoSchedule
operator: Exists
- key: CriticalAddonsOnly
operator: Exists
volumes:
- name: varlog
hostPath:
path: /var/log
53 changes: 52 additions & 1 deletion hack/log/log-dump.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,8 +127,52 @@ dump_workload_cluster_logs() {
wait
}

dump_workload_cluster_logs_windows() {
echo "Deploying log-dump-daemonset-windows"
"${KUBECTL}" apply -f "${REPO_ROOT}/hack/log/log-dump-daemonset-windows.yaml"
echo "Waiting for log-dump-daemonset-windows"
"${KUBECTL}" wait pod -l app=log-dump-node-windows --for=condition=Ready --timeout=5m
Copy link
Copy Markdown
Contributor Author

@marosset marosset Feb 3, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does anyone know if this would cause issues if there aren't any windows nodes / the DS doesn't schedule any pods?
I'm assuming not but will try and test this out...

Copy link
Copy Markdown
Contributor

@jsturtevant jsturtevant Feb 4, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it should be fine since total number of pods will be 0. Did you try it out?

Copy link
Copy Markdown
Contributor Author

@marosset marosset Feb 4, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried this out and the kubectl command returned with exitcode 1 (and error: no matches resources found).

when I ran kubectl get pod -l app=log-dump-node-windows -ojsonpath='{.items[*].metadata.name}' like on the next line that returns success and no output.

Should we let the wait command fail and exit out of the function or should I add || true there and just the for loop no-op?

Copy link
Copy Markdown
Contributor Author

@marosset marosset Feb 4, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a check to see if TEST_WINDOWS envvar was set and only call dump_workload_cluster_logs_windows if it is


IFS=" " read -ra log_dump_pods <<< "$(kubectl get pod -l app=log-dump-node-windows -ojsonpath='{.items[*].metadata.name}')"

for log_dump_pod in "${log_dump_pods[@]}"; do
local node_name
node_name="$(get_node_name "${log_dump_pod}")"
echo "Getting logs for node ${node_name}"

local log_dump_dir="${ARTIFACTS}/workload-cluster/${node_name}"
mkdir -p "${log_dump_dir}"

# make a new folder to copy logs to since files cannot be read to directly
"${KUBECTL}" exec "${log_dump_pod}" -- cmd.exe /c mkdir log
"${KUBECTL}" exec "${log_dump_pod}" -- cmd.exe /c xcopy /s c:\\var\\log\\kubelet c:\\log\\
"${KUBECTL}" exec "${log_dump_pod}" -- cmd.exe /c xcopy /s c:\\var\\log\\pods c:\\log\\

# Get a list of all of the files to copy with dir
# /s - recurse
# /B - bare format (no heading info or summaries)
# /A-D - exclude directories
IFS=" " read -ra log_dump_files <<< "$(kubectl exec "${log_dump_pod}" -- cmd.exe /c dir /s /B /A-D log | tr '\n' ' ' | tr -d '\r' )"
echo "Collecting pod logs"

for log_dump_file in "${log_dump_files[@]}"; do
echo " Getting logfile ${log_dump_file}"
# reverse slashes and remove c:\log\ from paths
fixed_dump_file_path="$(echo "${log_dump_file//\\//}" | cut -d "/" -f3-)"
dir="$(dirname "${fixed_dump_file_path}")"
file="$(basename "${fixed_dump_file_path}")"
mkdir -p "${log_dump_dir}"/"${dir}"
"${KUBECTL}" exec "${log_dump_pod}" -- cmd.exe /c type "${log_dump_file}" > "${log_dump_dir}"/"${dir}"/"${file}"
done

echo "Exported logs for node \"${node_name}\""
done

}

cleanup() {
"${KUBECTL}" delete -f "${REPO_ROOT}/hack/log/log-dump-daemonset.yaml" || true
"${KUBECTL}" delete -f "${REPO_ROOT}/hack/log/log-dump-daemonset-windows.yaml" || true
# shellcheck source=hack/log/redact.sh
source "${REPO_ROOT}/hack/log/redact.sh"
}
Expand All @@ -138,5 +182,12 @@ trap cleanup EXIT
echo "================ DUMPING LOGS FOR MANAGEMENT CLUSTER ================"
dump_mgmt_cluster_logs

echo "================ DUMPING LOGS FOR WORKLOAD CLUSTER ================"
echo "================ DUMPING LOGS FOR WORKLOAD CLUSTER (Linux) =========="
dump_workload_cluster_logs

if [[ -z "${TEST_WINDOWS}" ]]; then
echo "TEST_WINDOWS envvar not set, skipping log collection for Windows nodes."
else
echo "================ DUMPING LOGS FOR WORKLOAD CLUSTER (Windows) ========"
dump_workload_cluster_logs_windows
fi
4 changes: 2 additions & 2 deletions scripts/ci-entrypoint.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,10 +112,10 @@ create_cluster() {
}

wait_for_nodes() {
echo "Waiting for ${CONTROL_PLANE_MACHINE_COUNT} control plane machine(s) and ${WORKER_MACHINE_COUNT} worker machine(s) to become Ready"
echo "Waiting for ${CONTROL_PLANE_MACHINE_COUNT} control plane machine(s), ${WORKER_MACHINE_COUNT} worker machine(s), and ${WINDOWS_WORKER_MACHINE_COUNT} windows machine(s) to become Ready"

# Ensure that all nodes are registered with the API server before checking for readiness
local total_nodes="$((CONTROL_PLANE_MACHINE_COUNT + WORKER_MACHINE_COUNT))"
local total_nodes="$((CONTROL_PLANE_MACHINE_COUNT + WORKER_MACHINE_COUNT + WINDOWS_WORKER_MACHINE_COUNT))"
while [[ $("${KUBECTL}" get nodes -ojson | jq '.items | length') -ne "${total_nodes}" ]]; do
sleep 10
done
Expand Down