Add Support for linux arm64 images (#1074)

prafull01 · web-flow · commit e0b56e0facad · 2024-12-23T23:09:04.000+05:30
diff --git a/BUILD.bazel b/BUILD.bazel
@@ -2,7 +2,8 @@
 # gazelle:proto disable_global
 # gazelle:exclude docs/generated/reference/generate/json_swagger
 
-load("@io_bazel_rules_docker//container:container.bzl", "container_push")
+load("@bazel_skylib//rules:native_binary.bzl", "native_binary")
+load("@aspect_bazel_lib//lib:expand_template.bzl", "expand_template")
 
 # export WORKSPACE so workspace_binary rules can be used outside the root
 exports_files([
@@ -14,16 +15,23 @@ exports_files([
 
 # TODO
 load("@bazel_gazelle//:def.bzl", "gazelle")
+load("@rules_oci//oci:defs.bzl", "oci_push")
 
 gazelle(name = "gazelle")
 
-container_push(
+expand_template(
+    name = "tags",
+    stamp_substitutions = {
+        "APP_VERSION": "{{STABLE_DOCKER_TAG}}",
+    },
+    template = ["APP_VERSION"],
+)
+
+oci_push(
     name = "push_operator_image",
-    format = "Docker",
-    image = "//cmd/cockroach-operator:operator_image",
-    registry = "{STABLE_DOCKER_REGISTRY}",
-    repository = "{STABLE_IMAGE_REPOSITORY}",
-    tag = "{STABLE_DOCKER_TAG}",
+    image = "//cmd/cockroach-operator:index",
+    remote_tags = ":tags",
+    repository = "${DOCKER_REGISTRY}/${DOCKER_IMAGE_REPOSITORY}",
 )
 
 filegroup(
diff --git a/Makefile b/Makefile
@@ -330,7 +330,7 @@ release/image:
 	DOCKER_REGISTRY=$(DOCKER_REGISTRY) \
 	DOCKER_IMAGE_REPOSITORY=$(DOCKER_IMAGE_REPOSITORY) \
 	APP_VERSION=$(APP_VERSION) \
-	bazel run --stamp --platforms=@io_bazel_rules_go//go/toolchain:linux_amd64 \
+	bazel run --stamp \
 		//:push_operator_image
 
 #
diff --git a/WORKSPACE b/WORKSPACE
@@ -64,40 +64,53 @@ gazelle_dependencies()
 # gazelle:repository_macro hack/build/repos.bzl%_go_dependencies
 go_dependencies()
 
-######################################
-# Load rules_docker and dependencies #
-######################################
+################################
+# begin rules_oci dependencies #
+################################
 http_archive(
-    name = "io_bazel_rules_docker",
-    sha256 = "92779d3445e7bdc79b961030b996cb0c91820ade7ffa7edca69273f404b085d5",
-    strip_prefix = "rules_docker-0.20.0",
-    urls = ["https://github.com/bazelbuild/rules_docker/releases/download/v0.20.0/rules_docker-v0.20.0.tar.gz"],
+    name = "aspect_bazel_lib",
+    sha256 = "d0529773764ac61184eb3ad3c687fb835df5bee01afedf07f0cf1a45515c96bc",
+    strip_prefix = "bazel-lib-1.42.3",
+    url = "https://storage.googleapis.com/public-bazel-artifacts/bazel/bazel-lib-v1.42.3.tar.gz",
 )
 
-load(
-    "@io_bazel_rules_docker//repositories:repositories.bzl",
-    container_repositories = "repositories",
+http_archive(
+    name = "rules_oci",
+    sha256 = "21a7d14f6ddfcb8ca7c5fc9ffa667c937ce4622c7d2b3e17aea1ffbc90c96bed",
+    strip_prefix = "rules_oci-1.4.0",
+    url = "https://storage.googleapis.com/public-bazel-artifacts/bazel/rules_oci-v1.4.0.tar.gz",
 )
 
-container_repositories()
+load("@rules_oci//oci:dependencies.bzl", "rules_oci_dependencies")
+load("@rules_oci//oci:pull.bzl", "oci_pull")
 
-load("@io_bazel_rules_docker//repositories:deps.bzl", container_deps = "deps")
+rules_oci_dependencies()
 
-container_deps()
+# TODO: This will pull from an upstream location: specifically it will download
+# `crane` from https://github.com/google/go-containerregistry/... Before this is
+# used in CI or anything production-ready, this should be mirrored. rules_oci
+# doesn't support this mirroring yet so we'd have to submit a patch.
+load("@rules_oci//oci:repositories.bzl", "LATEST_CRANE_VERSION", "oci_register_toolchains")
 
-load(
-    "@io_bazel_rules_docker//container:container.bzl",
-    "container_pull",
-)
-load(
-    "@io_bazel_rules_docker//go:image.bzl",
-    _go_image_repos = "repositories",
+oci_register_toolchains(
+    name = "oci",
+    crane_version = LATEST_CRANE_VERSION,
 )
 
-_go_image_repos()
+load("@aspect_bazel_lib//lib:repositories.bzl", "aspect_bazel_lib_dependencies")
 
-container_pull(
+aspect_bazel_lib_dependencies()
+
+##############################
+# end rules_oci dependencies #
+##############################
+
+oci_pull(
     name = "redhat_ubi_minimal",
+    platforms = [
+        "linux/amd64",
+        "linux/arm64",
+    ],
     registry = "registry.access.redhat.com",
     repository = "ubi8/ubi-minimal",
     tag = "latest",
diff --git a/cmd/cockroach-operator/BUILD.bazel b/cmd/cockroach-operator/BUILD.bazel
@@ -1,8 +1,25 @@
 load("@io_bazel_rules_go//go:def.bzl", "go_binary", "go_library")
-load("@io_bazel_rules_docker//container:container.bzl", "container_image")
-load("@io_bazel_rules_docker//go:image.bzl", "go_image")
+load("@rules_oci//oci:defs.bzl", "oci_image", "oci_image_index")
 load("@rules_pkg//:pkg.bzl", "pkg_tar")
-load("@io_bazel_rules_docker//docker/util:run.bzl", "container_run_and_commit_layer")
+load("@aspect_bazel_lib//lib:expand_template.bzl", "expand_template")
+
+expand_template(
+    name = "labels",
+    out = "labels.txt",
+    stamp_substitutions = {
+        "APP_VERSION": "{{STABLE_DOCKER_TAG}}",
+        "NUMBER_COMMITS_ON_BRANCH": "{{NUMBER_COMMITS_ON_BRANCH}}",
+    },
+    template = [
+        "name=CockroachDB Operator",
+        "vendor=Cockroach Labs",
+        "release=NUMBER_COMMITS_ON_BRANCH",
+        "version=APP_VERSION",
+        "summary=CockroachDB is a distributed SQL database",
+        "description=CockroachDB is a PostgreSQL wire-compatible distributed SQL database",
+        "maintainer=Cockroach Labs",
+    ],
+)
 
 go_library(
     name = "go_default_library",
@@ -31,8 +48,20 @@ go_library(
 )
 
 go_binary(
-    name = "cockroach-operator",
+    name = "cockroach-operator-linux-amd64",
+    out = "cockroach-operator",
     embed = [":go_default_library"],
+    goarch = "amd64",
+    goos = "linux",
+    visibility = ["//visibility:public"],
+)
+
+go_binary(
+    name = "cockroach-operator-linux-arm64",
+    out = "cockroach-operator",
+    embed = [":go_default_library"],
+    goarch = "arm64",
+    goos = "linux",
     visibility = ["//visibility:public"],
 )
 
@@ -43,67 +72,48 @@ pkg_tar(
     package_dir = "/licenses",
 )
 
-container_run_and_commit_layer(
-    name = "ubi_update",
-    commands = [
-        "microdnf install yum",
-        "yum -v -y update --all",
-        "microdnf clean all && rm -rf /var/cache/yum",
+oci_image_index(
+    name = "index",
+    images = [
+        ":cockroach_image_linux_amd64",
+        ":cockroach_image_linux_arm64",
     ],
-    image = "@redhat_ubi_minimal//image",
+    visibility = ["//visibility:public"],
 )
 
-container_image(
-    name = "ubi_base_image",
-    architecture = "amd64",
+oci_image(
+    name = "cockroach_image_linux_amd64",
     # References container_pull from WORKSPACE
-    base = "@redhat_ubi_minimal//image",
-    labels = {
-        "name": "CockroachDB Operator",
-        "vendor": "Cockroach Labs",
-        "release": "{NUMBER_COMMITS_ON_BRANCH}",
-        "version": "{STABLE_DOCKER_TAG}",
-        "summary": "CockroachDB is a distributed SQL database",
-        "description": "CockroachDB is a PostgreSQL wire-compatible distributed SQL database",
-    },
-    layers = [
-        ":ubi_update",
-    ],
-    stamp = True,
+    base = "@redhat_ubi_minimal_linux_amd64",
+    labels = ":labels",
     tars = [
         ":licenses",
+        "//cmd/cockroach-operator/linux-amd64:cockroach-linux-amd64-tar",
+        ":operator_image_linux_amd64",
     ],
 )
 
-#  fetch_crdb downloads the cockroach binary
-genrule(
-    name = "fetch_crdb_container",
-    srcs = ["@crdb_linux//:file"],
-    outs = ["cockroach"],
-    cmd = "cp $(SRCS) $@",
-    visibility = ["//visibility:public"],
+oci_image(
+    name = "cockroach_image_linux_arm64",
+    # References container_pull from WORKSPACE
+    base = "@redhat_ubi_minimal_linux_arm64",
+    labels = ":labels",
+    tars = [
+        ":licenses",
+        "//cmd/cockroach-operator/linux-arm64:cockroach-linux-arm64-tar",
+        ":operator_image_linux_arm64",
+    ],
 )
 
 pkg_tar(
-    name = "cockroach-tar",
-    srcs = [":fetch_crdb_container"],
-    mode = "0755",
-    package_dir = "/usr/local/bin",
-)
-
-# include cockroach in an image
-container_image(
-    name = "cockroach_image",
-    base = ":ubi_base_image",
-    tars = [
-        ":cockroach-tar",
-    ],
+    name = "operator_image_linux_amd64",
+    srcs = [":cockroach-operator-linux-amd64"],
+    visibility = ["//visibility:public"],
 )
 
-go_image(
-    name = "operator_image",
-    base = ":cockroach_image",  # include the cr binary
-    binary = ":cockroach-operator",
+pkg_tar(
+    name = "operator_image_linux_arm64",
+    srcs = [":cockroach-operator-linux-arm64"],
     visibility = ["//visibility:public"],
 )
 
@@ -116,7 +126,11 @@ filegroup(
 
 filegroup(
     name = "all-srcs",
-    srcs = [":package-srcs"],
+    srcs = [
+        ":package-srcs",
+        "//cmd/cockroach-operator/linux-amd64:all-srcs",
+        "//cmd/cockroach-operator/linux-arm64:all-srcs",
+    ],
     tags = ["automanaged"],
     visibility = ["//visibility:public"],
 )
diff --git a/cmd/cockroach-operator/linux-amd64/BUILD.bazel b/cmd/cockroach-operator/linux-amd64/BUILD.bazel
@@ -0,0 +1,31 @@
+load("@rules_pkg//:pkg.bzl", "pkg_tar")
+
+genrule(
+    name = "fetch_linux_amd64_crdb_container",
+    srcs = ["@crdb_linux_amd64//:file"],
+    outs = ["cockroach"],
+    cmd = "cp $(SRCS) $@",
+    visibility = ["//visibility:public"],
+)
+
+pkg_tar(
+    name = "cockroach-linux-amd64-tar",
+    srcs = [":fetch_linux_amd64_crdb_container"],
+    mode = "0755",
+    package_dir = "/usr/local/bin",
+    visibility = ["//visibility:public"],
+)
+
+filegroup(
+    name = "package-srcs",
+    srcs = glob(["**"]),
+    tags = ["automanaged"],
+    visibility = ["//visibility:private"],
+)
+
+filegroup(
+    name = "all-srcs",
+    srcs = [":package-srcs"],
+    tags = ["automanaged"],
+    visibility = ["//visibility:public"],
+)
diff --git a/cmd/cockroach-operator/linux-arm64/BUILD.bazel b/cmd/cockroach-operator/linux-arm64/BUILD.bazel
@@ -0,0 +1,31 @@
+load("@rules_pkg//:pkg.bzl", "pkg_tar")
+
+genrule(
+    name = "fetch_linux_arm64_crdb_container",
+    srcs = ["@crdb_linux_arm64//:file"],
+    outs = ["cockroach"],
+    cmd = "cp $(SRCS) $@",
+    visibility = ["//visibility:public"],
+)
+
+pkg_tar(
+    name = "cockroach-linux-arm64-tar",
+    srcs = [":fetch_linux_arm64_crdb_container"],
+    mode = "0755",
+    package_dir = "/usr/local/bin",
+    visibility = ["//visibility:public"],
+)
+
+filegroup(
+    name = "package-srcs",
+    srcs = glob(["**"]),
+    tags = ["automanaged"],
+    visibility = ["//visibility:private"],
+)
+
+filegroup(
+    name = "all-srcs",
+    srcs = [":package-srcs"],
+    tags = ["automanaged"],
+    visibility = ["//visibility:public"],
+)
diff --git a/config/manager/deployment.yaml b/config/manager/deployment.yaml
@@ -33,6 +33,8 @@ spec:
         - name: cockroach-operator
           image: cockroachdb/cockroach-operator:latest
           imagePullPolicy: IfNotPresent
+          command:
+            - ./cockroach-operator
           args:
             - -zap-log-level
             - info
diff --git a/hack/bin/BUILD.bazel b/hack/bin/BUILD.bazel
@@ -233,7 +233,7 @@ genrule(
     srcs = select({
         ":m1": ["@crdb_darwin//:file"],
         ":darwin": ["@crdb_darwin//:file"],
-        ":k8": ["@crdb_linux//:file"],
+        ":k8": ["@crdb_linux_amd64//:file"],
     }),
     outs = ["cockroach"],
     cmd = "cp $(SRCS) $@",
diff --git a/hack/bin/deps.bzl b/hack/bin/deps.bzl
diff --git a/install/operator.yaml b/install/operator.yaml

Original file line number	Diff line number	Diff line change
`@@ -330,7 +330,7 @@ release/image:`
`330`	`330`	`DOCKER_REGISTRY=$(DOCKER_REGISTRY) \`
`331`	`331`	`DOCKER_IMAGE_REPOSITORY=$(DOCKER_IMAGE_REPOSITORY) \`
`332`	`332`	`APP_VERSION=$(APP_VERSION) \`
`333`		`- bazel run --stamp --platforms=@io_bazel_rules_go//go/toolchain:linux_amd64 \`
	`333`	`+ bazel run --stamp \`
`334`	`334`	`//:push_operator_image`
`335`	`335`
`336`	`336`	`#`