Limitador Operator

Overview

The Operator to manage Limitador deployments.

CustomResourceDefinitions

• Limitador, which defines a desired Limitador deployment.

Limitador CRD

Limitador v1alpha1 API reference

Example:

---
apiVersion: limitador.kuadrant.io/v1alpha1
kind: Limitador
metadata:
  name: limitador-sample
spec:
  listener:
    http:
      port: 8080
    grpc:
      port: 8081
  limits:
    - conditions: ["get_toy == 'yes'"]
      max_value: 2
      namespace: toystore-app
      seconds: 30
      variables: []

Features

• Storage Options
• Rate Limit Headers
• Logging
• Tracing
• Custom Image

Contributing

The Development guide describes how to build the operator and how to test your changes before submitting a patch or opening a PR.

Join us on the #kuadrant channel in the Kubernetes Slack workspace, for live discussions about the roadmap and more.

Profiling

The operator supports runtime profiling via Go's built-in pprof tooling. Enabled by default on :8084.

Connect to a running instance:

kubectl port-forward -n limitador-operator-system deploy/limitador-operator-controller-manager 8084:8084
go tool pprof -http=:8080 http://localhost:8084/debug/pprof/profile?seconds=30
go tool pprof -http=:8080 http://localhost:8084/debug/pprof/heap

Licensing

This software is licensed under the Apache 2.0 license.

See the LICENSE and NOTICE files that should have been provided along with this software for details.