Skip to content

docs: webpage sample docs improvement #2069

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Sep 21, 2023
Merged

docs: webpage sample docs improvement #2069

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions sample-operators/webpage/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -23,6 +23,16 @@ spec:
</html>
```


### 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
Expand Down