catalogd
Catalogd is a Kubernetes extension that unpacks file-based catalog (FBC) content for on-cluster clients. Currently, catalogd unpacks FBC content that is packaged and distributed as container images. The catalogd road map includes plans for unpacking other content sources, such as Git repositories and OCI artifacts. For more information, see the catalogd issues page.
Catalogd helps customers discover installable content by hosting catalog metadata for Kubernetes extensions, such as Operators and controllers. For more information on the Operator Lifecycle Manager (OLM) v1 suite of microservices, see the documentation for the Operator Controller.
Quick start
NOTE: Procedure steps marked with an asterisk (*
) are likely to change with future API updates.
-
To install catalogd, navigate to the releases page, and follow the install instructions included in the release you want to install.
-
Create a Catalog
object that points to the OperatorHub Community catalog by running the following command:
$ kubectl apply -f - << EOF
apiVersion: catalogd.operatorframework.io/v1alpha1
kind: Catalog
metadata:
name: operatorhubio
spec:
source:
type: image
image:
ref: quay.io/operatorhubio/catalog:latest
EOF
-
Verify the Catalog
object was created successfully by running the following command:
$ kubectl describe catalog/operatorhubio
Example output
Name: operatorhubio
Namespace:
Labels: <none>
Annotations: <none>
API Version: catalogd.operatorframework.io/v1alpha1
Kind: Catalog
Metadata:
Creation Timestamp: 2023-06-23T18:35:13Z
Generation: 1
Managed Fields:
API Version: catalogd.operatorframework.io/v1alpha1
Fields Type: FieldsV1
fieldsV1:
f:metadata:
f:annotations:
.:
f:kubectl.kubernetes.io/last-applied-configuration:
f:spec:
.:
f:source:
.:
f:image:
.:
f:ref:
f:type:
Manager: kubectl-client-side-apply
Operation: Update
Time: 2023-06-23T18:35:13Z
API Version: catalogd.operatorframework.io/v1alpha1
Fields Type: FieldsV1
fieldsV1:
f:status:
.:
f:conditions:
f:phase:
Manager: manager
Operation: Update
Subresource: status
Time: 2023-06-23T18:35:43Z
Resource Version: 1397
UID: 709cee9d-c669-46e1-97d0-e97dcce8f388
Spec:
Source:
Image:
Ref: quay.io/operatorhubio/catalog:latest
Type: image
Status:
Conditions:
Last Transition Time: 2023-06-23T18:35:13Z
Message:
Reason: Unpacking
Status: False
Type: Unpacked
Phase: Unpacking
Events: <none>
-
Run the following command to get a list of packages:
$ kubectl get catalogmetadata -l schema=olm.package
Example output
NAME AGE
operatorhubio-olm.package-ack-acm-controller 18m
operatorhubio-olm.package-ack-apigatewayv2-controller 18m
operatorhubio-olm.package-ack-applicationautoscaling-controller 18m
operatorhubio-olm.package-ack-cloudtrail-controller 18m
operatorhubio-olm.package-ack-cloudwatch-controller 18m
operatorhubio-olm.package-ack-dynamodb-controller 18m
operatorhubio-olm.package-ack-ec2-controller 18m
operatorhubio-olm.package-ack-ecr-controller 18m
operatorhubio-olm.package-ack-eks-controller 18m
operatorhubio-olm.package-ack-elasticache-controller 18m
operatorhubio-olm.package-ack-emrcontainers-controller 18m
operatorhubio-olm.package-ack-eventbridge-controller 18m
operatorhubio-olm.package-ack-iam-controller 18m
operatorhubio-olm.package-ack-kinesis-controller 18m
...
-
Run the following command to get a list of channels:
$ kubectl get catalogmetadata -l olm.channel
Example output
NAME AGE
operatorhubio-olm.channel-ack-acm-controller-alpha 21m
operatorhubio-olm.channel-ack-apigatewayv2-controller-alpha 21m
operatorhubio-olm.channel-ack-applicationautoscaling-controller-alpha 21m
operatorhubio-olm.channel-ack-cloudtrail-controller-alpha 21m
operatorhubio-olm.channel-ack-cloudwatch-controller-alpha 21m
operatorhubio-olm.channel-ack-dynamodb-controller-alpha 21m
operatorhubio-olm.channel-ack-ec2-controller-alpha 21m
operatorhubio-olm.channel-ack-ecr-controller-alpha 21m
operatorhubio-olm.channel-ack-eks-controller-alpha 21m
operatorhubio-olm.channel-ack-elasticache-controller-alpha 21m
operatorhubio-olm.channel-ack-emrcontainers-controller-alpha 21m
operatorhubio-olm.channel-ack-eventbridge-controller-alpha 21m
operatorhubio-olm.channel-ack-iam-controller-alpha 21m
operatorhubio-olm.channel-ack-kinesis-controller-alpha 21m
...
-
Run the following command to get a list of bundles:
$ kubectl get catalogmetadata -l olm.bundle
Example output
NAME AGE
operatorhubio-olm.bundle-ack-acm-controller-ack-acm-controller.v0.0.1 19m
operatorhubio-olm.bundle-ack-acm-controller-ack-acm-controller.v0.0.2 19m
operatorhubio-olm.bundle-ack-acm-controller-ack-acm-controller.v0.0.4 19m
operatorhubio-olm.bundle-ack-acm-controller-ack-acm-controller.v0.0.5 19m
operatorhubio-olm.bundle-ack-acm-controller-ack-acm-controller.v0.0.6 19m
operatorhubio-olm.bundle-ack-acm-controller-ack-acm-controller.v0.0.7 19m
operatorhubio-olm.bundle-ack-apigatewayv2-controller-ack-apigatewayv2-controller.v0.0.10 19m
operatorhubio-olm.bundle-ack-apigatewayv2-controller-ack-apigatewayv2-controller.v0.0.11 19m
operatorhubio-olm.bundle-ack-apigatewayv2-controller-ack-apigatewayv2-controller.v0.0.12 19m
operatorhubio-olm.bundle-ack-apigatewayv2-controller-ack-apigatewayv2-controller.v0.0.13 19m
operatorhubio-olm.bundle-ack-apigatewayv2-controller-ack-apigatewayv2-controller.v0.0.14 19m
operatorhubio-olm.bundle-ack-apigatewayv2-controller-ack-apigatewayv2-controller.v0.0.15 19m
operatorhubio-olm.bundle-ack-apigatewayv2-controller-ack-apigatewayv2-controller.v0.0.16 19m
operatorhubio-olm.bundle-ack-apigatewayv2-controller-ack-apigatewayv2-controller.v0.0.17 19m
...
Contributing
Thanks for your interest in contributing to catalogd
!
catalogd
is in the very early stages of development and a more in depth contributing guide will come in the near future.
In the mean time, it is assumed you know how to make contributions to open source projects in general and this guide will only focus on how to manually test your changes (no automated testing yet).
If you have any questions, feel free to reach out to us on the Kubernetes Slack channel #olm-dev or create an issue
Testing Local Changes
Prerequisites
Local (not on cluster)
Note: This will work only for the controller
kind create cluster
- Install CRDs and run the controller locally:
kubectl apply -f config/crd/bases/ && make run
On Cluster
- Build the images locally:
make docker-build-controller && make docker-build-server
kind create cluster
- Load the images onto the cluster:
kind load docker-image quay.io/operator-framework/catalogd-controller:latest && kind load docker-image quay.io/operator-framework/catalogd-server:latest
make cert-manager
kubectl apply -f config/crd/bases/
- Deploy the apiserver, etcd, and controller:
kubectl apply -f config/
- Create the sample Catalog (this will trigger the reconciliation loop):
kubectl apply -f config/samples/core_v1alpha1_catalog.yaml