github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-06-27 15:57:09 +00:00
Code Issues Projects Releases Wiki Activity

virtcontainers: fix outdated example code in api document

Browse Source 
Some type declarations were changed. The example code here is outdated
according to the example_pod_run_test.go under virtcontainers directory.
And add the imports to make where the types from clear.

Fixes: #507

Signed-off-by: Li Ning <lining_yewu@cmss.chinamobile.com>
This commit is contained in:
Li Ning 2020-08-12 17:21:53 +08:00
parent 50c76b696f
commit 2511cabbc3
1 changed files with 16 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
src/runtime/virtcontainers/documentation/api/1.0/api.md
View File

@ -819,17 +819,28 @@ func ProcessListContainer(sandboxID, containerID string, options ProcessListOpti
```Go ```Go
import (
"context"
"fmt"
"strings"
vc "github.com/kata-containers/kata-containers/src/runtime/virtcontainers"
"github.com/kata-containers/kata-containers/src/runtime/virtcontainers/types"
)
var containerRootfs = vc.RootFs{Target: "/var/lib/container/bundle/", Mounted: true}
// This example creates and starts a single container sandbox, // This example creates and starts a single container sandbox,
// using qemu as the hypervisor and kata as the VM agent. // using qemu as the hypervisor and kata as the VM agent.
func Example_createAndStartSandbox() { func Example_createAndStartSandbox() {
envs := []vc.EnvVar{ envs := []types.EnvVar{
{ {
Var: "PATH", Var: "PATH",
Value: "/bin:/usr/bin:/sbin:/usr/sbin", Value: "/bin:/usr/bin:/sbin:/usr/sbin",
}, },
} }
cmd := vc.Cmd{ cmd := types.Cmd{
Args: strings.Split("/bin/sh", " "), Args: strings.Split("/bin/sh", " "),
Envs: envs, Envs: envs,
WorkDir: "/", WorkDir: "/",
@ -844,27 +855,20 @@ func Example_createAndStartSandbox() {
// Sets the hypervisor configuration. // Sets the hypervisor configuration.
hypervisorConfig := vc.HypervisorConfig{ hypervisorConfig := vc.HypervisorConfig{
KernelPath: "/usr/share/clear-containers/vmlinux.container", KernelPath: "/usr/share/kata-containers/vmlinux.container",
ImagePath: "/usr/share/clear-containers/clear-containers.img", ImagePath: "/usr/share/kata-containers/clear-containers.img",
HypervisorPath: "/usr/bin/qemu-system-x86_64", HypervisorPath: "/usr/bin/qemu-system-x86_64",
MemorySize: 1024,
} }
// Use kata default values for the agent. // Use kata default values for the agent.
agConfig := vc.KataAgentConfig{} agConfig := vc.KataAgentConfig{}
// VM resources
vmConfig := vc.Resources{
VCPUs: 4,
Memory: 1024,
}
// The sandbox configuration: // The sandbox configuration:
// - One container // - One container
// - Hypervisor is QEMU // - Hypervisor is QEMU
// - Agent is kata // - Agent is kata
sandboxConfig := vc.SandboxConfig{ sandboxConfig := vc.SandboxConfig{
VMConfig: vmConfig,
HypervisorType: vc.QemuHypervisor, HypervisorType: vc.QemuHypervisor,
HypervisorConfig: hypervisorConfig, HypervisorConfig: hypervisorConfig,