github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-07-21 10:51:05 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #6330 from c3d/issue/6329-contribution-link-in-devguide

Browse Source 
devguide: Add link to the contribution guidelines
This commit is contained in:
GabyCT 2023-02-21 09:17:20 -06:00 committed by GitHub
commit fc5c62a5a1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/Developer-Guide.md
View File

@ -2,6 +2,8 @@
This document is written **specifically for developers**: it is not intended for end users. This document is written **specifically for developers**: it is not intended for end users.
If you want to contribute changes that you have made, please read the [community guidelines](https://github.com/kata-containers/community/blob/main/CONTRIBUTING.md) for information about our processes.
# Assumptions # Assumptions
- You are working on a non-critical test or development system. - You are working on a non-critical test or development system.
@ -654,7 +656,7 @@ section when using rootfs, or when using initrd, complete the steps in the [Buil
Install the image: Install the image:
>**Note**: When using an initrd image, replace the below rootfs image name `kata-containers.img` >**Note**: When using an initrd image, replace the below rootfs image name `kata-containers.img`
>with the initrd image name `kata-containers-initrd.img`. >with the initrd image name `kata-containers-initrd.img`.
```bash ```bash
@ -688,25 +690,25 @@ $ sudo crictl run -r kata container.yaml pod.yaml
The steps required to enable debug console for QEMU slightly differ with The steps required to enable debug console for QEMU slightly differ with
those for firecracker / cloud-hypervisor. those for firecracker / cloud-hypervisor.
##### Enabling debug console for QEMU ##### Enabling debug console for QEMU
Add `agent.debug_console` to the guest kernel command line to allow the agent process to start a debug console. Add `agent.debug_console` to the guest kernel command line to allow the agent process to start a debug console.
```bash ```bash
$ sudo sed -i -e 's/^kernel_params = "\(.*\)"/kernel_params = "\1 agent.debug_console"/g' "${kata_configuration_file}" $ sudo sed -i -e 's/^kernel_params = "\(.*\)"/kernel_params = "\1 agent.debug_console"/g' "${kata_configuration_file}"
``` ```
Here `kata_configuration_file` could point to `/etc/kata-containers/configuration.toml` Here `kata_configuration_file` could point to `/etc/kata-containers/configuration.toml`
or `/usr/share/defaults/kata-containers/configuration.toml` or `/usr/share/defaults/kata-containers/configuration.toml`
or `/opt/kata/share/defaults/kata-containers/configuration-{hypervisor}.toml`, if or `/opt/kata/share/defaults/kata-containers/configuration-{hypervisor}.toml`, if
you installed Kata Containers using `kata-deploy`. you installed Kata Containers using `kata-deploy`.
##### Enabling debug console for cloud-hypervisor / firecracker ##### Enabling debug console for cloud-hypervisor / firecracker
Slightly different configuration is required in case of firecracker and cloud hypervisor. Slightly different configuration is required in case of firecracker and cloud hypervisor.
Firecracker and cloud-hypervisor don't have a UNIX socket connected to `/dev/console`. Firecracker and cloud-hypervisor don't have a UNIX socket connected to `/dev/console`.
Hence, the kernel command line option `agent.debug_console` will not work for them. Hence, the kernel command line option `agent.debug_console` will not work for them.
These hypervisors support `hybrid vsocks`, which can be used for communication These hypervisors support `hybrid vsocks`, which can be used for communication
between the host and the guest. The kernel command line option `agent.debug_console_vport` between the host and the guest. The kernel command line option `agent.debug_console_vport`
was added to allow developers specify on which `vsock` port the debugging console should be connected. was added to allow developers specify on which `vsock` port the debugging console should be connected.
@ -719,7 +721,7 @@ sudo sed -i -e 's/^kernel_params = "\(.*\)"/kernel_params = "\1 agent.debug_cons
``` ```
> **Note** Ports 1024 and 1025 are reserved for communication with the agent > **Note** Ports 1024 and 1025 are reserved for communication with the agent
> and gathering of agent logs respectively. > and gathering of agent logs respectively.
##### Connecting to the debug console ##### Connecting to the debug console