📖 add guide for distributing Kubebuilder project #4884
Conversation
k8s-ci-robot
added
the
cncf-cla: yes
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: rayowang The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
size/L
rayowang
changed the title
rayowang
changed the title
rayowang
force-pushed
the
distributing-kubebuilder-project
branch
from
2f9805c to
52c8b03
Compare
rayowang
changed the title
rayowang
force-pushed
the
distributing-kubebuilder-project
branch
2 times, most recently
from
395224a to
7d53f01
Compare
rayowang
force-pushed
the
distributing-kubebuilder-project
branch
from
43ff10f to
01faa13
Compare
|
/retest |
|
/test pull-kubebuilder-e2e-k8s-1-31-4 |
rayowang
force-pushed
the
distributing-kubebuilder-project
branch
from
ecb3432 to
772f907
Compare
|
@camilamacedo86 @mateusoliveira43 Hi， Sorry, I didn’t know why the e2e tests kept timing out before, but it’s working fine now. If you have time, could you please help review it again to see if there are any issues? Thank you! |
k8s-ci-robot
added
size/M
rayowang
force-pushed
the
distributing-kubebuilder-project
branch
from
2ab317d to
879ed1a
Compare
|
/test pull-kubebuilder-e2e-k8s-1-32-0 |
|
@camilamacedo86 Hi, Camila, currently, following the suggestions, I am focusing on ‘how to distribute operators built with Kubebuilder.’ I would appreciate it if you could review it when you have time. |
|
|
||
| This section would help users understand how to package and deliver their Kubebuilder-based Operators to end users. | ||
|
|
||
| ## By Providing Operator SDK Bundle |
There was a problem hiding this comment.
Hi @rayowang,
Thank you so much for your effort on this — the current approach looks great!
I think it would be a good idea to include this in the FAQ section instead: https://book.kubebuilder.io/faq#faq, under a new question like:
"How to build a bundle with Kubebuilder-based projects to be managed by OLM and/or published in OperatorHub.io?"
Would you mind moving it there?
Also, can you please squash the commits? We can only merge them with one commit.
Thanks again! 🙏
There was a problem hiding this comment.
So, that we can try to be more focused in only a small info, yet ;-)
| ## FAQ: How to Publish Your Project to OperatorHub.io / OKD / OCP Catalog | ||
|
|
||
| To publish your operator to public platforms like OperatorHub.io, OKD, or the OCP catalog, here are the steps you can follow: | ||
| 1. OperatorHub.io: Follow the [OperatorHub.io Documentation](https://operatorhub.io/docs/) to submit your operator. | ||
| 2. OKD/OCP Catalog: Refer to the [OKD or OCP documentation]((https://okd.io/docs/documentation/) ) for adding your operator to their catalogs. |
There was a problem hiding this comment.
Can we remove this part and link it in the question title?
Also, we should not speak about OCP/OKD, only OLM ( https://operator-framework.github.io/operator-controller/ )
By last check, all docs have the links as aliases; can we proceed as with the other ones?
The link is defined at the bottom of the pages
Complete Fixes #4873