From 6f3aa3b5e74d848b9890fbb8f30ef052babb6bb3 Mon Sep 17 00:00:00 2001 From: Harvey Xia Date: Mon, 11 Nov 2024 15:05:25 -0500 Subject: [PATCH] [README] link to achilles-token-controller --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b9676a8..9795e4d 100644 --- a/README.md +++ b/README.md @@ -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: