force docker linux/amd64 platform (#169)

* force docker platform

* set default platform

* update imports

* add test

* temporary fix for arm

* log platform event

* update known issues

Author: niqdev

README.md

@@ -280,6 +280,10 @@ tail -F ${HOME}/.local/state/hck/log/hckctl-*.log
 just publish <MAJOR.MINOR.PATCH>
 ```
 
+## Known issues
+
+* Most of the images are built by default only for [`linux/amd64`](https://github.com/hckops/hckctl/pull/169), but they should work also on `linux/arm64`
+
 ## Roadmap
 
 * `flow` orchestrate and schedule multistage tasks, collect and output the combined results in multiple formats

go.mod

@@ -14,6 +14,7 @@ require (
 	github.com/google/uuid v1.5.0
 	github.com/mitchellh/mapstructure v1.5.0
 	github.com/moby/term v0.5.0
+	github.com/opencontainers/image-spec v1.1.0-rc2.0.20221005185240-3a7f492d3f1b
 	github.com/pkg/errors v0.9.1
 	github.com/rs/zerolog v1.31.0
 	github.com/santhosh-tekuri/jsonschema/v5 v5.3.1
@@ -91,7 +92,6 @@ require (
 	github.com/morikuni/aec v1.0.0 // indirect
 	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
 	github.com/opencontainers/go-digest v1.0.0 // indirect
-	github.com/opencontainers/image-spec v1.1.0-rc2.0.20221005185240-3a7f492d3f1b // indirect
 	github.com/opencontainers/runc v1.1.9 // indirect
 	github.com/pelletier/go-toml/v2 v2.1.0 // indirect
 	github.com/peterbourgon/diskv v2.0.1+incompatible // indirect

pkg/box/docker/docker.go

@@ -136,6 +136,7 @@ func (box *DockerBoxClient) createBox(opts *boxModel.CreateOptions) (*boxModel.B
 		ContainerConfig:              containerConfig,
 		HostConfig:                   hostConfig,
 		NetworkingConfig:             docker.BuildNetworkingConfig(networkName, networkId), // all on the same network
+		Platform:                     docker.DefaultPlatform(),
 		WaitStatus:                   false,
 		CaptureInterrupt:             false,
 		OnContainerInterruptCallback: func(string) {},

pkg/client/docker/builder.go

@@ -10,6 +10,7 @@ import (
 	"github.com/docker/docker/api/types/mount"
 	"github.com/docker/docker/api/types/network"
 	"github.com/docker/go-connections/nat"
+	ocispec "github.com/opencontainers/image-spec/specs-go/v1"
 
 	"github.com/hckops/hckctl/pkg/util"
 )
@@ -138,3 +139,10 @@ func ContainerNetworkMode(idOrName string) string {
 func BuildNetworkingConfig(networkName, networkId string) *network.NetworkingConfig {
 	return &network.NetworkingConfig{EndpointsConfig: map[string]*network.EndpointSettings{networkName: {NetworkID: networkId}}}
 }
+
+func DefaultPlatform() *ocispec.Platform {
+	return &ocispec.Platform{
+		Architecture: "amd64",
+		OS:           "linux",
+	}
+}

pkg/client/docker/builder_test.go

@@ -9,6 +9,7 @@ import (
 	"github.com/docker/docker/api/types/mount"
 	"github.com/docker/docker/api/types/network"
 	"github.com/docker/go-connections/nat"
+	ocispec "github.com/opencontainers/image-spec/specs-go/v1"
 )
 
 func TestBuildContainerConfig(t *testing.T) {
@@ -137,3 +138,8 @@ func TestBuildNetworkingConfig(t *testing.T) {
 	result := BuildNetworkingConfig("myNetwork", "123")
 	assert.Equal(t, expected, result)
 }
+
+func TestDefaultPlatform(t *testing.T) {
+	expected := &ocispec.Platform{Architecture: "amd64", OS: "linux"}
+	assert.Equal(t, expected, DefaultPlatform())
+}

pkg/client/docker/client.go

@@ -43,7 +43,7 @@ func (client *DockerClient) Close() error {
 
 func (client *DockerClient) ImagePull(opts *ImagePullOpts) error {
 
-	reader, err := client.docker.ImagePull(client.ctx, opts.ImageName, types.ImagePullOptions{})
+	reader, err := client.docker.ImagePull(client.ctx, opts.ImageName, types.ImagePullOptions{Platform: opts.PlatformString()})
 	if err != nil {
 		return errors.Wrap(err, "error image pull")
 	}
@@ -90,7 +90,7 @@ func (client *DockerClient) ContainerCreate(opts *ContainerCreateOpts) (string,
 		opts.ContainerConfig,
 		opts.HostConfig,
 		opts.NetworkingConfig,
-		nil, // platform
+		opts.Platform, // consistent with ImagePull, on ARM it works also if "nil"
 		opts.ContainerName)
 	if err != nil {
 		return "", errors.Wrap(err, "error container create")

pkg/client/docker/client_test.go

@@ -100,3 +100,10 @@ func TestNewContainerDetails(t *testing.T) {
 	assert.NoError(t, err)
 	assert.Equal(t, expected, containerDetails)
 }
+
+func TestImagePlatform(t *testing.T) {
+	opts := &ImagePullOpts{
+		Platform: DefaultPlatform(),
+	}
+	assert.Equal(t, "linux/amd64", opts.PlatformString())
+}

pkg/client/docker/options.go

@@ -1,10 +1,12 @@
 package docker
 
 import (
+	"fmt"
 	"io"
 
 	"github.com/docker/docker/api/types/container"
 	"github.com/docker/docker/api/types/network"
+	ocispec "github.com/opencontainers/image-spec/specs-go/v1"
 
 	commonModel "github.com/hckops/hckctl/pkg/common/model"
 )
@@ -33,9 +35,14 @@ type ContainerPortConfigOpts struct {
 
 type ImagePullOpts struct {
 	ImageName           string
+	Platform            *ocispec.Platform
 	OnImagePullCallback func()
 }
 
+func (o *ImagePullOpts) PlatformString() string {
+	return fmt.Sprintf("%s/%s", o.Platform.OS, o.Platform.Architecture)
+}
+
 type ImageRemoveOpts struct {
 	OnImageRemoveCallback      func(imageId string)
 	OnImageRemoveErrorCallback func(imageId string, err error)
@@ -46,6 +53,7 @@ type ContainerCreateOpts struct {
 	ContainerConfig              *container.Config
 	HostConfig                   *container.HostConfig
 	NetworkingConfig             *network.NetworkingConfig
+	Platform                     *ocispec.Platform
 	WaitStatus                   bool
 	CaptureInterrupt             bool
 	OnContainerInterruptCallback func(containerId string)

pkg/common/docker/client.go

@@ -46,11 +46,18 @@ func (common *DockerCommonClient) Close() error {
 
 func (common *DockerCommonClient) PullImageOffline(imageName string, onImagePullCallback func()) error {
 
+	// TODO add support at least for linux/arm64
+	// temporary solution to force the architecture, ideally:
+	// - every image should be correctly built for all the architectures
+	// - the templates should have a field with the list of supported architectures and use the default only as fallback
+	platform := docker.DefaultPlatform()
+
 	imagePullOpts := &docker.ImagePullOpts{
 		ImageName:           imageName,
+		Platform:            platform,
 		OnImagePullCallback: onImagePullCallback,
 	}
-	common.eventBus.Publish(newImagePullDockerEvent(imageName))
+	common.eventBus.Publish(newImagePullDockerEvent(imageName, imagePullOpts.PlatformString()))
 	if err := common.client.ImagePull(imagePullOpts); err != nil {
 		// ignore error and try to use an existing image if exists
 		if common.clientOpts.IgnoreImagePullError {
@@ -150,6 +157,7 @@ func (common *DockerCommonClient) SidecarVpnInject(opts *commonModel.SidecarVpnI
 		ContainerName:    containerName,
 		ContainerConfig:  containerConfig,
 		HostConfig:       hostConfig,
+		Platform:         docker.DefaultPlatform(),
 		WaitStatus:       false,
 		CaptureInterrupt: false, // edge case: killing this while creating will leave an orphan sidecar container
 		OnContainerCreateCallback: func(containerId string) error {

pkg/common/docker/events.go

@@ -32,8 +32,8 @@ func newCloseDockerClientEvent() *dockerCommonEvent {
 	return &dockerCommonEvent{kind: event.LogDebug, value: "close docker client"}
 }
 
-func newImagePullDockerEvent(imageName string) *dockerCommonEvent {
-	return &dockerCommonEvent{kind: event.LogInfo, value: fmt.Sprintf("image pull: imageName=%s", imageName)}
+func newImagePullDockerEvent(imageName string, platform string) *dockerCommonEvent {
+	return &dockerCommonEvent{kind: event.LogInfo, value: fmt.Sprintf("image pull: imageName=%s platform=%s", imageName, platform)}
 }
 
 func newImagePullIgnoreDockerEvent(imageName string) *dockerCommonEvent {

pkg/task/docker/docker.go

@@ -101,7 +101,8 @@ func (task *DockerTaskClient) runTask(opts *taskModel.RunOptions) error {
 		ContainerConfig:  containerConfig,
 		HostConfig:       hostConfig,
 		NetworkingConfig: docker.BuildNetworkingConfig(networkName, networkId), // all on the same network
-		WaitStatus:       true,                                                 // block
+		Platform:         docker.DefaultPlatform(),
+		WaitStatus:       true, // block
 		CaptureInterrupt: true,
 		OnContainerInterruptCallback: func(containerId string) {
 			// returns control to runTask, it will correctly invoke defer to remove the sidecar