https://github.com/docker-client/docker-compose-v3

https://github.com/docker-client/docker-compose-v3

client compose docker docker-client docker-compose docker-stack docker-swarm-mode hacktoberfest java kotlin moby

Last synced: 12 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/docker-client/docker-compose-v3
• Owner: docker-client
• License: mit
• Created: 2017-03-12T12:17:26.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2024-10-28T15:58:33.000Z (23 days ago)
• Last Synced: 2024-11-01T06:42:29.741Z (19 days ago)
• Topics: client, compose, docker, docker-client, docker-compose, docker-stack, docker-swarm-mode, hacktoberfest, java, kotlin, moby
• Language: Kotlin
• Homepage:
• Size: 924 KB
• Stars: 18
• Watchers: 3
• Forks: 4
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://img.shields.io/github/actions/workflow/status/docker-client/docker-compose-v3/cd.yml?branch=main&style=for-the-badge)](https://github.com/docker-client/docker-compose-v3/actions)

[![Maven Central](https://img.shields.io/maven-central/v/de.gesellix/docker-compose.svg?style=for-the-badge&maxAge=86400)](https://search.maven.org/search?q=g:de.gesellix%20AND%20a:docker-compose)

# docker-compose-v3

### About

This is a small library to load Docker Compose v3 YAML files for further consumption. The driving force is the [Docker Client](https://github.com/gesellix/docker-client) library, where the equivalent to `docker stack deploy` needs to load such Compose v3 YAML files.

A bit more clarification can be found at [issue #2](https://github.com/docker-client/docker-compose-v3/issues/2).

### Usage

Given a Compose file being available as `InputStream` and its `workingDir` you can read the YAML file like this:

    InputStream composeStack = getClass().getResourceAsStream('docker-stack.yml')

    String workingDir = Paths.get(getClass().getResource('docker-stack.yml').toURI()).parent

    ComposeConfig composeConfig = new ComposeFileReader().load(composeStack, workingDir, System.getenv())

    ...

You can find a real life example at the [Docker Client's DeployConfigReader](https://github.com/gesellix/docker-client/blob/0ee342ef0d766c44909f83cb6fba720ed627fcc5/client/src/main/groovy/de/gesellix/docker/client/stack/DeployConfigReader.groovy#L55).

### Contributing

Please submit an issue if you'd like to ask a question or propose a new feature (maybe Compose v2 support?). Pull Requests are welcome, too!

## Publishing/Release Workflow

See RELEASE.md