<commit_before><!--
    This Source Code Form is subject to the terms of the Mozilla Public
    License, v. 2.0. If a copy of the MPL was not distributed with this
    file, You can obtain one at http://mozilla.org/MPL/2.0/.
-->

<!--
    Copyright (c) 2014, Joyent, Inc.
-->

# sdc-docker

A Docker Engine for SmartDataCenter, where the whole DC is
exposed as a single docker host. The Docker remote API is
served from a 'docker' core SDC zone (built from this repo).


# Disclaimer

This is still very much alpha. Use at your own risk!


# Current State

The following shows the state of the various docker commands when talking to
sdc-docker instead of a regular docker host.

## Working and partially-working commands

 * docker create --name=foo64 lx-busybox:0.002 /bin/sh
   * supports -m, -c
   * does not support any other options (especially interactive modes)
 * docker exec
   * supports -i, -t, -d
 * docker history
 * docker images
   * does not filter, fakes 'latest'
 * docker info
 * docker inspect
   * supports inspecting a container
   * supports inspecting an image
 * docker kill
   * only signals supported by node
 * docker pull
   * does not support -a yet
 * docker ps
   * does not filter
 * docker restart
   * supports -t
 * docker rm
   * *ALWAYS* behaves as though -f were passed
   * does not support other options
 * docker rmi
   * does not support -f and --no-prune
 * docker run -d --name=foo lx-busybox:0.002 /bin/sh
   * supports -m, -c
   * does not support any other options (especially interactive modes)
 * docker search
 * docker stop
   * supports -t
 * docker start <id|short-id|name>
   * does not support -a or -i
 * docker version
 * docker wait

## Non-working commands

 * currently none that are implemented but non-working

## Non implemented commands

 * docker attach (DOCKER-4)
   * not implemented
 * docker build
   * not implemented
 * docker commit
   * not implemented
 * docker cp
   * not implemented
 * docker diff
   * not implemented
 * docker events
   * not implemented
 * docker export
   * not implemented
 * docker import
   * not implemented
 * docker load
   * not implemented
 * docker login
   * not implemented
 * docker logout
   * not implemented
 * docker logs
   * not implemented
 * docker port
   * not implemented
 * docker pause (blocked on OS-3455)
   * not implemented
 * docker push
   * not implemented
 * docker save
   * not implemented
 * docker tag
   * not implemented
 * docker top
   * not implemented
 * docker unpause (blocked on OS-3456)
   * not implemented


# Installation
<commit_msg>DOCKER-25 add initial support for 'docker top' (update README)<commit_after><!--
    This Source Code Form is subject to the terms of the Mozilla Public
    License, v. 2.0. If a copy of the MPL was not distributed with this
    file, You can obtain one at http://mozilla.org/MPL/2.0/.
-->

<!--
    Copyright (c) 2014, Joyent, Inc.
-->

# sdc-docker

A Docker Engine for SmartDataCenter, where the whole DC is
exposed as a single docker host. The Docker remote API is
served from a 'docker' core SDC zone (built from this repo).


# Disclaimer

This is still very much alpha. Use at your own risk!


# Current State

The following shows the state of the various docker commands when talking to
sdc-docker instead of a regular docker host.

## Working and partially-working commands

 * docker create --name=foo64 lx-busybox:0.002 /bin/sh
   * supports -m, -c
   * does not support any other options (especially interactive modes)
 * docker exec
   * supports -i, -t, -d
 * docker history
 * docker images
   * does not filter, fakes 'latest'
 * docker info
 * docker inspect
   * supports inspecting a container
   * supports inspecting an image
 * docker kill
   * only signals supported by node
 * docker pull
   * does not support -a yet
 * docker ps
   * does not filter
 * docker restart
   * supports -t
 * docker rm
   * *ALWAYS* behaves as though -f were passed
   * does not support other options
 * docker rmi
   * does not support -f and --no-prune
 * docker run -d --name=foo lx-busybox:0.002 /bin/sh
   * supports -m, -c
   * does not support any other options (especially interactive modes)
 * docker search
 * docker stop
   * supports -t
 * docker start <id|short-id|name>
   * does not support -a or -i
 * docker top
   * does not honor ps_args
   * non-standard format for some fields
 * docker version
 * docker wait

## Non-working commands

 * currently none that are implemented but non-working

## Non implemented commands

 * docker attach (DOCKER-4)
   * not implemented
 * docker build
   * not implemented
 * docker commit
   * not implemented
 * docker cp
   * not implemented
 * docker diff
   * not implemented
 * docker events
   * not implemented
 * docker export
   * not implemented
 * docker import
   * not implemented
 * docker load
   * not implemented
 * docker login
   * not implemented
 * docker logout
   * not implemented
 * docker logs
   * not implemented
 * docker port
   * not implemented
 * docker pause (blocked on OS-3455)
   * not implemented
 * docker push
   * not implemented
 * docker save
   * not implemented
 * docker tag
   * not implemented
 * docker unpause (blocked on OS-3456)
   * not implemented


# Installation

{'fraction_non_alphanumeric': 0.07578347578347579, 'fraction_numerical': 0.01063627730294397, 'mean_word_length': 2.9298507462686567, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 9, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2508198', 'n_tokens_mistral': 1612, 'n_tokens_neox': 1466, 'n_words': 681}