Adding functionality to DevOps Deploy container agent

Creation of Dockerfile for extended image

Extending the agent container image can be accomplished by specifying the agent build level that you wish to enhance as your base image and then invoking the docker entrypoint provided by the base image. Here is an example Dockerfile and shell script that can be used to add Python 3.8 to the 8.0.0.0 agent image:

# Base image for 8.0.0.0 agent version
ARG BASE_IMAGE=”hclcr.io/launch/launch/agent:hcl-8.0.0.0.1164108”

FROM ${BASE_IMAGE}

# Copy shell script into /tmp directory
COPY artifacts/* /tmp/

# Important: Need root access to install packages
USER root

# Install packages to extend agent functionality
RUN bash /tmp/install-pkgs-extend.sh

USER 1001

# Important: Must invoke existing docker-entrypoint script provided by base image
ENTRYPOINT [“/usr/local/bin/docker-entrypoint.sh”]

#!/bin/bash

# List of packages to install
PKG_LIST="python38"

# Agent is based on RHEL8 ubi-minimal image which uses microdnf to install packages
microdnf update -y
microdnf install -y --nodocs ${PKG_LIST}
microdnf clean all
rm -rf /var/cache/microdnf
rm -rf /var/tmp/microdnf-*

How to identify Deploy agent base image

The base image that you use is based on the agent version that you wish to extend.

The supported agent versions can be located in the templates/_hcl-launch-agent-chart-config.tpl file of the agent Helm Chart. Here are some examples:

{{- define "{{ .Chart.Name }}.imageSpec" -}}
{{- if eq .Values.version "7.2.0.0" -}}
  hclcr.io/launch/launch/agent:hcl-7.2.0.0.1109832
{{- else if eq .Values.version "7.1.2.1" -}}
  hclcr.io/launch/launch/agent:hcl-7.1.2.1.1104332
{{- else if eq .Values.version "7.1.2.0" -}}
  hclcr.io/launch/launch/agent:hcl-7.1.2.0.1100493
{{- else -}}
  hclcr.io/launch/launch/agent:unknownProductVersion
{{- end -}}
{{- end -}}

Authenticate to HCL Container Registry prior to building the image

To pull the base image from the desired registry, you must perform a docker login prior to the running docker build command. Here is an example docker login command to use:

docker login hclcr.io -u <harbor-username> -p <harbor-cli-secret>

HCL container images are contained in the Harbor repositiory hclcr.io. To gain access to this repository, please follow these instructions:

New customers:

You must create a support ticket to get the credentials that are required to access the product binaries from the Harbor repository. For more information, refer to How to create an HCL support case.

You must use your existing Harbor repository credentials to access the product binaries.

Updating the agent Helm Chart

This step is only required for agent releases prior to 7.2.0.1

In order to use the extended agent image, you will need to update the _hcl-launch-agent-chart-config.tpl file to look something like this:

{{- define "{{ .Chart.Name }}.imageSpec" -}}
{{- if contains "extended" .Values.version -}}
  {{ .Values.version }}
{{- else if eq .Values.version "7.2.0.0" -}}
  hclcr.io/launch/launch/agent:hcl-7.2.0.0.1109832
{{- else if eq .Values.version "7.1.2.1" -}}
  hclcr.io/launch/launch/agent:hcl-7.1.2.1.1104332
{{- else if eq .Values.version "7.1.2.0" -}}
  hclcr.io/launch/launch/agent:hcl-7.1.2.0.1100493
{{- else -}}
  hclcr.io/launch/launch/agent:unknownProductVersion
{{- end -}}
{{- end -}}

Note lines 2 and 3 are added to the logic.

Specifying the new ImageSpec for deployment

To use the extended image, specify the imagespec in the version parameter of your values.yaml file. The tag for your image must include the word extended for this process to work. Here is an example values.yaml:

# Agent Version
version: "myregistry/agent:7.2.0.0-extended-amd64"

Update remaining parameters in values.yaml for your modified helm chart and then run the helm install command.

To verify your packages were installed successfully, you can run the kubectl exec -it <podname> -- /bin/sh command to open a command prompt into the running agent.