diff --git a/docs/Release-Process.md b/docs/Release-Process.md index 3fc2f324a2..9dfc37041a 100644 --- a/docs/Release-Process.md +++ b/docs/Release-Process.md @@ -65,7 +65,7 @@ ### Check Git-hub Actions - We make use of [GitHub actions](https://github.com/features/actions) in this [file](https://github.com/kata-containers/kata-containers/blob/main/.github/workflows/release.yaml) in the `kata-containers/kata-containers` repository to build and upload release artifacts. This action is auto triggered with the above step when a new tag is pushed to the `kata-containers/kata-containers` repository. + We make use of [GitHub actions](https://github.com/features/actions) in this [file](../.github/workflows/release.yaml) in the `kata-containers/kata-containers` repository to build and upload release artifacts. This action is auto triggered with the above step when a new tag is pushed to the `kata-containers/kata-containers` repository. Check the [actions status page](https://github.com/kata-containers/kata-containers/actions) to verify all steps in the actions workflow have completed successfully. On success, a static tarball containing Kata release artifacts will be uploaded to the [Release page](https://github.com/kata-containers/kata-containers/releases). diff --git a/docs/Unit-Test-Advice.md b/docs/Unit-Test-Advice.md index 8cbf3163f6..8b02bcc8f3 100644 --- a/docs/Unit-Test-Advice.md +++ b/docs/Unit-Test-Advice.md @@ -337,7 +337,7 @@ will run if the correct type of user is detected and skipped if not. The main repository has the most comprehensive set of skip abilities. See: -- https://github.com/kata-containers/kata-containers/tree/main/src/runtime/pkg/katatestutils +- [`katatestutils`](../src/runtime/pkg/katatestutils) ### Run Rust tests as a different user diff --git a/docs/code-pr-advice.md b/docs/code-pr-advice.md index 1b5aac0687..57aac6f8c4 100644 --- a/docs/code-pr-advice.md +++ b/docs/code-pr-advice.md @@ -154,7 +154,7 @@ func testFoo() error { ### Tracing Consider if the code needs to create a new -[trace span](https://github.com/kata-containers/kata-containers/blob/main/docs/tracing.md). +[trace span](./tracing.md). Ensure any new trace spans added to the code are completed. 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 af595e8532..279a69aa68 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 @@ -257,7 +257,7 @@ go directly to a full Kata specific JSON format logfile test. Kata runtime has the ability to generate JSON logs directly, rather than its default `logfmt` format. Passing the `--log-format=json` argument to the Kata runtime enables this. The easiest way to pass in this extra -parameter from a [Kata deploy](https://github.com/kata-containers/kata-containers/tree/main/tools/packaging/kata-deploy) installation +parameter from a [Kata deploy](../../tools/packaging/kata-deploy) installation is to edit the `/opt/kata/bin/kata-qemu` shell script. At the same time, we will add the `--log=/var/log/kata-runtime.log` argument to store the Kata logs in their diff --git a/docs/how-to/how-to-run-docker-with-kata.md b/docs/how-to/how-to-run-docker-with-kata.md index d01c6f9214..3f5e114713 100644 --- a/docs/how-to/how-to-run-docker-with-kata.md +++ b/docs/how-to/how-to-run-docker-with-kata.md @@ -22,7 +22,7 @@ You can learn more about about Docker-in-Docker at the following links: - [`docker` image Docker Hub page](https://hub.docker.com/_/docker/) (this page lists the `-dind` releases) While normally DinD refers to running `docker` from inside a Docker container, -Kata Containers 2.x allows only supported runtimes (such as [`containerd`](../install/container-manager/containerd/containerd-install.md)). +Kata Containers 2.x allows only [supported runtimes][kata-2.x-supported-runtimes] (such as [`containerd`](../install/container-manager/containerd/containerd-install.md)). Running `docker` in a Kata Container implies creating Docker containers from inside a container managed by `containerd` (or another supported container manager), as illustrated below: @@ -37,7 +37,7 @@ container manager -> Kata Containers shim -> Docker Daemon -> Docker contain [OverlayFS]: https://www.kernel.org/doc/html/latest/filesystems/overlayfs.html [v2.0.0]: https://github.com/kata-containers/kata-containers/releases/tag/2.0.0 -[kata-2.x-supported-runtimes]: https://github.com/kata-containers/kata-containers/blob/5737b36a3513f4da11a9dc7301b0c97ea22a51cf/docs/install/container-manager/containerd/containerd-install.md +[kata-2.x-supported-runtimes]: ../install/container-manager/containerd/containerd-install.md ## Why Docker in Kata Containers 2.x requires special measures diff --git a/docs/how-to/how-to-use-virtio-fs-with-kata.md b/docs/how-to/how-to-use-virtio-fs-with-kata.md index 732b315c2a..4337b37439 100644 --- a/docs/how-to/how-to-use-virtio-fs-with-kata.md +++ b/docs/how-to/how-to-use-virtio-fs-with-kata.md @@ -6,4 +6,4 @@ Container deployments utilize explicit or implicit file sharing between host fil As of the 2.0 release of Kata Containers, [virtio-fs](https://virtio-fs.gitlab.io/) is the default filesystem sharing mechanism. -virtio-fs support works out of the box for `cloud-hypervisor` and `qemu`, when Kata Containers is deployed using `kata-deploy`. Learn more about `kata-deploy` and how to use `kata-deploy` in Kubernetes [here](https://github.com/kata-containers/kata-containers/tree/main/tools/packaging/kata-deploy#kubernetes-quick-start). +virtio-fs support works out of the box for `cloud-hypervisor` and `qemu`, when Kata Containers is deployed using `kata-deploy`. Learn more about `kata-deploy` and how to use `kata-deploy` in Kubernetes [here](../../tools/packaging/kata-deploy/README.md#kubernetes-quick-start). diff --git a/docs/install/minikube-installation-guide.md b/docs/install/minikube-installation-guide.md index 9695cde605..7bc80b4b81 100644 --- a/docs/install/minikube-installation-guide.md +++ b/docs/install/minikube-installation-guide.md @@ -6,7 +6,7 @@ cluster locally. It creates a single node Kubernetes stack in a local VM. [Kata Containers](https://github.com/kata-containers) can be installed into a Minikube cluster using -[`kata-deploy`](https://github.com/kata-containers/kata-containers/tree/main/tools/packaging/kata-deploy). +[`kata-deploy`](../../tools/packaging/kata-deploy). This document details the pre-requisites, installation steps, and how to check the installation has been successful. @@ -123,7 +123,7 @@ $ kubectl apply -f kata-deploy/base/kata-deploy.yaml This installs the Kata Containers components into `/opt/kata` inside the Minikube node. It can take a few minutes for the operation to complete. You can check the installation has worked by checking the status of the `kata-deploy` pod, which will be executing -[this script](https://github.com/kata-containers/kata-containers/tree/main/tools/packaging/kata-deploy/scripts/kata-deploy.sh), +[this script](../../tools/packaging/kata-deploy/scripts/kata-deploy.sh), and will be executing a `sleep infinity` once it has successfully completed its work. You can accomplish this by running the following: diff --git a/docs/install/snap-installation-guide.md b/docs/install/snap-installation-guide.md index 6e384289f9..0f22c22115 100644 --- a/docs/install/snap-installation-guide.md +++ b/docs/install/snap-installation-guide.md @@ -39,8 +39,8 @@ can be used as runtime. Read the following documents to know how to run Kata Containers 2.x with `containerd`. -* [How to use Kata Containers and Containerd](https://github.com/kata-containers/kata-containers/blob/main/docs/how-to/containerd-kata.md) -* [Install Kata Containers with containerd](https://github.com/kata-containers/kata-containers/blob/main/docs/install/container-manager/containerd/containerd-install.md) +* [How to use Kata Containers and Containerd](../how-to/containerd-kata.md) +* [Install Kata Containers with containerd](./container-manager/containerd/containerd-install.md) ## Remove Kata Containers snap package diff --git a/docs/tracing.md b/docs/tracing.md index 5ddbf0fcb1..7de551f1ff 100644 --- a/docs/tracing.md +++ b/docs/tracing.md @@ -203,11 +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. -[enable-full-debug]: https://github.com/kata-containers/kata-containers/blob/main/docs/Developer-Guide.md#enable-full-debug +[enable-full-debug]: ./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 +[osbuilder]: ../tools/osbuilder +[setup-debug-console]: ./Developer-Guide.md#set-up-a-debug-console [trace-forwarder]: /src/tools/trace-forwarder [vsock]: https://wiki.qemu.org/Features/VirtioVsock diff --git a/docs/use-cases/using-Intel-QAT-and-kata.md b/docs/use-cases/using-Intel-QAT-and-kata.md index 528e9ea7f0..3a7e6cf689 100644 --- a/docs/use-cases/using-Intel-QAT-and-kata.md +++ b/docs/use-cases/using-Intel-QAT-and-kata.md @@ -231,7 +231,7 @@ $ cp ${GOPATH}/${LINUX_VER}/vmlinux ${KATA_KERNEL_LOCATION}/${KATA_KERNEL_NAME} These instructions build upon the OS builder instructions located in the [Developer Guide](../Developer-Guide.md). At this point it is recommended that [Docker](https://docs.docker.com/engine/install/ubuntu/) is installed first, and -then [Kata-deploy](https://github.com/kata-containers/kata-containers/tree/main/tools/packaging/kata-deploy) +then [Kata-deploy](../../tools/packaging/kata-deploy) is use to install Kata. This will make sure that the correct `agent` version is installed into the rootfs in the steps below. @@ -419,11 +419,11 @@ You might need to disable Docker before initializing Kubernetes. Be aware that the OpenSSL container image built above will need to be exported from Docker and imported into containerd. -If Kata is installed through [`kata-deploy`](https://github.com/kata-containers/kata-containers/blob/stable-2.0/tools/packaging/kata-deploy/README.md) +If Kata is installed through [`kata-deploy`](../../tools/packaging/kata-deploy/README.md) there will be multiple `configuration.toml` files associated with different hypervisors. Rather than add in the custom Kata kernel, Kata rootfs, and kernel modules to each `configuration.toml` as the default, instead use -[annotations](https://github.com/kata-containers/kata-containers/blob/stable-2.0/docs/how-to/how-to-load-kernel-modules-with-kata.md) +[annotations](../how-to/how-to-load-kernel-modules-with-kata.md) in the Kubernetes YAML file to tell Kata which kernel and rootfs to use. The easy way to do this is to use `kata-deploy` which will install the Kata binaries to `/opt` and properly configure the `/etc/containerd/config.toml` with annotation diff --git a/docs/use-cases/using-Intel-SGX-and-kata.md b/docs/use-cases/using-Intel-SGX-and-kata.md index d48cf62c60..5427331ed9 100644 --- a/docs/use-cases/using-Intel-SGX-and-kata.md +++ b/docs/use-cases/using-Intel-SGX-and-kata.md @@ -17,7 +17,7 @@ CONFIG_X86_SGX_KVM=y ``` * Kubernetes cluster configured with: - * [`kata-deploy`](https://github.com/kata-containers/kata-containers/tree/main/tools/packaging/kata-deploy) based Kata Containers installation + * [`kata-deploy`](../../tools/packaging/kata-deploy) based Kata Containers installation * [Intel SGX Kubernetes device plugin](https://github.com/intel/intel-device-plugins-for-kubernetes/tree/main/cmd/sgx_plugin#deploying-with-pre-built-images) > Note: Kata Containers supports creating VM sandboxes with IntelĀ® SGX enabled diff --git a/src/runtime/README.md b/src/runtime/README.md index c7de965445..217cd2d443 100644 --- a/src/runtime/README.md +++ b/src/runtime/README.md @@ -26,7 +26,7 @@ to work seamlessly with both Docker and Kubernetes respectively. ## License The code is licensed under an Apache 2.0 license. -See [the license file](https://github.com/kata-containers/kata-containers/blob/main/LICENSE) for further details. +See [the license file](../../LICENSE) for further details. ## Platform support @@ -60,7 +60,7 @@ $ kata-runtime check [![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-black.svg)](https://snapcraft.io/kata-containers) -See the [installation guides](https://github.com/kata-containers/kata-containers/blob/main/docs/install/README.md) +See the [installation guides](../../docs/install/README.md) available for various operating systems. ## Quick start for developers diff --git a/tools/osbuilder/rootfs-builder/README.md b/tools/osbuilder/rootfs-builder/README.md index 71c92792ce..f82a569ef4 100644 --- a/tools/osbuilder/rootfs-builder/README.md +++ b/tools/osbuilder/rootfs-builder/README.md @@ -33,7 +33,7 @@ $ ./rootfs.sh -r "$PWD/kata-overlay" The rootfs must provide at least the following components: -- [Kata agent](https://github.com/kata-containers/kata-containers/tree/main/src/agent) +- [Kata agent](../../../src/agent) Path: `/bin/kata-agent` - Kata Containers guest.