From 32586bc277301e4b08b8d04ed6e34e34b9291596 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Attila=20M=C3=A9sz=C3=A1ros?= Date: Thu, 21 Sep 2023 10:18:43 +0200 Subject: [PATCH] docs: webpage sample docs improvement MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Attila Mészáros --- sample-operators/webpage/README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/sample-operators/webpage/README.md b/sample-operators/webpage/README.md index afbabf4abe..7718d0f2f3 100644 --- a/sample-operators/webpage/README.md +++ b/sample-operators/webpage/README.md @@ -1,7 +1,7 @@ -# WebServer Operator +# WebPage Operator This is a simple example of how a Custom Resource backed by an Operator can serve as -an abstraction layer. This Operator will use a webserver resource, which mainly contains a +an abstraction layer. This Operator will use a WebPage resource, which mainly contains a static webpage definition and creates an NGINX Deployment backed by a ConfigMap which holds the HTML. @@ -23,6 +23,16 @@ spec: ``` + +### Different Flavors + +Sample contains three implementation, that are showcasing the different approaches possible with the framework, +the resulting behavior is almost identical behavior at the end: + +- [Low level API](https://github.com/java-operator-sdk/java-operator-sdk/blob/main/sample-operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/WebPageDependentsWorkflowReconciler.java) +- [Using managed dependent resources](https://github.com/java-operator-sdk/java-operator-sdk/blob/main/sample-operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/WebPageManagedDependentsReconciler.java) +- [Using standalone Dependent Resources](https://github.com/java-operator-sdk/java-operator-sdk/blob/main/sample-operators/webpage/src/main/java/io/javaoperatorsdk/operator/sample/WebPageStandaloneDependentsReconciler.java) + ### Try The quickest way to try the operator is to run it on your local machine, while it connects to a local or remote