From 0608e20a0171ffe4487bcf4854fad4b87ea87b3d Mon Sep 17 00:00:00 2001 From: Chelsea Mafrica Date: Thu, 19 Oct 2023 06:40:49 -0700 Subject: [PATCH] docs: Fix broken links Update broken links so that static checks pass. Fixes #8254 Signed-off-by: Chelsea Mafrica --- docs/how-to/how-to-import-kata-logs-with-fluentd.md | 2 +- docs/threat-model/threat-model.md | 2 +- docs/use-cases/using-Intel-QAT-and-kata.md | 8 ++++---- src/runtime/virtcontainers/README.md | 8 ++++---- 4 files changed, 10 insertions(+), 10 deletions(-) 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 8db33edb51..b01e93f11d 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 @@ -115,7 +115,7 @@ Fluentd [systemd plugin](https://github.com/fluent-plugin-systemd/fluent-plugin- We modify the Fluentd config file with the following fragment. For reference, the Minikube YAML can be found -[on GitHub](https://github.com/kubernetes/minikube/blob/master/deploy/addons/efk/fluentd-es-configmap.yaml.tmpl): +[on GitHub](https://github.com/kubernetes/minikube/blob/master/deploy/addons/efk/fluentd-es-configmap.yaml): > **Note:** The below Fluentd config fragment is in the "older style" to match the Minikube version of > Fluentd. If using a more up to date version of Fluentd, you may need to update some parameters, such as diff --git a/docs/threat-model/threat-model.md b/docs/threat-model/threat-model.md index 91abb6eb0e..efa380d789 100644 --- a/docs/threat-model/threat-model.md +++ b/docs/threat-model/threat-model.md @@ -85,7 +85,7 @@ The `virtio-fs` client, running in the guest, will generate requests to access f to `mmap` it into the guest. When DAX is utilized, the guest will access the host's page cache, avoiding the need for copy and duplication. DAX is still an experimental feature, and is not enabled by default. -From the `virtiofsd` [documentation](https://qemu-project.gitlab.io/qemu/tools/virtiofsd.html): +From the `virtiofsd` [documentation](https://gitlab.com/virtio-fs/virtiofsd/-/blob/main/README.md): ```This program must be run as the root user. Upon startup the program will switch into a new file system namespace with the shared directory tree as its root. This prevents “file system escapes” due to symlinks and other file system objects that might lead to files outside the shared directory. The program also sandboxes itself using seccomp(2) to prevent ptrace(2) and other vectors that could allow an attacker to compromise the system after gaining control of the virtiofsd process.``` DAX-less support for `virtio-fs` is available as of the 5.4 Linux kernel. QEMU VMM supports virtio-fs as of v4.2. Cloud Hypervisor diff --git a/docs/use-cases/using-Intel-QAT-and-kata.md b/docs/use-cases/using-Intel-QAT-and-kata.md index e83569fbed..1173c5d233 100644 --- a/docs/use-cases/using-Intel-QAT-and-kata.md +++ b/docs/use-cases/using-Intel-QAT-and-kata.md @@ -20,7 +20,7 @@ kernel and custom Kata Containers rootfs. ## Helpful Links before starting -[Intel® QuickAssist Technology at `01.org`](https://01.org/intel-quickassist-technology) +[Intel® QuickAssist Technology at `01.org`](https://www.intel.com/content/www/us/en/developer/topic-technology/open/quick-assist-technology/overview.html) [Intel® QuickAssist Technology Engine for OpenSSL](https://github.com/intel/QAT_Engine) @@ -42,7 +42,7 @@ needed to point to updated drivers or different install locations. ### Set environment variables (Every Reboot) -Make sure to check [`01.org`](https://01.org/intel-quickassist-technology) for +Make sure to check [`01.org`](https://www.intel.com/content/www/us/en/developer/topic-technology/open/quick-assist-technology/overview.html) for the latest driver. ```bash @@ -89,7 +89,7 @@ $ sudo reboot ### Download Intel® QAT drivers -This will download the [Intel® QAT drivers](https://01.org/intel-quickassist-technology). +This will download the [Intel® QAT drivers](https://www.intel.com/content/www/us/en/developer/topic-technology/open/quick-assist-technology/overview.html). Make sure to check the website for the latest version. ```bash @@ -107,7 +107,7 @@ This section starts from a base config file and changes the `SSL` section to `SHIM` to support the OpenSSL engine. There are more tweaks that you can make depending on the use case and how many Intel® QAT engines should be run. You can find more information about how to customize in the -[Intel® QuickAssist Technology Software for Linux* - Programmer's Guide.](https://01.org/sites/default/files/downloads/336210qatswprogrammersguiderev006.pdf) +[Intel® QuickAssist Technology Software for Linux* - Programmer's Guide.](https://www.intel.com/content/www/us/en/content-details/709196/intel-quickassist-technology-api-programmer-s-guide.html) > **Note: This section assumes that a Intel® QAT `c6xx` platform is used.** diff --git a/src/runtime/virtcontainers/README.md b/src/runtime/virtcontainers/README.md index cbf8da7786..5832148da1 100644 --- a/src/runtime/virtcontainers/README.md +++ b/src/runtime/virtcontainers/README.md @@ -14,12 +14,12 @@ Ideally, VM-based container runtime implementations would become translation layers from the runtime specification they implement (e.g. the [OCI runtime-spec][oci] 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. +`virtcontainers` was used as a foundational package for the [Kata Containers][kata-containers] [runtime][kata-containers-runtime] implementation, formerly the Clear Containers runtime implementation. [oci]: https://github.com/opencontainers/runtime-spec [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/ +[kata-containers]: https://github.com/kata-containers/ +[kata-containers-runtime]: https://github.com/kata-containers/runtime/ # Out of scope @@ -232,7 +232,7 @@ is also supported in Kata. Pass-through happens separated by adapter and domain, i.e. a passable VFIO device has one or multiple adapter-domain combinations. -1. You must follow the [kernel documentation for preparing VFIO-AP passthrough](https://www.kernel.org/doc/html/latest/s390/vfio-ap.html). +1. You must follow the [kernel documentation for preparing VFIO-AP passthrough](https://www.kernel.org/doc/Documentation/s390/vfio-ap.txt). In short, your host kernel should have the following enabled or available as module (in case of modules, load the modules accordingly, e.g. through `modprobe`). If one is missing, you will have to update your kernel