github.com/mkimuram/operator-sdk@v0.7.1-0.20190410172100-52ad33a4bda0/doc/design/long-term/norms-to-follow.md (about)

     1  ## SDK examples/docs show API norms authors should follow
     2  
     3  **Goal:** Help Operator authors avoid common mistakes and usability issues that the community has learned through the various operators in use today.
     4  
     5  **Problem:** There are three classes of mistakes that we have seen folks make:
     6  1. Methods for connecting Kubernetes objects through labels, OwnerRefs, status etc that may be incompatible with future updates or too restrictive in the long term.
     7  2. Attempting to add in remote connectivity directly into the Operator via an HTTP API. The Kubernetes API should be the source of desired state.
     8  3. Requiring state that is not stored within the cluster to operate safely.
     9  
    10  **Why is this important:** The SDK will be successful if it solves problems for developers out of the box. Shipping updates and new features safely via an Operator is only possible when they are deployed and used correctly.
    11  
    12  **Proposed work streams to accomplish this:**
    13   - Documentation for dos and don’ts for an Operator
    14   - Canonical sample operator that shows a complex use-case done correctly
    15  
    16  **Open questions:**
    17  1. How much of the object organization is done via helper code in the SDK vs well-planned label queries and OwnerRefs by the developer?