Operator deployment

.github/workflows/publish-artifacts.yml

@@ -15,7 +15,7 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  build-publish-demo:
+  build-publish-artifacts:
     runs-on: ubuntu-latest
     # if: github.ref == 'refs/heads/main'
     steps:

Makefile

@@ -21,6 +21,9 @@ CONTAINER_TOOL ?= docker
 SHELL = /usr/bin/env bash -o pipefail
 .SHELLFLAGS = -ec
 
+# Kardinal Operator
+IMG ?= kurtosistech/kardinal-operator:latest
+
 .PHONY: all
 all: build
 

README.md

@@ -2,37 +2,57 @@
 
 Implementation of [Kardinal](https://github.com/kurtosis-tech/kardinal) as a K8S Operator.
 
-## Development
-
-Minikube + K8S manifest deployed. K8S context set to your local cluster.
-```
-make install (to install the CRDs into the cluster)
-```
+## Install
 
-The following three commands are commonly used during development:
+The Kardinal Operator is built using Kubebuilder.  Run the following commands to install the CRDs and the operator in the cluster pointed by your kubeconfig.
 
 ```
-make lint (Run golangci linter. Can also be configured inside your IDE.)
-make test (Run tests against local cluster)
-make run (Run operator against your local cluster)
+make deploy
 ```
 
-Manage custom resources with kubectl:
+## CRDs
+
+### Flows
 
 ```yaml
 apiVersion: core.kardinal.dev/v1
 kind: Flow
 metadata:
   labels:
     app.kubernetes.io/name: kardinal
-    app.kubernetes.io/managed-by: kustomize
+    app.kubernetes.io/managed-by: kardinal-operator
   name: flow-test
   namespace: baseline
 spec:
   service: frontend
   image: kurtosistech/frontend:demo-frontend
 ```
 
+## Uninstall
+
+Run the following commands to uninstall the CRDs and the operator in the cluster pointed by your kubeconfig.
+
+```
+make undeploy
+```
+
+## Development
+
+Minikube + K8S manifest deployed. K8S context set to your local cluster.
+```
+make install (to install the CRDs into the cluster)
+```
+
+The following three commands are commonly used during development:
+
+```
+make lint (Run golangci linter. Can also be configured inside your IDE.)
+make test (Run tests against local cluster)
+make run (Run operator against your local cluster)
+```
+
+Manage custom resources with kubectl:
+
 ```
 # Create a flow 
 kubectl create -f ./ci/flow-test.yaml
@@ -47,11 +67,6 @@ kubectl get flows -n baseline
 kubectl describe flows flow-test -n baseline
 ```
 
-Deploy the operator inside the cluster
-```
-make deploy (when you want to test it inside the cluster)
-```
-
 ## Update the CRDs API
 
 1. Read [this document][api-design-doc] to follow the design rules.
@@ -73,4 +88,4 @@ make deploy (when you want to test it inside the cluster)
    4. NOTE: If you receive an error, please run the specified command in the error and re-run make manifests.
 
 [api-design-doc]: https://book.kubebuilder.io/cronjob-tutorial/api-design
-[rbac-markers-doc]: https://book.kubebuilder.io/reference/markers/rbac
+[rbac-markers-doc]: https://book.kubebuilder.io/reference/markers/rbac

config/manager/kustomization.yaml

@@ -1,2 +1,8 @@
 resources:
 - manager.yaml
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+images:
+- name: controller
+  newName: controller
+  newTag: latest