DeveloperLocalWorkbenchForDocker

KO | EN

gitlite — search

#javascript #hacktoberfest #react #ai #typescript #llm #go #android #rust #windows #awesome-list #mcp #ios #open-source

DeveloperLocalWorkbenchForDocker

(★ 10)

Develop muticontainer Project using the local Docker Daemon and a set of CLI scripts which generate and apply Docker commands, like docker build|run|ps ... to groups of containers/images.

DeveloperLocalWorkbenchForDocker 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

### Building, Running, & Reporting on Image/Container Pods

##### ToC

[Purpose](#purpose)  
[Features](#features)  
[How Does It Work](#how-does-it-work)  
[Installing](#installing)  
&nbsp;&nbsp;&nbsp;&nbsp;[Pulling Image](#installing-pulling-image)  
&nbsp;&nbsp;&nbsp;&nbsp;[Sample Project & Testing](#installing-sample-project--testing)  
[Project Tutorial](#project-tutorial)  
[Exploring Commands](#exploring-commands)  
&nbsp;&nbsp;&nbsp;&nbsp;[rm, rmi](#exploring-commands-rm-rmi)  
&nbsp;&nbsp;&nbsp;&nbsp;[run](#exploring-commands-run)  
&nbsp;&nbsp;&nbsp;&nbsp;[tmux](#exploring-commands-tmux)  
[Declaring Dependencies](#declaring-dependencies)  
[Concepts](#concepts)  
[What's Provided](#whats-provided)  
[License](#license)  
[Legal Notice](#legal-notice)  
### Purpose

To facilitate the development of cooperative multicontainer services by extending core [Docker&reg;](#legal-notice) CLI commands to operate on related groups of images/containers managed by the local Docker&reg; Daemon.  Facilitation embodies a desire to accelerate the iterative development loop through the efficiency of local file and computing resources, thereby, avoiding the network and service contention delays inherent to remote web interfaces.

Although Docker Inc. provides [Compose](https://docs.docker.com/compose/), a Trusted Build cluster, and GitHub integration that conceptually provide this functionality, some may adopt this tool to:
+ Avoid implementing a private registry and Docker&reg; Trusted Build cluster, especially for small projects.
+ Potentially improve the responsiveness of the development cycle, as all Docker&reg; commands are executed by the local Docker&reg; Daemon, especially, in situations when the public Docker&reg; Trusted Build cluster performance slows due to congestion of build requests or network connectivity issues.
+ Verify the construction of statically dependent images and execution of cooperative containers before committing them to a public index/registry.
+ Maintain a level of "free privacy", as multiple private repositories hosted by Docker&reg; Trusted Build clusters currently incur a monthly fee.

### Features

+ Use simple commands like ```dlw build```,```dlw run```, and ```dlw images``` to manage and report on a service composed from multiple cooperating containers.
+ Extend ```docker build``` using integrated [GNU make](https://www.gnu.org/software/make/) facility.  For example, employ ```make``` to construct all final artifacts in the host file system producing a build context that's simply copied into a container, such as [scratch](https://hub.docker.com/_/scratch/), resulting in a minimally sized container for deployment.  
+ Launch and concurrently attach to the terminal interfaces of multiple containers using the terminal multiplex feature of [tmux](http://tmux.github.io/).
+ Combined tmux, [linux watch](http://en.wikipedia.org/wiki/Watch_%28Unix%29) and reporting commands, like ```dlw top```, to actively monitor the status of multiple containers.
+ Generate Docker&reg; CLI stream including command line arguments stored in a file, using a rudimentary command template.
+ Enhance report generation by associating custom properties to a Docker&reg; image. 
+ Track previous versions of images and with single command remove all prior versions and their associated containers, ordering their removal to avoid "Conflict" errors issued by the Docker&reg; Daemon.
+ Enjoy the benefits of delivering and running this tool within a container.   
+ Add custom ```dlw``` extensions and repair code without changing existing script source.

### How Does It Work

In a nutshell, most ```dlw``` commands [wrap](http://en.wikipedia.org/wiki/Adapter_pattern) a corresponding Docker&reg; CLI command.  The wrapper transforms the ```dlw``` <a href=#ConceptsComponent>Component</a> and <a href=#ConceptsProject>Project</a> abstractions to an equivalent list of targeted images/containers.  These image/container lists are then used, along with a rudimentary command template, to generate a Docker&reg; CLI stream consisting of one or more individual Docker&reg; commands which implement the original ```dlw``` command.  Besides its template generation feature, the ```dlw``` , through a <a href=#ConceptsDependencySpecification>Dependency Specification</a>, applies a directed graph to order the individual Docker&reg; commands within the CLI stream to better ensure the successful execution of the entire stream.

For example, suppose a Project labeled 'sample' contains four Components: dlw_parent, dlw_sshserver, dlw_mysql, and dlw_apache.  Furthermore, the Components: dlw_sshserver, dlw_mysql, and dlw_apache lexically include dlw_parent.  In this situation, executing ```dlw build```will generate the following Docker&reg; CLI stream:
```
docker build  -t "dlw_parent" "/home/dlw/project/sample/component/dlw_parent/context/build"
docker build  -t "dlw_apache" "/home/dlw/project/sample/component/dlw_apache/context/build"
docker build  -t "dlw_mysql" "/home/dlw/project/sample/component/dlw_mysql/context/build"
docker build  -t "dlw_sshserver" "/home/dlw/project/sample/component/dlw_sshserver/context/build"
```
Notice, the placement of the ```docker build -t dlw_parent...```  request before the other build requests, as dlw_parent must exist/be current to correctly build the derivative Components.

### Installing

#### Installing: Pulling Image

+ <a href="#InstallingTagVersionPull">Determine ```dlw``` tagged version to pull.</a>  View available [```dlw``` Docker&reg; Hub tags](https://registry.hub.docker.com/u/whisperingchaos/dlw/tags/manage/).
+ <a href="#InstallingDownloaddlwRunsh">Download ```dlwRun.sh``` and make it runnable.</a>
+ <a href="#InstallingCreateHostProjectDirectory">Create ```dlw``` host Project directory.</a>
+ Open command terminal accessing appropriate Docker&reg; Daemon.
+ Execute ```dlwRun.sh``` specifying the desired Tag and host Project directory arguments.  
  + Ex: ```> dlwRun.sh -p ~/Desktop/projects 0.5_1.3```
    Once ```dlwRun.sh``` completes, an active ```dlw``` terminal session should appear:
```
    Welcome to Ubuntu 12.04.5 LTS (GNU/Linux 3.8.0-37-generic x86_64)

* Documentation:  https://help.ubuntu.com/

The programs included with the Ubuntu system are free software;
    the exact distribution terms for each program are described in the
    individual files in /usr/share/doc/*/copyright.

Ubuntu comes with ABSOLUTELY NO WARRANTY, to the extent permitted by
    applicable law.

dlw@a1d8390a5a8d:~$ 
```
##### Determine Docker&reg; Tag <a id="InstallingTagVersionPull"></a>
Since the ```dlw``` issues Docker&reg; CLI commands, its image contains a copy of Docker&reg; Daemon.  This embedded instance acts as a client to communicate with the locally running Docker&reg; Daemon by forwarding, [via socket](https://docs.docker.com/articles/basics/#bind-docker-to-another-hostport-or-a-unix-socket), Docker&reg; CLI commands generated by ```dlw```.  Therefore, the embedded Docker&reg; Daemon version must be compatible with the locally running one.  To facilitate selecting the correct ```dlw``` version, its [image tag](https://docs.docker.com/userguide/dockerimages/#setting-tags-on-an-image) consists of two version numbers.  The first one represents the ```dlw``` version, while the second specifies the Docker&reg; Daemon version.  Tag generation appends the first version to an underscore ('_') then appends the second one.  For example, a ```dlw``` version of 0.5 and Docker&reg; Daemon version of 1.3 produces an image tag of '0.5_1.3'.

##### Download dlwRun.sh <a id="InstallingDownloaddlwRunsh"></a>
```dlwRun.sh``` wraps the Docker&reg; CLI request to pull and then run a newly created container from the desired ```dlw``` image.  It also mounts a host directory to store ```dlw``` <a href="#ConceptsProject">Projects</a> to the appropriate mount point within the newly created ```dlw``` container.
+ Start terminal session on host.
+ 'cd' to appropriate directory to contain the download of ```dlwRun.sh```.
+ Enter either ```curl``` or ```wget``` specifying ```https://github.com/WhisperingChaos/DeveloperLocalWorkbenchForDocker/raw/<gitTag>/dlwRun.sh``` replacing \<gitTag\> with the appropriate <a href="#InstallingTagVersionPull">Tag name</a>.
  + Ex: ```wget https://github.com/WhisperingChaos/DeveloperLocalWorkbenchForDocker/raw/0.5_1.3/dlwRun.sh``` downloads ```dlw``` 0.5 version coupled to Docker&reg; 1.3 Daemon.
+ Issue ```chmod +x dlwRun.sh```.

Other methods to download ```dlwRun.sh``` exist [see stackoverflow.com](http://stackoverflow.com/questions/4604663/download-single-files-from-github).

##### Create Host Project Directory <a id="InstallingCreateHostProjectDirectory"></a>
Most likely, ```dlw``` <a href="#ConceptsProject">Projects</a>, which consist of source artifacts to construct <a href="#ConceptsComponent">Component(s)</a>, will reside in the host's more "permanent" file system.  Although Projects can be encapsulated within a container running the ```dlw``` or stored in an associated [Docker&reg; Data Volume](http://docs.docker.com/userguide/dockervolumes/), at this time, it just feels "safer" for Projects to exist within a "traditional" file system, as opposed to a cellular one. Given this guidance, create a subdirectory to group one or more Projects within it.  Mounting this directory into the ```dlw``` container will omit the group directory name from the running ```dlw``` container, however, its contents will be accessible.

Accessing host directories from a container's environment may elicit file permission errors due to differences between a container process' Linux [DAC](https://en.wikipedia.org/wiki/Discretionary_access_control) and the host system's own file security scheme.  The ```dlw``` image supports typical DAC security as explained [here](http://www.linuxsecurity.com/docs/SecurityAdminGuide/SecurityAdminGuide-8.html) supplying only a user's owner, primary group, and secondary group memberships to the host OS when determining access to host mounted files.  Therefore, when running a container derived from the ```dlw``` image, the UID, primary GID, and secondary GIDs of the ```dlw``` container account (also called ```dlw```) should mimic the values associated to the current host account used as your development account.  ```dlwRun.sh``` default behavior aligns the container account's UID and GIDs to assume the values specified by the host account that initiated the ```dlwRun.sh``` script.  ```dlwRun.sh``` additionally supports directly providing UID and GID values.  Please view its options via ```dlwRun.sh -h```.  You may wish to visit the Docker&reg; Forum thread [Hot to mount local directories as a non-root user in a container](https://forums.docker.com/t/hot-to-mount-local-directories-as-a-non-root-user-in-a-container/1789/2) for a more in-depth explanation of container process security.

#### Installing: Sample Project & Testing

+ Assumes successful completion of: [Installing: Pulling Image](#installing-pulling-image) and current terminal session connected to running ```dlw``` container.
+ ```mkdir -p ~/project/sample/component``` Ensure existence of 'sample''s <a href="#ConceptsProject">Project,</a> directory and <a href="#ConceptsComponentCatalog">Component Catalog</a>.
+ ```cd ~/project/sample``` Establish 'sample' as target Project directory for ```dlw``` commands.
+ ```dlw itest``` Installs a Project called 'sample' and performs integration tests.

Once testing successfully completes, a Project called 'sample' will exist in the <a href="#InstallingCreateHostProjectDirectory">host directory</a> specified by the ```dlwRun.sh``` script.  The Project provides examples demonstrating various aspects of the ```dlw```.  For example, specifying a Component's command line arguments for a particular command like ```dlw build``` or ```dlw run``` to avoid having to constantly repeat static argument values on the ```dlw``` command line (see: "../sample/component/dlw_apache/context/run")

+ Use 'sample' as a sandbox to explore various ```dlw``` options and their effects before applying these options to your own Project's Components.
+ The contents of the 'sample' project and local [Docker&reg; Registry](https://docs.docker.com/registry/) can be reverted at any time by running ```dlw itest```.

### Project Tutorial

##### Project Tutorial: Create

Create a minimal viable <a href="#ConceptsProject">Project</a>  that builds a single <a href="#ConceptsComponent">Component</a>.

+ Assumes successful completion of: [Installing: Pulling Image](#installing-pulling-image) and current terminal session connected to running ```dlw``` container.
+ Create a Project directory assigning it the desired Project's name.
  + Ex: ```mkdir ~/project/xproject``` given Project name of 'xproject'. 
+ Create the <a href="#ConceptsComponentCatalog">Component Catalog</a> directory named "component" to manage a Project's Components.
  + Ex: ```mkdir ~/project/xproject/component```
+ Create one or more Component instance directories with the desired Component's name.
  + Ex: ```mkdir ~/project/xproject/component/ycomponent``` given Component name of 'ycomponent'.
+ Create a Component's "context' directory.
  + Ex: ```mkdir ~/project/xproject/component/ycomponent/context``` given Component name of 'ycomponent'.
+ Create a Component's build context directory directory.  A build context directory encapsulates all the resources required to successfully build a Docker&reg; image.
  + Ex: ```mkdir ~/project/xproject/component/ycomponent/context/build```
+ Create and save a Dockerfile to a Component's build context directory.
  + Ex: Produces a Component that's slightly different from ubuntu:12:04 and starts bash when executing ```dlw run```.

```
        echo 'FROM ubuntu:12.04'        > ~/project/xproject/component/ycomponent/context/build/Dockerfile
        echo "ENV DIFF 'MakeItUnique'" >> ~/project/xproject/component/ycomponent/context/build/Dockerfile
        echo 'ENTRYPOINT /bin/bash'    >> ~/project/xproject/component/ycomponent/context/build/Dockerfile
        ```

##### Project Tutorial: Build

+ Build all Components associated to the Project.
  + Ex:

```
        cd ~/project/xproject
        dlw build --dlwm 'Tutorial version.'
        ```

##### Project Tutorial: Report

+ Report on a Project's related images:
  + Ex: ```dlw images``` Should return an extended form of the ```docker images``` report with only a single row of 'ycomponent' information.

##### Project Tutorial: Run

Create new containers for all Components then run and attach to their ttys.

+ Add the 'run' 'context' directory to the Component's definition.
  + Ex: ```mkdir ~/project/xproject/component/ycomponent/context/run```
+ Create the file named DOCKER_CMMDLINE_OPTION and populate it with run options of '-i --tty'.  This file preserves these options to ensure a terminal can be attached to the Component's derivative container and reflect a tty interface without having to specify them on every ```dlw run``` command.
  + Ex: ```echo '-i --tty' > ~/project/xproject/component/ycomponent/context/run/DOCKER_CMMDLINE_OPTION```
+ Create containers for all Components and run them deferring terminal attachment.
  + Ex: ```dlw run -d``` Constructs a container from the ycomponent image and runs it.  Should output the Docker&reg; GUID for the newly constructed and running container.
+ Attach a Project's active container terminal instances to either a new or an existing tmux session.
  + Ex: ```dlw tmux``` Creates a tmux session named 'xproject'. It consists of two terminal sessions (tmux windows): one running bash and the second connected to the executing container derived from 'ycomponent'.
+ Use [tmux](http://tmux.github.io/) attach command to connect to tmux session.
  + Ex: ```tmux attach``` Attaches the current tmux session named ```xproject```.
+ Terminate tmux window running container via 'exit' command.
+ Terminate tmux bash window via 'exit' command.  This should return control to the ```dlw```'s container terminal.

##### Project Tutorial: Remove Images

Removes all Images and derivative Containers associated to a Project from the local Docker&reg; Registry. However, data maintained in the Project's Component Catalog remains untouched.

+ ```dlw rmi --dlwrm --dlwcomp-ver=all all```

### Exploring Commands

+ Assumes successful completion of: [Installing: Pulling Image](#installing-pulling-image).
+ ```dlw``` provides typical help information:
  + Run ```dlw help``` to display a summary of all commands.
  + Run ```dlw <CommandName> --help``` to display a command's offered options.
    + Ex: ```dlw build --help```
```
Create image file for targeted Components.  Wraps docker build command.

Usage: dlw build [OPTIONS] TARGET 
TARGET:  {'all'|COMPONENT [COMPONENT...]}
  'all'              Process all Components defined by Project. Default Behavior.
  COMPONENT          Replace with one or more Component names.

OPTIONS: dlw:
    --dlwno-parent=false  Build only the targeted Component(s). Exclude prerequisite parent one(s).
    --dlwforce=false      Force build even when Component Resources haven't changed.
    --dlwno-exec=false    Do not execute the generated docker command.
    --dlwshow=false       Write the generated docker command to SYSOUT.
    --help=false          Display help for this command.

OPTIONS: docker:
    --force-rm=false     Always remove intermediate containers, even after unsuccessful builds
    --no-cache=false     Do not use cache when building the image
    -q, --quiet=false    Suppress the verbose output generated by the containers
    --rm=true            Remove intermediate containers after a successful build
    -t, --tag=""         Repository name (and optionally a tag) to be applied to the resulting image in case of success
```
Notes:
+ ```dlw``` wrapper commands display two sets of options: ```dlw``` specific, always prefixed by ```--dlw``` and the related Docker&reg; options. Allows weaving of ```dlw``` options and Docker&reg; specific ones.  
+ Options always consume the subsequent command line token, except when the token represents another option or is ``` -- ```: the argument separator.
+ The assignment operator, '=', can be omitted. Ex: ```--dlwno-parent true``` == ```--dlwno-parent=true```
+ Specifying a boolean option without a value negates its default value. Ex. ```--dlwno-parent --...``` Negates ```--dlwno-parent``` from 'false' to 'true'.
+ Most commands, like ```dlw rmi``` and ```dlw rm```, are <a href="#ConceptsComponentVersioning">Component Version</a> aware.  Use the option ```--dlwcomp-ver``` to specify a target version.  Most non-destructive ```dlw``` commands will assume the default version of *Current* ```--dlwcomp-ver=cur```.
+ Nearly all commands permit specifying a set of target component names as arguments.  The ```'all'``` name value is reserved. It specifies a shorthand representing the entire set of Components defined for the Project.
+ Nearly all commands support the ```--dlwshow``` option.  This option outputs the generated Docker&reg; CLI stream to STDOUT.
+ Nearly all commands support the ```--dlwno-exec``` option.  This option bypasses the execution of the generated CLI stream.  Use both ```--dlwshow``` and ```--dlwno-exec``` options to display the Docker&reg; CLI stream for the command.  Helps with debugging problems.
+ Docker&reg; array options [] <a id="ExploringCommandsDockerArray"></a>, like '-v', aren't properly supported by the ```dlw``` command line, as only the rightmost (last) recurring value will appear on the generated ```docker {ps|run|images|...}``` command(s).  Also, since these option values are generally unique to a specific Component, entering them when executing a pod level command is most likely undesirable, as the option values are typically different for each Component.  Therefore, recurring and other Component specific option values should be specified within a file called "DOCKER_CMMDLINE_OPTION".  When specified, this file must be located in a Component's <a href="#ConceptsComponent">command-context directory</a>.   
+ All ```dlw``` wrapper commands are compiled using a bash implemented [linux pipeline](http://en.wikipedia.org/wiki/Pipeline_%28Unix%29).  Therefore, resultant Docker&reg; commands which attempt to immediately attach to standard system streams, like ```docker {run|attach|start}...```, will fail, perhaps, silently.  In this situation, either actively defer attachment, ```dlw run -d ...```, or passively avoid attachment by omitting options that actively attach standard streams, see ```dlw start```.

#### Exploring Commands: rm, rmi

+ **Remove all <a href="#ConceptsComponentVersioning">Component Versions</a> for All Components:**
  Deletes all images, their versions, and all associated containers even if the containers are running at the time of this request:  
  ```
> dlw rmi --dlwrm --dlwcomp-ver=all all
```
+ **Remove just the Current Component Version for all Components:**
  Deletes the most recently built image for every Component and all associated containers, even if the containers are running at the time of this request:  
  ```
> dlw rmi --dlwrm --dlwcomp-ver=cur all
```
+ **Remove all Component Versions and their containers except for the current ones:**
  Deletes every container and every image version except for the most recent version.  
  ```
> dlw rmi --dlwrm --dlwcomp-ver=allButCur all
```
+ **Remove all containers for all Component versions except for the current Component Version:**
  Deletes every container associated to every Component except the most recent Component Version.  
  ```
> dlw rm --dlwcomp-ver=allButCur all
```
+ **Remove all the containers for current Component Version of dlw_sshserver:**
  Deletes every container associated to the most recently built Component named "dlw_sshserver".  
  ```
> dlw rm --dlwcomp-ver=cur dlw_sshserver
```

#### Exploring Commands: run

Since ```dlw run``` wraps its companion ```docker run```, it inherits its myriad options.  Nearly all ```docker run``` options represent static properties assigned to the newly constructed and then executed container produced by this command.
+ To avoid repeatedly specifying these generally constant option values for each single Component, these options should be specified, as a single line, in a file named ```DOCKER_CMMDLINE_OPTION``` located in the specific Component's <a href="#ConceptsComponent">run-context directory</a>. See <a href="#project-tutorial-run">Project Tutorial: Run</a> for an example.
+ All ```dlw``` commands are compiled and executed using a bash implemented [linux pipeline](http://en.wikipedia.org/wiki/Pipeline_%28Unix%29).  In situations where a Component's ```docker run``` option value, like ```-i```, cause a newly running container to commandeer the current terminal session, it will abnormally terminate this pipeline.  The interruption maybe noticed/unnoticed depending on the ordering of the ```docker run``` CLI stream.  Therefore, for projects with at least one interactive container, specify [detached mode (-d)](https://docs.docker.com/reference/run/#detached-vs-foreground), as either an option on the initiating ```dlw run -d ...``` or via that Component's ```DOCKER_CMMDLINE_OPTION``` file.
+ Use the ```dlw tmux``` command to access an interactive process' standard streams/tty for one or more running containers.
+ **A usual dlw workflow assuming interactive container processes and all appropriate options specified in each Component's ```DOCKER_CMMDLINE_OPTION``` file:**

```
> dlw run -d
> dlw tmux
> tmux a
```
+ **Another way to accomplish the same outcome as above:**

```
> dlw create
> dlw start
> dlw tmux
> tmux a
```

#### Exploring Commands: tmux

[tmux](http://tmux.github.io/) implements a popular terminal multiplexer enabling the ```dlw``` to launch and concurrently attach to the terminal interfaces of multiple containers.  ```dlw tmux``` executes a recursive call to first generate the Docker&reg; CLI stream from the ```dlw``` command specified via its ```--dlwc``` option then partition this stream into individual ```tmux new-window``` commands.  Each individual ```tmux new-window``` command for a given execution of the ```dlw tmux``` will be assigned to the same tmux session.  The name of this session defaults to the Project's name or one specified as an argument to the ```dlw tmux``` command.  Besides the tmux terminals produced by the the Docker&reg; CLI stream, each newly created session includes an additional bash terminal.  If desired, ```dlw``` commands can be issued from this tmux managed window.  Note, the resulting Docker&reg; command must keep STDIN open in order to persist its ```tmux``` window (terminal), otherwise, the ```tmux``` window will close.  When STDIN closes immediately, it may seem as if the ```dlw``` command completely or partially failed due to the absence of an "expected" window.  Therefore, please ensure the specific Docker&reg; CLI command generated from the ```dlw``` persists STDIN before assuming an abnormality in ```dlw``` execution.  Finally, for commands, like ```dlw {ps|image|port...}```, which at completion immediately close STDIN, use the ```dlw watch``` command to persist STDIN's open status and periodically re-execute the ```dlw``` command.

+ **Attach to already running containers, derived from the Current Version of the Project's Components, started as interactive (STDIN open) and detached**
  ```
> dlw tmux
> tmux a
```

+ **Monitor the status of all running containers for any Component version.**
  ```
> dlw tmux --dlwc='watch --dlwc="'"ps --dlwcomp-ver=all"'"'
> # or equivalent to minimize quoting
> dlw tmux --dlwc 'watch --dlwc "ps --dlwcomp-ver=all"'
> tmux a
```

### Declaring Dependencies

The ```dlw``` provides a flexible and familiar means to declare dependencies, when necessary, between Components for each command-context.  See <a href="#ConceptsDependencySpecification">Dependency Specification</a> for detailed explanation.

Assuming the necessity of a ```Dependency``` file:
+ Either add an empty text file of that name to the Project's <a href="#ConceptsComponentCatalog">Component Catalog</a> or copy the contents of ['Dependency'](https://github.com/WhisperingChaos/DeveloperLocalWorkbenchForDocker/blob/master/Dependency) from GitHub.
+ Use a text editor to specify the dependencies using GNU makefile [rule syntax](http://www.gnu.org/software/make/manual/make.html#Rule-Syntax), however, omit encoding recipes.  For example, given a Component named "Child" with a static build dependency on another Component named "Parent" and assuming that "Parent" is a root Component, it doesn't depend on other Components, then enter the following GNU rule: ```Child.build : Parent.build``` on its own line in the ```Dependency``` file.  Once saved, ```dlw build``` command will order the resulting ```docker build``` commands to execute the 'Parent' build before performing the child's.

Ex: Dependency file generated during the [Install: Sample Project & Testing](#installing-sample-project--testing).

```
dlw_mysql.build : dlw_parent.build
dlw_apache.build : dlw_parent.build
dlw_apache.run : dlw_mysql.run
```

### Concepts

+ **Component**<a id="ConceptsComponent"></a>:  A widget that contributes one or more elemental services to a cooperative pod of other Components.  Components offer their service(s) through either lexical inclusion, statically inheriting a base Component's implementation ([see FROM](http://docs.docker.io/reference/builder/#from)), or dynamically, as individually executing entities that coordinate their activity through some protocol mechanism ([see LINK](https://docs.docker.com/userguide/dockerlinks/)).

The ```dlw``` implements a Component as a directory whose name reflects the image's name in the local repository.  This directory contains a subdirectory called "context" which represents the resources required to execute a particular ```dlw``` command.  "context" is further subdivided by subdirectories whose names reflect a ```dlw``` command.  These **command-context** subdirectories contain resources, like command line options, required to execute the particular command.  They also identify which commands apply to a particular Component, as certain Components may support some but not all ```dlw``` commands. For example, a statically included Component might not support the ```dlw run``` command.
+ **Dependency Specification**<a id="ConceptsDependencySpecification"></a>: A declarative mechanism to encode ```dlw``` command dependencies between Components.  Component dependencies can be independently specified for any ```dlw``` command, permitting for example, separate dependency graphs for build-time, ```dlw build``` vs. run-time concerns, ```dlw run```.  In general, nearly all ```dlw``` commands mirror either build-time or run-time dependencies.  For example, ```dlw start``` shares the same dependency graph as ```dlw run```.  In these cases, individual ```dlw``` commands can share an existing command's dependency graph.  Specified dependencies will order the ```dlw``` generated Docker&reg; Daemon CLI stream to more fully ensure its successful completion (see [How Does It Work](#how-does-it-work)).  Dependency Specification maybe optional, as weakly coupled Components, a pod whose ordering doesn't affect the outcome of any ```dlw``` command, eliminate its encoding.

A file named "Dependency" captures [GNU make rules](http://www.gnu.org/software/make/manual/html_node/Rule-Introduction.html#Rule-Introduction) for each Component name and ```dlw``` command pair. A rule should only specify a target and its prerequisite(s).  In all cases, a provided default recipe triggers an appropriate process chain to implement the specified ```dlw``` command.  As indicated above, this file should not exist in situations involving weakly coupled Components, as it will be empty.
+ **Component Catalog**<a id="ConceptsComponentCatalog"></a>: Defines the pod of directly interacting Components from which desired group behavior emerges and optionally contains a Dependency Specification.

A directory called "component" implements a Component Catalog.  One or more Component directories exist as subdirectories within "component".  ```dlw``` commands that operate on individual images and their derived containers iterate over "component".
+ **Image GUID List**<a id="ConceptsImageGUIDList"></a>:  An object that maintains a list of Docker&reg; image GUIDs generated when building a specific Component.  The different GUIDs in this list represent various image versions generated due to alterations applied to resources, like a Dockerfile, that comprise a Component's (image's) build context.  Associated to each GUID, a column property bag enables extending the metadata for an image to include an arbitrary set of attributes/columns.  These columns can appear in the reporting generated by the ```dlw ps``` and ```dlw image``` commands.

A standard text file implements each Image GUID List.  The text file is assigned the same name as the Component (image) name with a suffix of ".GUIDlist".  The image GUIDs in the file are ordered from the oldest, which appears as the first line in the text file, to the most recent GUID that occupies its last line.  The column property bag appears space prefixed after the GUID.  It's implemented as a [bash associative array](http://www.gnu.org/software/bash/manual/html_node/Arrays.html#Arrays) named "componentPropBag".  Simply update this column property bag with the custom property names and values you wish displayed as reporting columns.
+ **Component Versioning**<a id="ConceptsComponentVersioning"></a>: A change to a Component's build context results in a new version of the compiled image.  This newly compiled image is automatically assigned a Docker&reg; repository name mirroring the Component's name and a Docker&reg; tag name of 'latest'.  An existing and now prior version of the Component will loose these names reverting to repository and tag names of '\<none\>'. ```dlw``` maintains a list of these prior versions (see <a id="ConceptsImageGUIDList">Image GUID List</a>) and offers a means of indicating a version specifier for a number of its commands.  The ```dlw``` supports the following version specifiers:
  + *Current* (=cur): the most recent image version,
  + *All* (=all): every known image version,
  + *All But Current* (=allButCur): All image versions excluding  the *current* one.
    Since the development process typically focuses on evolving the *Current* version, ```dlw``` omits a means to select a particular previous one.
+ **Build Target**<a id="ConceptsBuildTarget"></a>: An implementation level object whose timestamp represents a Component's last successful ```dlw build```.  This timestamp enables build-time optimization by only executing a ```dlw build``` for a given Component iff at least one of the Component's resources reflects a more recent date than the Build Target.  In this case, ```dlw build``` considers the Component changed since the last ```dlw build``` request causing ```dlw build``` to construct a new Component version.

A Build Target implements itself as a file whose name concatenates the Component name with the suffix ".build".

+ **Build Catalog**<a id="ConceptsBuildCatalog"></a>: An implementation level object that encapsulates one or more Build Targets.

A Build Catalog appears as a directory called "build".
+ **Image Catalog**<a id="ConceptsImageCatalog"></a>:  An object that encapsulates all Image GUID Lists and Build Targets.

It's implemented as a directory named "image".

+ **Script Catalog**<a id="ConceptsScriptCatalog"></a>: A repository comprised almost entirely of bash scripts.  The bash scripts can be categorized as either "framework" or "command" scripts.  Framework scripts generically encode the behavior to support ```dlw``` commands, while command scripts override the necessary functions within framework modules to support a particular command, such as ```dlw build``` or ```dlw run```.  Script Catalogs can exist on two levels: Installation and Project.  An Installation Script Catalog organizes scripts so a single instance of the Catalog can be shared among several ```dlw``` Projects.  In contrast, a Project Script Catalog exists within a particular Project, is inaccessible/isolated from other Projects, and can override any portion of or the entire Installation Script Catalog.

A directory named 'script' implements a Script Catalog.  The Installation Script Catalog resides in the "/usr/bin/dlw/" while a Project Script Catalog, if desired, dwells within a specific Project.

+ **Project**<a id="ConceptsProject"></a>:  An object encapsulating a Component Catalog, an Image Catalog, and potentially a Project Script Catalog.  A Project's Component Catalog defines the complete scope of Components addressable by a ```dlw``` command.  A viable Project minimally contains a Component Catalog consisting of at least one buildable and/or runnable Component.

Implemented as a directory whose name reflects the one assigned to the Project.  The ```dlw``` command will assume the current working directory contains the Project that should be affected by it.  Project may also contain a temporary directory named "tmp" if the current ```dlw``` command fails providing state information that may be important to debugging the its cause.

##### What's Provided

+ Docker&reg; image: [Ubuntu 12.04](https://github.com/tianon/docker-brew-ubuntu-core/blob/7fef77c821d7f806373c04675358ac6179eaeaf3/precise/Dockerfile)
  + [GNU bash](https://www.gnu.org/software/bash/): [4.2.25(1)-release](http://manpages.ubuntu.com/manpages/precise/man1/bash.1.html)
+ [Docker&reg; Daemon (Client)](https://docs.docker.com/reference/commandline/cli/): lxc-docker-?.?.?
+ [GNU make](http://www.gnu.org/software/make/manual/html_node/index.html): [3.81-8.1ubuntu1.1](http://packages.ubuntu.com/precise/make)
+ [tmux](http://tmux.github.io/): [1.9a-1~ppa1~p](https://launchpad.net/~pi-rho/+archive/ubuntu/dev/+index?field.series_filter=precise)
+ [Developer Local Workbench For Docker](https://github.com/WhisperingChaos/DeveloperLocalWorkbenchForDocker)

### License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

###Legal Notice

Docker and the Docker logo are trademarks or registered trademarks of Docker, Inc. in the United States and/or other countries. Docker, Inc. and other parties may also have trademark rights in other terms used herein.

DeveloperLocalWorkbenchForDocker

DeveloperLocalWorkbenchForDocker 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

DeveloperLocalWorkbenchForDocker

DeveloperLocalWorkbenchForDocker 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README