Skip to content

Deploying kas fleetshard from Source

Michael Edgar edited this page Apr 3, 2023 · 4 revisions

A custom build of kas-fleetshard operator and sync can be deployed using kas-installer by running the operators/generate-kas-fleetshard-olm-bundle.sh script. The script requires at least the location of the kas-fleetshard repository and the version of the OLM bundle that will be generated.

Required Tools

Example

The following example will generate an OLM bundle and index, overriding the operator CSV’s display name using the --patch-file option.

cat '[{
  "op": "add",
  "path": "/spec/displayName",
  "value": "My Custom KAS Fleetshard Operator"
}]' > bundle-patch.json

operators/generate-kas-fleetshard-olm-bundle.sh --git-url ${HOME}/git/kas-fleetshard --bundle-version 1.0.20-1 --patch-file bundle-patch.json

Parameter Details

Parameter Usage Description Default
--git-url

Required

URL or directory path to a kas-fleetshard source code repository. When the value is a local directory, the source will be built as-is. When not a directory the repository will be cloned locally prior to building.

N/A

--git-ref

Optional

git branch, tag, or commit. Used when --git-url is not a directory path.

main

--image-registry

Optional

Image registry to push the generated kas-fleetshard images.

quay.io

--image-group

Optional

Image group/organization to push the generated kas-fleetshard images.

${USER}

--bundle-repo

Optional

Image repository name for the for the generated OLM bundle index image

kas-fleetshard-operator-index
--bundle-version

Required

The version of the OLM bundle. Format is <major>.<minor>.<micro>-<build>.

N/A

--update-config

Optional

When set, the kas-installer.env file will be updated to use the generated OLM bundle index image

N/A

--build-engine

Optional

Tool for build container images. Examples: buildah, docker, podman.

docker

--patch-file

Optional

JSON patch file to be applied to the kas-fleetshard operator’s OLM ClusterServiceVersion after all defaults have been generated.

N/A