Documentation

[nolar]

The project is now in the proof-of-concept stage, and lacks the documentation (beside the docstrings and examples).

It needs some normal hosted HTML docs (e.g. on ReadTheDocs).

• Hosting configured.
• Builds configured.

Specifically, some topics to not forget:

• Typical patterns to solve typical problems (similar to examples). E.g., children object creation.
• Deployment patterns: namespace isolation, deployment and RBAC-based service accounts
  (minimum rules needed for the framework, not the general recommendations), etc. See Add the RBAC examples for deployments #17.
• Getting starting (or quick-start) guide (isn't it an example/01-minimal?).
• The requirement for **kwargs or **_ (for no-linting) for the forward-compatibility with the new keywords passed to the existing handlers by the new versions of the framework (part of the DSL).
• The full list of all the available keywords now: body, meta, spec, status, patch, logger, retry, diff, old, new.
• How the state is persistent in k8s itself, point out that the framework is stateless (same as the web servers).
• What happens when the operator is killed during the handler, and how to avoid the duplicated side-effects (i.e. idempotent handlers).
• What happens when the changes are applied when the operator is dead or fails permanently due to the bugs (the last-seen state preservation and comparison), i.e. that no changes are left behind unnoticed.
• Strategies to isolate the operators to the namespaces; but still to have the cluster-wide operators (cluster CRDs or all-namespace monitoring, as e.g. Postgres operators, i.e. not already domain-specific ad-hoc solutions).
• Alternatives: CoreOS Operator Framework, all Go-based solutions, etc). Differences and similarities, and the self-positioning of Kopf.