Skip to content

Latest commit

 

History

History
101 lines (77 loc) · 4.3 KB

README.md

File metadata and controls

101 lines (77 loc) · 4.3 KB
Raw

Image URL Helper

Overview

Image URL Helper is a tool that provides the following subcommands:

  • The check command finds all Helm chart images that don't use the imageurl template.
  • The list command lists all Helm chart images by checking the values.yaml files.
  • The missing command lists all non-existent Helm chart images by checking the values.yaml files.
  • The promote command updates the container registry path and Helm chart images versions in the values.yaml files. The subcommand also prints a YAML that can be used by the image-syncer tool to promote images.

Usage

To run the check command, use:

go run main.go \
    --resources-directory={PATH_TO_A_KYMA_RESOURCES_DIRECTORY} \
    check \
    --skip-comments=true \
    --excludes-list={PATH_TO_AN_EXCLUDES_LIST}

To run the list command, use:

go run main.go \
    --resources-directory={PATH_TO_A_KYMA_RESOURCES_DIRECTORY} \
    list \
    --exclude-test-images=true \
    --output-format=json

To run the missing command, use:

go run main.go \
    --resources-directory={PATH_TO_A_KYMA_RESOURCES_DIRECTORY} \
    missing \
    --exclude-test-images=true \
    --output-format=json

To run the promote command, use:

go run main.go \
    --resources-directory={PATH_TO_A_KYMA_RESOURCES_DIRECTORY} \
    promote \
    --target-container-registry=eu.gcr.io/example \
    --target-tag=release-1 \
    --dry-run=false

Exclude Images from the Check Command

To exclude image lines from being checked, create a YAML file that contains a list of files and values of images that you want to exclude from the check. Then, provide a path to this file in the check command argument. See the example of such a YAML file:

excludes:
  - filename: "monitoring/charts/grafana/values.yaml"
    images:
      - "bats/bats"
  - filename: "monitoring/charts/grafana/templates/image-renderer-deployment.yaml"
    images:
      - "{{ .Values.imageRenderer.image.repository }}:{{ .Values.imageRenderer.image.tag }}@sha256:{{ .Values.imageRenderer.image.sha }}"
      - "{{ .Values.imageRenderer.image.repository }}:{{ .Values.imageRenderer.image.tag }}"

Check Command Flags

See the list of flags available for the check command:

Name Required Description
--resources-directory Yes Path to the Kyma resources directory.
--skip-comments No Skip commented out lines.
--excludes-list No Path to the list of excluded images.

List Command Flags

See the list of flags available for the list and missing command:

Name Required Description
--resources-directory Yes Path to the Kyma resources directory.
--output-format No Name of the output format (JSON/YAML).
--exclude-test-images No Exclude test images from the output.

Promote command flags

See the list of flags available for the promote command:

Name Required Description
--resources-directory Yes Path to the Kyma resources directory.
--target-container-registry No Path of the target container registry.
--target-tag No Name of the target image tags.
--dry-run No The boolean value that controls the dry-run mode. It defaults to true.
--sign No The boolean value that sets sign value in the output YAML list. It defaults to true.
--excludes-list No Path to the list of excluded values.yaml files.