-
Notifications
You must be signed in to change notification settings - Fork 1.8k
README: add What's SDK section #38
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
Conversation
lgtm defer @hasbro17 |
README.md
Outdated
## What’s Operator SDK? | ||
## What is Operator SDK? | ||
|
||
Kubernetes is a wonderful platform and a lot of applications can be run on top of it smoothly. However, there are still some applications not so native to Kubernetes. In other words, it requires significant effort to write Kubernetes deploy code/scripts, besides that those applications are already hard to configure and manage correctly. [Operator][operator_link] is an approach to easily and natively manage applications on Kubernetes. Domain experts write down operational knowledge as code and extend kube-API to connect everything to the one platform. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a suggestion if you wanted to make it more concise.
it requires significant effort to write Kubernetes deploy code/scripts, besides that those applications are already hard to configure and manage correctly
to
it requires significant effort to write code/scripts to deploy, configure, and manage applications on Kubernetes correctly
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
to connect everything to the one platform
==> to connect everything to a single platform
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it requires significant effort to write code/scripts to deploy, configure, and manage applications on Kubernetes correctly
This would change what was meant.
There are two parts: 1. apps are hard to manage; 2. hard to run on Kubernetes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah if we want to emphasize the two parts separately then keep it as it is for now. The exact wording is a little subjective and we can refine it later if needed.
README.md
Outdated
|
||
Kubernetes is a wonderful platform and a lot of applications can be run on top of it smoothly. However, there are still some applications not so native to Kubernetes. In other words, it requires significant effort to write Kubernetes deploy code/scripts, besides that those applications are already hard to configure and manage correctly. [Operator][operator_link] is an approach to easily and natively manage applications on Kubernetes. Domain experts write down operational knowledge as code and extend kube-API to connect everything to the one platform. | ||
|
||
Operator SDK is a Kubernetes operator framework written in Go language. It is designed to make writing an operator easier by having opinions about the programming model. It empowers developers to build powerful operators by providing high level API and reusing common modules to do more with less. It makes developing on Kubernetes more fun. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
providing high level API
==> providing a high level API
Addressed two minor points @hasbro17 . PTAL |
LGTM |
Additions: - chore: bump go 1.17, k8s 1.23, and kubebuilder 3.3 (#69) - chore(deps): update to Quarkus SDK extension 3.0.2 and Quarkus 2.6.3 (#70) - chore(deps): update to use Quarkus JOSDK extension 3.0.1 (#67) - Remove useless file (#65) - chore: bump k8s 1.22.2 and kubebuilder 3.2 (#64) - exposed exnpoints for micrometer metrics (#45) - modified the Quarkus operator SDK version and tutorial too (#40) - chore: bump fabric8 5.8.0 & quarkus 2.4.0 (#42) - modified the doc file and removed file after generation (#41) - release: fix release script to understand release branches (#38) Bug Fixes: - Fix for wrongly generated file name (#73) Signed-off-by: jesus m. rodriguez <jesusr@redhat.com>
No description provided.