Skip to content

Latest commit

 

History

History
executable file
·
40 lines (26 loc) · 4.41 KB

how-versions-are-related.md

File metadata and controls

executable file
·
40 lines (26 loc) · 4.41 KB

How versions are related

This project uses different version types: GIT repository, applications, container images, and Helm charts versions.

This table summarizes the relationship of the different version types within the context of the Cloud Deployment Kit for Spotfire recipes.

Version type Description Defined in How it is defined How the provided Makefiles use it Examples of its use
Application The version of the main contained component versions.mk SPOTFIRE_SERVER_VERSION=12.0.0 - Extract packages from the downloads directory into the built container
- Set the org.opencontainers.image.version container label
- Set appVersion in Chart.yaml
- tss-12.0.0.x86_64.tar.gz
- org.opencontainers.image.version=12.0.0
- appVersion: "12.0.0"
Container image The built container image version containers/Makefile Composed using the Application version (and in some cases an additional part):
<APPLICATION_VERSION>
- Tag the container image
- Refer to the container image tag from the chart values.yaml
- spotfire/spotfire-server:12.0.0
- image.tag: "12.0.0"
Helm chart The packaged chart version helm/charts/<chart>/Chart.yaml Chart version in the respective Chart.yaml; example: 1.0.1 - Set the packaged chart version - spotfire-server-1.0.1.tgz

The default CDK for Spotfire and Application versions are configured in the versions.mk file.

Build container images with other application versions

You can use other application versions by modifying the related files for each case. For example, you can build a new container image with the latest released application version.

For this specific case, modify the component version in versions.mk (for example, SPOTFIRE_SERVER_VERSION=12.0.1), put that application component version in the containers/downloads directory, and then build the new containers using make from the containers/ directory.

Build container images using custom tags

If you run make from the containers/ directory without arguments, it tags the built images with the tag <APPLICATION_VERSION>. You can add an additional part of the image tag using the IMAGE_BUILD_ID argument. For example:

make IMAGE_BUILD_ID=my-custom-image-0.1

This strategy is useful to mark your container recipes as custom images when they deviate from the default recipes for a specific Cloud Deployment Kit Version.

Use Helm charts with other container image versions

You can use other container image versions than the default versions configured in the Helm charts. For that, you can use your custom image.tag value within the corresponding chart values.yaml file.

For example, set image.tag=12.0.0-my-custom-image-0.1 from the helm command line or using the values.yaml file to override the default tags. See the corresponding Helm chart README for the available image tag values.