WIP: PoC: use the rukpak PoC OCI artifact source

[joelanford]

Setup

1. Clone the 4 repos and checkout the correct commits:

   mkdir -p demo && pushd demo
   gh repo clone joelanford/olm-oci
   gh repo clone operator-framework/catalogd -- --branch oci-artifact-source
   gh repo clone joelanford/operator-controller -- --branch oci-artifacts
   gh repo clone anik120/rukpak -- --branch oci-artifacts-provisioner
   

2. Setup binaries and cluster

   export PATH=$(pwd)/olm-oci/bin:$PATH
   export KIND_CLUSTER_NAME=demo
   kind create cluster --name $KIND_CLUSTER_NAME
   (cd olm-oci && make)
   (cd operator-controller && make docker-build kind-load deploy)
   (cd catalogd && make generate install)
   (cd rukpak && make build-container kind-load install)
   

Demo Script

1. Example commands + Build and push bundles

   mkdir example-catalog
   bundlebuild ./olm-oci/samples/bundles/argo-cd/argo-cd.v2.7.3 example-catalog/argo-cd.v2.7.3.oci.tar
   bundlebuild ./olm-oci/samples/bundles/argo-cd/argo-cd.v2.7.4 example-catalog/argo-cd.v2.7.4.oci.tar
   bundlebuild ./olm-oci/samples/bundles/prometheus/prometheusoperator.v0.65.1 example-catalog/prometheusoperator.v0.65.1.oci.tar
   createcatalog ./example-catalog ./example-catalog.oci.tar
   olmoci inspect example-catalog.oci.tar:catalog
   rm -r example-catalog ./example-catalog.oci.tar
   
   export CATALOG_REPO=docker.io/joelanford/catalog
   ./olm-oci/samples/build_push.sh
   

2. Create an OCI Artifact-based catalog and examine catalog APIs

   kubectl create -f ./operator-controller/config/samples/catalogd_operatorcatalog.yaml
   kubectl get catalog oci-artifacts -o yaml
   kubectl get packages
   kubectl get package oci-artifacts-prometheus -o yaml
   kubectl get bundlemetadata
   kubectl get bundlemetadata oci-artifacts-prometheus.v0.65.1-0 -o yaml
   kubectl get bundlemetadata oci-artifacts-argo-cd.v2.7.4-0 -o yaml
   

3. Create an Operator for prometheus and argo-cd and example operator-controller APIs

   kubectl create -f ./operator-controller/config/samples/operators_v1alpha1_prometheus.yaml
   kubectl create -f ./operator-controller/config/samples/operators_v1alpha1_argocd.yaml
   kubectl get operator prometheus -o yaml
   kubectl get operator argo-cd -o yaml
   

4. Example rukpak APIs

   kubectl get bundledeployment prometheus -o yaml
   kubectl get bundledeployment argo-cd -o yaml
   

5. Check if expected CRDs are installed

   kubectl get crds -l core.rukpak.io/owner-name=prometheus
   kubectl get crds -l core.rukpak.io/owner-name=argo-cd
   

6. Remove grafana-operator from the catalog, rebuild, and push

   rm olm-oci/samples/catalog/grafana-operator*
   ./olm-oci/bin/createcatalog ./olm-oci/samples/catalog ./olm-oci/samples/catalog2.oci.tar
   (cd ./olm-oci/samples && ../bin/olmoci push archive catalog2.oci.tar:catalog ${CATALOG_REPO}:catalog)
   

7. Force another reconcile of the catalog, and verify the digest changed

   kubectl get catalog oci-artifacts -o jsonpath='{.status.resolvedSource.ociArtifact.ref}'
   kubectl annotate catalog oci-artifacts updateTime="$(date)"
   kubectl get catalog oci-artifacts -o jsonpath='{.status.resolvedSource.ociArtifact.ref}'
   

8. Verify that the grafana-operator package and bundlemetadata disappeared

   kubectl get package oci-artifacts-grafana-operator
   kubectl get bundlemetadata -o json \
   	| jq '[.items[] | select(.spec.package == "grafana-operator") | .metadata.name] | length'
   

Note 1

The OCI artifact spec is still very much in flux. In fact the "application/vnd.oci.artifact.manifest.v1+json" (which this demo uses) was removed from the spec just recently, and replaced with other modifications to the pre-existing OCI image manifest type.

See opencontainers/image-spec#999 (comment)

Note 2

There is a referrers API as part of the in-progress OCI spec. This enables new objects to refer to existing objects without changing the digest of the existing objects. This is perfect for use cases like deprecation and retroactive assertions. Unfortunately, I can't demo this because docker hub doesn't support the referrers API (yet?)

Reviewer Checklist

• API Go Documentation
• Tests: Unit Tests (and E2E Tests, if appropriate)
• Comprehensive Commit Messages
• Links to related GitHub Issue(s)

[openshift-merge-robot]

PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[perdasilva]

would it be better to add a new sample rather than edit the existing one? Or are we subbing out image src in favor of oci?

[perdasilva]

should this logic move to rukpak?

[perdasilva]

do we want a separate PR for this?

[perdasilva]

Looks awesome!

[joelanford]

Closing since this served its purpose for demos and there are no plans to merge this.