Prerequisites
Local Development
Tilt offers a simple way of creating a local development environment.
Create local k8s cluster
Open the tilt
browser UI by pressing the "space" key when prompted. Note that tilt
sets up a directory watcher and will automatically redeploy any code changes!
You can check the "temporal-operator-controller-manager" Pod status with kubectl get pods -n temporal-system -w
.
Apply Manifests
Once the local cluster is created, start applying your desired manifests and let the temporal operator handle reconciliation:
# example
make artifacts
kubectl apply -f examples/cluster-postgres/00-namespace.yaml
kubectl apply -f examples/cluster-postgres/01-postgresql.yaml
kubectl apply -f examples/cluster-postgres/02-temporal-cluster.yaml
kubectl apply -f examples/cluster-postgres/03-temporal-namespace.yaml
Note: if you wish to interact with the Temporal Web UI or frontend gRPC service, you should port forward the services to localhost.
Generate
Generate crd and docs when api is modified
Test
Run tests with coverage report:
Run end-to-end tests:
Run end-to-end tests on development computer using kind
: