1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
|
/*
Copyright The containerd Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package commands
import (
"bytes"
gocontext "context"
"encoding/csv"
"encoding/json"
"fmt"
"os"
"path/filepath"
"runtime"
"strings"
"github.com/containerd/containerd"
"github.com/containerd/containerd/containers"
"github.com/containerd/containerd/content"
"github.com/containerd/containerd/contrib/nvidia"
"github.com/containerd/containerd/images"
"github.com/containerd/containerd/oci"
"github.com/containerd/containerd/pkg/netns"
gocni "github.com/containerd/go-cni"
"github.com/hashicorp/go-multierror"
imagespec "github.com/opencontainers/image-spec/specs-go/v1"
runtimespec "github.com/opencontainers/runtime-spec/specs-go"
"github.com/rs/xid"
"github.com/sirupsen/logrus"
"github.com/urfave/cli"
)
const netnsMountDir = "/var/run/netns"
var samplerFlags = []cli.Flag{
cli.BoolFlag{
Name: "terminal,t",
Usage: "enable terminal for sample container. must be specified with i option",
},
cli.BoolFlag{
Name: "i",
Usage: "attach stdin to the container",
},
cli.IntFlag{
Name: "period",
Usage: "time period to monitor access log",
Value: defaultPeriod,
},
cli.StringFlag{
Name: "user",
Usage: "user/group name to override image's default config(user[:group])",
},
cli.StringFlag{
Name: "cwd",
Usage: "working dir to override image's default config",
},
cli.StringFlag{
Name: "args",
Usage: "command arguments to override image's default config(in JSON array)",
},
cli.StringFlag{
Name: "entrypoint",
Usage: "entrypoint to override image's default config(in JSON array)",
},
cli.StringSliceFlag{
Name: "env",
Usage: "environment valulable to add or override to the image's default config",
},
cli.StringFlag{
Name: "env-file",
Usage: "specify additional container environment variables in a file(i.e. FOO=bar, one per line)",
},
cli.StringSliceFlag{
Name: "mount",
Usage: "additional mounts for the container (e.g. type=foo,source=/path,destination=/target,options=bind)",
},
cli.StringFlag{
Name: "dns-nameservers",
Usage: "comma-separated nameservers added to the container's /etc/resolv.conf",
Value: "8.8.8.8",
},
cli.StringFlag{
Name: "dns-search-domains",
Usage: "comma-separated search domains added to the container's /etc/resolv.conf",
},
cli.StringFlag{
Name: "dns-options",
Usage: "comma-separated options added to the container's /etc/resolv.conf",
},
cli.StringFlag{
Name: "add-hosts",
Usage: "comma-separated hosts configuration (host:IP) added to container's /etc/hosts",
},
cli.BoolFlag{
Name: "cni",
Usage: "enable CNI-based networking",
},
cli.StringFlag{
Name: "cni-plugin-conf-dir",
Usage: "path to the CNI plugins configuration directory",
},
cli.StringFlag{
Name: "cni-plugin-dir",
Usage: "path to the CNI plugins binary directory",
},
cli.IntSliceFlag{
Name: "gpus",
Usage: "add gpus to the container",
},
cli.BoolFlag{
Name: "net-host",
Usage: "enable host networking in the container",
},
}
func getSpecOpts(clicontext *cli.Context) func(image containerd.Image, rootfs string) (opts []oci.SpecOpts, done func() error, rErr error) {
return func(image containerd.Image, rootfs string) (opts []oci.SpecOpts, done func() error, rErr error) {
var cleanups []func() error
done = func() (allErr error) {
for i := len(cleanups) - 1; i >= 0; i-- {
if err := cleanups[i](); err != nil {
allErr = multierror.Append(allErr, err)
}
}
return
}
defer func() {
if rErr != nil {
if err := done(); err != nil {
rErr = fmt.Errorf("failed to cleanup: %w", rErr)
}
}
}()
entrypointOpt, err := withEntrypointArgs(clicontext, image)
if err != nil {
rErr = fmt.Errorf("failed to parse entrypoint and arg flags: %w", err)
return
}
resolverOpt, cleanup, err := withResolveConfig(clicontext)
if err != nil {
rErr = fmt.Errorf("failed to parse DNS-related flags: %w", err)
return
}
cleanups = append(cleanups, cleanup)
var mounts []runtimespec.Mount
for _, mount := range clicontext.StringSlice("mount") {
m, err := parseMountFlag(mount)
if err != nil {
rErr = fmt.Errorf("failed to parse mount flag %q: %w", mount, err)
return
}
mounts = append(mounts, m)
}
opts = append(opts,
oci.WithDefaultSpec(),
oci.WithDefaultUnixDevices,
oci.WithRootFSPath(rootfs),
oci.WithImageConfig(image),
oci.WithEnv(clicontext.StringSlice("env")),
oci.WithMounts(mounts),
resolverOpt,
entrypointOpt,
)
if envFile := clicontext.String("env-file"); envFile != "" {
opts = append(opts, oci.WithEnvFile(envFile))
}
if username := clicontext.String("user"); username != "" {
opts = append(opts, oci.WithUser(username))
}
if cwd := clicontext.String("cwd"); cwd != "" {
opts = append(opts, oci.WithProcessCwd(cwd))
}
if clicontext.Bool("terminal") {
if !clicontext.Bool("i") {
rErr = fmt.Errorf("terminal flag must be specified with \"-i\"")
return
}
opts = append(opts, oci.WithTTY)
}
if clicontext.Bool("cni") {
var nOpt oci.SpecOpts
nOpt, cleanup, err = withCNI(clicontext)
if err != nil {
rErr = fmt.Errorf("failed to parse CNI-related flags: %w", err)
return
}
cleanups = append(cleanups, cleanup)
opts = append(opts, nOpt)
}
if clicontext.Bool("net-host") {
if runtime.GOOS == "windows" {
logrus.Warn("option --net-host is not supported on Windows")
} else {
opts = append(opts, oci.WithHostNamespace(runtimespec.NetworkNamespace), oci.WithHostHostsFile, oci.WithHostResolvconf)
}
}
if clicontext.IsSet("gpus") {
if runtime.GOOS == "windows" {
logrus.Warn("option --gpus is not supported on Windows")
} else {
opts = append(opts, nvidia.WithGPUs(nvidia.WithDevices(clicontext.IntSlice("gpus")...), nvidia.WithAllCapabilities))
}
}
return
}
}
func withEntrypointArgs(clicontext *cli.Context, image containerd.Image) (oci.SpecOpts, error) {
var eFlag []string
if eStr := clicontext.String("entrypoint"); eStr != "" {
if err := json.Unmarshal([]byte(eStr), &eFlag); err != nil {
return nil, fmt.Errorf("invalid option \"entrypoint\": %w", err)
}
}
var aFlag []string
if aStr := clicontext.String("args"); aStr != "" {
if err := json.Unmarshal([]byte(aStr), &aFlag); err != nil {
return nil, fmt.Errorf("invalid option \"args\": %w", err)
}
}
return func(ctx gocontext.Context, client oci.Client, container *containers.Container, s *runtimespec.Spec) error {
configDesc, err := image.Config(ctx)
if err != nil {
return err
}
var ociimage imagespec.Image
switch configDesc.MediaType {
case imagespec.MediaTypeImageConfig, images.MediaTypeDockerSchema2Config:
p, err := content.ReadBlob(ctx, image.ContentStore(), configDesc)
if err != nil {
return err
}
if err := json.Unmarshal(p, &ociimage); err != nil {
return err
}
default:
return fmt.Errorf("unknown image config media type %s", configDesc.MediaType)
}
entrypoint := ociimage.Config.Entrypoint
if len(eFlag) > 0 {
entrypoint = eFlag
}
args := ociimage.Config.Cmd
if len(aFlag) > 0 {
args = aFlag
}
return oci.WithProcessArgs(append(entrypoint, args...)...)(ctx, client, container, s)
}, nil
}
func withCNI(clicontext *cli.Context) (specOpt oci.SpecOpts, done func() error, rErr error) {
var cleanups []func() error
done = func() (allErr error) {
for i := len(cleanups) - 1; i >= 0; i-- {
if err := cleanups[i](); err != nil {
allErr = multierror.Append(allErr, err)
}
}
return
}
defer func() {
if rErr != nil {
if err := done(); err != nil {
rErr = fmt.Errorf("failed to cleanup: %w", rErr)
}
}
}()
// Create a new network namespace for configuring it with CNI plugins
ns, err := netns.NewNetNS(netnsMountDir)
if err != nil {
rErr = fmt.Errorf("failed to prepare netns: %w", err)
return
}
cleanups = append(cleanups, ns.Remove)
// Configure the namespace with CNI plugins
var cniopts []gocni.Opt
if cdir := clicontext.String("cni-plugin-conf-dir"); cdir != "" {
cniopts = append(cniopts, gocni.WithPluginConfDir(cdir))
}
if pdir := clicontext.String("cni-plugin-dir"); pdir != "" {
cniopts = append(cniopts, gocni.WithPluginDir([]string{pdir}))
}
// The first-found configration file will be effective
// TODO: Should we make the number of reading files configurable?
cniopts = append(cniopts, gocni.WithDefaultConf)
network, err := gocni.New(cniopts...)
if err != nil {
rErr = fmt.Errorf("failed to prepare CNI plugins: %w", err)
return
}
id := xid.New().String()
ctx := gocontext.Background()
if _, err := network.Setup(ctx, id, ns.GetPath()); err != nil {
rErr = fmt.Errorf("failed to setup netns with CNI plugins: %w", err)
return
}
cleanups = append(cleanups, func() error {
return network.Remove(ctx, id, ns.GetPath())
})
// Make the container use this network namespace
return oci.WithLinuxNamespace(runtimespec.LinuxNamespace{
Type: runtimespec.NetworkNamespace,
Path: ns.GetPath(),
}), done, nil
}
func withResolveConfig(clicontext *cli.Context) (specOpt oci.SpecOpts, cleanup func() error, rErr error) {
defer func() {
if rErr != nil {
if err := cleanup(); err != nil {
rErr = fmt.Errorf("failed to cleanup: %w", rErr)
}
}
}()
extrahosts, nameservers, searches, dnsopts, err := parseResolveFlag(clicontext)
if err != nil {
return nil, nil, err
}
// Generate /etc/hosts and /etc/resolv.conf
resolvDir, err := os.MkdirTemp("", "tmpetc")
if err != nil {
return nil, nil, err
}
cleanup = func() error { return os.RemoveAll(resolvDir) }
var (
etcHostsPath = filepath.Join(resolvDir, "hosts")
etcResolvConfPath = filepath.Join(resolvDir, "resolv.conf")
buf = new(bytes.Buffer)
)
for _, n := range nameservers {
if _, err := fmt.Fprintf(buf, "nameserver %s\n", n); err != nil {
rErr = fmt.Errorf("failed to prepare nameserver of /etc/resolv.conf: %w", err)
return
}
}
if len(searches) > 0 {
_, err := fmt.Fprintf(buf, "search %s\n", strings.Join(searches, " "))
if err != nil {
rErr = fmt.Errorf("failed to prepare search contents of /etc/resolv.conf: %w", err)
return
}
}
if len(dnsopts) > 0 {
_, err := fmt.Fprintf(buf, "options %s\n", strings.Join(dnsopts, " "))
if err != nil {
rErr = fmt.Errorf("failed to prepare options contents of /etc/resolv.conf: %w", err)
return
}
}
if err := os.WriteFile(etcResolvConfPath, buf.Bytes(), 0644); err != nil {
rErr = fmt.Errorf("failed to write contents to /etc/resolv.conf: %w", err)
return
}
buf.Reset() // Reusing for /etc/hosts
for _, h := range []struct {
host string
ip string
}{
// Configuration compatible to docker's config
// https://github.com/moby/libnetwork/blob/535ef365dc1dd82a5135803a58bc6198a3b9aa27/etchosts/etchosts.go#L28-L36
{"localhost", "127.0.0.1"},
{"localhost ip6-localhost ip6-loopback", "::1"},
{"ip6-localnet", "fe00::0"},
{"ip6-mcastprefix", "ff00::0"},
{"ip6-allnodes", "ff02::1"},
{"ip6-allrouters", "ff02::2"},
} {
if _, err := fmt.Fprintf(buf, "%s\t%s\n", h.ip, h.host); err != nil {
rErr = fmt.Errorf("failed to write default hosts to /etc/hosts: %w", err)
return
}
}
for _, h := range extrahosts {
parts := strings.SplitN(h, ":", 2) // host:IP
if len(parts) != 2 {
rErr = fmt.Errorf("cannot parse %q as extra host; must be \"host:IP\"", h)
return
}
// TODO: Validate them
if _, err := fmt.Fprintf(buf, "%s\t%s\n", parts[1], parts[0]); err != nil {
rErr = fmt.Errorf("failed to write extra hosts to /etc/hosts: %w", err)
return
}
}
if err := os.WriteFile(etcHostsPath, buf.Bytes(), 0644); err != nil {
rErr = fmt.Errorf("failed to write contents to /etc/hosts: %w", err)
return
}
return oci.WithMounts([]runtimespec.Mount{
{
Destination: "/etc/resolv.conf",
Source: etcResolvConfPath,
Options: []string{"bind"},
},
{
Destination: "/etc/hosts",
Source: etcHostsPath,
Options: []string{"bind"},
},
}), cleanup, nil
}
// parseMountFlag parses a mount string in the form "type=foo,source=/path,destination=/target,options=rbind:rw"
func parseMountFlag(m string) (runtimespec.Mount, error) {
mount := runtimespec.Mount{}
r := csv.NewReader(strings.NewReader(m))
fields, err := r.Read()
if err != nil {
return mount, err
}
for _, field := range fields {
v := strings.Split(field, "=")
if len(v) != 2 {
return mount, fmt.Errorf("invalid mount specification: expected key=val")
}
key := v[0]
val := v[1]
switch key {
case "type":
mount.Type = val
case "source", "src":
mount.Source = val
case "destination", "dst":
mount.Destination = val
case "options":
mount.Options = strings.Split(val, ":")
default:
return mount, fmt.Errorf("mount option %q not supported", key)
}
}
return mount, nil
}
func parseResolveFlag(clicontext *cli.Context) (hosts []string, nameservers []string, searches []string, dnsopts []string, _ error) {
if nFlag := clicontext.String("dns-nameservers"); nFlag != "" {
fields, err := csv.NewReader(strings.NewReader(nFlag)).Read()
if err != nil {
return nil, nil, nil, nil, err
}
nameservers = append(nameservers, fields...)
}
if sFlag := clicontext.String("dns-search-domains"); sFlag != "" {
fields, err := csv.NewReader(strings.NewReader(sFlag)).Read()
if err != nil {
return nil, nil, nil, nil, err
}
searches = append(searches, fields...)
}
if oFlag := clicontext.String("dns-options"); oFlag != "" {
fields, err := csv.NewReader(strings.NewReader(oFlag)).Read()
if err != nil {
return nil, nil, nil, nil, err
}
dnsopts = append(dnsopts, fields...)
}
if hFlag := clicontext.String("add-hosts"); hFlag != "" {
fields, err := csv.NewReader(strings.NewReader(hFlag)).Read()
if err != nil {
return nil, nil, nil, nil, err
}
hosts = append(hosts, fields...)
}
return
}
|