https://github.com/compose-spec/compose-spec
The Compose specification
https://github.com/compose-spec/compose-spec
compose containers docker kubernetes specification
Last synced: 23 days ago
JSON representation
The Compose specification
- Host: GitHub
- URL: https://github.com/compose-spec/compose-spec
- Owner: compose-spec
- License: apache-2.0
- Created: 2019-12-10T15:16:39.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-26T00:02:27.000Z (6 months ago)
- Last Synced: 2024-10-29T15:45:44.461Z (6 months ago)
- Topics: compose, containers, docker, kubernetes, specification
- Language: Dockerfile
- Homepage: https://compose-spec.io
- Size: 763 KB
- Stars: 2,252
- Watchers: 63
- Forks: 764
- Open Issues: 105
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Governance: GOVERNANCE.md
Awesome Lists containing this project
- awesome-github-repos - compose-spec/compose-spec - The Compose specification (Dockerfile)
- awesome-standards - Compose Specification - The Compose Specification is developer focused for defining cloud and platform agnostic container-based applications. (Tools)
- awesome-standards - Compose Specification - The Compose Specification is developer focused for defining cloud and platform agnostic container-based applications. (Tools)
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](00-overview.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](https://github.com/kubernetes/kompose)
or [Okteto Stacks](https://okteto.com/docs/reference/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](https://groups.google.com/forum/#!forum/compose-spec).
The specification and code is licensed under the Apache 2.0 license found in the
[LICENSE](LICENSE) file.
## Implementations
[Docker Compose](https://github.com/docker/compose) is the Reference Implementation of the Compose Specification.
Compose Specification is also implemented by:
* [Kompose](https://github.com/kubernetes/kompose)
* [Nerdctl](https://github.com/containerd/nerdctl)
* [Okteto Stacks](https://okteto.com/docs/reference/stacks)
* [Docker Cloud Integrations](https://github.com/docker/compose-cli)
* [Podman Compose](https://github.com/containers/podman-compose)
| Metadata | |
| -------- | ---------------: |
| Status | Work in progress |
| Created | 2020-01-02 |