build-definitions

This repository contains components that are installed or managed by the managed CI and Build Team.

This includes default Pipelines and Tasks. You need to have bootstrapped a working appstudio configuration from (see https://github.com/redhat-appstudio/infra-deployments) for the dev of pipelines or new tasks.

Pipelines are delivered into App Studio via quay.io/redhat-appstudio/build-templates-bundle:$GIT_SHA (the tag will be updated every change)

Tasks are delivered into App Studio via quay.io/redhat-appstudio/appstudio-tasks. Where tasks are bundled and pushed into tag in format ${VERSION}-${PART} where VERSION is the same as pipelines bundle version and PART is sequence number. Tasks are grouped by 10 tasks per bundle.

Currently a set of utilities are bundled with App Studio in quay.io/redhat-appstudio/appstudio-utils:$GIT_SHA as a convenience but tasks may be run from different per-task containers in future.

Building

Script hack/build-and-push.sh creates bundles for pipelines, tasks and create appstudio-utils image. Images are pushed into your quay.io repository. You will need to set MY_QUAY_USER to use this feature and be logged into quay.io on your workstation. Once you run the hack/build-and-push.sh all pipelines will come from your bundle instead of from the default installed by gitops into the cluster.

Note

If you're using Mac OS, you need to install GNU coreutils before running the hack/build-and-push.sh script:

brew install coreutils

There is an option to push all bundles to a single quay.io repository (this method is used in PR testing). It is used by setting TEST_REPO_NAME environment variable. Bundle names are then specified in the container image tag, i.e. quay.io/<quay-user>/$TEST_REPO_NAME:<bundle-name>-<tag>

Pipelines

The pipelines can be found in the pipelines directories.

• base: creates build-templates-bundle
• hacbs: extension of base, adds hacbs tests, creates hacbs-templates-bundle
• hacbs-core-service: extension of hacbs, for core services of AppStudio/HACBS, allows to create MR in infra-deployments. Creates hacbs-core-service-templates-bundle.

Gitops Mode

Replace the file https://github.com/redhat-appstudio/infra-deployments/blob/main/components/build/build-templates/bundle-config.yaml in your own fork (dev mode). This will sync to the cluster and all builds-definitions will come from the bundle you configure.

Please test in gitops mode when doing a new release into staging as it will be the best way to ensure that the deployment will function correctly when deployed via gitops.

Tasks

The tasks can be found in the tasks directories. Tasks are bundled and used by bundled pipelines. Tasks are not stored in the Cluster. For quick local innerloop style task development, you may install new Tasks in your local namespace manually and create your pipelines as well as the base task image to test new function. Tasks can be installed into local namespace using oc apply -k tasks/appstudio-utils/util-tasks.

There is a container which is used to support multiple set of tasks called quay.io/redhat-appstudio/appstudio-utils:GIT_SHA , which is a single container which is used by multiple tasks. Tasks may also be in their own container as well however many simple tasks are utilities and will be packaged for app studio in a single container. Tasks can rely on other tasks in the system which are co-packed in a container allowing combined tasks (build-only vs build-deploy) which use the same core implementations.

Release

Release is done by setting env variable MY_QUAY_USER=redhat-appstudio, BUILD_TAG=$(git rev-parse HEAD) and running hack/build-and-push.sh.

Testing

Script ./hack/test-builds.sh creates pipelines and tasks directly in current namespace and executes there test builds. Images are pushed into OpenShift image streams, by setting environment variable MY_QUAY_USER the images will be pushed into user's quay repository, in that case creation of secret named redhat-appstudio-staginguser-pull-secret is required.

Running script ./hack/test-builds.sh hacbs executes modified pipelines for HACBS.

Script ./hack/test-build.sh provides way to test on custom git repository and pipeline. Usage example: ./hack/test-build.sh https://github.com/jduimovich/spring-petclinic java-builder.

ShellSpec tests

There are tests in the test directory written using ShellSpec, to run them install it and run shellspec:

$ shellspec
Running: /usr/bin/bash [bash 5.1.8(1)-release]
....

Finished in 0.17 seconds (user 0.15 seconds, sys 0.06 seconds)
4 examples, 0 failures

Or run using the shellspec container, e.g. with podman:

$ podman run -it --rm -v "$PWD:/src":Z docker.io/shellspec/shellspec:kcov
Running: /bin/bash [bash 5.0.17(1)-release]
....

Finished in 0.17 seconds (user 0.18 seconds, sys 0.03 seconds)
4 examples, 0 failures