Popularity
6.2
Stable
Activity
7.6
Growing
1,290
54
581

Programming language: SCSS
License: Apache License 2.0
Tags: Others     DevOps Tools    
Add another 'Others' Package

README

Compose Specification

{:.no_toc}

The Compose specification establishes a standard for the definition of multi-container platform-agnostic applications. The specification can be found [here](spec.md).

  • ToC {:toc}

Use cases

To provide more context on the Compose specification the following section gives example use cases for each part of the specification.

Development tools

Developers can use a Compose file to specify a container-based application that will run as a set of containers on a local container engine. The Compose implementation in this scenario could offer some specific features (local volume binding, live-reload) to better address development needs. The application definition and Compose model is the same used as that used for other use cases. Platform features expected by the specification (like configs and secrets) can be mocked with local resources.

Kubernetes deployment

Kubernetes container orchestration relies on a set of abstract concepts and APIs to manage networking services, container deployments and their lifecycles. While this offers flexibility to address many operator use cases, it makes simple use cases, like the developer use case, more complicated to express than they need to be. Projects like Kompose or Okteto Stacks show how the simpler Compose model can be translated into Kubernetes API payloads and make the Compose file the source of truth for development and deployment.

Cloud providers

Some cloud providers offer proprietary container hosting solutions based on in-house orchestrators and custom APIs. The Compose specification offers a simple model that can be mapped to these hosting solutions so that users can reuse Compose files that they already have and so that they do not need to learn custom configuration file formats. Platform specific features can be added either using Compose extensions or a dedicated configuration file along side the Compose file.

Contributing

Development happens on GitHub for the specification. Issues are used to track bugs and actionable items. Longer discussions can happen on the mailing list.

The specification and code is licensed under the Apache 2.0 license found in the [LICENSE](LICENSE) file.

Implementations

Docker Compose is the Reference Implementation of the Compose Specification.

Compose Specification is also implemented by:

Metadata
Status Work in progress
Created 2020-01-02


*Note that all licence references and agreements mentioned in the docker-compose README section above are relevant to that project's source code only.