Open Application Model

October 17, 2024 ยท View on GitHub

Version

This is Open Application Model documentation version v0.3.0. Learn more about versioning below.

The Documentations

Notational Conventions

  1. Purpose and Goals
  2. Overview and Terminology
  3. Component Model
  4. Workload Types
  5. Application Scopes
  6. Traits
  7. Application
  8. Practical Considerations
  9. Design Principles

The Model Entities

CategoryAPI Version
ComponentDefinitoncorev1beta1
WorkloadDefinitoncorev1beta1
TraitDefinitioncorev1beta1
Application Scopecorev1beta1
Applicationcorev1beta1

Versioning

For the model objects, Open Application Model adopts Kubernetes API resource convention.

Releases of the model are versioned according to Semantic Versioning 2.0 and described in OAM release page. Implementations of the model are required to specify which version they implement.

Changes to the API objects

Changes to the API objects in this model follows on compatibility and incompatible api changes defined in Kubernetes API resource convention. It doesn't couple with release version of the model.

Changes to the change process (e.g. governance model, review/approve process etc) itself are not currently versioned but may be independently versioned in the future.