https://github.com/kuadrant/limitador-operator

https://github.com/kuadrant/limitador-operator

Last synced: about 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/kuadrant/limitador-operator
• Owner: Kuadrant
• License: apache-2.0
• Created: 2020-12-15T13:59:45.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T17:25:48.000Z (over 1 year ago)
• Last Synced: 2024-10-29T18:28:47.535Z (over 1 year ago)
• Language: Go
• Size: 20.8 MB
• Stars: 6
• Watchers: 9
• Forks: 14
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Limitador Operator

[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0) 

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FKuadrant%2Flimitador-operator.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2FKuadrant%2Flimitador-operator?ref=badge_shield)

[![codecov](https://codecov.io/gh/Kuadrant/limitador-operator/branch/main/graph/badge.svg?token=181Q05ZJBJ)](https://codecov.io/gh/Kuadrant/limitador-operator)

## Overview

The Operator to manage [Limitador](https://github.com/Kuadrant/limitador) deployments.

## CustomResourceDefinitions

* [Limitador](#limitador-crd), which defines a desired Limitador deployment.

### Limitador CRD

[Limitador v1alpha1 API reference](https://github.com/Kuadrant/limitador-operator/tree/main/api/v1alpha1/limitador_types.go)

Example:

```yaml

---

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](./doc/storage.md)

* [Rate Limit Headers](./doc/rate-limit-headers.md)

* [Logging](./doc/logging.md)

* [Tracing](./doc/tracing.md)

* [Custom Image](./doc/custom-image.md)

## Contributing

The [Development guide](./doc/development.md) 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](https://kubernetes.slack.com/archives/C05J0D0V525) channel in the Kubernetes Slack workspace, 

for live discussions about the roadmap and more.

## Licensing

This software is licensed under the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0).

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

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FKuadrant%2Flimitador-operator.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2FKuadrant%2Flimitador-operator?ref=badge_large)