Skip to content
The Open Application Model specification
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github add @resouer and @hongchaodeng to OWNERS (#209) Oct 14, 2019
assets fix red curve (#210) Oct 14, 2019
schema removed 'type' field from trait (#234) Oct 26, 2019
standard/traits Adding placeholder directory for standard trait definitions. Aug 13, 2019
.gitignore add gitignore and remove .DS_Store (#201) Oct 10, 2019
1.purpose_and_goals.md Readability updates (#184) Oct 7, 2019
2.overview_and_terminology.md Update 2.overview_and_terminology.md Nov 5, 2019
3.component_model.md removed 182 fix, which was surprisingly controversial Oct 15, 2019
4.application_scopes.md add declaration that runtime could have more extended application sco… Dec 2, 2019
5.traits.md fix typo in jsonschema (#244) Nov 7, 2019
6.application_configuration.md make parameter value required (#262) Nov 21, 2019
7.workload_types.md Replacing Hydra with Open Application Model (#207) Oct 11, 2019
8.practical_considerations.md Replacing Hydra with Open Application Model (#207) Oct 11, 2019
9.design_principles.md Merge pull request #204 from vturecek/remove-section-10 Oct 14, 2019
CONTRIBUTING.md fix OWNERS link in contributing.md (#257) Nov 15, 2019
LICENSE Governance (#189) Oct 10, 2019
OWNERS.md Adding owners file and updating links (#216) Oct 15, 2019
README.md add and fix broken liinks (#225) Oct 30, 2019
code-of-conduct.md Governance (#189) Oct 10, 2019
governance.md add and fix broken liinks (#225) Oct 30, 2019
introduction.md Edit pass on the intro doc (#220) Oct 15, 2019
notational_convention.md improve README and add story-based introduction (#190) Oct 9, 2019

README.md

Open Application Model Specification

Open Application Model is a specification for building cloud native applications.

Focused on separating concerns of development and operation needs, Open Application Model brings modular, extensible, and portable design to building and delivering applications on platforms like Kubernetes.

This repository is unstable, and open to contributions. The specification is under development, and breaking changes could be made. Interested in contributing? Take a look at the issue queue! We're looking for more great ideas on how to model cloud native applications.

Introduction

How it works

When it comes to application development and deployment, we think it is important to distinguish between the parts that developers are responsible for, and the parts that operations is responsible for. Otherwise, if these roles get muddled, it would result in communications mishaps, bugs, or even service outages.

Open Application Model attempts to solve this problem by modeling the application according to the roles responsible for building and running apps and operating infrastructure.

  • Developers are responsible for describing what a microservice or component does, and how it can be configured. They are the domain experts on the code.
  • Application Operators are responsible for configuring the runtime aspects of one or more of these microservices. They are the domain experts on the platform.
  • Infrastructure Operators are responsible for setting up and maintaining the infrastructure within which applications run. They are the domain experts on the low-level details.

For more details and user stories, see introduction.md.

See it in action

Rudr is a reference implementation of the Open Application Model specification for Kubernetes. To get started with an example on the Open Application Model, go to the Rudr Tutorial guide.

The Specification

Notational Conventions

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

Community

Milestones

To get an overview of the milestones and their description please visit the Milestones page.

Triaging

Triaging of items into milestones will occur during the bi-weekly community call. During this call, issues might be brought into milestones, removed from milestones or moved between milestones.

Contributing

See the CONTRIBUTING guide for more information about submitting changes to the spec.

One of the easiest ways to contribute is to participate in discussions. There are several ways to get involved.

Item Value
Mailing List https://groups.google.com/forum/#!forum/oam-dev
Community meeting info Bi-weekly (Starting Oct 22, 2019), Tuesdays 10:30AM PST
Community meeting link https://zoom.us/j/271516061
IM Channel https://gitter.im/oam-dev/
Twitter @oam_dev
You can’t perform that action at this time.