Dockerfile

# syntax=docker/dockerfile:1

# This Dockerfile shows how you can both build and run a container with
# a specific exporter/collector program. It uses two stages, copying the relevant
# material from the build step into the runtime container.
#
# It can cope with both platforms where a Redistributable Client is available, and platforms
# where it is not - copy the .rpm or .deb install images for such platforms into the MQINST
# subdirectory of this repository first. The UBI base image used here is rpm-based.
#
# Also note the use of "COPY --chmod" which requires the DOCKER_BUILDKIT to be
# enabled (which it ought to be by default anyway). The legacy docker builder
# is already deprecated and will be removed in a future Docker release.

# Global ARG. To be used in all stages.
# Override with "--build-arg EXPORTER=mq_xxxxx" when building.
ARG EXPORTER=mq_prometheus

# Runtime base image.
# This must be declared before the first FROM so Docker BuildKit
# can correctly expand it when selecting the runtime image.
# Override with: docker build --build-arg RUNTIME_IMAGE=<image> .
ARG RUNTIME_IMAGE=registry.access.redhat.com/ubi8-minimal:latest

# --- --- --- --- --- --- --- --- --- --- --- --- --- --- #
## ### ### ### ### ### ### BUILD ### ### ### ### ### ### ##
# --- --- --- --- --- --- --- --- --- --- --- --- --- --- #
ARG BASE_IMAGE=registry.access.redhat.com/ubi8/go-toolset:1.21
FROM $BASE_IMAGE AS builder

ARG EXPORTER
ENV EXPORTER=${EXPORTER} \
    ORG="github.com/ibm-messaging" \
    REPO="mq-metric-samples" \
    VRMF=9.4.5.0 \
    CGO_CFLAGS="-I/opt/mqm/inc/" \
    CGO_LDFLAGS_ALLOW="-Wl,-rpath.*" \
    genmqpkg_incnls=1 \
    genmqpkg_incsdk=1 \
    genmqpkg_inctls=1


ENV GOVERSION=1.22.8
USER 0

# Go module / toolchain proxy used during the build.
# This affects both the Go toolchain download and any module downloads.
# Override with: docker build --build-arg GOPROXY=<proxy-url> .
# Default is the public Go proxy.
ARG GOPROXY=https://proxy.golang.org,direct
RUN go env -w GOPROXY="$GOPROXY"

# The base UBI8 image does not (currently) contain the most
# recent Go compiler. Which tends to be required for the OTel
# packages.
# Go (1.21+) provides automatic toolchain selection via GOTOOLCHAIN.
# The Go version specified in this image (via GOVERSION) is installed
# by the Go toolchain and automatically downloaded if not present.
# In restricted environments, this requires GOPROXY to point to an
# internal repository.
# As long as the base image includes some Go compiler, the required Go version
# can be automatically downloaded and used when needed (for example, based on
# go.mod directives), without explicitly installing it in the image.
ENV GOTOOLCHAIN="go${GOVERSION}+auto"
RUN go version 
ENV GO=go
RUN echo "GO version"
RUN go version 

# Create directory structure
RUN mkdir -p /go/src /go/bin /go/pkg \
    && chmod -R 777 /go \
    && mkdir -p /go/src/$ORG \
    && mkdir -p /opt/mqm \
    && mkdir -p /MQINST \
    && chmod a+rx /opt/mqm

# Install MQ client and SDK
# For platforms with a Redistributable client, we can use curl to pull it in and unpack it.
# For most other platforms, we assume that you have deb or rpm files available under the current directory
# and we then copy them into the container image. Use dpkg or rpm to install from them; these have to be
# done in the right order.
# The rpm version of the install packages have a different VRMF format: instead of "9.1.2.3", they have "9.1.2-3" in
# the filenames. So we need to convert using sed. Note that the rpm signing information will not be in the container
# unless you modify this Dockerfile.
#
# The Linux ARM64 image is a full-function server package that is directly unpacked.
# We only need a subset of the files so strip the unneeded filesets. The download of the image could
# be automated via curl in the same way as the Linux/amd64 download, but it's a much bigger image and
# has a different license. So I'm not going to do that for now.
#
# If additional Redistributable Client platforms appear, then this block can be altered, including the MQARCH setting.
#
# The copy of the README is so that at least one file always gets copied, even if you don't have the deb files locally.
# Using a wildcard in the directory name also helps to ensure that this part of the build always succeeds.
COPY README.md MQINST*/*deb MQINST*/*rpm MQINST*/*tar.gz /MQINST

# These are values always set by the "docker build" process
ARG TARGETARCH TARGETOS
RUN echo "Target arch is $TARGETARCH; os is $TARGETOS"
# Might need to refer to TARGET* vars a few times in this block, so define something shorter.
ARG RDURL_ARG="https://public.dhe.ibm.com/ibmdl/export/pub/software/websphere/messaging/mqdev/redist"
RUN T="$TARGETOS/$TARGETARCH"; \
      if [ "$T" = "linux/amd64" ]; \
      then \
        MQARCH=X64;\
        RDURL=${RDURL_ARG};\
        RDTAR="IBM-MQC-Redist-Linux${MQARCH}.tar.gz"; \
        cd /opt/mqm \
        && curl -LO "$RDURL/$VRMF-$RDTAR" \
        && tar -zxf ./*.tar.gz \
        && rm -f ./*.tar.gz \
        && bin/genmqpkg.sh -b /opt/mqm;\
      elif [ "$T" = "linux/arm64" ] ;\
      then \
        cd /MQINST; \
        c=`ls *$VRMF*.tar.gz 2>/dev/null| wc -l`; if [ $c -ne 1 ]; then echo "MQ installation file does not exist in MQINST subdirectory";exit 1;fi; \
        cd /opt/mqm \
        && tar -zxf /MQINST/*.tar.gz \
        && export genmqpkg_incserver=0 \
        && bin/genmqpkg.sh -b /opt/mqm;\
      elif [ "$T" = "linux/ppc64le" -o "$T" = "linux/s390x" ];\
      then \
        cd /MQINST; \
        RHVRMF=`echo "$VRMF" | sed "s/\(.*\)\./\1-/"`;\
        cdeb=`ls ibmmq-*$VRMF*.deb 2>/dev/null| wc -l`; \
        crpm=`ls MQSeries*$RHVRMF*.rpm 2>/dev/null| grep "$VRMF" | wc -l`; \
        if [ $cdeb -ge 4 ]; \
        then \
          for f in ibmmq-runtime_$VRMF*.deb ibmmq-gskit_$VRMF*.deb ibmmq-client_$VRMF*.deb ibmmq-sdk_$VRMF*.deb;\
          do dpkg -i $f;\
          done; \
        elif [ $crpm -ge 4 ]; \
        then \
          rpm --noverify -i MQSeriesRuntime-$RHVRMF*.rpm MQSeriesGSKit-$RHVRMF*.rpm MQSeriesClient-$RHVRMF*.rpm MQSeriesSDK-$RHVRMF*.rpm;\
          if [ $? -ne 0 ]; then exit 1;fi;\
        else \
          echo "MQ installation files do not exist in MQINST subdirectory";\
          exit 1;\
        fi;\
      else   \
        echo "Unsupported platform $T";\
        exit 1;\
      fi

# Build the Go application
WORKDIR /go/src/$ORG/$REPO
COPY go.mod .
COPY go.sum .
COPY --chmod=777 ./cmd/${EXPORTER} .
COPY --chmod=777 vendor ./vendor
COPY --chmod=777 pkg ./pkg
# This file holds something like the current commit level if it exists in your tree. It might not be there, so
# we use wildcards and a known file to avoid errors on non-existent files/dirs.
COPY --chmod=777 README.md ./.git*/refs/heads/master* .
RUN buildStamp=`date +%Y%m%d-%H%M%S`; \
    hw=`uname -m`; \
    os=`uname -s`; \
    bp="$os/$hw"; \
    if [ -r master ]; then gitCommit=`cat master`;else gitCommit="Unknown";fi; \
    BUILD_EXTRA_INJECT="-X \"main.BuildStamp=$buildStamp\" -X \"main.BuildPlatform=$bp\" -X \"main.GitCommit=$gitCommit\""; \
    $GO build -mod=vendor -ldflags "$BUILD_EXTRA_INJECT" -o /go/bin/${EXPORTER} ./*.go

# --- --- --- --- --- --- --- --- --- --- --- --- --- --- #
### ### ### ### ### ### ### RUN ### ### ### ### ### ### ###
# --- --- --- --- --- --- --- --- --- --- --- --- --- --- #
# Use a "minimal" runtime image
FROM ${RUNTIME_IMAGE} AS runtime

ARG EXPORTER

# Create directory structure
RUN mkdir -p /opt/bin \
    && chmod -R 777 /opt/bin \
    && mkdir -p /opt/mqm \
    && chmod 775 /opt/mqm \
    && mkdir -p /opt/config \
    && chmod a+rx /opt/config

# Create MQ client directories
WORKDIR /opt/mqm
RUN mkdir -p /IBM/MQ/data/errors \
    && mkdir -p /.mqm \
    && chmod -R 777 /IBM \
    && chmod -R 777 /.mqm

ENV EXPORTER=${EXPORTER} \
    LD_LIBRARY_PATH="/opt/mqm/lib64:/usr/lib64" \
    MQ_CONNECT_TYPE=CLIENT \
    IBMMQ_GLOBAL_CONFIGURATIONFILE=/opt/config/${EXPORTER}.yaml

COPY --chmod=555 --from=builder /go/bin/${EXPORTER} /opt/bin/${EXPORTER}
COPY             --from=builder /opt/mqm/ /opt/mqm/

CMD ["sh", "-c", "/opt/bin/${EXPORTER}"]