From 6413ecf459f5b09bffb7cf3fba4744ec3dde4708 Mon Sep 17 00:00:00 2001 From: Jakob Naucke Date: Wed, 22 Dec 2021 17:54:55 +0100 Subject: [PATCH 1/4] docs: Backport source reorganization links #3244 moved directories that were referred to with links to `main`, which affects stable. Fixes: #3334 Signed-off-by: Jakob Naucke --- docs/tracing.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/tracing.md b/docs/tracing.md index 184bedfb4d..87dc7a738c 100644 --- a/docs/tracing.md +++ b/docs/tracing.md @@ -203,12 +203,11 @@ is highly recommended. For working with the agent, you may also wish to [enable a debug console][setup-debug-console] to allow you to access the VM environment. -[agent-ctl]: https://github.com/kata-containers/kata-containers/blob/main/tools/agent-ctl [enable-full-debug]: https://github.com/kata-containers/kata-containers/blob/main/docs/Developer-Guide.md#enable-full-debug [jaeger-all-in-one]: https://www.jaegertracing.io/docs/getting-started/ [jaeger-tracing]: https://www.jaegertracing.io [opentelemetry]: https://opentelemetry.io [osbuilder]: https://github.com/kata-containers/kata-containers/blob/main/tools/osbuilder [setup-debug-console]: https://github.com/kata-containers/kata-containers/blob/main/docs/Developer-Guide.md#set-up-a-debug-console -[trace-forwarder]: https://github.com/kata-containers/kata-containers/blob/main/src/trace-forwarder +[trace-forwarder]: /src/trace-forwarder [vsock]: https://wiki.qemu.org/Features/VirtioVsock From 77a2502a0fe572e2500900a1c6e57673f2bd956d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabiano=20Fid=C3=AAncio?= Date: Mon, 15 Nov 2021 11:14:07 +0100 Subject: [PATCH 2/4] cri-o: Update links for the CRI-O github page MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The links are either pointing to the not-used-anymore `master` branch, or to the kubernetes-incubator page. Let's always point to the CRI-O github page, using the `main`branch. Signed-off-by: Fabiano Fidêncio --- docs/how-to/run-kata-with-k8s.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/how-to/run-kata-with-k8s.md b/docs/how-to/run-kata-with-k8s.md index 98da0622fa..c563bd62d6 100644 --- a/docs/how-to/run-kata-with-k8s.md +++ b/docs/how-to/run-kata-with-k8s.md @@ -20,7 +20,7 @@ required to spawn pods and containers, and this is the preferred way to run Kata An equivalent shim implementation for CRI-O is planned. ### CRI-O -For CRI-O installation instructions, refer to the [CRI-O Tutorial](https://github.com/kubernetes-incubator/cri-o/blob/master/tutorial.md) page. +For CRI-O installation instructions, refer to the [CRI-O Tutorial](https://github.com/cri-o/cri-o/blob/main/tutorial.md) page. The following sections show how to set up the CRI-O configuration file (default path: `/etc/crio/crio.conf`) for Kata. @@ -30,7 +30,7 @@ Unless otherwise stated, all the following settings are specific to the `crio.ru # runtime used and options for how to set up and manage the OCI runtime. [crio.runtime] ``` -A comprehensive documentation of the configuration file can be found [here](https://github.com/cri-o/cri-o/blob/master/docs/crio.conf.5.md). +A comprehensive documentation of the configuration file can be found [here](https://github.com/cri-o/cri-o/blob/main/docs/crio.conf.5.md). > **Note**: After any change to this file, the CRI-O daemon have to be restarted with: >```` From 514bf74f8f9a6392a1febe0857071ab7d447810a Mon Sep 17 00:00:00 2001 From: Jakob Naucke Date: Wed, 22 Dec 2021 18:15:01 +0100 Subject: [PATCH 3/4] docs: Replicate branch rename on runtime-spec renamed branch `master` to `main` Fixes: #3336 Signed-off-by: Jakob Naucke --- docs/design/host-cgroups.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/design/host-cgroups.md b/docs/design/host-cgroups.md index cabdfe47a2..afbc93809c 100644 --- a/docs/design/host-cgroups.md +++ b/docs/design/host-cgroups.md @@ -242,8 +242,8 @@ On the other hand, running all non vCPU threads under a dedicated overhead cgrou accurate metrics on the actual Kata Container pod overhead, allowing for tuning the overhead cgroup size and constraints accordingly. -[linux-config]: https://github.com/opencontainers/runtime-spec/blob/master/config-linux.md -[cgroupspath]: https://github.com/opencontainers/runtime-spec/blob/master/config-linux.md#cgroups-path +[linux-config]: https://github.com/opencontainers/runtime-spec/blob/main/config-linux.md +[cgroupspath]: https://github.com/opencontainers/runtime-spec/blob/main/config-linux.md#cgroups-path # Supported cgroups From 24085c95538a17820d98ed903d579b3987207efb Mon Sep 17 00:00:00 2001 From: Jakob Naucke Date: Wed, 22 Dec 2021 19:40:25 +0100 Subject: [PATCH 4/4] docs: Fix outdated k8s link in virtcontainers readme Signed-off-by: Jakob Naucke --- src/runtime/virtcontainers/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/runtime/virtcontainers/README.md b/src/runtime/virtcontainers/README.md index 97f01cfb91..2ba040b121 100644 --- a/src/runtime/virtcontainers/README.md +++ b/src/runtime/virtcontainers/README.md @@ -17,7 +17,7 @@ or the [Kubernetes CRI][cri]) to the `virtcontainers` API. `virtcontainers` was used as a foundational package for the [Clear Containers][cc] [runtime][cc-runtime] implementation. [oci]: https://github.com/opencontainers/runtime-spec -[cri]: https://git.k8s.io/community/contributors/devel/sig-node/container-runtime-interface.md +[cri]: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-node/container-runtime-interface.md [cc]: https://github.com/clearcontainers/ [cc-runtime]: https://github.com/clearcontainers/runtime/