airship/docs
Code Issues Proposed changes
docs/doc/source/develop/crd-conventions.rst
Drew Walters bc6b004dba Restructure Documentation 
This change restructures the documentation into three categories that we
will expand on later:

  1. Try Airship
  2. Develop Airship
  3. Learn About Airship

Change-Id: I52286c3b1d87222a436be86b4ab748dba61d080c
Signed-off-by: Drew Walters <andrew.walters@att.com>
2020-03-02 16:04:01 +00:00

1.8 KiB
Raw Blame History

CRD Conventions

Airship will use CRDs to enrich the Kubernetes API with Airship-specific document schema. Airship projects will follow the following conventions when defining Custom Resource Definitions (CRDs).

Note that Airship integrates and consumes a number of projects from other open source communities, which may have their own style conventions, and which will therefore be reflected in Airship deployment manifests. Those fall outside the scope of these Airship guidelines.

In general, Airship will follow the Kubernetes API Conventions when defining CRDs. These cover naming conventions (such as using camelCase for key names), expected document structure, HTTP request verbs and status codes, and behavioral norms.

Exceptions or restrictions from the Kubernetes conventions are specified below; this list may grow in the future.

  • The apiGroup (and apiVersion) for Airship CRDs will have values following the convention <function>.airshipit.org.