Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating readme #34

Merged
merged 3 commits into from
Aug 23, 2022
Merged

Updating readme #34

merged 3 commits into from
Aug 23, 2022

Conversation

didierofrivia
Copy link
Member

@didierofrivia didierofrivia commented Aug 22, 2022

  • License badge
  • Overview
  • Provided APIs
  • Documentation
  • License

It looks like this:

Kuadrant Operator

License

Overview

The Operator to install and manage the lifecycle of the Kuadrant components deployments.

Provided APIs

The kuadrant control plane owns the following Custom Resource Definitions, CRDs:

CRD Description Example
RateLimitPolicy CRD [doc] [reference] Enable access control on workloads based on HTTP rate limiting RateLimitPolicy CR
AuthPolicy CRD Enable AuthN and AuthZ based access control on workloads AuthPolicy CR

Additionally, Kuadrant provides the following CRDs

CRD Owner Description Example
Kuadrant CRD Kuadrant Operator Represents an instance of kuadrant Kuadrant CR
Limitador CRD Limitador Operator Represents an instance of Limitador Limitador CR
Authorino CRD Authorino Operator Represents an instance of Authorino Authorino CR

Documentation

Docs can be found on the Kuadrant website.

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.

* License badge
* Overview
* Provided APIs
* Examples
* License
@didierofrivia didierofrivia requested review from eguzki and a team August 22, 2022 15:52
README.md Outdated Show resolved Hide resolved
@didierofrivia didierofrivia merged commit 30c8190 into main Aug 23, 2022
@didierofrivia didierofrivia deleted the readme branch August 23, 2022 16:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants