Question -> docker run --rm

[diemol]

Description

Hi,

When using the command line, I start the container like this: "docker run --rm {other options}...".

So far, I am able to start the container without any issues through the docker client, nevertheless I have not found how to add the "-- rm" option.

I saw this issue, but I don't know if it is related to what I want to achieve.

If the option does not exist yet, I could implement it via PR. I just wonder if the HostConfig class is the right place to do it.
I see that most of the HostConfig parameters seen here are mapped in that class.

Please let me know if it is possible to add the option with an existing method or if I could go ahead and implement it.

Thanks!

[johnflavin]

I looked through the docker documentation, and I couldn't find a way to do it. You can check for yourself: https://github.com/docker/docker/tree/master/docs/reference/api.

If there is no documentation on how to do it, then either

1. There is no way, it doesn't exist.
2. There is a way, but it isn't documented.

I strongly suspect that 2 is the more likely option. In that case, you could open an issue with docker/docker to document the API for the --rm option. Once they document that, we'll know where to add the option on this side, and maybe you could do a PR for that.

[diemol]

I read again the link I provided for the docker API doc, and the field is there, it is called AutoRemove.
The thing is that it is added in the version 1.25 which has not been released (I think).
So, I guess we just need to wait until the new API version is released.

[johnflavin]

Yes, it does appear that HostConfig.AutoRemove was added in moby/moby#20848, and will be released in API 1.25. It looks like, in all existing docker versions, --rm is a bit of client-side trickery that removes the container when the client detects that it has died. Since the client was responsible, there was no daemon API to make it happen. Now with the newer version they moved that function to the daemon, thus it can be exposed through the API.

I think you could add that field to the HostConfig class before the Docker version is released without harming anything. You could even add tests for it, wrapped in a conditional if(apiVersionAtLeast("1.25")) {} or whatever the helper method is.

[diemol]

Great, I will add it and send the PR around next week.
Thanks.

[diemol]

PR sent #526

[davidxia]

Closed by #538