From a305bafeefe3d1f2ce720b99be9f57cc0067d8fe Mon Sep 17 00:00:00 2001 From: Binbin Zhang Date: Wed, 15 Jun 2022 15:50:56 +0800 Subject: [PATCH] docs: Update outdated URLs and keep them available By comparing the content of the old url and the new url, ensure that their content is consistent and does not contain ambiguities Fixes: #4454 Signed-off-by: Binbin Zhang --- docs/Unit-Test-Advice.md | 2 +- docs/code-pr-advice.md | 2 +- docs/design/architecture/kubernetes.md | 2 +- docs/how-to/how-to-import-kata-logs-with-fluentd.md | 4 ++-- src/runtime/README.md | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/Unit-Test-Advice.md b/docs/Unit-Test-Advice.md index ac099a4009..ea6caa031c 100644 --- a/docs/Unit-Test-Advice.md +++ b/docs/Unit-Test-Advice.md @@ -320,7 +320,7 @@ mod tests { ## Test user -[Unit tests are run *twice*](https://github.com/kata-containers/tests/blob/main/.ci/go-test.sh): +[Unit tests are run *twice*](../src/runtime/go-test.sh): - as the current user - as the `root` user (if different to the current user) diff --git a/docs/code-pr-advice.md b/docs/code-pr-advice.md index 57aac6f8c4..751186d6c3 100644 --- a/docs/code-pr-advice.md +++ b/docs/code-pr-advice.md @@ -79,7 +79,7 @@ a "`BUG: feature X not implemented see {bug-url}`" type error. - Don't use multiple log calls when a single log call could be used. - Use structured logging where possible to allow - [standard tooling](https://github.com/kata-containers/tests/tree/main/cmd/log-parser) + [standard tooling](../src/tools/log-parser) be able to extract the log fields. ### Names diff --git a/docs/design/architecture/kubernetes.md b/docs/design/architecture/kubernetes.md index be7377b39f..be8165d75f 100644 --- a/docs/design/architecture/kubernetes.md +++ b/docs/design/architecture/kubernetes.md @@ -17,7 +17,7 @@ Kubelet instance is responsible for managing the lifecycle of pods within the nodes and eventually relies on a container runtime to handle execution. The Kubelet architecture decouples lifecycle management from container execution through a dedicated gRPC based -[Container Runtime Interface (CRI)](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/node/container-runtime-interface-v1.md). +[Container Runtime Interface (CRI)](https://github.com/kubernetes/design-proposals-archive/blob/main/node/container-runtime-interface-v1.md). In other words, a Kubelet is a CRI client and expects a CRI implementation to handle the server side of the interface. diff --git a/docs/how-to/how-to-import-kata-logs-with-fluentd.md b/docs/how-to/how-to-import-kata-logs-with-fluentd.md index 279a69aa68..8db33edb51 100644 --- a/docs/how-to/how-to-import-kata-logs-with-fluentd.md +++ b/docs/how-to/how-to-import-kata-logs-with-fluentd.md @@ -68,7 +68,7 @@ the Kata logs import to the EFK stack. > stack they are able to utilise in order to modify and test as necessary. Minikube by default -[configures](https://github.com/kubernetes/minikube/blob/master/deploy/iso/minikube-iso/board/coreos/minikube/rootfs-overlay/etc/systemd/journald.conf) +[configures](https://github.com/kubernetes/minikube/blob/master/deploy/iso/minikube-iso/board/minikube/x86_64/rootfs-overlay/etc/systemd/journald.conf) the `systemd-journald` with the [`Storage=volatile`](https://www.freedesktop.org/software/systemd/man/journald.conf.html) option, which results in the journal being stored in `/run/log/journal`. Unfortunately, the Minikube EFK @@ -163,7 +163,7 @@ sub-filter on, for instance, the `SYSLOG_IDENTIFIER` to differentiate the Kata c on the `PRIORITY` to filter out critical issues etc. Kata generates a significant amount of Kata specific information, which can be seen as -[`logfmt`](https://github.com/kata-containers/tests/tree/main/cmd/log-parser#logfile-requirements). +[`logfmt`](../../src/tools/log-parser/README.md#logfile-requirements). data contained in the `MESSAGE` field. Imported as-is, there is no easy way to filter on that data in Kibana: diff --git a/src/runtime/README.md b/src/runtime/README.md index 75febbe9df..d6738f66fb 100644 --- a/src/runtime/README.md +++ b/src/runtime/README.md @@ -125,7 +125,7 @@ $ kata-runtime env For detailed information and analysis on obtaining logs for other system components, see the documentation for the -[`kata-log-parser`](https://github.com/kata-containers/tests/tree/main/cmd/log-parser) +[`kata-log-parser`](../tools/log-parser) tool. ### Kata containerd shimv2