1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
30 "git.curoverse.com/arvados.git/lib/crunchstat"
31 "git.curoverse.com/arvados.git/sdk/go/arvados"
32 "git.curoverse.com/arvados.git/sdk/go/arvadosclient"
33 "git.curoverse.com/arvados.git/sdk/go/keepclient"
34 "git.curoverse.com/arvados.git/sdk/go/manifest"
35 "golang.org/x/net/context"
37 dockertypes "github.com/docker/docker/api/types"
38 dockercontainer "github.com/docker/docker/api/types/container"
39 dockernetwork "github.com/docker/docker/api/types/network"
40 dockerclient "github.com/docker/docker/client"
45 // IArvadosClient is the minimal Arvados API methods used by crunch-run.
46 type IArvadosClient interface {
47 Create(resourceType string, parameters arvadosclient.Dict, output interface{}) error
48 Get(resourceType string, uuid string, parameters arvadosclient.Dict, output interface{}) error
49 Update(resourceType string, uuid string, parameters arvadosclient.Dict, output interface{}) error
50 Call(method, resourceType, uuid, action string, parameters arvadosclient.Dict, output interface{}) error
51 CallRaw(method string, resourceType string, uuid string, action string, parameters arvadosclient.Dict) (reader io.ReadCloser, err error)
52 Discovery(key string) (interface{}, error)
55 // ErrCancelled is the error returned when the container is cancelled.
56 var ErrCancelled = errors.New("Cancelled")
58 // IKeepClient is the minimal Keep API methods used by crunch-run.
59 type IKeepClient interface {
60 PutB(buf []byte) (string, int, error)
61 ReadAt(locator string, p []byte, off int) (int, error)
62 ManifestFileReader(m manifest.Manifest, filename string) (arvados.File, error)
63 LocalLocator(locator string) (string, error)
67 // NewLogWriter is a factory function to create a new log writer.
68 type NewLogWriter func(name string) (io.WriteCloser, error)
70 type RunArvMount func(args []string, tok string) (*exec.Cmd, error)
72 type MkTempDir func(string, string) (string, error)
74 // ThinDockerClient is the minimal Docker client interface used by crunch-run.
75 type ThinDockerClient interface {
76 ContainerAttach(ctx context.Context, container string, options dockertypes.ContainerAttachOptions) (dockertypes.HijackedResponse, error)
77 ContainerCreate(ctx context.Context, config *dockercontainer.Config, hostConfig *dockercontainer.HostConfig,
78 networkingConfig *dockernetwork.NetworkingConfig, containerName string) (dockercontainer.ContainerCreateCreatedBody, error)
79 ContainerStart(ctx context.Context, container string, options dockertypes.ContainerStartOptions) error
80 ContainerRemove(ctx context.Context, container string, options dockertypes.ContainerRemoveOptions) error
81 ContainerWait(ctx context.Context, container string, condition dockercontainer.WaitCondition) (<-chan dockercontainer.ContainerWaitOKBody, <-chan error)
82 ContainerInspect(ctx context.Context, id string) (dockertypes.ContainerJSON, error)
83 ImageInspectWithRaw(ctx context.Context, image string) (dockertypes.ImageInspect, []byte, error)
84 ImageLoad(ctx context.Context, input io.Reader, quiet bool) (dockertypes.ImageLoadResponse, error)
85 ImageRemove(ctx context.Context, image string, options dockertypes.ImageRemoveOptions) ([]dockertypes.ImageDeleteResponseItem, error)
88 type PsProcess interface {
89 CmdlineSlice() ([]string, error)
92 // ContainerRunner is the main stateful struct used for a single execution of a
94 type ContainerRunner struct {
95 Docker ThinDockerClient
97 // Dispatcher client is initialized with the Dispatcher token.
98 // This is a priviledged token used to manage container status
101 // We have both dispatcherClient and DispatcherArvClient
102 // because there are two different incompatible Arvados Go
103 // SDKs and we have to use both (hopefully this gets fixed in
105 dispatcherClient *arvados.Client
106 DispatcherArvClient IArvadosClient
107 DispatcherKeepClient IKeepClient
109 // Container client is initialized with the Container token
110 // This token controls the permissions of the container, and
111 // must be used for operations such as reading collections.
113 // Same comment as above applies to
114 // containerClient/ContainerArvClient.
115 containerClient *arvados.Client
116 ContainerArvClient IArvadosClient
117 ContainerKeepClient IKeepClient
119 Container arvados.Container
120 ContainerConfig dockercontainer.Config
121 HostConfig dockercontainer.HostConfig
125 NewLogWriter NewLogWriter
126 loggingDone chan bool
127 CrunchLog *ThrottledLogger
128 Stdout io.WriteCloser
129 Stderr io.WriteCloser
132 LogCollection arvados.CollectionFileSystem
134 RunArvMount RunArvMount
140 Volumes map[string]struct{}
142 SigChan chan os.Signal
143 ArvMountExit chan error
144 SecretMounts map[string]arvados.Mount
145 MkArvClient func(token string) (IArvadosClient, IKeepClient, *arvados.Client, error)
149 statLogger io.WriteCloser
150 statReporter *crunchstat.Reporter
151 hoststatLogger io.WriteCloser
152 hoststatReporter *crunchstat.Reporter
153 statInterval time.Duration
155 // What we expect the container's cgroup parent to be.
156 expectCgroupParent string
157 // What we tell docker to use as the container's cgroup
158 // parent. Note: Ideally we would use the same field for both
159 // expectCgroupParent and setCgroupParent, and just make it
160 // default to "docker". However, when using docker < 1.10 with
161 // systemd, specifying a non-empty cgroup parent (even the
162 // default value "docker") hits a docker bug
163 // (https://github.com/docker/docker/issues/17126). Using two
164 // separate fields makes it possible to use the "expect cgroup
165 // parent to be X" feature even on sites where the "specify
166 // cgroup parent" feature breaks.
167 setCgroupParent string
169 cStateLock sync.Mutex
170 cCancelled bool // StopContainer() invoked
171 cRemoved bool // docker confirmed the container no longer exists
173 enableNetwork string // one of "default" or "always"
174 networkMode string // passed through to HostConfig.NetworkMode
175 arvMountLog *ThrottledLogger
177 containerWatchdogInterval time.Duration
180 // setupSignals sets up signal handling to gracefully terminate the underlying
181 // Docker container and update state when receiving a TERM, INT or QUIT signal.
182 func (runner *ContainerRunner) setupSignals() {
183 runner.SigChan = make(chan os.Signal, 1)
184 signal.Notify(runner.SigChan, syscall.SIGTERM)
185 signal.Notify(runner.SigChan, syscall.SIGINT)
186 signal.Notify(runner.SigChan, syscall.SIGQUIT)
188 go func(sig chan os.Signal) {
195 // stop the underlying Docker container.
196 func (runner *ContainerRunner) stop(sig os.Signal) {
197 runner.cStateLock.Lock()
198 defer runner.cStateLock.Unlock()
200 runner.CrunchLog.Printf("caught signal: %v", sig)
202 if runner.ContainerID == "" {
205 runner.cCancelled = true
206 runner.CrunchLog.Printf("removing container")
207 err := runner.Docker.ContainerRemove(context.TODO(), runner.ContainerID, dockertypes.ContainerRemoveOptions{Force: true})
209 runner.CrunchLog.Printf("error removing container: %s", err)
211 if err == nil || strings.Contains(err.Error(), "No such container: "+runner.ContainerID) {
212 runner.cRemoved = true
216 var errorBlacklist = []string{
217 "(?ms).*[Cc]annot connect to the Docker daemon.*",
218 "(?ms).*oci runtime error.*starting container process.*container init.*mounting.*to rootfs.*no such file or directory.*",
219 "(?ms).*grpc: the connection is unavailable.*",
221 var brokenNodeHook *string = flag.String("broken-node-hook", "", "Script to run if node is detected to be broken (for example, Docker daemon is not running)")
223 func (runner *ContainerRunner) runBrokenNodeHook() {
224 if *brokenNodeHook == "" {
225 runner.CrunchLog.Printf("No broken node hook provided, cannot mark node as broken.")
227 runner.CrunchLog.Printf("Running broken node hook %q", *brokenNodeHook)
229 c := exec.Command(*brokenNodeHook)
230 c.Stdout = runner.CrunchLog
231 c.Stderr = runner.CrunchLog
234 runner.CrunchLog.Printf("Error running broken node hook: %v", err)
239 func (runner *ContainerRunner) checkBrokenNode(goterr error) bool {
240 for _, d := range errorBlacklist {
241 if m, e := regexp.MatchString(d, goterr.Error()); m && e == nil {
242 runner.CrunchLog.Printf("Error suggests node is unable to run containers: %v", goterr)
243 runner.runBrokenNodeHook()
250 // LoadImage determines the docker image id from the container record and
251 // checks if it is available in the local Docker image store. If not, it loads
252 // the image from Keep.
253 func (runner *ContainerRunner) LoadImage() (err error) {
255 runner.CrunchLog.Printf("Fetching Docker image from collection '%s'", runner.Container.ContainerImage)
257 var collection arvados.Collection
258 err = runner.ContainerArvClient.Get("collections", runner.Container.ContainerImage, nil, &collection)
260 return fmt.Errorf("While getting container image collection: %v", err)
262 manifest := manifest.Manifest{Text: collection.ManifestText}
263 var img, imageID string
264 for ms := range manifest.StreamIter() {
265 img = ms.FileStreamSegments[0].Name
266 if !strings.HasSuffix(img, ".tar") {
267 return fmt.Errorf("First file in the container image collection does not end in .tar")
269 imageID = img[:len(img)-4]
272 runner.CrunchLog.Printf("Using Docker image id '%s'", imageID)
274 _, _, err = runner.Docker.ImageInspectWithRaw(context.TODO(), imageID)
276 runner.CrunchLog.Print("Loading Docker image from keep")
278 var readCloser io.ReadCloser
279 readCloser, err = runner.ContainerKeepClient.ManifestFileReader(manifest, img)
281 return fmt.Errorf("While creating ManifestFileReader for container image: %v", err)
284 response, err := runner.Docker.ImageLoad(context.TODO(), readCloser, true)
286 return fmt.Errorf("While loading container image into Docker: %v", err)
289 defer response.Body.Close()
290 rbody, err := ioutil.ReadAll(response.Body)
292 return fmt.Errorf("Reading response to image load: %v", err)
294 runner.CrunchLog.Printf("Docker response: %s", rbody)
296 runner.CrunchLog.Print("Docker image is available")
299 runner.ContainerConfig.Image = imageID
301 runner.ContainerKeepClient.ClearBlockCache()
306 func (runner *ContainerRunner) ArvMountCmd(arvMountCmd []string, token string) (c *exec.Cmd, err error) {
307 c = exec.Command("arv-mount", arvMountCmd...)
309 // Copy our environment, but override ARVADOS_API_TOKEN with
310 // the container auth token.
312 for _, s := range os.Environ() {
313 if !strings.HasPrefix(s, "ARVADOS_API_TOKEN=") {
314 c.Env = append(c.Env, s)
317 c.Env = append(c.Env, "ARVADOS_API_TOKEN="+token)
319 w, err := runner.NewLogWriter("arv-mount")
323 runner.arvMountLog = NewThrottledLogger(w)
324 c.Stdout = runner.arvMountLog
325 c.Stderr = runner.arvMountLog
327 runner.CrunchLog.Printf("Running %v", c.Args)
334 statReadme := make(chan bool)
335 runner.ArvMountExit = make(chan error)
340 time.Sleep(100 * time.Millisecond)
341 _, err = os.Stat(fmt.Sprintf("%s/by_id/README", runner.ArvMountPoint))
353 runner.CrunchLog.Printf("Arv-mount exit error: %v", mnterr)
355 runner.ArvMountExit <- mnterr
356 close(runner.ArvMountExit)
362 case err := <-runner.ArvMountExit:
363 runner.ArvMount = nil
371 func (runner *ContainerRunner) SetupArvMountPoint(prefix string) (err error) {
372 if runner.ArvMountPoint == "" {
373 runner.ArvMountPoint, err = runner.MkTempDir(runner.parentTemp, prefix)
378 func copyfile(src string, dst string) (err error) {
379 srcfile, err := os.Open(src)
384 os.MkdirAll(path.Dir(dst), 0777)
386 dstfile, err := os.Create(dst)
390 _, err = io.Copy(dstfile, srcfile)
395 err = srcfile.Close()
396 err2 := dstfile.Close()
409 func (runner *ContainerRunner) SetupMounts() (err error) {
410 err = runner.SetupArvMountPoint("keep")
412 return fmt.Errorf("While creating keep mount temp dir: %v", err)
415 token, err := runner.ContainerToken()
417 return fmt.Errorf("could not get container token: %s", err)
422 arvMountCmd := []string{
426 fmt.Sprintf("--crunchstat-interval=%v", runner.statInterval.Seconds())}
428 if runner.Container.RuntimeConstraints.KeepCacheRAM > 0 {
429 arvMountCmd = append(arvMountCmd, "--file-cache", fmt.Sprintf("%d", runner.Container.RuntimeConstraints.KeepCacheRAM))
432 collectionPaths := []string{}
434 runner.Volumes = make(map[string]struct{})
435 needCertMount := true
436 type copyFile struct {
440 var copyFiles []copyFile
443 for bind := range runner.Container.Mounts {
444 binds = append(binds, bind)
446 for bind := range runner.SecretMounts {
447 if _, ok := runner.Container.Mounts[bind]; ok {
448 return fmt.Errorf("Secret mount %q conflicts with regular mount", bind)
450 if runner.SecretMounts[bind].Kind != "json" &&
451 runner.SecretMounts[bind].Kind != "text" {
452 return fmt.Errorf("Secret mount %q type is %q but only 'json' and 'text' are permitted.",
453 bind, runner.SecretMounts[bind].Kind)
455 binds = append(binds, bind)
459 for _, bind := range binds {
460 mnt, ok := runner.Container.Mounts[bind]
462 mnt = runner.SecretMounts[bind]
464 if bind == "stdout" || bind == "stderr" {
465 // Is it a "file" mount kind?
466 if mnt.Kind != "file" {
467 return fmt.Errorf("Unsupported mount kind '%s' for %s. Only 'file' is supported.", mnt.Kind, bind)
470 // Does path start with OutputPath?
471 prefix := runner.Container.OutputPath
472 if !strings.HasSuffix(prefix, "/") {
475 if !strings.HasPrefix(mnt.Path, prefix) {
476 return fmt.Errorf("%s path does not start with OutputPath: %s, %s", strings.Title(bind), mnt.Path, prefix)
481 // Is it a "collection" mount kind?
482 if mnt.Kind != "collection" && mnt.Kind != "json" {
483 return fmt.Errorf("Unsupported mount kind '%s' for stdin. Only 'collection' or 'json' are supported.", mnt.Kind)
487 if bind == "/etc/arvados/ca-certificates.crt" {
488 needCertMount = false
491 if strings.HasPrefix(bind, runner.Container.OutputPath+"/") && bind != runner.Container.OutputPath+"/" {
492 if mnt.Kind != "collection" && mnt.Kind != "text" && mnt.Kind != "json" {
493 return fmt.Errorf("Only mount points of kind 'collection', 'text' or 'json' are supported underneath the output_path for %q, was %q", bind, mnt.Kind)
498 case mnt.Kind == "collection" && bind != "stdin":
500 if mnt.UUID != "" && mnt.PortableDataHash != "" {
501 return fmt.Errorf("Cannot specify both 'uuid' and 'portable_data_hash' for a collection mount")
505 return fmt.Errorf("Writing to existing collections currently not permitted.")
508 src = fmt.Sprintf("%s/by_id/%s", runner.ArvMountPoint, mnt.UUID)
509 } else if mnt.PortableDataHash != "" {
510 if mnt.Writable && !strings.HasPrefix(bind, runner.Container.OutputPath+"/") {
511 return fmt.Errorf("Can never write to a collection specified by portable data hash")
513 idx := strings.Index(mnt.PortableDataHash, "/")
515 mnt.Path = path.Clean(mnt.PortableDataHash[idx:])
516 mnt.PortableDataHash = mnt.PortableDataHash[0:idx]
517 runner.Container.Mounts[bind] = mnt
519 src = fmt.Sprintf("%s/by_id/%s", runner.ArvMountPoint, mnt.PortableDataHash)
520 if mnt.Path != "" && mnt.Path != "." {
521 if strings.HasPrefix(mnt.Path, "./") {
522 mnt.Path = mnt.Path[2:]
523 } else if strings.HasPrefix(mnt.Path, "/") {
524 mnt.Path = mnt.Path[1:]
526 src += "/" + mnt.Path
529 src = fmt.Sprintf("%s/tmp%d", runner.ArvMountPoint, tmpcount)
530 arvMountCmd = append(arvMountCmd, "--mount-tmp")
531 arvMountCmd = append(arvMountCmd, fmt.Sprintf("tmp%d", tmpcount))
535 if bind == runner.Container.OutputPath {
536 runner.HostOutputDir = src
537 runner.Binds = append(runner.Binds, fmt.Sprintf("%s:%s", src, bind))
538 } else if strings.HasPrefix(bind, runner.Container.OutputPath+"/") {
539 copyFiles = append(copyFiles, copyFile{src, runner.HostOutputDir + bind[len(runner.Container.OutputPath):]})
541 runner.Binds = append(runner.Binds, fmt.Sprintf("%s:%s", src, bind))
544 runner.Binds = append(runner.Binds, fmt.Sprintf("%s:%s:ro", src, bind))
546 collectionPaths = append(collectionPaths, src)
548 case mnt.Kind == "tmp":
550 tmpdir, err = runner.MkTempDir(runner.parentTemp, "tmp")
552 return fmt.Errorf("While creating mount temp dir: %v", err)
554 st, staterr := os.Stat(tmpdir)
556 return fmt.Errorf("While Stat on temp dir: %v", staterr)
558 err = os.Chmod(tmpdir, st.Mode()|os.ModeSetgid|0777)
560 return fmt.Errorf("While Chmod temp dir: %v", err)
562 runner.Binds = append(runner.Binds, fmt.Sprintf("%s:%s", tmpdir, bind))
563 if bind == runner.Container.OutputPath {
564 runner.HostOutputDir = tmpdir
567 case mnt.Kind == "json" || mnt.Kind == "text":
569 if mnt.Kind == "json" {
570 filedata, err = json.Marshal(mnt.Content)
572 return fmt.Errorf("encoding json data: %v", err)
575 text, ok := mnt.Content.(string)
577 return fmt.Errorf("content for mount %q must be a string", bind)
579 filedata = []byte(text)
582 tmpdir, err := runner.MkTempDir(runner.parentTemp, mnt.Kind)
584 return fmt.Errorf("creating temp dir: %v", err)
586 tmpfn := filepath.Join(tmpdir, "mountdata."+mnt.Kind)
587 err = ioutil.WriteFile(tmpfn, filedata, 0444)
589 return fmt.Errorf("writing temp file: %v", err)
591 if strings.HasPrefix(bind, runner.Container.OutputPath+"/") {
592 copyFiles = append(copyFiles, copyFile{tmpfn, runner.HostOutputDir + bind[len(runner.Container.OutputPath):]})
594 runner.Binds = append(runner.Binds, fmt.Sprintf("%s:%s:ro", tmpfn, bind))
597 case mnt.Kind == "git_tree":
598 tmpdir, err := runner.MkTempDir(runner.parentTemp, "git_tree")
600 return fmt.Errorf("creating temp dir: %v", err)
602 err = gitMount(mnt).extractTree(runner.ContainerArvClient, tmpdir, token)
606 runner.Binds = append(runner.Binds, tmpdir+":"+bind+":ro")
610 if runner.HostOutputDir == "" {
611 return fmt.Errorf("Output path does not correspond to a writable mount point")
614 if wantAPI := runner.Container.RuntimeConstraints.API; needCertMount && wantAPI != nil && *wantAPI {
615 for _, certfile := range arvadosclient.CertFiles {
616 _, err := os.Stat(certfile)
618 runner.Binds = append(runner.Binds, fmt.Sprintf("%s:/etc/arvados/ca-certificates.crt:ro", certfile))
625 arvMountCmd = append(arvMountCmd, "--mount-by-pdh", "by_id")
627 arvMountCmd = append(arvMountCmd, "--mount-by-id", "by_id")
629 arvMountCmd = append(arvMountCmd, runner.ArvMountPoint)
631 runner.ArvMount, err = runner.RunArvMount(arvMountCmd, token)
633 return fmt.Errorf("While trying to start arv-mount: %v", err)
636 for _, p := range collectionPaths {
639 return fmt.Errorf("While checking that input files exist: %v", err)
643 for _, cp := range copyFiles {
644 st, err := os.Stat(cp.src)
646 return fmt.Errorf("While staging writable file from %q to %q: %v", cp.src, cp.bind, err)
649 err = filepath.Walk(cp.src, func(walkpath string, walkinfo os.FileInfo, walkerr error) error {
653 target := path.Join(cp.bind, walkpath[len(cp.src):])
654 if walkinfo.Mode().IsRegular() {
655 copyerr := copyfile(walkpath, target)
659 return os.Chmod(target, walkinfo.Mode()|0777)
660 } else if walkinfo.Mode().IsDir() {
661 mkerr := os.MkdirAll(target, 0777)
665 return os.Chmod(target, walkinfo.Mode()|os.ModeSetgid|0777)
667 return fmt.Errorf("Source %q is not a regular file or directory", cp.src)
670 } else if st.Mode().IsRegular() {
671 err = copyfile(cp.src, cp.bind)
673 err = os.Chmod(cp.bind, st.Mode()|0777)
677 return fmt.Errorf("While staging writable file from %q to %q: %v", cp.src, cp.bind, err)
684 func (runner *ContainerRunner) ProcessDockerAttach(containerReader io.Reader) {
685 // Handle docker log protocol
686 // https://docs.docker.com/engine/reference/api/docker_remote_api_v1.15/#attach-to-a-container
687 defer close(runner.loggingDone)
689 header := make([]byte, 8)
692 _, err = io.ReadAtLeast(containerReader, header, 8)
699 readsize := int64(header[7]) | (int64(header[6]) << 8) | (int64(header[5]) << 16) | (int64(header[4]) << 24)
702 _, err = io.CopyN(runner.Stdout, containerReader, readsize)
705 _, err = io.CopyN(runner.Stderr, containerReader, readsize)
710 runner.CrunchLog.Printf("error reading docker logs: %v", err)
713 err = runner.Stdout.Close()
715 runner.CrunchLog.Printf("error closing stdout logs: %v", err)
718 err = runner.Stderr.Close()
720 runner.CrunchLog.Printf("error closing stderr logs: %v", err)
723 if runner.statReporter != nil {
724 runner.statReporter.Stop()
725 err = runner.statLogger.Close()
727 runner.CrunchLog.Printf("error closing crunchstat logs: %v", err)
732 func (runner *ContainerRunner) stopHoststat() error {
733 if runner.hoststatReporter == nil {
736 runner.hoststatReporter.Stop()
737 err := runner.hoststatLogger.Close()
739 return fmt.Errorf("error closing hoststat logs: %v", err)
744 func (runner *ContainerRunner) startHoststat() error {
745 w, err := runner.NewLogWriter("hoststat")
749 runner.hoststatLogger = NewThrottledLogger(w)
750 runner.hoststatReporter = &crunchstat.Reporter{
751 Logger: log.New(runner.hoststatLogger, "", 0),
752 CgroupRoot: runner.cgroupRoot,
753 PollPeriod: runner.statInterval,
755 runner.hoststatReporter.Start()
759 func (runner *ContainerRunner) startCrunchstat() error {
760 w, err := runner.NewLogWriter("crunchstat")
764 runner.statLogger = NewThrottledLogger(w)
765 runner.statReporter = &crunchstat.Reporter{
766 CID: runner.ContainerID,
767 Logger: log.New(runner.statLogger, "", 0),
768 CgroupParent: runner.expectCgroupParent,
769 CgroupRoot: runner.cgroupRoot,
770 PollPeriod: runner.statInterval,
771 TempDir: runner.parentTemp,
773 runner.statReporter.Start()
777 type infoCommand struct {
782 // LogHostInfo logs info about the current host, for debugging and
783 // accounting purposes. Although it's logged as "node-info", this is
784 // about the environment where crunch-run is actually running, which
785 // might differ from what's described in the node record (see
787 func (runner *ContainerRunner) LogHostInfo() (err error) {
788 w, err := runner.NewLogWriter("node-info")
793 commands := []infoCommand{
795 label: "Host Information",
796 cmd: []string{"uname", "-a"},
799 label: "CPU Information",
800 cmd: []string{"cat", "/proc/cpuinfo"},
803 label: "Memory Information",
804 cmd: []string{"cat", "/proc/meminfo"},
808 cmd: []string{"df", "-m", "/", os.TempDir()},
811 label: "Disk INodes",
812 cmd: []string{"df", "-i", "/", os.TempDir()},
816 // Run commands with informational output to be logged.
817 for _, command := range commands {
818 fmt.Fprintln(w, command.label)
819 cmd := exec.Command(command.cmd[0], command.cmd[1:]...)
822 if err := cmd.Run(); err != nil {
823 err = fmt.Errorf("While running command %q: %v", command.cmd, err)
832 return fmt.Errorf("While closing node-info logs: %v", err)
837 // LogContainerRecord gets and saves the raw JSON container record from the API server
838 func (runner *ContainerRunner) LogContainerRecord() error {
839 logged, err := runner.logAPIResponse("container", "containers", map[string]interface{}{"filters": [][]string{{"uuid", "=", runner.Container.UUID}}}, nil)
840 if !logged && err == nil {
841 err = fmt.Errorf("error: no container record found for %s", runner.Container.UUID)
846 // LogNodeRecord logs arvados#node record corresponding to the current host.
847 func (runner *ContainerRunner) LogNodeRecord() error {
848 hostname := os.Getenv("SLURMD_NODENAME")
850 hostname, _ = os.Hostname()
852 _, err := runner.logAPIResponse("node", "nodes", map[string]interface{}{"filters": [][]string{{"hostname", "=", hostname}}}, func(resp interface{}) {
853 // The "info" field has admin-only info when obtained
854 // with a privileged token, and should not be logged.
855 node, ok := resp.(map[string]interface{})
863 func (runner *ContainerRunner) logAPIResponse(label, path string, params map[string]interface{}, munge func(interface{})) (logged bool, err error) {
864 writer, err := runner.LogCollection.OpenFile(label+".json", os.O_CREATE|os.O_WRONLY, 0666)
869 ArvClient: runner.DispatcherArvClient,
870 UUID: runner.Container.UUID,
871 loggingStream: label,
875 reader, err := runner.DispatcherArvClient.CallRaw("GET", path, "", "", arvadosclient.Dict(params))
877 return false, fmt.Errorf("error getting %s record: %v", label, err)
881 dec := json.NewDecoder(reader)
883 var resp map[string]interface{}
884 if err = dec.Decode(&resp); err != nil {
885 return false, fmt.Errorf("error decoding %s list response: %v", label, err)
887 items, ok := resp["items"].([]interface{})
889 return false, fmt.Errorf("error decoding %s list response: no \"items\" key in API list response", label)
890 } else if len(items) < 1 {
896 // Re-encode it using indentation to improve readability
897 enc := json.NewEncoder(w)
898 enc.SetIndent("", " ")
899 if err = enc.Encode(items[0]); err != nil {
900 return false, fmt.Errorf("error logging %s record: %v", label, err)
904 return false, fmt.Errorf("error closing %s.json in log collection: %v", label, err)
909 // AttachStreams connects the docker container stdin, stdout and stderr logs
910 // to the Arvados logger which logs to Keep and the API server logs table.
911 func (runner *ContainerRunner) AttachStreams() (err error) {
913 runner.CrunchLog.Print("Attaching container streams")
915 // If stdin mount is provided, attach it to the docker container
916 var stdinRdr arvados.File
918 if stdinMnt, ok := runner.Container.Mounts["stdin"]; ok {
919 if stdinMnt.Kind == "collection" {
920 var stdinColl arvados.Collection
921 collId := stdinMnt.UUID
923 collId = stdinMnt.PortableDataHash
925 err = runner.ContainerArvClient.Get("collections", collId, nil, &stdinColl)
927 return fmt.Errorf("While getting stdin collection: %v", err)
930 stdinRdr, err = runner.ContainerKeepClient.ManifestFileReader(
931 manifest.Manifest{Text: stdinColl.ManifestText},
933 if os.IsNotExist(err) {
934 return fmt.Errorf("stdin collection path not found: %v", stdinMnt.Path)
935 } else if err != nil {
936 return fmt.Errorf("While getting stdin collection path %v: %v", stdinMnt.Path, err)
938 } else if stdinMnt.Kind == "json" {
939 stdinJson, err = json.Marshal(stdinMnt.Content)
941 return fmt.Errorf("While encoding stdin json data: %v", err)
946 stdinUsed := stdinRdr != nil || len(stdinJson) != 0
947 response, err := runner.Docker.ContainerAttach(context.TODO(), runner.ContainerID,
948 dockertypes.ContainerAttachOptions{Stream: true, Stdin: stdinUsed, Stdout: true, Stderr: true})
950 return fmt.Errorf("While attaching container stdout/stderr streams: %v", err)
953 runner.loggingDone = make(chan bool)
955 if stdoutMnt, ok := runner.Container.Mounts["stdout"]; ok {
956 stdoutFile, err := runner.getStdoutFile(stdoutMnt.Path)
960 runner.Stdout = stdoutFile
961 } else if w, err := runner.NewLogWriter("stdout"); err != nil {
964 runner.Stdout = NewThrottledLogger(w)
967 if stderrMnt, ok := runner.Container.Mounts["stderr"]; ok {
968 stderrFile, err := runner.getStdoutFile(stderrMnt.Path)
972 runner.Stderr = stderrFile
973 } else if w, err := runner.NewLogWriter("stderr"); err != nil {
976 runner.Stderr = NewThrottledLogger(w)
981 _, err := io.Copy(response.Conn, stdinRdr)
983 runner.CrunchLog.Print("While writing stdin collection to docker container %q", err)
987 response.CloseWrite()
989 } else if len(stdinJson) != 0 {
991 _, err := io.Copy(response.Conn, bytes.NewReader(stdinJson))
993 runner.CrunchLog.Print("While writing stdin json to docker container %q", err)
996 response.CloseWrite()
1000 go runner.ProcessDockerAttach(response.Reader)
1005 func (runner *ContainerRunner) getStdoutFile(mntPath string) (*os.File, error) {
1006 stdoutPath := mntPath[len(runner.Container.OutputPath):]
1007 index := strings.LastIndex(stdoutPath, "/")
1009 subdirs := stdoutPath[:index]
1011 st, err := os.Stat(runner.HostOutputDir)
1013 return nil, fmt.Errorf("While Stat on temp dir: %v", err)
1015 stdoutPath := filepath.Join(runner.HostOutputDir, subdirs)
1016 err = os.MkdirAll(stdoutPath, st.Mode()|os.ModeSetgid|0777)
1018 return nil, fmt.Errorf("While MkdirAll %q: %v", stdoutPath, err)
1022 stdoutFile, err := os.Create(filepath.Join(runner.HostOutputDir, stdoutPath))
1024 return nil, fmt.Errorf("While creating file %q: %v", stdoutPath, err)
1027 return stdoutFile, nil
1030 // CreateContainer creates the docker container.
1031 func (runner *ContainerRunner) CreateContainer() error {
1032 runner.CrunchLog.Print("Creating Docker container")
1034 runner.ContainerConfig.Cmd = runner.Container.Command
1035 if runner.Container.Cwd != "." {
1036 runner.ContainerConfig.WorkingDir = runner.Container.Cwd
1039 for k, v := range runner.Container.Environment {
1040 runner.ContainerConfig.Env = append(runner.ContainerConfig.Env, k+"="+v)
1043 runner.ContainerConfig.Volumes = runner.Volumes
1045 maxRAM := int64(runner.Container.RuntimeConstraints.RAM)
1046 if maxRAM < 4*1024*1024 {
1047 // Docker daemon won't let you set a limit less than 4 MiB
1048 maxRAM = 4 * 1024 * 1024
1050 runner.HostConfig = dockercontainer.HostConfig{
1051 Binds: runner.Binds,
1052 LogConfig: dockercontainer.LogConfig{
1055 Resources: dockercontainer.Resources{
1056 CgroupParent: runner.setCgroupParent,
1057 NanoCPUs: int64(runner.Container.RuntimeConstraints.VCPUs) * 1000000000,
1058 Memory: maxRAM, // RAM
1059 MemorySwap: maxRAM, // RAM+swap
1060 KernelMemory: maxRAM, // kernel portion
1064 if wantAPI := runner.Container.RuntimeConstraints.API; wantAPI != nil && *wantAPI {
1065 tok, err := runner.ContainerToken()
1069 runner.ContainerConfig.Env = append(runner.ContainerConfig.Env,
1070 "ARVADOS_API_TOKEN="+tok,
1071 "ARVADOS_API_HOST="+os.Getenv("ARVADOS_API_HOST"),
1072 "ARVADOS_API_HOST_INSECURE="+os.Getenv("ARVADOS_API_HOST_INSECURE"),
1074 runner.HostConfig.NetworkMode = dockercontainer.NetworkMode(runner.networkMode)
1076 if runner.enableNetwork == "always" {
1077 runner.HostConfig.NetworkMode = dockercontainer.NetworkMode(runner.networkMode)
1079 runner.HostConfig.NetworkMode = dockercontainer.NetworkMode("none")
1083 _, stdinUsed := runner.Container.Mounts["stdin"]
1084 runner.ContainerConfig.OpenStdin = stdinUsed
1085 runner.ContainerConfig.StdinOnce = stdinUsed
1086 runner.ContainerConfig.AttachStdin = stdinUsed
1087 runner.ContainerConfig.AttachStdout = true
1088 runner.ContainerConfig.AttachStderr = true
1090 createdBody, err := runner.Docker.ContainerCreate(context.TODO(), &runner.ContainerConfig, &runner.HostConfig, nil, runner.Container.UUID)
1092 return fmt.Errorf("While creating container: %v", err)
1095 runner.ContainerID = createdBody.ID
1097 return runner.AttachStreams()
1100 // StartContainer starts the docker container created by CreateContainer.
1101 func (runner *ContainerRunner) StartContainer() error {
1102 runner.CrunchLog.Printf("Starting Docker container id '%s'", runner.ContainerID)
1103 runner.cStateLock.Lock()
1104 defer runner.cStateLock.Unlock()
1105 if runner.cCancelled {
1108 err := runner.Docker.ContainerStart(context.TODO(), runner.ContainerID,
1109 dockertypes.ContainerStartOptions{})
1112 if m, e := regexp.MatchString("(?ms).*(exec|System error).*(no such file or directory|file not found).*", err.Error()); m && e == nil {
1113 advice = fmt.Sprintf("\nPossible causes: command %q is missing, the interpreter given in #! is missing, or script has Windows line endings.", runner.Container.Command[0])
1115 return fmt.Errorf("could not start container: %v%s", err, advice)
1120 // WaitFinish waits for the container to terminate, capture the exit code, and
1121 // close the stdout/stderr logging.
1122 func (runner *ContainerRunner) WaitFinish() error {
1123 var runTimeExceeded <-chan time.Time
1124 runner.CrunchLog.Print("Waiting for container to finish")
1126 waitOk, waitErr := runner.Docker.ContainerWait(context.TODO(), runner.ContainerID, dockercontainer.WaitConditionNotRunning)
1127 arvMountExit := runner.ArvMountExit
1128 if timeout := runner.Container.SchedulingParameters.MaxRunTime; timeout > 0 {
1129 runTimeExceeded = time.After(time.Duration(timeout) * time.Second)
1132 containerGone := make(chan struct{})
1134 defer close(containerGone)
1135 if runner.containerWatchdogInterval < 1 {
1136 runner.containerWatchdogInterval = time.Minute
1138 for range time.NewTicker(runner.containerWatchdogInterval).C {
1139 ctx, cancel := context.WithDeadline(context.Background(), time.Now().Add(runner.containerWatchdogInterval))
1140 ctr, err := runner.Docker.ContainerInspect(ctx, runner.ContainerID)
1142 runner.cStateLock.Lock()
1143 done := runner.cRemoved || runner.ExitCode != nil
1144 runner.cStateLock.Unlock()
1147 } else if err != nil {
1148 runner.CrunchLog.Printf("Error inspecting container: %s", err)
1149 runner.checkBrokenNode(err)
1151 } else if ctr.State == nil || !(ctr.State.Running || ctr.State.Status == "created") {
1152 runner.CrunchLog.Printf("Container is not running: State=%v", ctr.State)
1160 case waitBody := <-waitOk:
1161 runner.CrunchLog.Printf("Container exited with code: %v", waitBody.StatusCode)
1162 code := int(waitBody.StatusCode)
1163 runner.ExitCode = &code
1165 // wait for stdout/stderr to complete
1166 <-runner.loggingDone
1169 case err := <-waitErr:
1170 return fmt.Errorf("container wait: %v", err)
1172 case <-arvMountExit:
1173 runner.CrunchLog.Printf("arv-mount exited while container is still running. Stopping container.")
1175 // arvMountExit will always be ready now that
1176 // it's closed, but that doesn't interest us.
1179 case <-runTimeExceeded:
1180 runner.CrunchLog.Printf("maximum run time exceeded. Stopping container.")
1182 runTimeExceeded = nil
1184 case <-containerGone:
1185 return errors.New("docker client never returned status")
1190 func (runner *ContainerRunner) updateLogs() {
1191 ticker := time.NewTicker(crunchLogUpdatePeriod / 360)
1194 sigusr1 := make(chan os.Signal, 1)
1195 signal.Notify(sigusr1, syscall.SIGUSR1)
1196 defer signal.Stop(sigusr1)
1198 saveAtTime := time.Now().Add(crunchLogUpdatePeriod)
1199 saveAtSize := crunchLogUpdateSize
1205 saveAtTime = time.Now()
1207 runner.logMtx.Lock()
1208 done := runner.LogsPDH != nil
1209 runner.logMtx.Unlock()
1213 size := runner.LogCollection.Size()
1214 if size == savedSize || (time.Now().Before(saveAtTime) && size < saveAtSize) {
1217 saveAtTime = time.Now().Add(crunchLogUpdatePeriod)
1218 saveAtSize = runner.LogCollection.Size() + crunchLogUpdateSize
1219 saved, err := runner.saveLogCollection(false)
1221 runner.CrunchLog.Printf("error updating log collection: %s", err)
1225 var updated arvados.Container
1226 err = runner.DispatcherArvClient.Update("containers", runner.Container.UUID, arvadosclient.Dict{
1227 "container": arvadosclient.Dict{"log": saved.PortableDataHash},
1230 runner.CrunchLog.Printf("error updating container log to %s: %s", saved.PortableDataHash, err)
1238 // CaptureOutput saves data from the container's output directory if
1239 // needed, and updates the container output accordingly.
1240 func (runner *ContainerRunner) CaptureOutput() error {
1241 if wantAPI := runner.Container.RuntimeConstraints.API; wantAPI != nil && *wantAPI {
1242 // Output may have been set directly by the container, so
1243 // refresh the container record to check.
1244 err := runner.DispatcherArvClient.Get("containers", runner.Container.UUID,
1245 nil, &runner.Container)
1249 if runner.Container.Output != "" {
1250 // Container output is already set.
1251 runner.OutputPDH = &runner.Container.Output
1256 txt, err := (&copier{
1257 client: runner.containerClient,
1258 arvClient: runner.ContainerArvClient,
1259 keepClient: runner.ContainerKeepClient,
1260 hostOutputDir: runner.HostOutputDir,
1261 ctrOutputDir: runner.Container.OutputPath,
1262 binds: runner.Binds,
1263 mounts: runner.Container.Mounts,
1264 secretMounts: runner.SecretMounts,
1265 logger: runner.CrunchLog,
1270 if n := len(regexp.MustCompile(` [0-9a-f]+\+\S*\+R`).FindAllStringIndex(txt, -1)); n > 0 {
1271 runner.CrunchLog.Printf("Copying %d data blocks from remote input collections...", n)
1272 fs, err := (&arvados.Collection{ManifestText: txt}).FileSystem(runner.containerClient, runner.ContainerKeepClient)
1276 txt, err = fs.MarshalManifest(".")
1281 var resp arvados.Collection
1282 err = runner.ContainerArvClient.Create("collections", arvadosclient.Dict{
1283 "ensure_unique_name": true,
1284 "collection": arvadosclient.Dict{
1286 "name": "output for " + runner.Container.UUID,
1287 "manifest_text": txt,
1291 return fmt.Errorf("error creating output collection: %v", err)
1293 runner.OutputPDH = &resp.PortableDataHash
1297 func (runner *ContainerRunner) CleanupDirs() {
1298 if runner.ArvMount != nil {
1300 umount := exec.Command("arv-mount", fmt.Sprintf("--unmount-timeout=%d", delay), "--unmount", runner.ArvMountPoint)
1301 umount.Stdout = runner.CrunchLog
1302 umount.Stderr = runner.CrunchLog
1303 runner.CrunchLog.Printf("Running %v", umount.Args)
1304 umnterr := umount.Start()
1307 runner.CrunchLog.Printf("Error unmounting: %v", umnterr)
1309 // If arv-mount --unmount gets stuck for any reason, we
1310 // don't want to wait for it forever. Do Wait() in a goroutine
1311 // so it doesn't block crunch-run.
1312 umountExit := make(chan error)
1314 mnterr := umount.Wait()
1316 runner.CrunchLog.Printf("Error unmounting: %v", mnterr)
1318 umountExit <- mnterr
1321 for again := true; again; {
1327 case <-runner.ArvMountExit:
1329 case <-time.After(time.Duration((delay + 1) * int64(time.Second))):
1330 runner.CrunchLog.Printf("Timed out waiting for unmount")
1332 umount.Process.Kill()
1334 runner.ArvMount.Process.Kill()
1340 if runner.ArvMountPoint != "" {
1341 if rmerr := os.Remove(runner.ArvMountPoint); rmerr != nil {
1342 runner.CrunchLog.Printf("While cleaning up arv-mount directory %s: %v", runner.ArvMountPoint, rmerr)
1346 if rmerr := os.RemoveAll(runner.parentTemp); rmerr != nil {
1347 runner.CrunchLog.Printf("While cleaning up temporary directory %s: %v", runner.parentTemp, rmerr)
1351 // CommitLogs posts the collection containing the final container logs.
1352 func (runner *ContainerRunner) CommitLogs() error {
1354 // Hold cStateLock to prevent races on CrunchLog (e.g., stop()).
1355 runner.cStateLock.Lock()
1356 defer runner.cStateLock.Unlock()
1358 runner.CrunchLog.Print(runner.finalState)
1360 if runner.arvMountLog != nil {
1361 runner.arvMountLog.Close()
1363 runner.CrunchLog.Close()
1365 // Closing CrunchLog above allows them to be committed to Keep at this
1366 // point, but re-open crunch log with ArvClient in case there are any
1367 // other further errors (such as failing to write the log to Keep!)
1368 // while shutting down
1369 runner.CrunchLog = NewThrottledLogger(&ArvLogWriter{
1370 ArvClient: runner.DispatcherArvClient,
1371 UUID: runner.Container.UUID,
1372 loggingStream: "crunch-run",
1375 runner.CrunchLog.Immediate = log.New(os.Stderr, runner.Container.UUID+" ", 0)
1378 if runner.LogsPDH != nil {
1379 // If we have already assigned something to LogsPDH,
1380 // we must be closing the re-opened log, which won't
1381 // end up getting attached to the container record and
1382 // therefore doesn't need to be saved as a collection
1383 // -- it exists only to send logs to other channels.
1386 saved, err := runner.saveLogCollection(true)
1388 return fmt.Errorf("error saving log collection: %s", err)
1390 runner.logMtx.Lock()
1391 defer runner.logMtx.Unlock()
1392 runner.LogsPDH = &saved.PortableDataHash
1396 func (runner *ContainerRunner) saveLogCollection(final bool) (response arvados.Collection, err error) {
1397 runner.logMtx.Lock()
1398 defer runner.logMtx.Unlock()
1399 if runner.LogsPDH != nil {
1400 // Already finalized.
1403 mt, err := runner.LogCollection.MarshalManifest(".")
1405 err = fmt.Errorf("error creating log manifest: %v", err)
1408 updates := arvadosclient.Dict{
1409 "name": "logs for " + runner.Container.UUID,
1410 "manifest_text": mt,
1413 updates["is_trashed"] = true
1415 exp := time.Now().Add(crunchLogUpdatePeriod * 24)
1416 updates["trash_at"] = exp
1417 updates["delete_at"] = exp
1419 reqBody := arvadosclient.Dict{"collection": updates}
1420 if runner.logUUID == "" {
1421 reqBody["ensure_unique_name"] = true
1422 err = runner.DispatcherArvClient.Create("collections", reqBody, &response)
1424 err = runner.DispatcherArvClient.Update("collections", runner.logUUID, reqBody, &response)
1429 runner.logUUID = response.UUID
1433 // UpdateContainerRunning updates the container state to "Running"
1434 func (runner *ContainerRunner) UpdateContainerRunning() error {
1435 runner.cStateLock.Lock()
1436 defer runner.cStateLock.Unlock()
1437 if runner.cCancelled {
1440 return runner.DispatcherArvClient.Update("containers", runner.Container.UUID,
1441 arvadosclient.Dict{"container": arvadosclient.Dict{"state": "Running"}}, nil)
1444 // ContainerToken returns the api_token the container (and any
1445 // arv-mount processes) are allowed to use.
1446 func (runner *ContainerRunner) ContainerToken() (string, error) {
1447 if runner.token != "" {
1448 return runner.token, nil
1451 var auth arvados.APIClientAuthorization
1452 err := runner.DispatcherArvClient.Call("GET", "containers", runner.Container.UUID, "auth", nil, &auth)
1456 runner.token = fmt.Sprintf("v2/%s/%s/%s", auth.UUID, auth.APIToken, runner.Container.UUID)
1457 return runner.token, nil
1460 // UpdateContainerComplete updates the container record state on API
1461 // server to "Complete" or "Cancelled"
1462 func (runner *ContainerRunner) UpdateContainerFinal() error {
1463 update := arvadosclient.Dict{}
1464 update["state"] = runner.finalState
1465 if runner.LogsPDH != nil {
1466 update["log"] = *runner.LogsPDH
1468 if runner.finalState == "Complete" {
1469 if runner.ExitCode != nil {
1470 update["exit_code"] = *runner.ExitCode
1472 if runner.OutputPDH != nil {
1473 update["output"] = *runner.OutputPDH
1476 return runner.DispatcherArvClient.Update("containers", runner.Container.UUID, arvadosclient.Dict{"container": update}, nil)
1479 // IsCancelled returns the value of Cancelled, with goroutine safety.
1480 func (runner *ContainerRunner) IsCancelled() bool {
1481 runner.cStateLock.Lock()
1482 defer runner.cStateLock.Unlock()
1483 return runner.cCancelled
1486 // NewArvLogWriter creates an ArvLogWriter
1487 func (runner *ContainerRunner) NewArvLogWriter(name string) (io.WriteCloser, error) {
1488 writer, err := runner.LogCollection.OpenFile(name+".txt", os.O_CREATE|os.O_WRONLY, 0666)
1492 return &ArvLogWriter{
1493 ArvClient: runner.DispatcherArvClient,
1494 UUID: runner.Container.UUID,
1495 loggingStream: name,
1496 writeCloser: writer,
1500 // Run the full container lifecycle.
1501 func (runner *ContainerRunner) Run() (err error) {
1502 runner.CrunchLog.Printf("crunch-run %s started", version)
1503 runner.CrunchLog.Printf("Executing container '%s'", runner.Container.UUID)
1505 hostname, hosterr := os.Hostname()
1507 runner.CrunchLog.Printf("Error getting hostname '%v'", hosterr)
1509 runner.CrunchLog.Printf("Executing on host '%s'", hostname)
1512 runner.finalState = "Queued"
1515 runner.CleanupDirs()
1517 runner.CrunchLog.Printf("crunch-run finished")
1518 runner.CrunchLog.Close()
1521 err = runner.fetchContainerRecord()
1525 if runner.Container.State != "Locked" {
1526 return fmt.Errorf("dispatch error detected: container %q has state %q", runner.Container.UUID, runner.Container.State)
1530 // checkErr prints e (unless it's nil) and sets err to
1531 // e (unless err is already non-nil). Thus, if err
1532 // hasn't already been assigned when Run() returns,
1533 // this cleanup func will cause Run() to return the
1534 // first non-nil error that is passed to checkErr().
1535 checkErr := func(errorIn string, e error) {
1539 runner.CrunchLog.Printf("error in %s: %v", errorIn, e)
1543 if runner.finalState == "Complete" {
1544 // There was an error in the finalization.
1545 runner.finalState = "Cancelled"
1549 // Log the error encountered in Run(), if any
1550 checkErr("Run", err)
1552 if runner.finalState == "Queued" {
1553 runner.UpdateContainerFinal()
1557 if runner.IsCancelled() {
1558 runner.finalState = "Cancelled"
1559 // but don't return yet -- we still want to
1560 // capture partial output and write logs
1563 checkErr("CaptureOutput", runner.CaptureOutput())
1564 checkErr("stopHoststat", runner.stopHoststat())
1565 checkErr("CommitLogs", runner.CommitLogs())
1566 checkErr("UpdateContainerFinal", runner.UpdateContainerFinal())
1569 runner.setupSignals()
1570 err = runner.startHoststat()
1575 // check for and/or load image
1576 err = runner.LoadImage()
1578 if !runner.checkBrokenNode(err) {
1579 // Failed to load image but not due to a "broken node"
1580 // condition, probably user error.
1581 runner.finalState = "Cancelled"
1583 err = fmt.Errorf("While loading container image: %v", err)
1587 // set up FUSE mount and binds
1588 err = runner.SetupMounts()
1590 runner.finalState = "Cancelled"
1591 err = fmt.Errorf("While setting up mounts: %v", err)
1595 err = runner.CreateContainer()
1599 err = runner.LogHostInfo()
1603 err = runner.LogNodeRecord()
1607 err = runner.LogContainerRecord()
1612 if runner.IsCancelled() {
1616 err = runner.UpdateContainerRunning()
1620 runner.finalState = "Cancelled"
1622 err = runner.startCrunchstat()
1627 err = runner.StartContainer()
1629 runner.checkBrokenNode(err)
1633 err = runner.WaitFinish()
1634 if err == nil && !runner.IsCancelled() {
1635 runner.finalState = "Complete"
1640 // Fetch the current container record (uuid = runner.Container.UUID)
1641 // into runner.Container.
1642 func (runner *ContainerRunner) fetchContainerRecord() error {
1643 reader, err := runner.DispatcherArvClient.CallRaw("GET", "containers", runner.Container.UUID, "", nil)
1645 return fmt.Errorf("error fetching container record: %v", err)
1647 defer reader.Close()
1649 dec := json.NewDecoder(reader)
1651 err = dec.Decode(&runner.Container)
1653 return fmt.Errorf("error decoding container record: %v", err)
1657 SecretMounts map[string]arvados.Mount `json:"secret_mounts"`
1660 containerToken, err := runner.ContainerToken()
1662 return fmt.Errorf("error getting container token: %v", err)
1665 runner.ContainerArvClient, runner.ContainerKeepClient,
1666 runner.containerClient, err = runner.MkArvClient(containerToken)
1668 return fmt.Errorf("error creating container API client: %v", err)
1671 err = runner.ContainerArvClient.Call("GET", "containers", runner.Container.UUID, "secret_mounts", nil, &sm)
1673 if apierr, ok := err.(arvadosclient.APIServerError); !ok || apierr.HttpStatusCode != 404 {
1674 return fmt.Errorf("error fetching secret_mounts: %v", err)
1676 // ok && apierr.HttpStatusCode == 404, which means
1677 // secret_mounts isn't supported by this API server.
1679 runner.SecretMounts = sm.SecretMounts
1684 // NewContainerRunner creates a new container runner.
1685 func NewContainerRunner(dispatcherClient *arvados.Client,
1686 dispatcherArvClient IArvadosClient,
1687 dispatcherKeepClient IKeepClient,
1688 docker ThinDockerClient,
1689 containerUUID string) (*ContainerRunner, error) {
1691 cr := &ContainerRunner{
1692 dispatcherClient: dispatcherClient,
1693 DispatcherArvClient: dispatcherArvClient,
1694 DispatcherKeepClient: dispatcherKeepClient,
1697 cr.NewLogWriter = cr.NewArvLogWriter
1698 cr.RunArvMount = cr.ArvMountCmd
1699 cr.MkTempDir = ioutil.TempDir
1700 cr.MkArvClient = func(token string) (IArvadosClient, IKeepClient, *arvados.Client, error) {
1701 cl, err := arvadosclient.MakeArvadosClient()
1703 return nil, nil, nil, err
1706 kc, err := keepclient.MakeKeepClient(cl)
1708 return nil, nil, nil, err
1710 c2 := arvados.NewClientFromEnv()
1711 c2.AuthToken = token
1712 return cl, kc, c2, nil
1715 cr.LogCollection, err = (&arvados.Collection{}).FileSystem(cr.dispatcherClient, cr.DispatcherKeepClient)
1719 cr.Container.UUID = containerUUID
1720 w, err := cr.NewLogWriter("crunch-run")
1724 cr.CrunchLog = NewThrottledLogger(w)
1725 cr.CrunchLog.Immediate = log.New(os.Stderr, containerUUID+" ", 0)
1727 loadLogThrottleParams(dispatcherArvClient)
1734 statInterval := flag.Duration("crunchstat-interval", 10*time.Second, "sampling period for periodic resource usage reporting")
1735 cgroupRoot := flag.String("cgroup-root", "/sys/fs/cgroup", "path to sysfs cgroup tree")
1736 cgroupParent := flag.String("cgroup-parent", "docker", "name of container's parent cgroup (ignored if -cgroup-parent-subsystem is used)")
1737 cgroupParentSubsystem := flag.String("cgroup-parent-subsystem", "", "use current cgroup for given subsystem as parent cgroup for container")
1738 caCertsPath := flag.String("ca-certs", "", "Path to TLS root certificates")
1739 detach := flag.Bool("detach", false, "Detach from parent process and run in the background")
1740 stdinEnv := flag.Bool("stdin-env", false, "Load environment variables from JSON message on stdin")
1741 sleep := flag.Duration("sleep", 0, "Delay before starting (testing use only)")
1742 kill := flag.Int("kill", -1, "Send signal to an existing crunch-run process for given UUID")
1743 list := flag.Bool("list", false, "List UUIDs of existing crunch-run processes")
1744 enableNetwork := flag.String("container-enable-networking", "default",
1745 `Specify if networking should be enabled for container. One of 'default', 'always':
1746 default: only enable networking if container requests it.
1747 always: containers always have networking enabled
1749 networkMode := flag.String("container-network-mode", "default",
1750 `Set networking mode for container. Corresponds to Docker network mode (--net).
1752 memprofile := flag.String("memprofile", "", "write memory profile to `file` after running container")
1753 getVersion := flag.Bool("version", false, "Print version information and exit.")
1754 flag.Duration("check-containerd", 0, "Ignored. Exists for compatibility with older versions.")
1756 ignoreDetachFlag := false
1757 if len(os.Args) > 1 && os.Args[1] == "-no-detach" {
1758 // This process was invoked by a parent process, which
1759 // has passed along its own arguments, including
1760 // -detach, after the leading -no-detach flag. Strip
1761 // the leading -no-detach flag (it's not recognized by
1762 // flag.Parse()) and ignore the -detach flag that
1764 os.Args = append([]string{os.Args[0]}, os.Args[2:]...)
1765 ignoreDetachFlag = true
1770 if *stdinEnv && !ignoreDetachFlag {
1771 // Load env vars on stdin if asked (but not in a
1772 // detached child process, in which case stdin is
1778 case *detach && !ignoreDetachFlag:
1779 os.Exit(Detach(flag.Arg(0), os.Args, os.Stdout, os.Stderr))
1781 os.Exit(KillProcess(flag.Arg(0), syscall.Signal(*kill), os.Stdout, os.Stderr))
1783 os.Exit(ListProcesses(os.Stdout, os.Stderr))
1786 // Print version information if requested
1788 fmt.Printf("crunch-run %s\n", version)
1792 log.Printf("crunch-run %s started", version)
1795 containerId := flag.Arg(0)
1797 if *caCertsPath != "" {
1798 arvadosclient.CertFiles = []string{*caCertsPath}
1801 api, err := arvadosclient.MakeArvadosClient()
1803 log.Fatalf("%s: %v", containerId, err)
1807 kc, kcerr := keepclient.MakeKeepClient(api)
1809 log.Fatalf("%s: %v", containerId, kcerr)
1811 kc.BlockCache = &keepclient.BlockCache{MaxBlocks: 2}
1814 // API version 1.21 corresponds to Docker 1.9, which is currently the
1815 // minimum version we want to support.
1816 docker, dockererr := dockerclient.NewClient(dockerclient.DefaultDockerHost, "1.21", nil, nil)
1818 cr, err := NewContainerRunner(arvados.NewClientFromEnv(), api, kc, docker, containerId)
1822 if dockererr != nil {
1823 cr.CrunchLog.Printf("%s: %v", containerId, dockererr)
1824 cr.checkBrokenNode(dockererr)
1825 cr.CrunchLog.Close()
1829 parentTemp, tmperr := cr.MkTempDir("", "crunch-run."+containerId+".")
1831 log.Fatalf("%s: %v", containerId, tmperr)
1834 cr.parentTemp = parentTemp
1835 cr.statInterval = *statInterval
1836 cr.cgroupRoot = *cgroupRoot
1837 cr.expectCgroupParent = *cgroupParent
1838 cr.enableNetwork = *enableNetwork
1839 cr.networkMode = *networkMode
1840 if *cgroupParentSubsystem != "" {
1841 p := findCgroup(*cgroupParentSubsystem)
1842 cr.setCgroupParent = p
1843 cr.expectCgroupParent = p
1848 if *memprofile != "" {
1849 f, err := os.Create(*memprofile)
1851 log.Printf("could not create memory profile: %s", err)
1853 runtime.GC() // get up-to-date statistics
1854 if err := pprof.WriteHeapProfile(f); err != nil {
1855 log.Printf("could not write memory profile: %s", err)
1857 closeerr := f.Close()
1858 if closeerr != nil {
1859 log.Printf("closing memprofile file: %s", err)
1864 log.Fatalf("%s: %v", containerId, runerr)
1868 func loadEnv(rdr io.Reader) {
1869 buf, err := ioutil.ReadAll(rdr)
1871 log.Fatalf("read stdin: %s", err)
1873 var env map[string]string
1874 err = json.Unmarshal(buf, &env)
1876 log.Fatalf("decode stdin: %s", err)
1878 for k, v := range env {
1879 err = os.Setenv(k, v)
1881 log.Fatalf("setenv(%q): %s", k, err)