-
Notifications
You must be signed in to change notification settings - Fork 135
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
The new agent requires a container runtime to execute workflow actions. This commit introduces a Docker runtime. Signed-off-by: Chris Doherty <chris.doherty4@gmail.com>
- Loading branch information
1 parent
0dfb4e6
commit bbeda78
Showing
8 changed files
with
691 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| package runtime | ||
|
|
||
| const ( | ||
| // ReasonMountPath is the path used by Actions to write their failure reasons. | ||
| ReasonMountPath = "/tinkerbell/failure-reason" | ||
|
|
||
| // MessageMountPath is the path used by Actions to write their failure message. | ||
| MessageMountPath = "/tinkerbell/failure-message" | ||
| ) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,177 @@ | ||
| package runtime | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "io" | ||
| "regexp" | ||
|
|
||
| "github.com/docker/docker/api/types" | ||
| "github.com/docker/docker/api/types/container" | ||
| "github.com/docker/docker/api/types/mount" | ||
| "github.com/docker/docker/client" | ||
| "github.com/go-logr/logr" | ||
| "github.com/tinkerbell/tink/internal/agent" | ||
| "github.com/tinkerbell/tink/internal/agent/runtime/internal" | ||
| "github.com/tinkerbell/tink/internal/agent/workflow" | ||
| "github.com/tinkerbell/tink/internal/ptr" | ||
| ) | ||
|
|
||
| var _ agent.ContainerRuntime = &Docker{} | ||
|
|
||
| // DockerOptions defines the options for configuring a Docker instance. | ||
| type DockerOptions struct { | ||
| // Logger defines the logger to be used by the Docker instance. | ||
| // Defaults to logr.Discard(). | ||
| Logger logr.Logger | ||
|
|
||
| // Client is the client to be used by the Docker instance. | ||
| // Defaults to client.NewClientWithOpts(client.FromEnv). | ||
| Client *client.Client | ||
| } | ||
|
|
||
| // Docker is a docker runtime that satisfies agent.ContainerRuntime. | ||
| type Docker struct { | ||
| log logr.Logger | ||
| client *client.Client | ||
| } | ||
|
|
||
| // NewDocker creates a new Docker instance. | ||
| func NewDocker(opts DockerOptions) (*Docker, error) { | ||
| if opts.Client == nil { | ||
| clnt, err := client.NewClientWithOpts(client.FromEnv) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| clnt.NegotiateAPIVersion(context.Background()) | ||
| opts.Client = clnt | ||
| } | ||
|
|
||
| if opts.Logger.GetSink() == nil { | ||
| opts.Logger = logr.Discard() | ||
| } | ||
|
|
||
| return &Docker{ | ||
| log: opts.Logger, | ||
| client: opts.Client, | ||
| }, nil | ||
| } | ||
|
|
||
| // Run satisfies agent.ContainerRuntime. | ||
| func (d *Docker) Run(ctx context.Context, a workflow.Action) error { | ||
| // We need the image to be available before we can create a container. | ||
| image, err := d.client.ImagePull(ctx, a.Image, types.ImagePullOptions{}) | ||
| if err != nil { | ||
| return fmt.Errorf("docker: %w", err) | ||
| } | ||
| defer image.Close() | ||
|
|
||
| // Docker requires everything to be read from the images ReadCloser for the image to actually | ||
| // be pulled. We may want to log image pulls in a circular buffer somewhere for debugability. | ||
| if _, err = io.Copy(io.Discard, image); err != nil { | ||
| return fmt.Errorf("docker: %w", err) | ||
| } | ||
| // Close should be idempotent and we don't need the handle beyond this point. | ||
| image.Close() | ||
|
|
||
| // TODO: Support all the other things on the action such as volumes. | ||
| cfg := container.Config{ | ||
| Image: a.Image, | ||
| Env: toDockerEnv(a.Env), | ||
| } | ||
|
|
||
| failureFiles, err := internal.NewFailureFiles() | ||
| if err != nil { | ||
| return fmt.Errorf("create action failure files: %w", err) | ||
| } | ||
| defer failureFiles.Close() | ||
|
|
||
| hostCfg := container.HostConfig{ | ||
| Mounts: []mount.Mount{ | ||
| { | ||
| Type: mount.TypeBind, | ||
| Source: failureFiles.ReasonPath(), | ||
| Target: ReasonMountPath, | ||
| }, | ||
| { | ||
| Type: mount.TypeBind, | ||
| Source: failureFiles.MessagePath(), | ||
| Target: MessageMountPath, | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| containerName := toValidContainerName(a.ID) | ||
|
|
||
| // Docker uses the entrypoint as the default command. The Tink Action Cmd property is modeled | ||
| // as being the command launched in the container hence it is used as the entrypoint. Args | ||
| // on the action are therefore the command portion in Docker. | ||
| if a.Cmd != "" { | ||
| cfg.Entrypoint = append(cfg.Entrypoint, a.Cmd) | ||
| } | ||
| if len(a.Args) > 0 { | ||
| cfg.Cmd = append(cfg.Cmd, a.Args...) | ||
| } | ||
|
|
||
| // TODO: Figure out container logging. | ||
|
|
||
| create, err := d.client.ContainerCreate(ctx, &cfg, &hostCfg, nil, nil, containerName) | ||
| if err != nil { | ||
| return fmt.Errorf("docker: %w", err) | ||
| } | ||
|
|
||
| // Always try to remove the container on exit. | ||
| defer func() { | ||
| // We can't use the context passed to Run() as it may have been cancelled. | ||
| err := d.client.ContainerRemove(context.Background(), create.ID, types.ContainerRemoveOptions{}) | ||
| if err != nil { | ||
| d.log.Info("Couldn't remove container", "container_name", containerName, "error", err) | ||
| } | ||
| }() | ||
|
|
||
| // Issue the wait with a 'next-exit' condition so we can await a response originating from | ||
| // ContainerStart(). | ||
| waitBody, waitErr := d.client.ContainerWait(ctx, create.ID, container.WaitConditionNextExit) | ||
|
|
||
| if err := d.client.ContainerStart(ctx, create.ID, types.ContainerStartOptions{}); err != nil { | ||
| return fmt.Errorf("docker: %w", err) | ||
| } | ||
|
|
||
| select { | ||
| case result := <-waitBody: | ||
| if result.StatusCode == 0 { | ||
| return nil | ||
| } | ||
| return failureFiles.ToError() | ||
|
|
||
| case err := <-waitErr: | ||
| return fmt.Errorf("docker: %w", err) | ||
|
|
||
| case <-ctx.Done(): | ||
| // We can't use the context passed to Run() as its been cancelled. | ||
| err := d.client.ContainerStop(context.Background(), create.ID, container.StopOptions{ | ||
| Timeout: ptr.Int(5), | ||
| }) | ||
| if err != nil { | ||
| d.log.Info("Failed to gracefully stop container", "error", err) | ||
| } | ||
| return fmt.Errorf("docker: %w", ctx.Err()) | ||
| } | ||
| } | ||
|
|
||
| func toDockerEnv(env map[string]string) []string { | ||
| var de []string | ||
| for k, v := range env { | ||
| de = append(de, fmt.Sprintf("%v=%v", k, v)) | ||
| } | ||
| return de | ||
| } | ||
|
|
||
| var validContainerNameRegex = regexp.MustCompile(`[^a-zA-Z0-9_.-]`) | ||
|
|
||
| // toValidContainerName returns a valid container name for docker. Container names must satisfy | ||
| // [a-zA-Z0-9][a-zA-Z0-9_.-]. | ||
| func toValidContainerName(name string) string { | ||
| // Prepend 'action_' so we guarantee the additional constraints on the first character. | ||
| return "action_" + validContainerNameRegex.ReplaceAllString(name, "_") | ||
| } |
Oops, something went wrong.