dotcloud/docker

package client // import "github.com/docker/docker/client"

import (
    "context"
    "encoding/json"
    "net/url"
    "path"
    "sort"
    "strings"

    "github.com/docker/docker/api/types/container"
    "github.com/docker/docker/api/types/network"
    "github.com/docker/docker/api/types/versions"
    ocispec "github.com/opencontainers/image-spec/specs-go/v1"
)

// ContainerCreate creates a new container based on the given configuration.
// It can be associated with a name, but it's not mandatory.
func (cli *Client) ContainerCreate(ctx context.Context, config *container.Config, hostConfig *container.HostConfig, networkingConfig *network.NetworkingConfig, platform *ocispec.Platform, containerName string) (container.CreateResponse, error) {
    var response container.CreateResponse

    // Make sure we negotiated (if the client is configured to do so),
    // as code below contains API-version specific handling of options.
    //
    // Normally, version-negotiation (if enabled) would not happen until
    // the API request is made.
    if err := cli.checkVersion(ctx); err != nil {
        return response, err
    }

    if err := cli.NewVersionError(ctx, "1.25", "stop timeout"); config != nil && config.StopTimeout != nil && err != nil {
        return response, err
    }
    if err := cli.NewVersionError(ctx, "1.41", "specify container image platform"); platform != nil && err != nil {
        return response, err
    }
    if err := cli.NewVersionError(ctx, "1.44", "specify health-check start interval"); config != nil && config.Healthcheck != nil && config.Healthcheck.StartInterval != 0 && err != nil {
        return response, err
    }
    if err := cli.NewVersionError(ctx, "1.44", "specify mac-address per network"); hasEndpointSpecificMacAddress(networkingConfig) && err != nil {
        return response, err
    }

    if hostConfig != nil {
        if versions.LessThan(cli.ClientVersion(), "1.25") {
            // When using API 1.24 and under, the client is responsible for removing the container
            hostConfig.AutoRemove = false
        }
        if versions.GreaterThanOrEqualTo(cli.ClientVersion(), "1.42") || versions.LessThan(cli.ClientVersion(), "1.40") {
            // KernelMemory was added in API 1.40, and deprecated in API 1.42
            hostConfig.KernelMemory = 0
        }
        if platform != nil && platform.OS == "linux" && versions.LessThan(cli.ClientVersion(), "1.42") {
            // When using API under 1.42, the Linux daemon doesn't respect the ConsoleSize
            hostConfig.ConsoleSize = [2]uint{0, 0}
        }

        hostConfig.CapAdd = normalizeCapabilities(hostConfig.CapAdd)
        hostConfig.CapDrop = normalizeCapabilities(hostConfig.CapDrop)
    }

    // Since API 1.44, the container-wide MacAddress is deprecated and will trigger a WARNING if it's specified.
    if versions.GreaterThanOrEqualTo(cli.ClientVersion(), "1.44") {
        config.MacAddress = "" //nolint:staticcheck // ignore SA1019: field is deprecated, but still used on API < v1.44.
    }

    query := url.Values{}
    if p := formatPlatform(platform); p != "" {
        query.Set("platform", p)
    }

    if containerName != "" {
        query.Set("name", containerName)
    }

    body := container.CreateRequest{
        Config:           config,
        HostConfig:       hostConfig,
        NetworkingConfig: networkingConfig,
    }

    serverResp, err := cli.post(ctx, "/containers/create", query, body, nil)
    defer ensureReaderClosed(serverResp)
    if err != nil {
        return response, err
    }

    err = json.NewDecoder(serverResp.body).Decode(&response)
    return response, err
}

// formatPlatform returns a formatted string representing platform (e.g. linux/arm/v7).
//
// Similar to containerd's platforms.Format(), but does allow components to be
// omitted (e.g. pass "architecture" only, without "os":
// https://github.com/containerd/containerd/blob/v1.5.2/platforms/platforms.go#L243-L263
func formatPlatform(platform *ocispec.Platform) string {
    if platform == nil {
        return ""
    }
    return path.Join(platform.OS, platform.Architecture, platform.Variant)
}

// hasEndpointSpecificMacAddress checks whether one of the endpoint in networkingConfig has a MacAddress defined.
func hasEndpointSpecificMacAddress(networkingConfig *network.NetworkingConfig) bool {
    if networkingConfig == nil {
        return false
    }
    for _, endpoint := range networkingConfig.EndpointsConfig {
        if endpoint.MacAddress != "" {
            return true
        }
    }
    return false
}

// allCapabilities is a magic value for "all capabilities"
const allCapabilities = "ALL"

// normalizeCapabilities normalizes capabilities to their canonical form,
// removes duplicates, and sorts the results.
//
// It is similar to [github.com/docker/docker/oci/caps.NormalizeLegacyCapabilities],
// but performs no validation based on supported capabilities.
func normalizeCapabilities(caps []string) []string {
    var normalized []string

    unique := make(map[string]struct{})
    for _, c := range caps {
        c = normalizeCap(c)
        if _, ok := unique[c]; ok {
            continue
        }
        unique[c] = struct{}{}
        normalized = append(normalized, c)
    }

    sort.Strings(normalized)
    return normalized
}

// normalizeCap normalizes a capability to its canonical format by upper-casing
// and adding a "CAP_" prefix (if not yet present). It also accepts the "ALL"
// magic-value.
func normalizeCap(cap string) string {
    cap = strings.ToUpper(cap)
    if cap == allCapabilities {
        return cap
    }
    if !strings.HasPrefix(cap, "CAP_") {
        cap = "CAP_" + cap
    }
    return cap
}