Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marcy-terui/kitchen-docker_cli
Docker native CLI driver for Test-Kitchen
https://github.com/marcy-terui/kitchen-docker_cli
Last synced: about 1 month ago
JSON representation
Docker native CLI driver for Test-Kitchen
- Host: GitHub
- URL: https://github.com/marcy-terui/kitchen-docker_cli
- Owner: marcy-terui
- License: other
- Created: 2014-12-19T07:20:05.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2019-06-19T13:53:22.000Z (over 5 years ago)
- Last Synced: 2024-10-02T00:48:24.321Z (2 months ago)
- Language: Ruby
- Homepage: https://rubygems.org/gems/kitchen-docker_cli
- Size: 139 KB
- Stars: 24
- Watchers: 9
- Forks: 10
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-repositories - marcy-terui/kitchen-docker_cli - Docker native CLI driver for Test-Kitchen (Ruby)
README
# Kitchen::DockerCli
[](http://badge.fury.io/rb/kitchen-docker_cli)
[](https://travis-ci.org/marcy-terui/kitchen-docker_cli) [](https://circleci.com/gh/marcy-terui/kitchen-docker_cli)
[](https://gitter.im/marcy-terui/kitchen-docker_cli?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
A Test Kitchen Driver(and Transport) for Docker command line interface.
This plugin is created with only Docker CLI functions.
We can test on the environment that has no extra software such as `sshd`.
- Test-Kitchen (>= 1.3)
- Docker (>= 1.8)
This driver uses `docker exec` and `docker cp` to upload some files to the containers.
- tar (GNU Tar)
```sh
gem install kitchen-docker_cli
```
or put `Gemfile` in your project directory.
```ruby
source 'https://rubygems.org'
gem 'kitchen-docker_cli'
```
and
```sh
bundle install
```
At first, put your `.kitchen(.local).yml` like this.
```yml
---
driver:
name: docker_cli
transport:
name: docker_cli
platforms:
- name: ubuntu-12.04
- name: centos-6.4
suites:
- name: default
run_list:
attributes:
```
## Driver Configuration
### image
The Docker image's path.
The default value get from `platform.name`.
Examples:
```yml
image: marcy/amzn
```
### platform
The Docker image's platform.
The default value get from `platform.name`.
Examples:
```yml
platform: centos
```
### command
The command to be executed at `docker run`.
The default value is `sh -c 'while true; do sleep 1d; done;'`.
Examples:
```yml
command: /bin/bash
```
### run_command
Adds `RUN` command(s) to `Dockerfile`.
The default value is `nil`.
Examples:
```yml
run_command:
- yum -y install httpd
- service httpd start
```
### environment
Adds `ENV` command(s) to `Dockerfile`.
The default value is `nil`.
Examples:
```yml
environment:
http_proxy: http://proxy.example.com:8080/
LANG: ja_JP.UTF-8
```
### build_context
Pass the basedir as the Docker build context: 'docker build .' Default is 'false'.
### build_pull
Set option `--pull` to the defined value on `docker build`.
The default value is nil which is currently interpreted as `false` by Docker.
```yml
build_pull: true
```
### no_cache
Not use the cached image on `docker build`.
The default value is `false`.
Examples:
```yml
no_cache: true
```
### skip_preparation
Skip the automatically preparation in the step to building Docker image.
(i.e. Just pulling the image)
The default value is `false`.
Examples:
```yml
skip_preparation: true
```
### privileged
Give extended privileges to the suite container.
The default value is `false`.
Examples:
```yml
privileged: true
```
### security_opt
Define the seccomp security profile to use.
The default value is `nil`.
Examples:
```yml
security_opt: seccomp=unconfined
```
### container_name
Set the name of container to link other container(s).
Examples:
```yml
container_name: web
```
### instance_container_name
Use instance name to container_name.
The default value is `false`.
Examples:
```yml
instance_container_name: true
```
### destroy_container_name
Improve destroy action when containers have defined names.
When enabled, "kitchen destroy" will always try to remove suite containers with their name (if defined by container_name or instance_container_name options) in addition to with the id defined in the current state. This allows a clean removal of containers even if the state is corrupted or was removed.
The default value is `true`.
Examples:
```yml
destroy_container_name: false
```
### network
Set the Network mode for the container.
- `bridge`: creates a new network stack for the container on the docker bridge
- `none`: no networking for this container
- `container:`: reuses another container network stack
- `host`: use the host network stack inside the container
Examples:
```yml
network: host
```
### hostname
Set hostname to container.
Examples:
```yml
hostname: example.local
```
### instance_host_name
Use instance name to hostname.
The default value is `false`.
Examples:
```yml
instance_host_name: true
```
### dns
The IP addresses of your DNS servers.
```yml
dns: 8.8.8.8
```
```yml
dns:
- 8.8.8.8
- 8.8.4.4
```
### link
Set `container_name`(and alias) of other container(s) that connect from the suite container.
Examples:
```yml
link: mysql:db
```
```yml
link:
- mysql:db
- redis:kvs
```
### publish
Publish a container's port or a range of ports to the host.
The default value is `nil`.
Examples:
```yml
publish: 80
```
```yml
publish:
- 80:8080
- 22:2222
```
### publish_all
Publish all exposed ports to the host interfaces.
This option used to communicate between some containers.
The default value is `false`.
Examples:
```yml
publish_all: true
```
### expose
Expose a port or a range of ports from the container without publishing it to your host.
The default value is `nil`.
Examples:
```yml
expose: 80
```
```yml
expose:
- 80
- 22
```
### add_host
Add additional lines to `/etc/hosts`.
Examples:
```yml
add_host: myhost:127.0.0.1
```
```yml
add_host:
- myhost:127.0.0.1
- yourhost:123.123.123.123
```
### volume
Adds data volume(s) to the container.
Examples:
```yml
volume: /data
```
```yml
volume:
- /tmp:/tmp
- <%= Dir::pwd %>:/var:rw
```
### volumes_from
Mount data volume(s) from other container(s).
Examples:
```yml
volumes_from: container_name
```
```yml
volumes_from:
- container_a
- container_b
```
### mount
Attach a filesystem mount to the container.
Examples:
```yml
mount: type=volume,source=my-volume,destination=/path/in/container
```
### dockerfile
Create test image using a supplied Dockerfile, instead of the default Dockerfile created.
And it can be written as ERB template.
For best results, please:
- Ensure Package Repositories are updated
- Ensure Dockerfile installs sudo, curl, and tar
- If Ubuntu/Debian, Set DEBIAN_FRONTEND to noninteractive
```yml
dockerfile: my/dockerfile
```
### dockerfile_vars
Template variables for the custom Dockerfile.
Example:
- .kitchen.yml
```yml
driver:
image: marcy/hoge
dockerfile: dockerfile.erb
dockerfile_vars:
envs:
LANG: ja_JP.UTF-8
cmds:
- yum -y install httpd
```
- dockerfile.erb
```erb
FROM <%= config[:image] %>
<% @envs.each do |k,v| %>
ENV <%= k %> <%= v %>
<% end %>
<% @cmds.each do |c| %>
RUN <%= c %>
<% end %>
```
- Result
```
FROM marcy/hoge
ENV LANG ja_JP.UTF-8
RUN yum -y install httpd
```
### memory_limit
Constrain the memory available.
```yml
memory_limit: 256m
```
### cpu_shares
Change the priority of CPU Time.
This option with value 0 indicates that the running container has access to all 1024 (default) CPU shares.
```yml
cpu_shares: 512
```
## Transport Configuration
### lxc_driver
If you use the LXC Driver of Docker (CircleCI), please set `true`
The default value is `false`
```yml
lxc_driver: true
```
### docker_base
Base of `docker` command.
The default value is `docker`
Example:
```yml
docker_base: sudo /path/to/docker
```
### lxc_attach_base
Base of `lxc-attach` command.
This option is used on LXC driver only.
The default value is `sudo lxc-attach`
Example:
```yml
docker_base: sudo /path/to/lxc-attach
```
### lxc_console_base
Base of `lxc-console` command.
This option is used on LXC driver only.
The default value is `sudo lxc-console`
Example:
```yml
docker_base: sudo /path/to/lxc-console
```
### pre_create_command
A script or shell command to run locally prior to creating the
container. Used to prep the build environment, e.g. performing a login
to a private docker repository where the test images are housed.
Example:
```yml
pre_create_command: ./path/to/script.sh
```
### no_docker_cp
If true, it will not use docker\_cp to copy files into the container but the
old classic way of a docker exec "tar ...".
This option can be used as a workaround for this kind of bugs:
https://github.com/moby/moby/issues/38252.
It is better used in system config than in each cookbook as it is closely
related to the system configuration.
* Source hosted at [GitHub][repo]
* Report issues/questions/feature requests on [GitHub Issues][issues]
Pull requests are very welcome! Make sure your patches are well tested.
Ideally create a topic branch for every separate change you make. For
example:
1. Fork the repo
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Added some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
Created and maintained by [Masashi Terui][author] ()
Apache 2.0 (see [LICENSE][license])
[author]: https://github.com/marcy-terui
[issues]: https://github.com/marcy-terui/kitchen-docker_cli/issues
[license]: https://github.com/marcy-terui/kitchen-docker_cli/blob/master/LICENSE
[repo]: https://github.com/marcy-terui/kitchen-docker_cli
[driver_usage]: http://docs.kitchen-ci.org/drivers/usage
[chef_omnibus_dl]: http://www.getchef.com/chef/install/