Skip to content

Commit

Permalink
[README] link to achilles-token-controller (#6)
Browse files Browse the repository at this point in the history
  • Loading branch information
harveyxia authored Nov 11, 2024
1 parent 675783a commit d516430
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,18 @@
# Achilles SDK

The Achilles SDK offers efficient
[controller](https://kubernetes.io/docs/concepts/architecture/controller/) and
[operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/)
[operator/controller](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/)
creation by allowing engineers to focus on defining their automation business logic, modeled as transitions between resources states (i.e. an FSM). This
significantly lessens the knowledge of controller and Kubernetes plumbing
typically required to build controllers. It also forces standardization to
ensure consistency amongst controllers at Reddit, providing common functionality
such as metrics, logging, reusable API structs, etc..

See the [achilles-token-controller](https://github.com/reddit/achilles-token-controller) repo for
a complete, runnable example of an Achilles SDK backed controller.

## High Level Walkthrough

As an example, assume you wanted to create a declarative API that allows
developers to request object storage for their application. The API you wish to
expose may look something like:
Expand Down

0 comments on commit d516430

Please sign in to comment.