ims-utils

An Alpine-based Docker image which contains utilities that are required for image creation and customization. This image is typically used to run simple commands in sidecar/init containers that support the image creation and customization workflow.

This image exists in the image creation and customization workflows so that the image creation and user-supplied image customization docker images don't have to include dependencies related to setting up the build environment.

This is part of the CMS Image Management and Image Customization toolset for Shasta-based systems.

Getting Started

Prerequisites

To build and use the ims-utils Docker image, you will need Docker installed on your system.

Installation

Just clone this repo and cd into it. Bang! You're done.

Build the Docker Image

docker build -t ims-utils:dev .

Usage

1. Run the container and include the command that you want to execute on the docker run command line. A volume mounted at '/tmp/ims' is provided in the image definition if a mounted volume is required.

$ docker run ims-utils:dev /bin/sh -c "echo this"
this

Kubernetes Container Usage

An example of using this container (as an initContainer) is provided below.

      initContainers:
      - image: artifactory.algol60.net/csm-docker/stable/cray-ims-utils:2.7.0
        name: fetch-recipe
        env:
        - name: API_GATEWAY_HOSTNAME
          value: {{ api_gw_service_name }}.{{ api_gw_service_namespace }}.svc.cluster.local
        - name: CA_CERT
          value: /etc/cray/ca/certificate_authority.crt
        - name: OAUTH_CONFIG_DIR
          value: '/etc/admin-client-auth'
        - name: IMS_JOB_ID
          value: "$id"
        - name: IMS_PYTHON_HELPER_TIMEOUT
          value: 720
        envFrom:
        - configMapRef:
            name: cray-ims-$id-configmap
        volumeMounts:
        - name: ca-pubkey
          mountPath: /etc/cray/ca
          readOnly: true
        - name: admin-client-auth
          mountPath: '/etc/admin-client-auth'
          readOnly: true
        command: [ "sh", "-ce", "/scripts/fetch-recipe.sh /mnt/image/recipe $download_url" ]

Deployment

This Docker image will be deployed as part of the Shasta management plane stack via Kubernetes, specifically as a part of the Image Management Service.

Development

Development on this repository should follow the standard CMS development process.

Build Helpers

This repo uses some build helpers from the cms-meta-tools repo. See that repo for more details.

Local Builds

If you wish to perform a local build, you will first need to clone or copy the contents of the cms-meta-tools repo to ./cms_meta_tools in the same directory as the Makefile. When building on github, the cloneCMSMetaTools() function clones the cms-meta-tools repo into that directory.

For a local build, you will also need to manually write the .version, .docker_version (if this repo builds a docker image), and .chart_version (if this repo builds a helm chart) files. When building on github, this is done by the setVersionFiles() function.

Authors

• Randy Kleinman
• Eric Cozzi
• (Add your name here if you want praise or blame later)

Copyright and License

This project is copyrighted by Hewlett Packard Enterprise Development LP and is under the MIT license. See the LICENSE file for details.

When making any modifications to a file that has a Cray/HPE copyright header, that header must be updated to include the current year.

When creating any new files in this repo, if they contain source code, they must have the HPE copyright and license text in their header, unless the file is covered under someone else's copyright/license (in which case that should be in the header). For this purpose, source code files include Dockerfiles, Ansible files, RPM spec files, and shell scripts. It does not include Jenkinsfiles, OpenAPI/Swagger specs, or READMEs.

When in doubt, provided the file is not covered under someone else's copyright or license, then it does not hurt to add ours to the header.