Changelog

Unreleased

3.6.1 (2021-11-22)

[Task] Add major version as suffix to Go module; allows to install Crane via go install github.com/michaelsauter/crane@latest

3.6.0 (2020-07-09)

[Feature] Accelerated mounts are now available in the free version - there is no separate pro version anymore
[Feature] Support --runtime
[Task] As updates have become very infrequent, Crane no longer checks for updates.
[Task] Docs have moved to https://michaelsauter.github.io/crane/

3.5.0 (2019-01-01)

[Feature] Support external_links config of docker-compose. See #344.
[Task] Check for updates less frequently and allow higher timeout. Most importantly, check against the new domain, https://www.crane-orchestration.com. The old domain (and therefore the update checks) will cease to work 1st March 2019.
[Task] Update to Go 1.11 and use Go modules.
[Enhancement] Print given prefix when it is neither boolean nor string.

3.4.2 (2018-07-09)

[Enhancement] Support volumes_from config of docker-compose (volumes-from was already supported).
[Enhancement] Add --config, -tag and --prefix flags to shortcut command if those flags are specified for the original Crane command as well.

3.4.1 (2018-04-04)

[Bugfix] Fix broken share-ssh-socket by passing the value of SSH_AUTH_SOCK to the Docker flag, not the environment variable itself.
[Enhancement] Add --verbose flag to shortcut command if original Crane command is run in verbose mode.
[Enhancement] Add (ad-hoc) to log output when creating/running a container with an ad-hoc command.

3.4.0 (2018-04-02)

[Feature] Add an easy way to share the SSH socket with a container by adding the share-ssh-socket configuration.
[Feature] Implement shortcut commands. It is now possible to define commands in the crane.yml, which can be executed by running crane cmd <name>. For example, one could define console: run web rails c to run a Rails console in an ad-hoc web container with crane cmd console. Another use case is e.g. psql: exec postgres psql to run PSQL inside the postgres container via crane cmd psql.
[Enhancement] Improve CLI help output.
[Task] Check less frequently for updates (once every 14 days).

3.3.4 (2018-03-22)

[Bugfix] Attach --volumes flag to rm command, not provision
[Enhancement] Display proper error if non-existant network is referenced

3.3.3 (2017-12-03)

[Bugfix] Create default network automatically.
[Bugfix] If am logs is passed a service which has multiple bind-mounts configured, Crane is now selecting the first accelerated one, not simply the first one (which might not be accelerated).

3.3.2 (2017-11-21)

Remove broken flag crane start --attach. This flag was introduced in 3.3.0 but did not work properly, and doesn't add much value anyway. It would make more sense to have this flag on crane run, but that is left for another version.
Apply --interactive to docker start only if --attach is already passed to it.
Do not output container ID after docker create during crane run as the container name is printed after docker start anyway.

3.3.1 (2017-11-20)

Do not add --interactive to non-targeted containers, otherwise Docker attaches to them.
Do not try to connect containers with the default network when none has been setup (which is the case when prefixing is disabled).
Raise minimum Docker version to 1.13, as this is the first version to support docker create --rm, which is needed since 3.3.0 to run ad-hoc commands.

3.3.0 (2017-11-19)

Caution! Enable prefixing by default again. This restores 3.0 behaviour and makes Crane more compatible with docker-compose. If you don't want this, configure prefix: false. However, doing this will also disable the new, automatic default network described in the next section.
Caution! Create a default network automatically (if prefixing is enabled, which is the new default), and connect every container to it (using its name as an alias). This is the same behaviour that docker-compose has.
Allow multiple networks to be configured under networks, as well as options for each network: --alias (array), --ip (string) and --ip6 (string).
Add --init option
Fix --dns-search option
Ensure that accelerated mounts are started when starting / unpausing a container
Add subcommand am reset <mount> to reset an accelerated mount (removes sync container and volume).
Add subcommand am logs <mount> to show the Unison logs to debug syncing issues. Use --follow/-f to follow the logs.
Allow service names as accelerated mount as well. If a service is given, all configured bind-mounts of that service are accelerated. If a single bind-mount is given, only this mount is accelerated. Service names can also be passed to am reset (resulting in the reset of all configured bind-mounts) and am logs (if more than one bind-mount is configured, the first one is selected).
Accelerated mounts have learned a new option ignore, e.g. ignore: "Name {.git,*.md}". This is much easier than having to set all flags if you only want to customize which files/folders should not be synced.
The start command has learned the new option --attach to attach to a targeted container even if the configuration specifies detach: true.
The version command queries for newer versions now. This update check is also executed automatically before any command if the last check is more than one week ago. See the section about updating to find out more.

3.2.1 (2017-09-06)

Fix non-accelerated mounts if acceleration is enabled in general

3.2.0 (2017-08-01)

The following changes only affect the PRO version:

Rename mac-syncs to accelerated-mounts, as it is available on Windows as well now. Using mac-syncs in the config still works but is deprecated.
Installation of Unison / Unox is not needed anymore, accelerated mounts work out-of-the-box and have no host dependencies.
Accelerated mounts always start automatically once configured.
The mac-sync subcommand has been removed without replacement (for now).

3.1.0 (2017-07-27)

CLI interface changes:

lift command is now an alias for up again
rm command accepts -f (short for --force) again

Configuration changes:

cmd config is now an alias for command again

Behaviour changes:

Prefixing is disabled by default again - this is a breaking change from 3.0.0, and restores Crane 2.x behaviour. To set a prefix like docker-compose based on the containing folder, you now need to configure prefix: true explicitly.
Crane does not create a default network anymore - this is a breaking change from 3.0.0 as well and restores Crane 2.x behaviour. You need to configure all networks explicitly.
When detach is configured explicitly, it is honoured (thanks @inthroxify)

Other changes:

Built using Go 1.8.3

3.0.0 (2017-04-08)

As this is a major release, lots of things have changed. Please review the following list very carefully and adjust as needed.

CLI interface changes:

lift has been renamed to up (3.1.0 adds lift again).
rm doesn't have the short flag -f anymore, but --force still works (3.1.0 adds -f again)
rm learned --volumes to removed associated volumes, too
exec adds --interactive and --tty by default, and supports specifying --privileged and --user USER
The short-hand for --exclude is -x now
Dynamic targets (+affected/+dependencies) have been dropped, but it is still possible to extend a target to all dependencies by using --extend/-e. +affected was mainly useful with legacy links and should not be needed with the "new" networks. If you used it regularly, please open an issue.
up/run by default attach to the target, and detach from dependencies. If the target is configured to detach (either via file or --detach/-d) however, then lift/run detach from the target, too.
The configuration flag --config/-c can be repeated now. The specified configurations are merged together, last one wins. Multiple configuration files can also be set via CRANE_CONFIG by separating the files via colons. Consequently, the --override flag has been dropped.

Configuration changes:

The parameters for stop, start and exec have been removed. The corresponding CLI commands have learned some of the options to mitigate this.
The top-level configuration key containers has been renamed to services to align with docker-compose.
All run parameters have been moved up one level to align with docker-compose.
cmd has to be specified as command now (3.1.0 adds cmd again).
image is optional now. If it is not given, the service name will be used as the image name.
stop-timeout, sysctl and userns can be configured now.
Most configuration keys have an alternative name now, e.g. publish can now be specified as ports. The alternative name is the one that docker-compose uses. This allows Crane to read docker-compose configuration files, with some minor exceptions.
net also allows the form service:<container> now.
Support --health-cmd, --health-interval, --health-retries, --health-timeout and --no-healthcheck. Configuration via docker-compose's healtcheck object is also possible (though only string is supported for test at the moment).

Behaviour changes:

Crane reads docker-compose.yml, docker-compose.override.yml, crane.yml, crane.override.yml by default now (in this order).
To align with docker-compose, Crane sets a default prefix now, which is the name of the directory where the configuration files are in. You can remove the prefix by setting prefix: false in the configuration or by passing --prefix=""/-p "" or exporting CRANE_PREFIX="" (Careful! 3.1.0 reverts this to 2.x behaviour).
If neither net, network_mode or networks is configured, the default network mode is no longer bridge but a default network to align with docker-compose (Careful! 3.1.0 reverts this to 2.x behaviour).
The integration of Unison on macOS has been extracted into a paid pro version, see www.crane-orchestration.com. There is still a free version for macOS without this feature. If you would like to support Crane, you can also buy a pro version for Linux, but right now there is no difference in functionality.

2.11.0 (2016-11-14)

Allow to override configuration by another configuration file. By default, Crane is looking for e.g. crane.override.yml if the config file in use is crane.yml. This can be customized via --override/CRANE_OVERRIDE.

@michaelsauter

2.10.3 (2016-10-27)

Add --debug flag to crane mac-sync start which turns on verbose logging and runs the sync in the foreground.

@michaelsauter
Add image, flags, uid and gid to md5 hash identifying the Mac sync server.

@michaelsauter
Check Unison client as well when determining whether a Mac sync is running.

@michaelsauter

2.10.2 (2016-10-13)

Add autostart option to Mac syncs.

@michaelsauter

2.10.1 (2016-10-10)

Allow to pass relative host directories to mac-sync start/stop.

@michaelsauter
Print error message when volume passed to mac-sync start/stop is not configured.

@michaelsauter

2.10.0 (2016-10-08)

Optional Unison sync for Docker for Mac to improve performance. For more information, see Docker for Mac with Unison sync.

@michaelsauter
Built with Go 1.7.1, which might solve potential issues with macOS Sierra.

@michaelsauter

2.9.1 (2016-08-15)

Fix tag override for images with no tag specified in the config.

@michaelsauter

2.9.0 (2016-05-16)

Add --dry-run option to see what a certain command would do without actually doing anything.

@michaelsauter
Add --subnet support for networks

@michaelsauter
Document --only flag

@michaelsauter

2.8.2 (2016-05-04)

Add more error output when hook execution fails

@michaelsauter
Fix usage of CLI long flags prefixed by --no-

@bjaglin
Add support for --no-stream to crane stats (Docker >= 1.7)

@bjaglin

2.8.1 (2016-04-21)

Fix broken target when a default group is specified. The regression was introduced with #275, and reported in #285.

@michaelsauter

2.8.0 (2016-04-10)

Implicit ad-hoc containers. The pre-defined unique key is removed in favour of treating every container as unique when a command is passed via the CLI. The container name is suffixed with a timestamp, and the following changes are made to the configuration:
- publish, publish-all, ip, ip6 and detach are disabled
- rm is enabled
Note that ad-hoc containers are not targeted by Crane in any way, e.g. when running crane rm.

@michaelsauter
Add --only flag to restrict command to a container or group. This can be used for example to start one container without its dependencies.

@michaelsauter
Rename short flag --output for generate command from -o to -O since -o is the short flag for --only now. Since the generate feature is marked as experimental, this change is done in a minor version.

@michaelsauter

2.7.0 (2016-03-20)

Refactor exclude behaviour to make it easier to support only in the future

@michaelsauter
Add missing flags --ip and --ip6 from Docker 1.10 to Crane

@dreamcat4
Better handling of incorrect syntax for env and label configuration values

@bjaglin
docker run/exec/start flags catch-up in Crane configuration.

@bjaglin
Add new build-arg key to the build map. Equivalent of docker build --build-arg KEY=VALUE

Example:
```
containers:
  foo:
    image: foo
    build:
      context: "."
      build-arg:
        - KEY=VALUE
```
Requires Docker 1.9+

2.6.0 (2016-02-25)

Do not require link containers when requires is set. This is a breaking change if you defined both requires and run/link, and relied on Crane resolving the containers defined only in run/link. Now, all entries in run/link are treated as aliases only, and Crane does not handle them specifically. This allows to have optional dependencies when using Docker 1.9+ networks.

@michaelsauter
Update dependencies. While this should generally not have any side-effects, it is likely that coloring support was broken on Windows earlier and might be fixed now.

@michaelsauter

2.5.2 (2016-02-19)

Limit the number of Docker calls when cascading commands to affected containers.

@bjaglin

2.5.1 (2016-02-03)

Bugfix: Wait for post-start hook to complete. #258

Otherwise the hook runs in the background and does not block. @jesper
Bugfix: De-duplicate required volumes and networks in verbose output. #253

@michaelsauter

2.5.0 (2016-01-09)

Expose level of concurrency when provisioning

lift and provision commands can now be sped-up by passing a custom parallelism level via --parallel/-l. @bjaglin

2.4.0 (2015-12-30)

Fix a few minor configuration parsing problems when using maps. @bjaglin
Allow usage of environment variables for all flags' defaults

Default for flag foo-bar can be provided via the environment variable CRANE_FOO_BAR. @bjaglin
Gracefully ignore excluded containers in IPC/net dependencies. @bjaglin
Support several references for exclusion

--exclude can now be repeated on the CLI, and several values can be passed via CRANE_EXCLUDE using newline as a value separator. @bjaglin
Add escape sequence for $ in configuration

$$ now expands to $ in all string configuration values. @bjaglin
Add support for Docker networks

They can be configured via a top-level networks setting, and used from containers via e.g. net: foo. @michaelsauter
Add non-Docker dependency management

Containers learned a new top-level requires setting, which works exactly like links (minus the alias support) and can be used to reach dependent containers when relying on Docker networks. @michaelsauter
Add support for Docker volumes

They can be configured via a top-level volumes setting, and used from containers via e.g. volume: ["foo:/path"]. @michaelsauter

2.3.1 (2015-12-12)

Fix compatibility with engine < 1.8.0 and wrongly-forced option memory-swappinness on engine >= 1.8.0 @bjaglin

2.3.0 (2015-12-09)

When calculating affected containers, only existing ones are taken into account now @bjaglin
Add flags --ipc, --memory-reservation, --dns-opt, --stop-signal, --kernel-memory, --group-add, --memory-swappiness @bjaglin
Fix regression in --net=container:foo @bjaglin
Fix removing containers when one or more of the targets is marked as unique but no container exists for it @michaelsauter

2.2.0 (2015-11-10)

Add new generate command, which passes the targeted portion of the configuration through a given template to produce some output.
Remove graph command. The same output can be achieved with the new generate command specifying this DOT template.
Unique containers can now be addressed by Crane later on, e.g. given a unique container foo, crane kill foo will kill all instances of foo. All other commands that did not work with unique containers previously, e.g. status or logs will take unique containers into account now as well.
Fix broken stats and logs commands if a prefix was given.
Add --tag global flag, which overrides image tag part temporarily. A typical use of --tag flag is to synchronize image tags with the tag of VCSs. You can also set the tag via CRANE_TAG environment variable. @t-suwa

Example: If you specify a --tag rc-2, you will get these results:

original image name overridden image name

nginx nginx:rc-2

nginx:1.9 nginx:rc-2

repo/nginx repo/nginx:rc-2

host:5000/nginx host:5000/nginx:rc-2
[Internal] Introduce new ContainerInfo interface which is a subset of Container. At the same time, clean up the Container interface to include only the externally used methods.

2.1.0 (2015-10-15)

Add new file key to the build map. Equivalent of docker build --file=<file>

Example:

containers:
  foo:
    image: foo
    build:
      context: "."
      file: other_dockerfile.dkr

@dreamcat4

Add support for --dns-search flag @scornelissen85
Fix broken net flag

2.0.1 (2015-09-16)

Fixes messed up output for crane status using Docker 1.8.

2.0.0 (2015-09-15)

start behaves like run did in 1.x, run and lift behave like their --recreate counterparts in 1.x. The flag --recreate was removed consequently.
Remove multiple target handling. Commands can only be applied to a single target now, which can be either a group or a container. This simplification was needed for ad-hoc commands (see below).
Automatic resolution and handling of dependencies when creating and or starting containers. This is different to 1.x, in which the target needed to include all containers required for the command to succeed.

Example: Given a configuration with container web depending on container database, in 1.x you could not use crane run web, since the linked database was not included in the target. In 2.x however, Crane detects that a running database is required for web to run, which means it will bring database into a running state (by executing the equivalent of crane start database before dealing with web). Note that e.g. crane kill web will only kill web and do nothing to database, since a normal docker kill web will succeed just fine.
Extension of target to affected containers and/or dependencies. This replaces the cascade flags --cascade-affected and --cascade-dependencies.

Example: Given a configuration with container web depending on container database, if you wanted to make sure both web and database are recreated, you can use the target web and extend it with dependencies like so: crane run web+dependencies. affected works the other way around, so if you want to recreate database and all containers that depend on it, execute crane run database+affected. You may also use the shortcuts d and a.
Ad-hoc cmd for lift / run / create.

Example: If you have a multi-purpose ruby container in your configuration, you can now run multiple commands, e.g. crane run ruby pry and crane run ruby irb.
Uniquely named containers. This configuration option (unique: true) allows multiple instances of one container configuration at the same time. Crane will append a timestamp (with millisecond precision) to the container name to make it unique. It is advised to use this together with run: {rm: true} since Crane is not able to e.g. kill unique containers.
Remove --ignore-missing flag since it does not work well with the new dependency resolution. As an alternative, a new --exclude flag has been introduced, which allows to exclude a group or a container.

Example: Given a configuration with container web depending on container database, you can just run web by itself using crane --exclude database run web.
Trigger post-start hooks after start event is sent. Previously, it was executed after control was handed back to Crane, which could be very late in case the container attached to STDIN.
crane exec, which maps to docker exec, but additionaly starts the targeted container(s) first if necessary. The options interactive and tty can be configured underneath the exec key in the configuration.
Build hooks (pre-build and post-build) @t-suwa
Remove dockerfile key. Instead, there is a build map now with a context key (which is the equivalent of dockerfile).

Example:
```
containers:
  foo:
    image: foo
    build:
      context: "."
```
In the future, the build map might be extended with further options used by docker build. The map was introduced now so those changes can be made in a backwards-compatible way.
Add --prefix option, which adds a prefix to each container name in the target.

Example: crane --prefix="foo_" run web will run foo_web.
Allow configuration to be specified via CRANE_CONFIG, and prefix via CRANE_PREFIX. @tmc

Required Docker version: >= 1.6