Crates.io | coredb-operator |
lib.rs | coredb-operator |
version | 0.0.1 |
source | src |
created_at | 2023-01-27 14:32:59.739343 |
updated_at | 2023-01-27 14:32:59.739343 |
description | The CLI for CoreDB |
homepage | https://www.coredb.io |
repository | https://github.com/CoreDB-io/coredb |
max_upload_size | |
id | 769701 |
size | 134,923 |
A rust kubernetes controller for a CoreDB
resource using kube-rs.
The Controller
object reconciles CoreDB
instances when changes to it are detected, writes to its .status object, creates associated events, and uses finalizers for guaranteed delete handling.
Run linting with cargo fmt
and clippy
Clippy:
rustup component add clippy
cargo clippy
cargo fmt:
rustup component add rustfmt --toolchain nightly
cargo +nightly fmt
cargo test
kubectl label namespace default safe-to-run-coredb-tests=true
cargo test -- --ignored
--nocapture
flag to show print statements during test runsAs an example; install kind
. Once installed, follow these instructions to create a kind cluster connected to a local image registry.
Apply the CRD from cached file, or pipe it from crdgen
(best if changing it):
cargo run --bin crdgen | kubectl apply -f -
Setup an opentelemetry collector in your cluster. Tempo / opentelemetry-operator / grafana agent should all work out of the box. If your collector does not support grpc otlp you need to change the exporter in main.rs
.
cargo run
cargo install cargo-watch
cargo watch -x 'run'
OPENTELEMETRY_ENDPOINT_URL=https://0.0.0.0:55680 RUST_LOG=info,kube=trace,controller=debug cargo run --features=telemetry
Compile the controller with:
just compile
Build an image with:
just build
Push the image to your local registry with:
docker push localhost:5001/controller:<tag>
Edit the deployment's image tag appropriately, then run:
kubectl apply -f yaml/deployment.yaml
kubectl port-forward service/coredb-controller 8080:80
NB: namespace is assumed to be default
. If you need a different namespace, you can replace default
with whatever you want in the yaml and set the namespace in your current-context to get all the commands here to work.
In either of the run scenarios, your app is listening on port 8080
, and it will observe CoreDB
events.
Try some of:
kubectl apply -f yaml/sample-coredb.yaml
kubectl delete coredb sample-coredb
kubectl edit coredb sample-coredb # change replicas
The reconciler will run and write the status object on every change. You should see results in the logs of the pod, or on the .status object outputs of kubectl get coredb -o yaml
.
The sample web server exposes some example metrics and debug information you can inspect with curl
.
$ kubectl apply -f yaml/sample-coredb.yaml
$ curl 0.0.0.0:8080/metrics
# HELP cdb_controller_reconcile_duration_seconds The duration of reconcile to complete in seconds
# TYPE cdb_controller_reconcile_duration_seconds histogram
cdb_controller_reconcile_duration_seconds_bucket{le="0.01"} 1
cdb_controller_reconcile_duration_seconds_bucket{le="0.1"} 1
cdb_controller_reconcile_duration_seconds_bucket{le="0.25"} 1
cdb_controller_reconcile_duration_seconds_bucket{le="0.5"} 1
cdb_controller_reconcile_duration_seconds_bucket{le="1"} 1
cdb_controller_reconcile_duration_seconds_bucket{le="5"} 1
cdb_controller_reconcile_duration_seconds_bucket{le="15"} 1
cdb_controller_reconcile_duration_seconds_bucket{le="60"} 1
cdb_controller_reconcile_duration_seconds_bucket{le="+Inf"} 1
cdb_controller_reconcile_duration_seconds_sum 0.013
cdb_controller_reconcile_duration_seconds_count 1
# HELP cdb_controller_reconciliation_errors_total reconciliation errors
# TYPE cdb_controller_reconciliation_errors_total counter
cdb_controller_reconciliation_errors_total 0
# HELP cdb_controller_reconciliations_total reconciliations
# TYPE cdb_controller_reconciliations_total counter
cdb_controller_reconciliations_total 1
$ curl 0.0.0.0:8080/
{"last_event":"2019-07-17T22:31:37.591320068Z"}
The metrics will be auto-scraped if you have a standard PodMonitor
for prometheus.io/scrape
.