Documentation
¶
Overview ¶
Package compose is the Compose orchestrator: it applies a compose project to one Docker as plain containers, the way docker compose up --wait does, and labels them the way docker compose does, so that docker compose ps and logs still see them.
It drives the daemon with the moby client, not with the docker/compose packages, which pull the legacy docker/docker and docker/cli modules.
Index ¶
- Constants
- func New(ctx context.Context) (installer.Orchestrator, error)
- type Orchestrator
- func (orchestrator *Orchestrator) Close() error
- func (orchestrator *Orchestrator) Install(ctx context.Context, project *installer.Project, opts installer.InstallOptions) error
- func (orchestrator *Orchestrator) Name() string
- func (orchestrator *Orchestrator) Uninstall(ctx context.Context, project *installer.Project, ...) error
- func (orchestrator *Orchestrator) Validate(project *installer.Project) error
Constants ¶
const Name = "compose"
Name is the value of the nemo-orchestrator parameter that selects Compose.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Orchestrator ¶
type Orchestrator struct {
// contains filtered or unexported fields
}
Orchestrator applies compose projects to one Docker.
func (*Orchestrator) Close ¶
func (orchestrator *Orchestrator) Close() error
func (*Orchestrator) Install ¶
func (orchestrator *Orchestrator) Install(ctx context.Context, project *installer.Project, opts installer.InstallOptions) error
Install creates what the project declares and is not there yet, the way docker compose up --wait does: volumes, networks, then the containers of the services, level after level. It then deletes the containers of the services the project no longer declares.
func (*Orchestrator) Name ¶
func (orchestrator *Orchestrator) Name() string
func (*Orchestrator) Uninstall ¶
func (orchestrator *Orchestrator) Uninstall(ctx context.Context, project *installer.Project, opts installer.UninstallOptions) error
Uninstall deletes what Install created from the project, as docker compose down does: the containers of its services, dependants first, then its networks, and its volumes when asked. What Install deleted as orphans is not looked for.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package convert turns a compose project into what the Compose orchestrator creates on the Docker Engine: the create options of each container, its networks and volumes, and the state to wait for, the way docker compose does.
|
Package convert turns a compose project into what the Compose orchestrator creates on the Docker Engine: the create options of each container, its networks and volumes, and the state to wait for, the way docker compose does. |