Skip to content

Commit

Permalink
Merge pull request #1119 from nolar/move-the-warning-to-the-index
Browse files Browse the repository at this point in the history
Move the feedback warning to the intro page
  • Loading branch information
nolar authored Jun 15, 2024
2 parents c1f00bb + 12d7111 commit 073cb54
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
8 changes: 8 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
Kopf: Kubernetes Operators Framework
====================================

Please do not use Kopf, it is a nightmare of controller bad practices and some of its implicit behaviors will annihilate your API server. The individual handler approach it encourages is the exact opposite of how you should write a Kubernetes controller. Like fundamentally it teaches you the exact opposite mindset you should be in. Using Kopf legitimately has taken years off my life and it took down our clusters several times because of poor code practices on our side and sh***y defaults on its end. We have undergone the herculean effort to move all our controllers to pure golang and the result has been a much more stable ecosystem. /Jmc_da_boss__/

__ https://www.reddit.com/r/kubernetes/comments/1dge5qk/comment/l8qbbll/

Think twice before you step into this territory. You were warned!

And now, after this honest and so far the best summarizing and publicly available feedback, comes the Dark Side (with cookies) 😈

.. toctree::
:maxdepth: 2
:caption: First steps:
Expand Down
8 changes: 0 additions & 8 deletions docs/vision.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,3 @@ a mapping of Python classes to Kubernetes resources

.. _Occam's Razor: https://en.wikipedia.org/wiki/Occam%27s_razor
.. _KISS: https://en.wikipedia.org/wiki/KISS_principle

However, it brings its own vision on how to write operators and controllers, which is not always in line with the agreed best practices of the Kubernetes world, sometimes the opposite of those. Here is the indicative publicly available summary:

> Please do not use Kopf, it is a nightmare of controller bad practices and some of its implicit behaviors will annihilate your API server. The individual handler approach it encourages is the exact opposite of how you should write a Kubernetes controller. Like fundamentally it teaches you the exact opposite mindset you should be in. Using Kopf legitimately has taken years off my life and it took down our clusters several times because of poor code practices on our side and sh***y defaults on its end. We have undergone the herculean effort to move all our controllers to pure golang and the result has been a much more stable ecosystem. /Jmc_da_boss__/

__ https://www.reddit.com/r/kubernetes/comments/1dge5qk/comment/l8qbbll/

Think twice before you step into this territory ;-)

0 comments on commit 073cb54

Please sign in to comment.