mirror of
https://github.com/docker/compose.git
synced 2026-06-28 04:03:48 +00:00
1fdbcb6255
The big change here is to pass around an explicit `*BuildOptions` object
as part of Compose operations like `up` & `run` that may or may not do
builds. If the options object is `nil`, no builds whatsoever will be
attempted.
Motivation is to allow for partial rebuilds in the context of an `up`
for watch. This was broken and tricky to accomplish because various parts
of the Compose APIs mutate the `*Project` for convenience in ways that
make it unusable afterwards. (For example, it might set `service.Build = nil`
because it's not going to build that service right _then_. But we might
still want to build it later!)
NOTE: This commit does not actually touch the watch logic. This is all
in preparation to make it possible.
As part of this, a bunch of code moved around and I eliminated a bunch
of partially redundant logic, mostly around multi-platform. Several
edge cases have been addressed as part of this:
* `DOCKER_DEFAULT_PLATFORM` was _overriding_ explicitly set platforms
in some cases, this is no longer true, and it behaves like the Docker
CLI now
* It was possible for Compose to build an image for one platform and
then try to run it for a different platform (and fail)
* Errors are no longer returned if a local image exists but for the
wrong platform - the correct platform will be fetched/built (if
possible).
Because there's a LOT of subtlety and tricky logic here, I've also tried
to add an excessive amount of explanatory comments.
Signed-off-by: Milas Bowman <milas.bowman@docker.com>
76 lines
3.1 KiB
Go
76 lines
3.1 KiB
Go
/*
|
|
Copyright 2023 Docker Compose CLI 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 compose
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"github.com/compose-spec/compose-go/types"
|
|
"github.com/docker/compose/v2/pkg/utils"
|
|
)
|
|
|
|
func applyPlatforms(project *types.Project, buildForSinglePlatform bool) error {
|
|
defaultPlatform := project.Environment["DOCKER_DEFAULT_PLATFORM"]
|
|
for i := range project.Services {
|
|
// mutable reference so platform fields can be updated
|
|
service := &project.Services[i]
|
|
|
|
if service.Build == nil {
|
|
continue
|
|
}
|
|
|
|
// default platform only applies if the service doesn't specify
|
|
if defaultPlatform != "" && service.Platform == "" {
|
|
if len(service.Build.Platforms) > 0 && !utils.StringContains(service.Build.Platforms, defaultPlatform) {
|
|
return fmt.Errorf("service %q build.platforms does not support value set by DOCKER_DEFAULT_PLATFORM: %s", service.Name, defaultPlatform)
|
|
}
|
|
service.Platform = defaultPlatform
|
|
}
|
|
|
|
if service.Platform != "" {
|
|
if len(service.Build.Platforms) > 0 {
|
|
if !utils.StringContains(service.Build.Platforms, service.Platform) {
|
|
return fmt.Errorf("service %q build configuration does not support platform: %s", service.Name, service.Platform)
|
|
}
|
|
}
|
|
|
|
if buildForSinglePlatform || len(service.Build.Platforms) == 0 {
|
|
// if we're building for a single platform, we want to build for the platform we'll use to run the image
|
|
// similarly, if no build platforms were explicitly specified, it makes sense to build for the platform
|
|
// the image is designed for rather than allowing the builder to infer the platform
|
|
service.Build.Platforms = []string{service.Platform}
|
|
}
|
|
}
|
|
|
|
// services can specify that they should be built for multiple platforms, which can be used
|
|
// with `docker compose build` to produce a multi-arch image
|
|
// other cases, such as `up` and `run`, need a single architecture to actually run
|
|
// if there is only a single platform present (which might have been inferred
|
|
// from service.Platform above), it will be used, even if it requires emulation.
|
|
// if there's more than one platform, then the list is cleared so that the builder
|
|
// can decide.
|
|
// TODO(milas): there's no validation that the platform the builder will pick is actually one
|
|
// of the supported platforms from the build definition
|
|
// e.g. `build.platforms: [linux/arm64, linux/amd64]` on a `linux/ppc64` machine would build
|
|
// for `linux/ppc64` instead of returning an error that it's not a valid platform for the service.
|
|
if buildForSinglePlatform && len(service.Build.Platforms) > 1 {
|
|
// empty indicates that the builder gets to decide
|
|
service.Build.Platforms = nil
|
|
}
|
|
}
|
|
return nil
|
|
}
|