Skip to content

Added devices config handling and device HostConfig handling#1400

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dnephin merged 1 commit into from
May 11, 2015
Merged

Added devices config handling and device HostConfig handling #1400

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 23 additions & 18 deletions compose/config.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@
'cpuset',
'command',
'detach',
'devices',
'dns',
'dns_search',
'domainname',
Expand DownExpand Up@@ -50,6 +51,7 @@
'add_host': 'extra_hosts',
'hosts': 'extra_hosts',
'extra_host': 'extra_hosts',
'device': 'devices',
'link': 'links',
'port': 'ports',
'privilege': 'privileged',
Expand DownExpand Up@@ -200,11 +202,14 @@ def merge_service_dicts(base, override):
override.get('environment'),
)

if 'volumes' in base or 'volumes' in override:
d['volumes'] = merge_volumes(
base.get('volumes'),
override.get('volumes'),
)
path_mapping_keys = ['volumes', 'devices']

for key in path_mapping_keys:
if key in base or key in override:
d[key] = merge_path_mappings(
base.get(key),
override.get(key),
)

if 'labels' in base or 'labels' in override:
d['labels'] = merge_labels(
Expand All@@ -230,7 +235,7 @@ def merge_service_dicts(base, override):
if key in base or key in override:
d[key] = to_list(base.get(key)) + to_list(override.get(key))

already_merged_keys = ['environment', 'volumes', 'labels'] + list_keys + list_or_string_keys
already_merged_keys = ['environment', 'labels'] + path_mapping_keys + list_keys + list_or_string_keys

for k in set(ALLOWED_KEYS) - set(already_merged_keys):
if k in override:
Expand DownExpand Up@@ -346,7 +351,7 @@ def resolve_host_paths(volumes, working_dir=None):


def resolve_host_path(volume, working_dir):
container_path, host_path = split_volume(volume)
container_path, host_path = split_path_mapping(volume)
if host_path is not None:
host_path = os.path.expanduser(host_path)
host_path = os.path.expandvars(host_path)
Expand All@@ -368,32 +373,32 @@ def validate_paths(service_dict):
raise ConfigurationError("build path %s either does not exist or is not accessible." % build_path)


def merge_volumes(base, override):
d = dict_from_volumes(base)
d.update(dict_from_volumes(override))
return volumes_from_dict(d)
def merge_path_mappings(base, override):
d = dict_from_path_mappings(base)
d.update(dict_from_path_mappings(override))
return path_mappings_from_dict(d)


def dict_from_volumes(volumes):
if volumes:
return dict(split_volume(v) for v in volumes)
def dict_from_path_mappings(path_mappings):
if path_mappings:
return dict(split_path_mapping(v) for v in path_mappings)
else:
return {}


def volumes_from_dict(d):
return [join_volume(v) for v in d.items()]
def path_mappings_from_dict(d):
return [join_path_mapping(v) for v in d.items()]


def split_volume(string):
def split_path_mapping(string):
if ':' in string:
(host, container) = string.split(':', 1)
return (container, host)
else:
return (string, None)


def join_volume(pair):
def join_path_mapping(pair):
(container, host) = pair
if host is None:
return container
Expand Down
4 changes: 4 additions & 0 deletions compose/service.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@
DOCKER_START_KEYS = [
'cap_add',
'cap_drop',
'devices',
'dns',
'dns_search',
'env_file',
Expand DownExpand Up@@ -441,13 +442,16 @@ def _get_container_host_config(self, override_options, one_off=False):
extra_hosts = build_extra_hosts(options.get('extra_hosts', None))
read_only = options.get('read_only', None)

devices = options.get('devices', None)

return create_host_config(
links=self._get_links(link_to_self=one_off),
port_bindings=port_bindings,
binds=volume_bindings,
volumes_from=options.get('volumes_from'),
privileged=privileged,
network_mode=self._get_net(),
devices=devices,
dns=dns,
dns_search=dns_search,
restart_policy=restart,
Expand Down
6 changes: 3 additions & 3 deletions docs/extends.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -342,8 +342,8 @@ environment:
- BAZ=local
```

Finally, for `volumes`, Compose "merges" entries together with locally-defined
bindings taking precedence:
Finally, for `volumes` and `devices`, Compose "merges" entries together with
locally-defined bindings taking precedence:

```yaml
# original service
Expand All@@ -361,4 +361,4 @@ volumes:
- /original-dir/foo:/foo
- /local-dir/bar:/bar
- /local-dir/baz/:baz
```
```
14 changes: 12 additions & 2 deletions docs/yml.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,8 +29,8 @@ image: a4bc65fd

### build

Path to a directory containing a Dockerfile. When the value supplied is a
relative path, it is interpreted as relative to the location of the yml file
Path to a directory containing a Dockerfile. When the value supplied is a
relative path, it is interpreted as relative to the location of the yml file
itself. This directory is also the build context that is sent to the Docker daemon.

Compose will build and tag it with a generated name, and use that image thereafter.
Expand DownExpand Up@@ -342,6 +342,16 @@ dns_search:
- dc2.example.com
```

### devices

List of device mappings. Uses the same format as the `--device` docker
client create option.

```
devices:
- "/dev/ttyUSB0:/dev/ttyUSB0"
```

### working\_dir, entrypoint, user, hostname, domainname, mem\_limit, privileged, restart, stdin\_open, tty, cpu\_shares, cpuset, read\_only

Each of these is a single value, analogous to its
Expand Down
13 changes: 13 additions & 0 deletions tests/integration/service_test.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -669,3 +669,16 @@ def test_log_drive_none(self):

self.assertEqual('none', log_config['Type'])
self.assertFalse(log_config['Config'])

def test_devices(self):
service = self.create_service('web', devices=["/dev/random:/dev/mapped-random"])
device_config = create_and_start_container(service).get('HostConfig.Devices')

device_dict = {
'PathOnHost': '/dev/random',
'CgroupPermissions': 'rwm',
'PathInContainer': '/dev/mapped-random'
}

self.assertEqual(1, len(device_config))
self.assertDictEqual(device_dict, device_config[0])
45 changes: 30 additions & 15 deletions tests/unit/config_test.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -54,46 +54,61 @@ def test_volume_binding_with_home(self):
self.assertEqual(d['volumes'], ['/home/user:/container/path'])


class MergeVolumesTest(unittest.TestCase):
class MergePathMappingTest(object):
def config_name(self):
return ""

def test_empty(self):
service_dict = config.merge_service_dicts({}, {})
self.assertNotIn('volumes', service_dict)
self.assertNotIn(self.config_name(), service_dict)

def test_no_override(self):
service_dict = config.merge_service_dicts(
{'volumes': ['/foo:/code', '/data']},
{self.config_name(): ['/foo:/code', '/data']},
{},
)
self.assertEqual(set(service_dict['volumes']), set(['/foo:/code', '/data']))
self.assertEqual(set(service_dict[self.config_name()]), set(['/foo:/code', '/data']))

def test_no_base(self):
service_dict = config.merge_service_dicts(
{},
{'volumes': ['/bar:/code']},
{self.config_name(): ['/bar:/code']},
)
self.assertEqual(set(service_dict['volumes']), set(['/bar:/code']))
self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code']))

def test_override_explicit_path(self):
service_dict = config.merge_service_dicts(
{'volumes': ['/foo:/code', '/data']},
{'volumes': ['/bar:/code']},
{self.config_name(): ['/foo:/code', '/data']},
{self.config_name(): ['/bar:/code']},
)
self.assertEqual(set(service_dict['volumes']), set(['/bar:/code', '/data']))
self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code', '/data']))

def test_add_explicit_path(self):
service_dict = config.merge_service_dicts(
{'volumes': ['/foo:/code', '/data']},
{'volumes': ['/bar:/code', '/quux:/data']},
{self.config_name(): ['/foo:/code', '/data']},
{self.config_name(): ['/bar:/code', '/quux:/data']},
)
self.assertEqual(set(service_dict['volumes']), set(['/bar:/code', '/quux:/data']))
self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code', '/quux:/data']))

def test_remove_explicit_path(self):
service_dict = config.merge_service_dicts(
{'volumes': ['/foo:/code', '/quux:/data']},
{'volumes': ['/bar:/code', '/data']},
{self.config_name(): ['/foo:/code', '/quux:/data']},
{self.config_name(): ['/bar:/code', '/data']},
)
self.assertEqual(set(service_dict['volumes']), set(['/bar:/code', '/data']))
self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code', '/data']))


class MergeVolumesTest(unittest.TestCase, MergePathMappingTest):
def config_name(self):
return 'volumes'


class MergeDevicesTest(unittest.TestCase, MergePathMappingTest):
def config_name(self):
return 'devices'


class BuildOrImageMergeTest(unittest.TestCase):
def test_merge_build_or_image_no_override(self):
self.assertEqual(
config.merge_service_dicts({'build': '.'}, {}),
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Added devices config handling and device HostConfig handling by DanElbert · Pull Request #1400 · docker/compose · GitHub
Skip to content
Added devices config handling and device HostConfig handling#1400

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

dnephin
merged 1 commit into

from

May 11, 2015
 Merged


Added devices config handling and device HostConfig handling
#1400
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


41 changes: 23 additions & 18 deletions
compose/config.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@
 'cpuset',
 'command',
 'detach',
 'devices',
 'dns',
 'dns_search',
 'domainname',
Expand DownExpand Up@@ -50,6 +51,7 @@
 'add_host': 'extra_hosts',
 'hosts': 'extra_hosts',
 'extra_host': 'extra_hosts',
 'device': 'devices',
 'link': 'links',
 'port': 'ports',
 'privilege': 'privileged',
Expand DownExpand Up@@ -200,11 +202,14 @@ def merge_service_dicts(base, override):
 override.get('environment'),
 )

 if 'volumes' in base or 'volumes' in override:
 d['volumes'] = merge_volumes(
 base.get('volumes'),
 override.get('volumes'),
 )
 path_mapping_keys = ['volumes', 'devices']

 for key in path_mapping_keys:
 if key in base or key in override:
 d[key] = merge_path_mappings(
 base.get(key),
 override.get(key),
 )

 if 'labels' in base or 'labels' in override:
 d['labels'] = merge_labels(
Expand All@@ -230,7 +235,7 @@ def merge_service_dicts(base, override):
 if key in base or key in override:
 d[key] = to_list(base.get(key)) + to_list(override.get(key))

 already_merged_keys = ['environment', 'volumes', 'labels'] + list_keys + list_or_string_keys
 already_merged_keys = ['environment', 'labels'] + path_mapping_keys + list_keys + list_or_string_keys

 for k in set(ALLOWED_KEYS) - set(already_merged_keys):
 if k in override:
Expand DownExpand Up@@ -346,7 +351,7 @@ def resolve_host_paths(volumes, working_dir=None):


def resolve_host_path(volume, working_dir):
 container_path, host_path = split_volume(volume)
 container_path, host_path = split_path_mapping(volume)
 if host_path is not None:
 host_path = os.path.expanduser(host_path)
 host_path = os.path.expandvars(host_path)
Expand All@@ -368,32 +373,32 @@ def validate_paths(service_dict):
 raise ConfigurationError("build path %s either does not exist or is not accessible." % build_path)


def merge_volumes(base, override):
 d = dict_from_volumes(base)
 d.update(dict_from_volumes(override))
 return volumes_from_dict(d)
def merge_path_mappings(base, override):
 d = dict_from_path_mappings(base)
 d.update(dict_from_path_mappings(override))
 return path_mappings_from_dict(d)


def dict_from_volumes(volumes):
 if volumes:
 return dict(split_volume(v) for v in volumes)
def dict_from_path_mappings(path_mappings):
 if path_mappings:
 return dict(split_path_mapping(v) for v in path_mappings)
 else:
 return {}


def volumes_from_dict(d):
 return [join_volume(v) for v in d.items()]
def path_mappings_from_dict(d):
 return [join_path_mapping(v) for v in d.items()]


def split_volume(string):
def split_path_mapping(string):
 if ':' in string:
 (host, container) = string.split(':', 1)
 return (container, host)
 else:
 return (string, None)


def join_volume(pair):
def join_path_mapping(pair):
 (container, host) = pair
 if host is None:
 return container
Expand Down

4 changes: 4 additions & 0 deletions
compose/service.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@
DOCKER_START_KEYS = [
 'cap_add',
 'cap_drop',
 'devices',
 'dns',
 'dns_search',
 'env_file',
Expand DownExpand Up@@ -441,13 +442,16 @@ def _get_container_host_config(self, override_options, one_off=False):
 extra_hosts = build_extra_hosts(options.get('extra_hosts', None))
 read_only = options.get('read_only', None)

 devices = options.get('devices', None)

 return create_host_config(
 links=self._get_links(link_to_self=one_off),
 port_bindings=port_bindings,
 binds=volume_bindings,
 volumes_from=options.get('volumes_from'),
 privileged=privileged,
 network_mode=self._get_net(),
 devices=devices,
 dns=dns,
 dns_search=dns_search,
 restart_policy=restart,
Expand Down

6 changes: 3 additions & 3 deletions
docs/extends.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -342,8 +342,8 @@ environment:
 - BAZ=local
```

Finally, for `volumes`, Compose "merges" entries together with locally-defined
bindings taking precedence:
Finally, for `volumes` and `devices`, Compose "merges" entries together with
locally-defined bindings taking precedence:

```yaml
# original service
Expand All@@ -361,4 +361,4 @@ volumes:
 - /original-dir/foo:/foo
 - /local-dir/bar:/bar
 - /local-dir/baz/:baz
```
```

14 changes: 12 additions & 2 deletions
docs/yml.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,8 +29,8 @@ image: a4bc65fd

### build

Path to a directory containing a Dockerfile. When the value supplied is a
relative path, it is interpreted as relative to the location of the yml file
Path to a directory containing a Dockerfile. When the value supplied is a
relative path, it is interpreted as relative to the location of the yml file
itself. This directory is also the build context that is sent to the Docker daemon.

Compose will build and tag it with a generated name, and use that image thereafter.
Expand DownExpand Up@@ -342,6 +342,16 @@ dns_search:
 - dc2.example.com
```

### devices

List of device mappings. Uses the same format as the `--device` docker 
client create option.

```
devices:
 - "/dev/ttyUSB0:/dev/ttyUSB0"
```

### working\_dir, entrypoint, user, hostname, domainname, mem\_limit, privileged, restart, stdin\_open, tty, cpu\_shares, cpuset, read\_only

Each of these is a single value, analogous to its
Expand Down

13 changes: 13 additions & 0 deletions
tests/integration/service_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -669,3 +669,16 @@ def test_log_drive_none(self):

 self.assertEqual('none', log_config['Type'])
 self.assertFalse(log_config['Config'])

 def test_devices(self):
 service = self.create_service('web', devices=["/dev/random:/dev/mapped-random"])
 device_config = create_and_start_container(service).get('HostConfig.Devices')

 device_dict = {
 'PathOnHost': '/dev/random',
 'CgroupPermissions': 'rwm',
 'PathInContainer': '/dev/mapped-random'
 }

 self.assertEqual(1, len(device_config))
 self.assertDictEqual(device_dict, device_config[0])

45 changes: 30 additions & 15 deletions
tests/unit/config_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,46 +54,61 @@ def test_volume_binding_with_home(self):
 self.assertEqual(d['volumes'], ['/home/user:/container/path'])


class MergeVolumesTest(unittest.TestCase):
class MergePathMappingTest(object):
 def config_name(self):
 return ""

 def test_empty(self):
 service_dict = config.merge_service_dicts({}, {})
 self.assertNotIn('volumes', service_dict)
 self.assertNotIn(self.config_name(), service_dict)

 def test_no_override(self):
 service_dict = config.merge_service_dicts(
 {'volumes': ['/foo:/code', '/data']},
 {self.config_name(): ['/foo:/code', '/data']},
 {},
 )
 self.assertEqual(set(service_dict['volumes']), set(['/foo:/code', '/data']))
 self.assertEqual(set(service_dict[self.config_name()]), set(['/foo:/code', '/data']))

 def test_no_base(self):
 service_dict = config.merge_service_dicts(
 {},
 {'volumes': ['/bar:/code']},
 {self.config_name(): ['/bar:/code']},
 )
 self.assertEqual(set(service_dict['volumes']), set(['/bar:/code']))
 self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code']))

 def test_override_explicit_path(self):
 service_dict = config.merge_service_dicts(
 {'volumes': ['/foo:/code', '/data']},
 {'volumes': ['/bar:/code']},
 {self.config_name(): ['/foo:/code', '/data']},
 {self.config_name(): ['/bar:/code']},
 )
 self.assertEqual(set(service_dict['volumes']), set(['/bar:/code', '/data']))
 self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code', '/data']))

 def test_add_explicit_path(self):
 service_dict = config.merge_service_dicts(
 {'volumes': ['/foo:/code', '/data']},
 {'volumes': ['/bar:/code', '/quux:/data']},
 {self.config_name(): ['/foo:/code', '/data']},
 {self.config_name(): ['/bar:/code', '/quux:/data']},
 )
 self.assertEqual(set(service_dict['volumes']), set(['/bar:/code', '/quux:/data']))
 self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code', '/quux:/data']))

 def test_remove_explicit_path(self):
 service_dict = config.merge_service_dicts(
 {'volumes': ['/foo:/code', '/quux:/data']},
 {'volumes': ['/bar:/code', '/data']},
 {self.config_name(): ['/foo:/code', '/quux:/data']},
 {self.config_name(): ['/bar:/code', '/data']},
 )
 self.assertEqual(set(service_dict['volumes']), set(['/bar:/code', '/data']))
 self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code', '/data']))


class MergeVolumesTest(unittest.TestCase, MergePathMappingTest):
 def config_name(self):
 return 'volumes'


class MergeDevicesTest(unittest.TestCase, MergePathMappingTest):
 def config_name(self):
 return 'devices'


class BuildOrImageMergeTest(unittest.TestCase):
 def test_merge_build_or_image_no_override(self):
 self.assertEqual(
 config.merge_service_dicts({'build': '.'}, {}),
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Added devices config handling and device HostConfig handling by DanElbert · Pull Request #1400 · docker/compose · GitHub
Skip to content
Added devices config handling and device HostConfig handling#1400

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

dnephin
merged 1 commit into

from

May 11, 2015
 Merged


Added devices config handling and device HostConfig handling
#1400
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


41 changes: 23 additions & 18 deletions
compose/config.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@
 'cpuset',
 'command',
 'detach',
 'devices',
 'dns',
 'dns_search',
 'domainname',
Expand DownExpand Up@@ -50,6 +51,7 @@
 'add_host': 'extra_hosts',
 'hosts': 'extra_hosts',
 'extra_host': 'extra_hosts',
 'device': 'devices',
 'link': 'links',
 'port': 'ports',
 'privilege': 'privileged',
Expand DownExpand Up@@ -200,11 +202,14 @@ def merge_service_dicts(base, override):
 override.get('environment'),
 )

 if 'volumes' in base or 'volumes' in override:
 d['volumes'] = merge_volumes(
 base.get('volumes'),
 override.get('volumes'),
 )
 path_mapping_keys = ['volumes', 'devices']

 for key in path_mapping_keys:
 if key in base or key in override:
 d[key] = merge_path_mappings(
 base.get(key),
 override.get(key),
 )

 if 'labels' in base or 'labels' in override:
 d['labels'] = merge_labels(
Expand All@@ -230,7 +235,7 @@ def merge_service_dicts(base, override):
 if key in base or key in override:
 d[key] = to_list(base.get(key)) + to_list(override.get(key))

 already_merged_keys = ['environment', 'volumes', 'labels'] + list_keys + list_or_string_keys
 already_merged_keys = ['environment', 'labels'] + path_mapping_keys + list_keys + list_or_string_keys

 for k in set(ALLOWED_KEYS) - set(already_merged_keys):
 if k in override:
Expand DownExpand Up@@ -346,7 +351,7 @@ def resolve_host_paths(volumes, working_dir=None):


def resolve_host_path(volume, working_dir):
 container_path, host_path = split_volume(volume)
 container_path, host_path = split_path_mapping(volume)
 if host_path is not None:
 host_path = os.path.expanduser(host_path)
 host_path = os.path.expandvars(host_path)
Expand All@@ -368,32 +373,32 @@ def validate_paths(service_dict):
 raise ConfigurationError("build path %s either does not exist or is not accessible." % build_path)


def merge_volumes(base, override):
 d = dict_from_volumes(base)
 d.update(dict_from_volumes(override))
 return volumes_from_dict(d)
def merge_path_mappings(base, override):
 d = dict_from_path_mappings(base)
 d.update(dict_from_path_mappings(override))
 return path_mappings_from_dict(d)


def dict_from_volumes(volumes):
 if volumes:
 return dict(split_volume(v) for v in volumes)
def dict_from_path_mappings(path_mappings):
 if path_mappings:
 return dict(split_path_mapping(v) for v in path_mappings)
 else:
 return {}


def volumes_from_dict(d):
 return [join_volume(v) for v in d.items()]
def path_mappings_from_dict(d):
 return [join_path_mapping(v) for v in d.items()]


def split_volume(string):
def split_path_mapping(string):
 if ':' in string:
 (host, container) = string.split(':', 1)
 return (container, host)
 else:
 return (string, None)


def join_volume(pair):
def join_path_mapping(pair):
 (container, host) = pair
 if host is None:
 return container
Expand Down

4 changes: 4 additions & 0 deletions
compose/service.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@
DOCKER_START_KEYS = [
 'cap_add',
 'cap_drop',
 'devices',
 'dns',
 'dns_search',
 'env_file',
Expand DownExpand Up@@ -441,13 +442,16 @@ def _get_container_host_config(self, override_options, one_off=False):
 extra_hosts = build_extra_hosts(options.get('extra_hosts', None))
 read_only = options.get('read_only', None)

 devices = options.get('devices', None)

 return create_host_config(
 links=self._get_links(link_to_self=one_off),
 port_bindings=port_bindings,
 binds=volume_bindings,
 volumes_from=options.get('volumes_from'),
 privileged=privileged,
 network_mode=self._get_net(),
 devices=devices,
 dns=dns,
 dns_search=dns_search,
 restart_policy=restart,
Expand Down

6 changes: 3 additions & 3 deletions
docs/extends.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -342,8 +342,8 @@ environment:
 - BAZ=local
```

Finally, for `volumes`, Compose "merges" entries together with locally-defined
bindings taking precedence:
Finally, for `volumes` and `devices`, Compose "merges" entries together with
locally-defined bindings taking precedence:

```yaml
# original service
Expand All@@ -361,4 +361,4 @@ volumes:
 - /original-dir/foo:/foo
 - /local-dir/bar:/bar
 - /local-dir/baz/:baz
```
```

14 changes: 12 additions & 2 deletions
docs/yml.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,8 +29,8 @@ image: a4bc65fd

### build

Path to a directory containing a Dockerfile. When the value supplied is a
relative path, it is interpreted as relative to the location of the yml file
Path to a directory containing a Dockerfile. When the value supplied is a
relative path, it is interpreted as relative to the location of the yml file
itself. This directory is also the build context that is sent to the Docker daemon.

Compose will build and tag it with a generated name, and use that image thereafter.
Expand DownExpand Up@@ -342,6 +342,16 @@ dns_search:
 - dc2.example.com
```

### devices

List of device mappings. Uses the same format as the `--device` docker 
client create option.

```
devices:
 - "/dev/ttyUSB0:/dev/ttyUSB0"
```

### working\_dir, entrypoint, user, hostname, domainname, mem\_limit, privileged, restart, stdin\_open, tty, cpu\_shares, cpuset, read\_only

Each of these is a single value, analogous to its
Expand Down

13 changes: 13 additions & 0 deletions
tests/integration/service_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -669,3 +669,16 @@ def test_log_drive_none(self):

 self.assertEqual('none', log_config['Type'])
 self.assertFalse(log_config['Config'])

 def test_devices(self):
 service = self.create_service('web', devices=["/dev/random:/dev/mapped-random"])
 device_config = create_and_start_container(service).get('HostConfig.Devices')

 device_dict = {
 'PathOnHost': '/dev/random',
 'CgroupPermissions': 'rwm',
 'PathInContainer': '/dev/mapped-random'
 }

 self.assertEqual(1, len(device_config))
 self.assertDictEqual(device_dict, device_config[0])

45 changes: 30 additions & 15 deletions
tests/unit/config_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,46 +54,61 @@ def test_volume_binding_with_home(self):
 self.assertEqual(d['volumes'], ['/home/user:/container/path'])


class MergeVolumesTest(unittest.TestCase):
class MergePathMappingTest(object):
 def config_name(self):
 return ""

 def test_empty(self):
 service_dict = config.merge_service_dicts({}, {})
 self.assertNotIn('volumes', service_dict)
 self.assertNotIn(self.config_name(), service_dict)

 def test_no_override(self):
 service_dict = config.merge_service_dicts(
 {'volumes': ['/foo:/code', '/data']},
 {self.config_name(): ['/foo:/code', '/data']},
 {},
 )
 self.assertEqual(set(service_dict['volumes']), set(['/foo:/code', '/data']))
 self.assertEqual(set(service_dict[self.config_name()]), set(['/foo:/code', '/data']))

 def test_no_base(self):
 service_dict = config.merge_service_dicts(
 {},
 {'volumes': ['/bar:/code']},
 {self.config_name(): ['/bar:/code']},
 )
 self.assertEqual(set(service_dict['volumes']), set(['/bar:/code']))
 self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code']))

 def test_override_explicit_path(self):
 service_dict = config.merge_service_dicts(
 {'volumes': ['/foo:/code', '/data']},
 {'volumes': ['/bar:/code']},
 {self.config_name(): ['/foo:/code', '/data']},
 {self.config_name(): ['/bar:/code']},
 )
 self.assertEqual(set(service_dict['volumes']), set(['/bar:/code', '/data']))
 self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code', '/data']))

 def test_add_explicit_path(self):
 service_dict = config.merge_service_dicts(
 {'volumes': ['/foo:/code', '/data']},
 {'volumes': ['/bar:/code', '/quux:/data']},
 {self.config_name(): ['/foo:/code', '/data']},
 {self.config_name(): ['/bar:/code', '/quux:/data']},
 )
 self.assertEqual(set(service_dict['volumes']), set(['/bar:/code', '/quux:/data']))
 self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code', '/quux:/data']))

 def test_remove_explicit_path(self):
 service_dict = config.merge_service_dicts(
 {'volumes': ['/foo:/code', '/quux:/data']},
 {'volumes': ['/bar:/code', '/data']},
 {self.config_name(): ['/foo:/code', '/quux:/data']},
 {self.config_name(): ['/bar:/code', '/data']},
 )
 self.assertEqual(set(service_dict['volumes']), set(['/bar:/code', '/data']))
 self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code', '/data']))


class MergeVolumesTest(unittest.TestCase, MergePathMappingTest):
 def config_name(self):
 return 'volumes'


class MergeDevicesTest(unittest.TestCase, MergePathMappingTest):
 def config_name(self):
 return 'devices'


class BuildOrImageMergeTest(unittest.TestCase):
 def test_merge_build_or_image_no_override(self):
 self.assertEqual(
 config.merge_service_dicts({'build': '.'}, {}),
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Added devices config handling and device HostConfig handling by DanElbert · Pull Request #1400 · docker/compose · GitHub
Skip to content
Added devices config handling and device HostConfig handling#1400

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

dnephin
merged 1 commit into

from

May 11, 2015
 Merged


Added devices config handling and device HostConfig handling
#1400
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


41 changes: 23 additions & 18 deletions
compose/config.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@
 'cpuset',
 'command',
 'detach',
 'devices',
 'dns',
 'dns_search',
 'domainname',
Expand DownExpand Up@@ -50,6 +51,7 @@
 'add_host': 'extra_hosts',
 'hosts': 'extra_hosts',
 'extra_host': 'extra_hosts',
 'device': 'devices',
 'link': 'links',
 'port': 'ports',
 'privilege': 'privileged',
Expand DownExpand Up@@ -200,11 +202,14 @@ def merge_service_dicts(base, override):
 override.get('environment'),
 )

 if 'volumes' in base or 'volumes' in override:
 d['volumes'] = merge_volumes(
 base.get('volumes'),
 override.get('volumes'),
 )
 path_mapping_keys = ['volumes', 'devices']

 for key in path_mapping_keys:
 if key in base or key in override:
 d[key] = merge_path_mappings(
 base.get(key),
 override.get(key),
 )

 if 'labels' in base or 'labels' in override:
 d['labels'] = merge_labels(
Expand All@@ -230,7 +235,7 @@ def merge_service_dicts(base, override):
 if key in base or key in override:
 d[key] = to_list(base.get(key)) + to_list(override.get(key))

 already_merged_keys = ['environment', 'volumes', 'labels'] + list_keys + list_or_string_keys
 already_merged_keys = ['environment', 'labels'] + path_mapping_keys + list_keys + list_or_string_keys

 for k in set(ALLOWED_KEYS) - set(already_merged_keys):
 if k in override:
Expand DownExpand Up@@ -346,7 +351,7 @@ def resolve_host_paths(volumes, working_dir=None):


def resolve_host_path(volume, working_dir):
 container_path, host_path = split_volume(volume)
 container_path, host_path = split_path_mapping(volume)
 if host_path is not None:
 host_path = os.path.expanduser(host_path)
 host_path = os.path.expandvars(host_path)
Expand All@@ -368,32 +373,32 @@ def validate_paths(service_dict):
 raise ConfigurationError("build path %s either does not exist or is not accessible." % build_path)


def merge_volumes(base, override):
 d = dict_from_volumes(base)
 d.update(dict_from_volumes(override))
 return volumes_from_dict(d)
def merge_path_mappings(base, override):
 d = dict_from_path_mappings(base)
 d.update(dict_from_path_mappings(override))
 return path_mappings_from_dict(d)


def dict_from_volumes(volumes):
 if volumes:
 return dict(split_volume(v) for v in volumes)
def dict_from_path_mappings(path_mappings):
 if path_mappings:
 return dict(split_path_mapping(v) for v in path_mappings)
 else:
 return {}


def volumes_from_dict(d):
 return [join_volume(v) for v in d.items()]
def path_mappings_from_dict(d):
 return [join_path_mapping(v) for v in d.items()]


def split_volume(string):
def split_path_mapping(string):
 if ':' in string:
 (host, container) = string.split(':', 1)
 return (container, host)
 else:
 return (string, None)


def join_volume(pair):
def join_path_mapping(pair):
 (container, host) = pair
 if host is None:
 return container
Expand Down

4 changes: 4 additions & 0 deletions
compose/service.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@
DOCKER_START_KEYS = [
 'cap_add',
 'cap_drop',
 'devices',
 'dns',
 'dns_search',
 'env_file',
Expand DownExpand Up@@ -441,13 +442,16 @@ def _get_container_host_config(self, override_options, one_off=False):
 extra_hosts = build_extra_hosts(options.get('extra_hosts', None))
 read_only = options.get('read_only', None)

 devices = options.get('devices', None)

 return create_host_config(
 links=self._get_links(link_to_self=one_off),
 port_bindings=port_bindings,
 binds=volume_bindings,
 volumes_from=options.get('volumes_from'),
 privileged=privileged,
 network_mode=self._get_net(),
 devices=devices,
 dns=dns,
 dns_search=dns_search,
 restart_policy=restart,
Expand Down

6 changes: 3 additions & 3 deletions
docs/extends.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -342,8 +342,8 @@ environment:
 - BAZ=local
```

Finally, for `volumes`, Compose "merges" entries together with locally-defined
bindings taking precedence:
Finally, for `volumes` and `devices`, Compose "merges" entries together with
locally-defined bindings taking precedence:

```yaml
# original service
Expand All@@ -361,4 +361,4 @@ volumes:
 - /original-dir/foo:/foo
 - /local-dir/bar:/bar
 - /local-dir/baz/:baz
```
```

14 changes: 12 additions & 2 deletions
docs/yml.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,8 +29,8 @@ image: a4bc65fd

### build

Path to a directory containing a Dockerfile. When the value supplied is a
relative path, it is interpreted as relative to the location of the yml file
Path to a directory containing a Dockerfile. When the value supplied is a
relative path, it is interpreted as relative to the location of the yml file
itself. This directory is also the build context that is sent to the Docker daemon.

Compose will build and tag it with a generated name, and use that image thereafter.
Expand DownExpand Up@@ -342,6 +342,16 @@ dns_search:
 - dc2.example.com
```

### devices

List of device mappings. Uses the same format as the `--device` docker 
client create option.

```
devices:
 - "/dev/ttyUSB0:/dev/ttyUSB0"
```

### working\_dir, entrypoint, user, hostname, domainname, mem\_limit, privileged, restart, stdin\_open, tty, cpu\_shares, cpuset, read\_only

Each of these is a single value, analogous to its
Expand Down

13 changes: 13 additions & 0 deletions
tests/integration/service_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -669,3 +669,16 @@ def test_log_drive_none(self):

 self.assertEqual('none', log_config['Type'])
 self.assertFalse(log_config['Config'])

 def test_devices(self):
 service = self.create_service('web', devices=["/dev/random:/dev/mapped-random"])
 device_config = create_and_start_container(service).get('HostConfig.Devices')

 device_dict = {
 'PathOnHost': '/dev/random',
 'CgroupPermissions': 'rwm',
 'PathInContainer': '/dev/mapped-random'
 }

 self.assertEqual(1, len(device_config))
 self.assertDictEqual(device_dict, device_config[0])

45 changes: 30 additions & 15 deletions
tests/unit/config_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,46 +54,61 @@ def test_volume_binding_with_home(self):
 self.assertEqual(d['volumes'], ['/home/user:/container/path'])


class MergeVolumesTest(unittest.TestCase):
class MergePathMappingTest(object):
 def config_name(self):
 return ""

 def test_empty(self):
 service_dict = config.merge_service_dicts({}, {})
 self.assertNotIn('volumes', service_dict)
 self.assertNotIn(self.config_name(), service_dict)

 def test_no_override(self):
 service_dict = config.merge_service_dicts(
 {'volumes': ['/foo:/code', '/data']},
 {self.config_name(): ['/foo:/code', '/data']},
 {},
 )
 self.assertEqual(set(service_dict['volumes']), set(['/foo:/code', '/data']))
 self.assertEqual(set(service_dict[self.config_name()]), set(['/foo:/code', '/data']))

 def test_no_base(self):
 service_dict = config.merge_service_dicts(
 {},
 {'volumes': ['/bar:/code']},
 {self.config_name(): ['/bar:/code']},
 )
 self.assertEqual(set(service_dict['volumes']), set(['/bar:/code']))
 self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code']))

 def test_override_explicit_path(self):
 service_dict = config.merge_service_dicts(
 {'volumes': ['/foo:/code', '/data']},
 {'volumes': ['/bar:/code']},
 {self.config_name(): ['/foo:/code', '/data']},
 {self.config_name(): ['/bar:/code']},
 )
 self.assertEqual(set(service_dict['volumes']), set(['/bar:/code', '/data']))
 self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code', '/data']))

 def test_add_explicit_path(self):
 service_dict = config.merge_service_dicts(
 {'volumes': ['/foo:/code', '/data']},
 {'volumes': ['/bar:/code', '/quux:/data']},
 {self.config_name(): ['/foo:/code', '/data']},
 {self.config_name(): ['/bar:/code', '/quux:/data']},
 )
 self.assertEqual(set(service_dict['volumes']), set(['/bar:/code', '/quux:/data']))
 self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code', '/quux:/data']))

 def test_remove_explicit_path(self):
 service_dict = config.merge_service_dicts(
 {'volumes': ['/foo:/code', '/quux:/data']},
 {'volumes': ['/bar:/code', '/data']},
 {self.config_name(): ['/foo:/code', '/quux:/data']},
 {self.config_name(): ['/bar:/code', '/data']},
 )
 self.assertEqual(set(service_dict['volumes']), set(['/bar:/code', '/data']))
 self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code', '/data']))


class MergeVolumesTest(unittest.TestCase, MergePathMappingTest):
 def config_name(self):
 return 'volumes'


class MergeDevicesTest(unittest.TestCase, MergePathMappingTest):
 def config_name(self):
 return 'devices'


class BuildOrImageMergeTest(unittest.TestCase):
 def test_merge_build_or_image_no_override(self):
 self.assertEqual(
 config.merge_service_dicts({'build': '.'}, {}),
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Added devices config handling and device HostConfig handling by DanElbert · Pull Request #1400 · docker/compose · GitHub
Skip to content
Added devices config handling and device HostConfig handling#1400

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

dnephin
merged 1 commit into

from

May 11, 2015
 Merged


Added devices config handling and device HostConfig handling
#1400
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


41 changes: 23 additions & 18 deletions
compose/config.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@
 'cpuset',
 'command',
 'detach',
 'devices',
 'dns',
 'dns_search',
 'domainname',
Expand DownExpand Up@@ -50,6 +51,7 @@
 'add_host': 'extra_hosts',
 'hosts': 'extra_hosts',
 'extra_host': 'extra_hosts',
 'device': 'devices',
 'link': 'links',
 'port': 'ports',
 'privilege': 'privileged',
Expand DownExpand Up@@ -200,11 +202,14 @@ def merge_service_dicts(base, override):
 override.get('environment'),
 )

 if 'volumes' in base or 'volumes' in override:
 d['volumes'] = merge_volumes(
 base.get('volumes'),
 override.get('volumes'),
 )
 path_mapping_keys = ['volumes', 'devices']

 for key in path_mapping_keys:
 if key in base or key in override:
 d[key] = merge_path_mappings(
 base.get(key),
 override.get(key),
 )

 if 'labels' in base or 'labels' in override:
 d['labels'] = merge_labels(
Expand All@@ -230,7 +235,7 @@ def merge_service_dicts(base, override):
 if key in base or key in override:
 d[key] = to_list(base.get(key)) + to_list(override.get(key))

 already_merged_keys = ['environment', 'volumes', 'labels'] + list_keys + list_or_string_keys
 already_merged_keys = ['environment', 'labels'] + path_mapping_keys + list_keys + list_or_string_keys

 for k in set(ALLOWED_KEYS) - set(already_merged_keys):
 if k in override:
Expand DownExpand Up@@ -346,7 +351,7 @@ def resolve_host_paths(volumes, working_dir=None):


def resolve_host_path(volume, working_dir):
 container_path, host_path = split_volume(volume)
 container_path, host_path = split_path_mapping(volume)
 if host_path is not None:
 host_path = os.path.expanduser(host_path)
 host_path = os.path.expandvars(host_path)
Expand All@@ -368,32 +373,32 @@ def validate_paths(service_dict):
 raise ConfigurationError("build path %s either does not exist or is not accessible." % build_path)


def merge_volumes(base, override):
 d = dict_from_volumes(base)
 d.update(dict_from_volumes(override))
 return volumes_from_dict(d)
def merge_path_mappings(base, override):
 d = dict_from_path_mappings(base)
 d.update(dict_from_path_mappings(override))
 return path_mappings_from_dict(d)


def dict_from_volumes(volumes):
 if volumes:
 return dict(split_volume(v) for v in volumes)
def dict_from_path_mappings(path_mappings):
 if path_mappings:
 return dict(split_path_mapping(v) for v in path_mappings)
 else:
 return {}


def volumes_from_dict(d):
 return [join_volume(v) for v in d.items()]
def path_mappings_from_dict(d):
 return [join_path_mapping(v) for v in d.items()]


def split_volume(string):
def split_path_mapping(string):
 if ':' in string:
 (host, container) = string.split(':', 1)
 return (container, host)
 else:
 return (string, None)


def join_volume(pair):
def join_path_mapping(pair):
 (container, host) = pair
 if host is None:
 return container
Expand Down

4 changes: 4 additions & 0 deletions
compose/service.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@
DOCKER_START_KEYS = [
 'cap_add',
 'cap_drop',
 'devices',
 'dns',
 'dns_search',
 'env_file',
Expand DownExpand Up@@ -441,13 +442,16 @@ def _get_container_host_config(self, override_options, one_off=False):
 extra_hosts = build_extra_hosts(options.get('extra_hosts', None))
 read_only = options.get('read_only', None)

 devices = options.get('devices', None)

 return create_host_config(
 links=self._get_links(link_to_self=one_off),
 port_bindings=port_bindings,
 binds=volume_bindings,
 volumes_from=options.get('volumes_from'),
 privileged=privileged,
 network_mode=self._get_net(),
 devices=devices,
 dns=dns,
 dns_search=dns_search,
 restart_policy=restart,
Expand Down

6 changes: 3 additions & 3 deletions
docs/extends.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -342,8 +342,8 @@ environment:
 - BAZ=local
```

Finally, for `volumes`, Compose "merges" entries together with locally-defined
bindings taking precedence:
Finally, for `volumes` and `devices`, Compose "merges" entries together with
locally-defined bindings taking precedence:

```yaml
# original service
Expand All@@ -361,4 +361,4 @@ volumes:
 - /original-dir/foo:/foo
 - /local-dir/bar:/bar
 - /local-dir/baz/:baz
```
```

14 changes: 12 additions & 2 deletions
docs/yml.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,8 +29,8 @@ image: a4bc65fd

### build

Path to a directory containing a Dockerfile. When the value supplied is a
relative path, it is interpreted as relative to the location of the yml file
Path to a directory containing a Dockerfile. When the value supplied is a
relative path, it is interpreted as relative to the location of the yml file
itself. This directory is also the build context that is sent to the Docker daemon.

Compose will build and tag it with a generated name, and use that image thereafter.
Expand DownExpand Up@@ -342,6 +342,16 @@ dns_search:
 - dc2.example.com
```

### devices

List of device mappings. Uses the same format as the `--device` docker 
client create option.

```
devices:
 - "/dev/ttyUSB0:/dev/ttyUSB0"
```

### working\_dir, entrypoint, user, hostname, domainname, mem\_limit, privileged, restart, stdin\_open, tty, cpu\_shares, cpuset, read\_only

Each of these is a single value, analogous to its
Expand Down

13 changes: 13 additions & 0 deletions
tests/integration/service_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -669,3 +669,16 @@ def test_log_drive_none(self):

 self.assertEqual('none', log_config['Type'])
 self.assertFalse(log_config['Config'])

 def test_devices(self):
 service = self.create_service('web', devices=["/dev/random:/dev/mapped-random"])
 device_config = create_and_start_container(service).get('HostConfig.Devices')

 device_dict = {
 'PathOnHost': '/dev/random',
 'CgroupPermissions': 'rwm',
 'PathInContainer': '/dev/mapped-random'
 }

 self.assertEqual(1, len(device_config))
 self.assertDictEqual(device_dict, device_config[0])

45 changes: 30 additions & 15 deletions
tests/unit/config_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,46 +54,61 @@ def test_volume_binding_with_home(self):
 self.assertEqual(d['volumes'], ['/home/user:/container/path'])


class MergeVolumesTest(unittest.TestCase):
class MergePathMappingTest(object):
 def config_name(self):
 return ""

 def test_empty(self):
 service_dict = config.merge_service_dicts({}, {})
 self.assertNotIn('volumes', service_dict)
 self.assertNotIn(self.config_name(), service_dict)

 def test_no_override(self):
 service_dict = config.merge_service_dicts(
 {'volumes': ['/foo:/code', '/data']},
 {self.config_name(): ['/foo:/code', '/data']},
 {},
 )
 self.assertEqual(set(service_dict['volumes']), set(['/foo:/code', '/data']))
 self.assertEqual(set(service_dict[self.config_name()]), set(['/foo:/code', '/data']))

 def test_no_base(self):
 service_dict = config.merge_service_dicts(
 {},
 {'volumes': ['/bar:/code']},
 {self.config_name(): ['/bar:/code']},
 )
 self.assertEqual(set(service_dict['volumes']), set(['/bar:/code']))
 self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code']))

 def test_override_explicit_path(self):
 service_dict = config.merge_service_dicts(
 {'volumes': ['/foo:/code', '/data']},
 {'volumes': ['/bar:/code']},
 {self.config_name(): ['/foo:/code', '/data']},
 {self.config_name(): ['/bar:/code']},
 )
 self.assertEqual(set(service_dict['volumes']), set(['/bar:/code', '/data']))
 self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code', '/data']))

 def test_add_explicit_path(self):
 service_dict = config.merge_service_dicts(
 {'volumes': ['/foo:/code', '/data']},
 {'volumes': ['/bar:/code', '/quux:/data']},
 {self.config_name(): ['/foo:/code', '/data']},
 {self.config_name(): ['/bar:/code', '/quux:/data']},
 )
 self.assertEqual(set(service_dict['volumes']), set(['/bar:/code', '/quux:/data']))
 self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code', '/quux:/data']))

 def test_remove_explicit_path(self):
 service_dict = config.merge_service_dicts(
 {'volumes': ['/foo:/code', '/quux:/data']},
 {'volumes': ['/bar:/code', '/data']},
 {self.config_name(): ['/foo:/code', '/quux:/data']},
 {self.config_name(): ['/bar:/code', '/data']},
 )
 self.assertEqual(set(service_dict['volumes']), set(['/bar:/code', '/data']))
 self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code', '/data']))


class MergeVolumesTest(unittest.TestCase, MergePathMappingTest):
 def config_name(self):
 return 'volumes'


class MergeDevicesTest(unittest.TestCase, MergePathMappingTest):
 def config_name(self):
 return 'devices'


class BuildOrImageMergeTest(unittest.TestCase):
 def test_merge_build_or_image_no_override(self):
 self.assertEqual(
 config.merge_service_dicts({'build': '.'}, {}),
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Added devices config handling and device HostConfig handling by DanElbert · Pull Request #1400 · docker/compose · GitHub
Skip to content
Added devices config handling and device HostConfig handling#1400

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

dnephin
merged 1 commit into

from

May 11, 2015
 Merged


Added devices config handling and device HostConfig handling
#1400
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


41 changes: 23 additions & 18 deletions
compose/config.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@
 'cpuset',
 'command',
 'detach',
 'devices',
 'dns',
 'dns_search',
 'domainname',
Expand DownExpand Up@@ -50,6 +51,7 @@
 'add_host': 'extra_hosts',
 'hosts': 'extra_hosts',
 'extra_host': 'extra_hosts',
 'device': 'devices',
 'link': 'links',
 'port': 'ports',
 'privilege': 'privileged',
Expand DownExpand Up@@ -200,11 +202,14 @@ def merge_service_dicts(base, override):
 override.get('environment'),
 )

 if 'volumes' in base or 'volumes' in override:
 d['volumes'] = merge_volumes(
 base.get('volumes'),
 override.get('volumes'),
 )
 path_mapping_keys = ['volumes', 'devices']

 for key in path_mapping_keys:
 if key in base or key in override:
 d[key] = merge_path_mappings(
 base.get(key),
 override.get(key),
 )

 if 'labels' in base or 'labels' in override:
 d['labels'] = merge_labels(
Expand All@@ -230,7 +235,7 @@ def merge_service_dicts(base, override):
 if key in base or key in override:
 d[key] = to_list(base.get(key)) + to_list(override.get(key))

 already_merged_keys = ['environment', 'volumes', 'labels'] + list_keys + list_or_string_keys
 already_merged_keys = ['environment', 'labels'] + path_mapping_keys + list_keys + list_or_string_keys

 for k in set(ALLOWED_KEYS) - set(already_merged_keys):
 if k in override:
Expand DownExpand Up@@ -346,7 +351,7 @@ def resolve_host_paths(volumes, working_dir=None):


def resolve_host_path(volume, working_dir):
 container_path, host_path = split_volume(volume)
 container_path, host_path = split_path_mapping(volume)
 if host_path is not None:
 host_path = os.path.expanduser(host_path)
 host_path = os.path.expandvars(host_path)
Expand All@@ -368,32 +373,32 @@ def validate_paths(service_dict):
 raise ConfigurationError("build path %s either does not exist or is not accessible." % build_path)


def merge_volumes(base, override):
 d = dict_from_volumes(base)
 d.update(dict_from_volumes(override))
 return volumes_from_dict(d)
def merge_path_mappings(base, override):
 d = dict_from_path_mappings(base)
 d.update(dict_from_path_mappings(override))
 return path_mappings_from_dict(d)


def dict_from_volumes(volumes):
 if volumes:
 return dict(split_volume(v) for v in volumes)
def dict_from_path_mappings(path_mappings):
 if path_mappings:
 return dict(split_path_mapping(v) for v in path_mappings)
 else:
 return {}


def volumes_from_dict(d):
 return [join_volume(v) for v in d.items()]
def path_mappings_from_dict(d):
 return [join_path_mapping(v) for v in d.items()]


def split_volume(string):
def split_path_mapping(string):
 if ':' in string:
 (host, container) = string.split(':', 1)
 return (container, host)
 else:
 return (string, None)


def join_volume(pair):
def join_path_mapping(pair):
 (container, host) = pair
 if host is None:
 return container
Expand Down

4 changes: 4 additions & 0 deletions
compose/service.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@
DOCKER_START_KEYS = [
 'cap_add',
 'cap_drop',
 'devices',
 'dns',
 'dns_search',
 'env_file',
Expand DownExpand Up@@ -441,13 +442,16 @@ def _get_container_host_config(self, override_options, one_off=False):
 extra_hosts = build_extra_hosts(options.get('extra_hosts', None))
 read_only = options.get('read_only', None)

 devices = options.get('devices', None)

 return create_host_config(
 links=self._get_links(link_to_self=one_off),
 port_bindings=port_bindings,
 binds=volume_bindings,
 volumes_from=options.get('volumes_from'),
 privileged=privileged,
 network_mode=self._get_net(),
 devices=devices,
 dns=dns,
 dns_search=dns_search,
 restart_policy=restart,
Expand Down

6 changes: 3 additions & 3 deletions
docs/extends.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -342,8 +342,8 @@ environment:
 - BAZ=local
```

Finally, for `volumes`, Compose "merges" entries together with locally-defined
bindings taking precedence:
Finally, for `volumes` and `devices`, Compose "merges" entries together with
locally-defined bindings taking precedence:

```yaml
# original service
Expand All@@ -361,4 +361,4 @@ volumes:
 - /original-dir/foo:/foo
 - /local-dir/bar:/bar
 - /local-dir/baz/:baz
```
```

14 changes: 12 additions & 2 deletions
docs/yml.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,8 +29,8 @@ image: a4bc65fd

### build

Path to a directory containing a Dockerfile. When the value supplied is a
relative path, it is interpreted as relative to the location of the yml file
Path to a directory containing a Dockerfile. When the value supplied is a
relative path, it is interpreted as relative to the location of the yml file
itself. This directory is also the build context that is sent to the Docker daemon.

Compose will build and tag it with a generated name, and use that image thereafter.
Expand DownExpand Up@@ -342,6 +342,16 @@ dns_search:
 - dc2.example.com
```

### devices

List of device mappings. Uses the same format as the `--device` docker 
client create option.

```
devices:
 - "/dev/ttyUSB0:/dev/ttyUSB0"
```

### working\_dir, entrypoint, user, hostname, domainname, mem\_limit, privileged, restart, stdin\_open, tty, cpu\_shares, cpuset, read\_only

Each of these is a single value, analogous to its
Expand Down

13 changes: 13 additions & 0 deletions
tests/integration/service_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -669,3 +669,16 @@ def test_log_drive_none(self):

 self.assertEqual('none', log_config['Type'])
 self.assertFalse(log_config['Config'])

 def test_devices(self):
 service = self.create_service('web', devices=["/dev/random:/dev/mapped-random"])
 device_config = create_and_start_container(service).get('HostConfig.Devices')

 device_dict = {
 'PathOnHost': '/dev/random',
 'CgroupPermissions': 'rwm',
 'PathInContainer': '/dev/mapped-random'
 }

 self.assertEqual(1, len(device_config))
 self.assertDictEqual(device_dict, device_config[0])

45 changes: 30 additions & 15 deletions
tests/unit/config_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,46 +54,61 @@ def test_volume_binding_with_home(self):
 self.assertEqual(d['volumes'], ['/home/user:/container/path'])


class MergeVolumesTest(unittest.TestCase):
class MergePathMappingTest(object):
 def config_name(self):
 return ""

 def test_empty(self):
 service_dict = config.merge_service_dicts({}, {})
 self.assertNotIn('volumes', service_dict)
 self.assertNotIn(self.config_name(), service_dict)

 def test_no_override(self):
 service_dict = config.merge_service_dicts(
 {'volumes': ['/foo:/code', '/data']},
 {self.config_name(): ['/foo:/code', '/data']},
 {},
 )
 self.assertEqual(set(service_dict['volumes']), set(['/foo:/code', '/data']))
 self.assertEqual(set(service_dict[self.config_name()]), set(['/foo:/code', '/data']))

 def test_no_base(self):
 service_dict = config.merge_service_dicts(
 {},
 {'volumes': ['/bar:/code']},
 {self.config_name(): ['/bar:/code']},
 )
 self.assertEqual(set(service_dict['volumes']), set(['/bar:/code']))
 self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code']))

 def test_override_explicit_path(self):
 service_dict = config.merge_service_dicts(
 {'volumes': ['/foo:/code', '/data']},
 {'volumes': ['/bar:/code']},
 {self.config_name(): ['/foo:/code', '/data']},
 {self.config_name(): ['/bar:/code']},
 )
 self.assertEqual(set(service_dict['volumes']), set(['/bar:/code', '/data']))
 self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code', '/data']))

 def test_add_explicit_path(self):
 service_dict = config.merge_service_dicts(
 {'volumes': ['/foo:/code', '/data']},
 {'volumes': ['/bar:/code', '/quux:/data']},
 {self.config_name(): ['/foo:/code', '/data']},
 {self.config_name(): ['/bar:/code', '/quux:/data']},
 )
 self.assertEqual(set(service_dict['volumes']), set(['/bar:/code', '/quux:/data']))
 self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code', '/quux:/data']))

 def test_remove_explicit_path(self):
 service_dict = config.merge_service_dicts(
 {'volumes': ['/foo:/code', '/quux:/data']},
 {'volumes': ['/bar:/code', '/data']},
 {self.config_name(): ['/foo:/code', '/quux:/data']},
 {self.config_name(): ['/bar:/code', '/data']},
 )
 self.assertEqual(set(service_dict['volumes']), set(['/bar:/code', '/data']))
 self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code', '/data']))


class MergeVolumesTest(unittest.TestCase, MergePathMappingTest):
 def config_name(self):
 return 'volumes'


class MergeDevicesTest(unittest.TestCase, MergePathMappingTest):
 def config_name(self):
 return 'devices'


class BuildOrImageMergeTest(unittest.TestCase):
 def test_merge_build_or_image_no_override(self):
 self.assertEqual(
 config.merge_service_dicts({'build': '.'}, {}),
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Added devices config handling and device HostConfig handling by DanElbert · Pull Request #1400 · docker/compose · GitHub
Skip to content
Added devices config handling and device HostConfig handling#1400

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

dnephin
merged 1 commit into

from

May 11, 2015
 Merged


Added devices config handling and device HostConfig handling
#1400
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


41 changes: 23 additions & 18 deletions
compose/config.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@
 'cpuset',
 'command',
 'detach',
 'devices',
 'dns',
 'dns_search',
 'domainname',
Expand DownExpand Up@@ -50,6 +51,7 @@
 'add_host': 'extra_hosts',
 'hosts': 'extra_hosts',
 'extra_host': 'extra_hosts',
 'device': 'devices',
 'link': 'links',
 'port': 'ports',
 'privilege': 'privileged',
Expand DownExpand Up@@ -200,11 +202,14 @@ def merge_service_dicts(base, override):
 override.get('environment'),
 )

 if 'volumes' in base or 'volumes' in override:
 d['volumes'] = merge_volumes(
 base.get('volumes'),
 override.get('volumes'),
 )
 path_mapping_keys = ['volumes', 'devices']

 for key in path_mapping_keys:
 if key in base or key in override:
 d[key] = merge_path_mappings(
 base.get(key),
 override.get(key),
 )

 if 'labels' in base or 'labels' in override:
 d['labels'] = merge_labels(
Expand All@@ -230,7 +235,7 @@ def merge_service_dicts(base, override):
 if key in base or key in override:
 d[key] = to_list(base.get(key)) + to_list(override.get(key))

 already_merged_keys = ['environment', 'volumes', 'labels'] + list_keys + list_or_string_keys
 already_merged_keys = ['environment', 'labels'] + path_mapping_keys + list_keys + list_or_string_keys

 for k in set(ALLOWED_KEYS) - set(already_merged_keys):
 if k in override:
Expand DownExpand Up@@ -346,7 +351,7 @@ def resolve_host_paths(volumes, working_dir=None):


def resolve_host_path(volume, working_dir):
 container_path, host_path = split_volume(volume)
 container_path, host_path = split_path_mapping(volume)
 if host_path is not None:
 host_path = os.path.expanduser(host_path)
 host_path = os.path.expandvars(host_path)
Expand All@@ -368,32 +373,32 @@ def validate_paths(service_dict):
 raise ConfigurationError("build path %s either does not exist or is not accessible." % build_path)


def merge_volumes(base, override):
 d = dict_from_volumes(base)
 d.update(dict_from_volumes(override))
 return volumes_from_dict(d)
def merge_path_mappings(base, override):
 d = dict_from_path_mappings(base)
 d.update(dict_from_path_mappings(override))
 return path_mappings_from_dict(d)


def dict_from_volumes(volumes):
 if volumes:
 return dict(split_volume(v) for v in volumes)
def dict_from_path_mappings(path_mappings):
 if path_mappings:
 return dict(split_path_mapping(v) for v in path_mappings)
 else:
 return {}


def volumes_from_dict(d):
 return [join_volume(v) for v in d.items()]
def path_mappings_from_dict(d):
 return [join_path_mapping(v) for v in d.items()]


def split_volume(string):
def split_path_mapping(string):
 if ':' in string:
 (host, container) = string.split(':', 1)
 return (container, host)
 else:
 return (string, None)


def join_volume(pair):
def join_path_mapping(pair):
 (container, host) = pair
 if host is None:
 return container
Expand Down

4 changes: 4 additions & 0 deletions
compose/service.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@
DOCKER_START_KEYS = [
 'cap_add',
 'cap_drop',
 'devices',
 'dns',
 'dns_search',
 'env_file',
Expand DownExpand Up@@ -441,13 +442,16 @@ def _get_container_host_config(self, override_options, one_off=False):
 extra_hosts = build_extra_hosts(options.get('extra_hosts', None))
 read_only = options.get('read_only', None)

 devices = options.get('devices', None)

 return create_host_config(
 links=self._get_links(link_to_self=one_off),
 port_bindings=port_bindings,
 binds=volume_bindings,
 volumes_from=options.get('volumes_from'),
 privileged=privileged,
 network_mode=self._get_net(),
 devices=devices,
 dns=dns,
 dns_search=dns_search,
 restart_policy=restart,
Expand Down

6 changes: 3 additions & 3 deletions
docs/extends.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -342,8 +342,8 @@ environment:
 - BAZ=local
```

Finally, for `volumes`, Compose "merges" entries together with locally-defined
bindings taking precedence:
Finally, for `volumes` and `devices`, Compose "merges" entries together with
locally-defined bindings taking precedence:

```yaml
# original service
Expand All@@ -361,4 +361,4 @@ volumes:
 - /original-dir/foo:/foo
 - /local-dir/bar:/bar
 - /local-dir/baz/:baz
```
```

14 changes: 12 additions & 2 deletions
docs/yml.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,8 +29,8 @@ image: a4bc65fd

### build

Path to a directory containing a Dockerfile. When the value supplied is a
relative path, it is interpreted as relative to the location of the yml file
Path to a directory containing a Dockerfile. When the value supplied is a
relative path, it is interpreted as relative to the location of the yml file
itself. This directory is also the build context that is sent to the Docker daemon.

Compose will build and tag it with a generated name, and use that image thereafter.
Expand DownExpand Up@@ -342,6 +342,16 @@ dns_search:
 - dc2.example.com
```

### devices

List of device mappings. Uses the same format as the `--device` docker 
client create option.

```
devices:
 - "/dev/ttyUSB0:/dev/ttyUSB0"
```

### working\_dir, entrypoint, user, hostname, domainname, mem\_limit, privileged, restart, stdin\_open, tty, cpu\_shares, cpuset, read\_only

Each of these is a single value, analogous to its
Expand Down

13 changes: 13 additions & 0 deletions
tests/integration/service_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -669,3 +669,16 @@ def test_log_drive_none(self):

 self.assertEqual('none', log_config['Type'])
 self.assertFalse(log_config['Config'])

 def test_devices(self):
 service = self.create_service('web', devices=["/dev/random:/dev/mapped-random"])
 device_config = create_and_start_container(service).get('HostConfig.Devices')

 device_dict = {
 'PathOnHost': '/dev/random',
 'CgroupPermissions': 'rwm',
 'PathInContainer': '/dev/mapped-random'
 }

 self.assertEqual(1, len(device_config))
 self.assertDictEqual(device_dict, device_config[0])

45 changes: 30 additions & 15 deletions
tests/unit/config_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,46 +54,61 @@ def test_volume_binding_with_home(self):
 self.assertEqual(d['volumes'], ['/home/user:/container/path'])


class MergeVolumesTest(unittest.TestCase):
class MergePathMappingTest(object):
 def config_name(self):
 return ""

 def test_empty(self):
 service_dict = config.merge_service_dicts({}, {})
 self.assertNotIn('volumes', service_dict)
 self.assertNotIn(self.config_name(), service_dict)

 def test_no_override(self):
 service_dict = config.merge_service_dicts(
 {'volumes': ['/foo:/code', '/data']},
 {self.config_name(): ['/foo:/code', '/data']},
 {},
 )
 self.assertEqual(set(service_dict['volumes']), set(['/foo:/code', '/data']))
 self.assertEqual(set(service_dict[self.config_name()]), set(['/foo:/code', '/data']))

 def test_no_base(self):
 service_dict = config.merge_service_dicts(
 {},
 {'volumes': ['/bar:/code']},
 {self.config_name(): ['/bar:/code']},
 )
 self.assertEqual(set(service_dict['volumes']), set(['/bar:/code']))
 self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code']))

 def test_override_explicit_path(self):
 service_dict = config.merge_service_dicts(
 {'volumes': ['/foo:/code', '/data']},
 {'volumes': ['/bar:/code']},
 {self.config_name(): ['/foo:/code', '/data']},
 {self.config_name(): ['/bar:/code']},
 )
 self.assertEqual(set(service_dict['volumes']), set(['/bar:/code', '/data']))
 self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code', '/data']))

 def test_add_explicit_path(self):
 service_dict = config.merge_service_dicts(
 {'volumes': ['/foo:/code', '/data']},
 {'volumes': ['/bar:/code', '/quux:/data']},
 {self.config_name(): ['/foo:/code', '/data']},
 {self.config_name(): ['/bar:/code', '/quux:/data']},
 )
 self.assertEqual(set(service_dict['volumes']), set(['/bar:/code', '/quux:/data']))
 self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code', '/quux:/data']))

 def test_remove_explicit_path(self):
 service_dict = config.merge_service_dicts(
 {'volumes': ['/foo:/code', '/quux:/data']},
 {'volumes': ['/bar:/code', '/data']},
 {self.config_name(): ['/foo:/code', '/quux:/data']},
 {self.config_name(): ['/bar:/code', '/data']},
 )
 self.assertEqual(set(service_dict['volumes']), set(['/bar:/code', '/data']))
 self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code', '/data']))


class MergeVolumesTest(unittest.TestCase, MergePathMappingTest):
 def config_name(self):
 return 'volumes'


class MergeDevicesTest(unittest.TestCase, MergePathMappingTest):
 def config_name(self):
 return 'devices'


class BuildOrImageMergeTest(unittest.TestCase):
 def test_merge_build_or_image_no_override(self):
 self.assertEqual(
 config.merge_service_dicts({'build': '.'}, {}),
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Added devices config handling and device HostConfig handling by DanElbert · Pull Request #1400 · docker/compose · GitHub
Skip to content
Added devices config handling and device HostConfig handling#1400

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

dnephin
merged 1 commit into

from

May 11, 2015
 Merged


Added devices config handling and device HostConfig handling
#1400
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


41 changes: 23 additions & 18 deletions
compose/config.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@
 'cpuset',
 'command',
 'detach',
 'devices',
 'dns',
 'dns_search',
 'domainname',
Expand DownExpand Up@@ -50,6 +51,7 @@
 'add_host': 'extra_hosts',
 'hosts': 'extra_hosts',
 'extra_host': 'extra_hosts',
 'device': 'devices',
 'link': 'links',
 'port': 'ports',
 'privilege': 'privileged',
Expand DownExpand Up@@ -200,11 +202,14 @@ def merge_service_dicts(base, override):
 override.get('environment'),
 )

 if 'volumes' in base or 'volumes' in override:
 d['volumes'] = merge_volumes(
 base.get('volumes'),
 override.get('volumes'),
 )
 path_mapping_keys = ['volumes', 'devices']

 for key in path_mapping_keys:
 if key in base or key in override:
 d[key] = merge_path_mappings(
 base.get(key),
 override.get(key),
 )

 if 'labels' in base or 'labels' in override:
 d['labels'] = merge_labels(
Expand All@@ -230,7 +235,7 @@ def merge_service_dicts(base, override):
 if key in base or key in override:
 d[key] = to_list(base.get(key)) + to_list(override.get(key))

 already_merged_keys = ['environment', 'volumes', 'labels'] + list_keys + list_or_string_keys
 already_merged_keys = ['environment', 'labels'] + path_mapping_keys + list_keys + list_or_string_keys

 for k in set(ALLOWED_KEYS) - set(already_merged_keys):
 if k in override:
Expand DownExpand Up@@ -346,7 +351,7 @@ def resolve_host_paths(volumes, working_dir=None):


def resolve_host_path(volume, working_dir):
 container_path, host_path = split_volume(volume)
 container_path, host_path = split_path_mapping(volume)
 if host_path is not None:
 host_path = os.path.expanduser(host_path)
 host_path = os.path.expandvars(host_path)
Expand All@@ -368,32 +373,32 @@ def validate_paths(service_dict):
 raise ConfigurationError("build path %s either does not exist or is not accessible." % build_path)


def merge_volumes(base, override):
 d = dict_from_volumes(base)
 d.update(dict_from_volumes(override))
 return volumes_from_dict(d)
def merge_path_mappings(base, override):
 d = dict_from_path_mappings(base)
 d.update(dict_from_path_mappings(override))
 return path_mappings_from_dict(d)


def dict_from_volumes(volumes):
 if volumes:
 return dict(split_volume(v) for v in volumes)
def dict_from_path_mappings(path_mappings):
 if path_mappings:
 return dict(split_path_mapping(v) for v in path_mappings)
 else:
 return {}


def volumes_from_dict(d):
 return [join_volume(v) for v in d.items()]
def path_mappings_from_dict(d):
 return [join_path_mapping(v) for v in d.items()]


def split_volume(string):
def split_path_mapping(string):
 if ':' in string:
 (host, container) = string.split(':', 1)
 return (container, host)
 else:
 return (string, None)


def join_volume(pair):
def join_path_mapping(pair):
 (container, host) = pair
 if host is None:
 return container
Expand Down

4 changes: 4 additions & 0 deletions
compose/service.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@
DOCKER_START_KEYS = [
 'cap_add',
 'cap_drop',
 'devices',
 'dns',
 'dns_search',
 'env_file',
Expand DownExpand Up@@ -441,13 +442,16 @@ def _get_container_host_config(self, override_options, one_off=False):
 extra_hosts = build_extra_hosts(options.get('extra_hosts', None))
 read_only = options.get('read_only', None)

 devices = options.get('devices', None)

 return create_host_config(
 links=self._get_links(link_to_self=one_off),
 port_bindings=port_bindings,
 binds=volume_bindings,
 volumes_from=options.get('volumes_from'),
 privileged=privileged,
 network_mode=self._get_net(),
 devices=devices,
 dns=dns,
 dns_search=dns_search,
 restart_policy=restart,
Expand Down

6 changes: 3 additions & 3 deletions
docs/extends.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -342,8 +342,8 @@ environment:
 - BAZ=local
```

Finally, for `volumes`, Compose "merges" entries together with locally-defined
bindings taking precedence:
Finally, for `volumes` and `devices`, Compose "merges" entries together with
locally-defined bindings taking precedence:

```yaml
# original service
Expand All@@ -361,4 +361,4 @@ volumes:
 - /original-dir/foo:/foo
 - /local-dir/bar:/bar
 - /local-dir/baz/:baz
```
```

14 changes: 12 additions & 2 deletions
docs/yml.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -29,8 +29,8 @@ image: a4bc65fd

### build

Path to a directory containing a Dockerfile. When the value supplied is a
relative path, it is interpreted as relative to the location of the yml file
Path to a directory containing a Dockerfile. When the value supplied is a
relative path, it is interpreted as relative to the location of the yml file
itself. This directory is also the build context that is sent to the Docker daemon.

Compose will build and tag it with a generated name, and use that image thereafter.
Expand DownExpand Up@@ -342,6 +342,16 @@ dns_search:
 - dc2.example.com
```

### devices

List of device mappings. Uses the same format as the `--device` docker 
client create option.

```
devices:
 - "/dev/ttyUSB0:/dev/ttyUSB0"
```

### working\_dir, entrypoint, user, hostname, domainname, mem\_limit, privileged, restart, stdin\_open, tty, cpu\_shares, cpuset, read\_only

Each of these is a single value, analogous to its
Expand Down

13 changes: 13 additions & 0 deletions
tests/integration/service_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -669,3 +669,16 @@ def test_log_drive_none(self):

 self.assertEqual('none', log_config['Type'])
 self.assertFalse(log_config['Config'])

 def test_devices(self):
 service = self.create_service('web', devices=["/dev/random:/dev/mapped-random"])
 device_config = create_and_start_container(service).get('HostConfig.Devices')

 device_dict = {
 'PathOnHost': '/dev/random',
 'CgroupPermissions': 'rwm',
 'PathInContainer': '/dev/mapped-random'
 }

 self.assertEqual(1, len(device_config))
 self.assertDictEqual(device_dict, device_config[0])

45 changes: 30 additions & 15 deletions
tests/unit/config_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -54,46 +54,61 @@ def test_volume_binding_with_home(self):
 self.assertEqual(d['volumes'], ['/home/user:/container/path'])


class MergeVolumesTest(unittest.TestCase):
class MergePathMappingTest(object):
 def config_name(self):
 return ""

 def test_empty(self):
 service_dict = config.merge_service_dicts({}, {})
 self.assertNotIn('volumes', service_dict)
 self.assertNotIn(self.config_name(), service_dict)

 def test_no_override(self):
 service_dict = config.merge_service_dicts(
 {'volumes': ['/foo:/code', '/data']},
 {self.config_name(): ['/foo:/code', '/data']},
 {},
 )
 self.assertEqual(set(service_dict['volumes']), set(['/foo:/code', '/data']))
 self.assertEqual(set(service_dict[self.config_name()]), set(['/foo:/code', '/data']))

 def test_no_base(self):
 service_dict = config.merge_service_dicts(
 {},
 {'volumes': ['/bar:/code']},
 {self.config_name(): ['/bar:/code']},
 )
 self.assertEqual(set(service_dict['volumes']), set(['/bar:/code']))
 self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code']))

 def test_override_explicit_path(self):
 service_dict = config.merge_service_dicts(
 {'volumes': ['/foo:/code', '/data']},
 {'volumes': ['/bar:/code']},
 {self.config_name(): ['/foo:/code', '/data']},
 {self.config_name(): ['/bar:/code']},
 )
 self.assertEqual(set(service_dict['volumes']), set(['/bar:/code', '/data']))
 self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code', '/data']))

 def test_add_explicit_path(self):
 service_dict = config.merge_service_dicts(
 {'volumes': ['/foo:/code', '/data']},
 {'volumes': ['/bar:/code', '/quux:/data']},
 {self.config_name(): ['/foo:/code', '/data']},
 {self.config_name(): ['/bar:/code', '/quux:/data']},
 )
 self.assertEqual(set(service_dict['volumes']), set(['/bar:/code', '/quux:/data']))
 self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code', '/quux:/data']))

 def test_remove_explicit_path(self):
 service_dict = config.merge_service_dicts(
 {'volumes': ['/foo:/code', '/quux:/data']},
 {'volumes': ['/bar:/code', '/data']},
 {self.config_name(): ['/foo:/code', '/quux:/data']},
 {self.config_name(): ['/bar:/code', '/data']},
 )
 self.assertEqual(set(service_dict['volumes']), set(['/bar:/code', '/data']))
 self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code', '/data']))


class MergeVolumesTest(unittest.TestCase, MergePathMappingTest):
 def config_name(self):
 return 'volumes'


class MergeDevicesTest(unittest.TestCase, MergePathMappingTest):
 def config_name(self):
 return 'devices'


class BuildOrImageMergeTest(unittest.TestCase):
 def test_merge_build_or_image_no_override(self):
 self.assertEqual(
 config.merge_service_dicts({'build': '.'}, {}),
Expand Down