README
¶
Devfile Registry Operator
The Devfile Registry operator manages the lifecycle of the following custom resources:
Issue Tracking
Issue tracking repo: https://github.com/devfile/api with label area/registry
Changelog
Access the CHANGELOG.md here.
Requirements
Deployment cluster must meet one of the following criteria:
- OpenShift Container Platform (OCP) 4.12.x
- Kubernetes 1.25.x-1.26.x
More on the support of container orchestration systems can be found here.
Deployments made by the devfile registry operator must never target the default namespace due to incompatibility with security setups.
Development
- Go 1.19.x
- Docker / Podman
- Operator SDK 1.28.x
See Upgrade SDK Version for a guide on updating the Operator SDK. Ensure the Operator SDK version and the version of Kubernetes APIs match each other when updating by checking CLUSTER_SUPPORT.md.
Running the controller in a cluster
Install cert-manager to provision self-signed certificates for the validating webhooks which are used specifically for the ClusterDevfileRegistriesList and DevfileRegistriesList CRs. Cert manager needs to be installed in order for the controller manager to start.
make install-cert
The controller can be deployed to a cluster provided you are logged in with cluster-admin credentials:
make install && make deploy
The operator will be installed under the registry-operator-system namespace. However, devfile registries can be deployed in any namespace.
Development
The repository contains a Makefile; building and deploying can be configured via the environment variables
| variable | purpose | default value |
|---|---|---|
IMG |
Image used for controller (run makefile, if IMG is updated) |
quay.io/devfile/registry-operator:next |
Some of the rules supported by the makefile:
| rule | purpose |
|---|---|
| controller-gen | install the controll-gen tool, used by other commands |
| kustomize | install the kustomize tool, used by other commands |
| docker-build | build registry operator docker image |
| docker-push | push registry operator docker image |
| docker-buildx | build & push registry operator docker image for all supported architectures (does not work with podman) |
| deploy | deploy operator to cluster |
| undeploy | undeploy operator from cluster |
| install | create the devfile registry CRDs on the cluster |
| uninstall | remove the devfile registry operator and CRDs from the cluster |
| install-cert | for validating webhooks, install cert manager on the cluster |
| uninstall-cert | for validating webhooks, remove cert manager from the cluster |
| manifests | Generate manifests e.g. CRD, RBAC etc. |
| generate | Generate the API type definitions. Must be run after modifying the DevfileRegistry type. |
| bundle | Generate bundle manifests and metadata, then validate generated files. |
| test-integration | Run the integration tests for the operator. |
| test | Run the unit tests for the operator. |
| fmt | Check code formatting |
| fmt_license | Ensure license header is set on all files |
| vet | Check suspicious constructs into code |
| gosec | Check for security problems in non-test source files |
To see all rules supported by the makefile, run make help
Testing
To run integration tests for the operator, run make test-integration.
The oc executable must be accessible.
By default, the tests will use the default image for the operator, quay.io/devfile/registry-operator:next.
You can use make docker-build to build your own image, make docker-push to publish it. Then, to use your own image, run:
IMG=<your-operator-image> make test-integration
Run operator locally
It's possible to run an instance of the operator locally while communicating with a cluster.
- You may need to install the
controller-gentool before, used when building the binary:
make controller-gen
- Build the binary
make manager
- Deploy the CRDs
make install
- Run the controller
make run ENABLE_WEBHOOKS=false
Contributing
Please see our contributing.md.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
api
|
|
|
v1alpha1
Package v1alpha1 contains API Schema definitions for the registry v1alpha1 API group +kubebuilder:object:generate=true +groupName=registry.devfile.io
|
Package v1alpha1 contains API Schema definitions for the registry v1alpha1 API group +kubebuilder:object:generate=true +groupName=registry.devfile.io |
|
pkg
|
|
|
tests
|
|