registry-support

Provide support for devfile registries

Issue tracking repo: https://github.com/devfile/api with label area/registry

Build

Prerequisite

The current release relies on oapi-codegen 1.12.4 for OpenAPI source generation. See the Index Server README for more information.

To install, run: go install github.com/deepmap/oapi-codegen/cmd/oapi-codegen@v1.12.4

Instructions

If you want to run the build scripts with Podman, set the environment variable export USE_PODMAN=true

To build all of the components together (recommended) for dev/test, run bash ./build_registry.sh to build a Devfile Registry index image that is populated with the mock devfile registry data under tests/registry/.

By default bash ./build_registry.sh will build for linux/amd64 architectures. To build for a different architecture pass in an argument to the script. E.g. bash ./build_registry.sh linux/arm64.

Once the container has been pushed, you can push it to a container registry of your choosing with the following commands:

docker tag devfile-index <registry>/<username>/devfile-index:latest

followed by

docker push <registry>/<username>/devfile-index:latest

See the following for more on the component specific build process:

• Building the OCI Registry
• Building the Index Server

Deploy

Via the Devfile Registry Operator

We recommend using the Devfile Registry Operator to install a Devfile Registry on your Kubernetes or OpenShift cluster. Consult its Readme for more information.

Via the Devfile Registry Helm Chart

Alternatively, a Helm chart is also provided if you do not wish to use an operator. You can find instructions below for installing via Helm to either a Kubernetes or OpenShift environment. You can find detailed instructions here.

Security

Further information for the devfile organization security policy can be found here.

Contributing

Please see our contributing.md.