add kubebuilder/operator-sdk FAQ #4411
Conversation
jberkhahn
force-pushed
the
kubebuilder_faq
branch
from
fbe1d41 to
5cd1841
Compare
|
Did I not do this right? The netlify job is saying no content changes were detected so it didn't deploy a preview. |
jberkhahn
force-pushed
the
kubebuilder_faq
branch
from
5cd1841 to
ba35887
Compare
|
@camilamacedo86 updated based on your comments. Also I sorted the links. |
jberkhahn
force-pushed
the
kubebuilder_faq
branch
2 times, most recently
from
7a895d1 to
fc8f84b
Compare
camilamacedo86
left a comment
camilamacedo86
left a comment
There was a problem hiding this comment.
I added small suggestions.
Otherwise, I think it is fine. Let's see what others think as well.
|
|
||
| Operator-SDK offers additional features on top of the basic project scaffolding that Kubebuilder provides. It allows you to generate scaffolding to integrate your project with the [Operator Lifecycle Manager][olm] or OLM, a tool for mananaging the deployment, use, and upgrade of an operator on an actual in-use cluster. This scaffolding can also be used to distribute your operator on [OperatorHub][operatorhub.io], a community hub for publishing operators. Operator-SDK also has support for [Scorecard][scorecard-doc], a set of features that allow you to scaffold and run a suite of integration tests for a deployed operator. Operator-SDK also allows you to work with other languages such as Ansible and Helm to create operators as well. | ||
|
|
||
| For further context about the relationship between Kubebuilder and Operator-SDK, see [this blog post][operator-sdk-reaches-v1.0]. Note that in the past, the relationship was somewhat different, see [this comment][legacy-issue] about some of the legacy functionality from pre-1.0.0 versions of OperatorSDK. |
There was a problem hiding this comment.
| For further context about the relationship between Kubebuilder and Operator-SDK, see [this blog post][operator-sdk-reaches-v1.0]. Note that in the past, the relationship was somewhat different, see [this comment][legacy-issue] about some of the legacy functionality from pre-1.0.0 versions of OperatorSDK. | |
| For further information, check [this blog post][operator-sdk-reaches-v1.0] and [this comment][legacy-issue]. |
There was a problem hiding this comment.
I'm not so sure about this change. I want to mention that things were different pre 1.0.0
There was a problem hiding this comment.
Hi @jberkhahn,
the issue explains the diffs and the blog teh diffs + what was achieved with 1.0. In this way, IMO we can be less verbose and just say for more info check here and here. But it is just my opinion. Otherwise, it shows great for me 👍
|
@camilamacedo86 updated |
jberkhahn
force-pushed
the
kubebuilder_faq
branch
from
fc8f84b to
f2cb168
Compare
estroz
left a comment
estroz
left a comment
There was a problem hiding this comment.
@jberkhahn thanks for adding this! Got a few changes I'd like to see.
|
|
||
| ## What are the the differences between Kubebuilder and Operator-SDK? | ||
|
|
||
| Kubebuilder and Operator-SDK are integrated projects which both allow you to quickly scaffold an operator project. Both tools make use [controller-runtime][controller-runtime] and the resulting projects will have the same basic layout. For more information see the doc about [what’s in a basic project][kb-doc-what-is-a-basic-project]. |
There was a problem hiding this comment.
| Kubebuilder and Operator-SDK are integrated projects which both allow you to quickly scaffold an operator project. Both tools make use [controller-runtime][controller-runtime] and the resulting projects will have the same basic layout. For more information see the doc about [what’s in a basic project][kb-doc-what-is-a-basic-project]. | |
| Kubebuilder and Operator SDK are both projects that allow you to quickly create and manage an operator project. Operator SDK uses kubebuilder under the hood to do so for Go projects, such that the `operator-sdk` CLI tool will work with a project created by `kubebuilder`. Therefore each project makes use of [controller-runtime][controller-runtime] and will have the same [basic layout][kb-doc-what-is-a-basic-project]. |
There was a problem hiding this comment.
what is the definitive stylization of the name of our project? I've seen Operator-SDK, operator-sdk, and now Operator SDK
There was a problem hiding this comment.
Its either all lowercase and hyphenated operator-sdk (when referring to the binary itself or repo name) or title'd and not hyphenated Operator SDK (when formally referring to the Operator SDK project). I personally prefer always using operator-sdk to avoid ambiguity.
jberkhahn
force-pushed
the
kubebuilder_faq
branch
from
f2cb168 to
2700f6a
Compare
|
@estroz updated |
Signed-off-by: Jonathan Berkhahn <jaberkha@us.ibm.com>
jberkhahn
force-pushed
the
kubebuilder_faq
branch
from
2700f6a to
baa0365
Compare
Signed-off-by: Jonathan Berkhahn <jaberkha@us.ibm.com> Signed-off-by: Rein van 't Veer <reinvantveer@gmail.com>
Signed-off-by: Jonathan Berkhahn <jaberkha@us.ibm.com> Signed-off-by: Rein van 't Veer <reinvantveer@gmail.com>
Signed-off-by: Jonathan Berkhahn <jaberkha@us.ibm.com> Signed-off-by: reinvantveer <rein.van.t.veer@geodan.nl>
4 participants
Fixes #4350