Skip to content

Commit

Permalink
Allow different tags for required images in Helm charts
Browse files Browse the repository at this point in the history
  • Loading branch information
@abhay-krishna
abhay-krishna committed Mar 7, 2024
1 parent 7b0d4cd commit 5d861d3
Show file tree
Hide file tree
Showing 3 changed files with 63 additions and 51 deletions.
3 changes: 2 additions & 1 deletion Common.mk
View file
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,7 @@ HELM_USE_UPSTREAM_IMAGE?=false
HELM_DIRECTORY?=.
HELM_DESTINATION_REPOSITORY?=$(HELM_CHART_NAME)
HELM_IMAGE_LIST?=$(IMAGE_COMPONENT)
HELM_IMAGE_TAG_LIST?=$(foreach _,$(HELM_IMAGE_LIST),$(IMAGE_TAG))
HELM_GIT_CHECKOUT_TARGET?=$(HELM_SOURCE_REPOSITORY)/eks-anywhere-checkout-$(HELM_GIT_TAG)
HELM_GIT_PATCH_TARGET?=$(HELM_SOURCE_REPOSITORY)/eks-anywhere-helm-patched
PACKAGE_DEPENDENCIES?=
Expand Down Expand Up @@ -856,7 +857,7 @@ $(call FULL_CHART_TARGETS,copy) : %/helm/copy: checkout-repo checkout-helm-repo
@$(BUILD_LIB)/helm_copy.sh $(HELM_SOURCE_REPOSITORY) $(HELM_DESTINATION_REPOSITORY) $(HELM_DIRECTORY) $(OUTPUT_DIR)

$(call FULL_CHART_TARGETS,require) : %/helm/require: %/helm/copy | $$(ENABLE_LOGGING)
@$(BUILD_LIB)/helm_require.sh $(HELM_SOURCE_IMAGE_REPO) $(HELM_DESTINATION_REPOSITORY) $(OUTPUT_DIR) $(IMAGE_TAG) $(HELM_TAG) $(PROJECT_ROOT) $(LATEST) $(HELM_USE_UPSTREAM_IMAGE) "$(PACKAGE_DEPENDENCIES)" "$(FORCE_JSON_SCHEMA_FILE)" $(HELM_IMAGE_LIST)
@$(BUILD_LIB)/helm_require.sh $(HELM_SOURCE_IMAGE_REPO) $(HELM_DESTINATION_REPOSITORY) $(OUTPUT_DIR) $(IMAGE_TAG) $(HELM_TAG) $(PROJECT_ROOT) $(LATEST) $(HELM_USE_UPSTREAM_IMAGE) "$(PACKAGE_DEPENDENCIES)" "$(FORCE_JSON_SCHEMA_FILE)" $(HELM_IMAGE_LIST) $(HELM_IMAGE_TAG_LIST)

$(call FULL_CHART_TARGETS,replace) : %/helm/replace: %/helm/require | $$(ENABLE_LOGGING)
@$(BUILD_LIB)/helm_replace.sh $(HELM_DESTINATION_REPOSITORY) $(OUTPUT_DIR)
Expand Down
108 changes: 58 additions & 50 deletions build/lib/helm_require.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ HELM_USE_UPSTREAM_IMAGE="${8?Eigth argument is bool determining whether to use c
PACKAGE_DEPENDENCIES="${9?Ninth argument is optional project dependencies}"
FORCE_JSON_SCHEMA_FILE="${10?Tenth argument is optional schema file}"
HELM_IMAGE_LIST="${@:11}"
HELM_IMAGE_TAG_LIST="${@:12}"

CHART_NAME=$(basename ${HELM_DESTINATION_REPOSITORY})
DEST_DIR=${OUTPUT_DIR}/helm/${CHART_NAME}
Expand Down Expand Up @@ -78,7 +79,7 @@ function get_image_tag_not_latest() {
# to find another tag associated with this image we have to use the aws cli
# the following only works for ecr repos
if [ "${JOB_TYPE:-}" = "presubmit" ] || [[ "${IMAGE_REGISTRY}" != *"ecr"* ]]; then
echo ${tag}
echo ${tag}
else
if ! aws sts get-caller-identity &> /dev/null; then
echo "The AWS cli is used to find the ECR registries and repos for the current AWS account please login!"
Expand All @@ -87,63 +88,70 @@ function get_image_tag_not_latest() {

local service="ecr"
if [[ "${IMAGE_REGISTRY}" = *"public.ecr"* ]]; then
service="--region us-east-1 ecr-public"
service="--region us-east-1 ecr-public"
fi
build::common::echo_and_run aws ${service} describe-images --repository-name ${image} --image-id imageDigest=${shasum} --query 'imageDetails[0].imageTags' --output yaml | grep -v ${LATEST} | head -1| sed -e 's/- //'
build::common::echo_and_run aws ${service} describe-images --repository-name ${image} --image-id imageDigest=${shasum} --query 'imageDetails[0].imageTags' --output yaml | grep -v ${LATEST} | head -1| sed -e 's/- //'
fi
}

for IMAGE in ${HELM_IMAGE_LIST:-}; do
# the image_list will include images built by the current project and potentially images built from
# other projects, ex: prometheus chart includes the node_exporter which is built seperately
# since each project is built independently and is tagged with the current HEAD commit hash
# images built via this current build may not be tagged exactly the same as images from other builds
# this code will first try to pull the image by the IMAGE_TAG and if that is not available
# it will fallback to the LATEST tag which follows the same pattern we use for artifacts on s3
# in the event that the LATEST tag is used, the ecr api will be used to get a different tag, which
# should be the tag in the format <version>-<commit-hash>, this tag will be used in the requires.yaml
IMAGE_SHASUM=$(get_image_shasum ${IMAGE} ${IMAGE_TAG})

if [[ -z ${IMAGE_SHASUM} ]]; then
IMAGE_SHASUM=$(get_image_shasum ${IMAGE} ${LATEST})
fi

if [[ -z ${IMAGE_SHASUM} ]]; then
echo "Neither ${IMAGE}@${IMAGE_TAG} nor ${IMAGE}@${LATEST} exists!"
exit 1
fi

echo "s,{{${IMAGE}}},${IMAGE_SHASUM},g" >>${SEDFILE}
if [ "${IMAGE_TAG}" = "${LATEST}" ]; then
# if finding an image from another project using the `latest` tag, find the image and a different tag associated with that image
USE_TAG=$(get_image_tag_not_latest ${IMAGE} ${IMAGE_SHASUM})
if [[ -z ${USE_TAG} ]]; then
echo "non-${LATEST} tag does not exist for ${IMAGE}@${IMAGE_SHASUM}!"
if [ -n "$HELM_IMAGE_LIST" ]; then
HELM_IMAGE_LIST_ARR=($HELM_IMAGE_LIST)
HELM_IMAGE_TAG_ARR=($HELM_IMAGE_TAG_LIST)
for i in ${!HELM_IMAGE_ARR[@]}; do
IMAGE="${HELM_IMAGE_ARR[$i]}"
TAG="${HELM_IMAGE_TAG_ARR[$i]}"
# the image_list will include images built by the current project and potentially images built from
# other projects, ex: prometheus chart includes the node_exporter which is built seperately
# since each project is built independently and is tagged with the current HEAD commit hash
# images built via this current build may not be tagged exactly the same as images from other builds
# this code will first try to pull the image by the IMAGE_TAG and if that is not available
# it will fallback to the LATEST tag which follows the same pattern we use for artifacts on s3
# in the event that the LATEST tag is used, the ecr api will be used to get a different tag, which
# should be the tag in the format <version>-<commit-hash>, this tag will be used in the requires.yaml
IMAGE_SHASUM=$(get_image_shasum ${IMAGE} ${TAG}
if [[ -z ${IMAGE_SHASUM} ]]; then
IMAGE_SHASUM=$(get_image_shasum ${IMAGE} ${LATEST})
fi
if [[ -z ${IMAGE_SHASUM} ]]; then
echo "Neither ${IMAGE}@${TAG} nor ${IMAGE}@${LATEST} exists!"
exit 1
fi
else
USE_TAG=$IMAGE_TAG
fi

# If HELM_USE_UPSTREAM_IMAGE is true, we are using images from upstream.
# Though we pull images directly from upstream for build tooling checks (i.e.
# get images shasums), we will use cached images in the helm charts. Cached
# images follow the convention of ${PROJECT_NAME}/${UPSTREAM_IMAGE_NAME}.
if [ "${HELM_USE_UPSTREAM_IMAGE}" == true ]; then
PROJECT_NAME=$(echo "$HELM_DESTINATION_REPOSITORY" | awk -F "/" '{print $1}')
IMAGE_REPO="${PROJECT_NAME}/${IMAGE}"
else
IMAGE_REPO="${IMAGE}"
fi
fi
cat >>${REQUIRES_FILE} <<!
- repository: ${IMAGE_REPO}
tag: ${USE_TAG}
digest: ${IMAGE_SHASUM}
!
done
echo "s,{{${IMAGE}}},${IMAGE_SHASUM},g" >>${SEDFILE}
if [ "${TAG}" = "${LATEST}" ]; then
# if finding an image from another project using the `latest` tag, find the image and a different tag associated with that image
USE_TAG=$(get_image_tag_not_latest ${IMAGE} ${IMAGE_SHASUM})
if [[ -z ${USE_TAG} ]]; then
echo "non-${LATEST} tag does not exist for ${IMAGE}@${IMAGE_SHASUM}!"
exit 1
fi
else
USE_TAG=$TAG
fi
# If HELM_USE_UPSTREAM_IMAGE is true, we are using images from upstream.
# Though we pull images directly from upstream for build tooling checks (i.e.
# get images shasums), we will use cached images in the helm charts. Cached
# images follow the convention of ${PROJECT_NAME}/${UPSTREAM_IMAGE_NAME}.
if [ "${HELM_USE_UPSTREAM_IMAGE}" == true ]; then
PROJECT_NAME=$(echo "$HELM_DESTINATION_REPOSITORY" | awk -F "/" '{print $1}')
IMAGE_REPO="${PROJECT_NAME}/${IMAGE}"
else
IMAGE_REPO="${IMAGE}"
fi
cat >>${REQUIRES_FILE} <<!
- repository: ${IMAGE_REPO}
tag: ${USE_TAG}
digest: ${IMAGE_SHASUM}
!
done
fi
if [ -n "${FORCE_JSON_SCHEMA_FILE}" ]; then
if [ -n "${FORCE_JSON_SCHEMA_FILE}" ]; then
JSON_SCHEMA_FILE=${FORCE_JSON_SCHEMA_FILE}
fi
Expand Down
3 changes: 3 additions & 0 deletions projects/prometheus/prometheus/Makefile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ BASE_DIRECTORY:=$(abspath ../../../)
GIT_TAG=$(shell cat GIT_TAG)
HELM_GIT_TAG=$(shell cat HELM_GIT_TAG)
GOLANG_VERSION=$(shell cat GOLANG_VERSION)
PROMETHEUS_NODE_EXPORTER_GIT_TAG=$(shell cat ../node_exporter/GIT_TAG)
PROMETHEUS_NODE_EXPORTER_IMAGE_TAG=$(PROMETHEUS_NODE_EXPORTER_GIT_TAG)-$(GIT_HASH)
REPO=prometheus
REPO_OWNER=prometheus

Expand Down Expand Up @@ -34,6 +36,7 @@ HELM_SOURCE_OWNER=prometheus-community
HELM_SOURCE_REPOSITORY=helm-charts
HELM_DIRECTORY=charts/prometheus
HELM_IMAGE_LIST=prometheus/prometheus prometheus/node-exporter
HELM_IMAGE_TAG_LIST=$(IMAGE_TAG) $(PROMETHEUS_NODE_EXPORTER_IMAGE_TAG)

HELM_CHART_NAMES=prometheus/charts/prometheus

Expand Down

0 comments on commit 5d861d3

Please sign in to comment.