packer-cn/builder/docker/config.go

199 lines
7.6 KiB
Go
Raw Normal View History

//go:generate struct-markdown
//go:generate mapstructure-to-hcl2 -type Config
2013-11-08 19:55:02 -05:00
package docker
import (
2013-11-09 14:47:32 -05:00
"fmt"
"os"
2017-04-04 16:39:01 -04:00
"github.com/hashicorp/packer/common"
"github.com/hashicorp/packer/helper/communicator"
"github.com/hashicorp/packer/helper/config"
"github.com/hashicorp/packer/packer"
"github.com/hashicorp/packer/template/interpolate"
"github.com/mitchellh/mapstructure"
2013-11-08 19:55:02 -05:00
)
var (
2015-08-19 16:12:16 -04:00
errArtifactNotUsed = fmt.Errorf("No instructions given for handling the artifact; expected commit, discard, or export_path")
errArtifactUseConflict = fmt.Errorf("Cannot specify more than one of commit, discard, and export_path")
errExportPathNotFile = fmt.Errorf("export_path must be a file, not a directory")
errImageNotSpecified = fmt.Errorf("Image must be specified")
)
2013-11-08 19:55:02 -05:00
type Config struct {
common.PackerConfig `mapstructure:",squash"`
Comm communicator.Config `mapstructure:",squash"`
2013-11-08 19:55:02 -05:00
// Set the author (e-mail) of a commit.
Author string `mapstructure:"author"`
// Dockerfile instructions to add to the commit. Example of instructions
// are CMD, ENTRYPOINT, ENV, and EXPOSE. Example: [ "USER ubuntu", "WORKDIR
// /app", "EXPOSE 8080" ]
Changes []string `mapstructure:"changes"`
// If true, the container will be committed to an image rather than exported.
Commit bool `mapstructure:"commit" required:"true"`
// The directory inside container to mount temp directory from host server
// for work [file provisioner](/docs/provisioners/file.html). This defaults
// to c:/packer-files on windows and /packer-files on other systems.
2019-06-06 10:29:25 -04:00
ContainerDir string `mapstructure:"container_dir" required:"false"`
// Throw away the container when the build is complete. This is useful for
// the [artifice
// post-processor](https://www.packer.io/docs/post-processors/artifice.html).
Discard bool `mapstructure:"discard" required:"true"`
// Username (UID) to run remote commands with. You can also set the group
// name/ID if you want: (UID or UID:GID). You may need this if you get
// permission errors trying to run the shell or other provisioners.
ExecUser string `mapstructure:"exec_user" required:"false"`
// The path where the final container will be exported as a tar file.
ExportPath string `mapstructure:"export_path" required:"true"`
// The base image for the Docker container that will be started. This image
// will be pulled from the Docker registry if it doesn't already exist.
Image string `mapstructure:"image" required:"true"`
// Set a message for the commit.
Message string `mapstructure:"message" required:"true"`
// If true, run the docker container with the `--privileged` flag. This
// defaults to false if not set.
2019-06-06 10:29:25 -04:00
Privileged bool `mapstructure:"privileged" required:"false"`
Pty bool
// If true, the configured image will be pulled using `docker pull` prior
// to use. Otherwise, it is assumed the image already exists and can be
// used. This defaults to true if not set.
Pull bool `mapstructure:"pull" required:"false"`
// An array of arguments to pass to docker run in order to run the
// container. By default this is set to ["-d", "-i", "-t",
// "--entrypoint=/bin/sh", "--", "{{.Image}}"] if you are using a linux
// container, and ["-d", "-i", "-t", "--entrypoint=powershell", "--",
// "{{.Image}}"] if you are running a windows container. {{.Image}} is a
// template variable that corresponds to the image template option. Passing
// the entrypoint option this way will make it the default entrypoint of
// the resulting image, so running docker run -it --rm will start the
// docker image from the /bin/sh shell interpreter; you could run a script
// or another shell by running docker run -it --rm -c /bin/bash. If your
// docker image embeds a binary intended to be run often, you should
// consider changing the default entrypoint to point to it.
2019-06-06 10:29:25 -04:00
RunCommand []string `mapstructure:"run_command" required:"false"`
// A mapping of additional volumes to mount into this container. The key of
// the object is the host path, the value is the container path.
Volumes map[string]string `mapstructure:"volumes" required:"false"`
// If true, files uploaded to the container will be owned by the user the
// container is running as. If false, the owner will depend on the version
// of docker installed in the system. Defaults to true.
2019-06-06 10:29:25 -04:00
FixUploadOwner bool `mapstructure:"fix_upload_owner" required:"false"`
// If "true", tells Packer that you are building a Windows container
// running on a windows host. This is necessary for building Windows
// containers, because our normal docker bindings do not work for them.
WindowsContainer bool `mapstructure:"windows_container" required:"false"`
2013-11-09 01:00:57 -05:00
2015-08-18 19:55:29 -04:00
// This is used to login to dockerhub to pull a private base container. For
// pushing to dockerhub, see the docker post-processors
Login bool `mapstructure:"login" required:"false"`
// The password to use to authenticate to login.
2019-06-06 10:29:25 -04:00
LoginPassword string `mapstructure:"login_password" required:"false"`
// The server address to login to.
2019-06-06 10:29:25 -04:00
LoginServer string `mapstructure:"login_server" required:"false"`
// The username to use to authenticate to login.
2019-06-06 10:29:25 -04:00
LoginUsername string `mapstructure:"login_username" required:"false"`
// Defaults to false. If true, the builder will login in order to pull the
// image from Amazon EC2 Container Registry (ECR). The builder only logs in
// for the duration of the pull. If true login_server is required and
// login, login_username, and login_password will be ignored. For more
2019-06-06 10:29:25 -04:00
// information see the section on ECR.
EcrLogin bool `mapstructure:"ecr_login" required:"false"`
AwsAccessConfig `mapstructure:",squash"`
2015-07-16 22:34:36 -04:00
ctx interpolate.Context
2013-11-08 19:55:02 -05:00
}
2013-11-09 14:47:32 -05:00
2013-11-09 20:07:14 -05:00
func NewConfig(raws ...interface{}) (*Config, []string, error) {
c := new(Config)
2013-11-09 20:07:14 -05:00
c.FixUploadOwner = true
var md mapstructure.Metadata
err := config.Decode(c, &config.DecodeOpts{
Metadata: &md,
Interpolate: true,
InterpolateContext: &c.ctx,
InterpolateFilter: &interpolate.RenderFilter{
Exclude: []string{
"run_command",
},
},
}, raws...)
2013-11-09 20:07:14 -05:00
if err != nil {
return nil, nil, err
}
// Defaults
if len(c.RunCommand) == 0 {
c.RunCommand = []string{"-d", "-i", "-t", "--entrypoint=/bin/sh", "--", "{{.Image}}"}
if c.WindowsContainer {
c.RunCommand = []string{"-d", "-i", "-t", "--entrypoint=powershell", "--", "{{.Image}}"}
}
}
// Default Pull if it wasn't set
hasPull := false
for _, k := range md.Keys {
if k == "pull" {
hasPull = true
break
}
}
if !hasPull {
c.Pull = true
}
// Default to the normal Docker type
if c.Comm.Type == "" {
c.Comm.Type = "docker"
if c.WindowsContainer {
c.Comm.Type = "dockerWindowsContainer"
}
}
var errs *packer.MultiError
if es := c.Comm.Prepare(&c.ctx); len(es) > 0 {
errs = packer.MultiErrorAppend(errs, es...)
}
2013-11-09 14:47:32 -05:00
if c.Image == "" {
2015-08-19 16:12:16 -04:00
errs = packer.MultiErrorAppend(errs, errImageNotSpecified)
2013-11-09 20:07:14 -05:00
}
if (c.ExportPath != "" && c.Commit) || (c.ExportPath != "" && c.Discard) || (c.Commit && c.Discard) {
2015-08-19 16:12:16 -04:00
errs = packer.MultiErrorAppend(errs, errArtifactUseConflict)
}
if c.ExportPath == "" && !c.Commit && !c.Discard {
2015-08-19 16:12:16 -04:00
errs = packer.MultiErrorAppend(errs, errArtifactNotUsed)
}
if c.ExportPath != "" {
if fi, err := os.Stat(c.ExportPath); err == nil && fi.IsDir() {
2015-08-19 16:12:16 -04:00
errs = packer.MultiErrorAppend(errs, errExportPathNotFile)
}
}
2017-07-17 12:08:33 -04:00
if c.ContainerDir == "" {
if c.WindowsContainer {
c.ContainerDir = "c:/packer-files"
} else {
c.ContainerDir = "/packer-files"
}
2017-07-17 12:08:33 -04:00
}
if c.EcrLogin && c.LoginServer == "" {
errs = packer.MultiErrorAppend(errs, fmt.Errorf("ECR login requires login server to be provided."))
}
2013-11-09 20:07:14 -05:00
if errs != nil && len(errs.Errors) > 0 {
return nil, nil, errs
2013-11-09 14:47:32 -05:00
}
return c, nil, nil
2013-11-09 14:47:32 -05:00
}