lib/vagabond/cookbooks/lxc/README.md in vagabond-0.2.0 vs lib/vagabond/cookbooks/lxc/README.md in vagabond-0.2.2
- old
+ new
@@ -1,58 +1,87 @@
-## LXC
+# LXC
Manage linux containers with Chef.
-### Recipes
+## Recipes
-#### default
+### default
Installs the packages and configuration files needed for lxc on the server. If
the node uses apt-cacher-ng as a client, the server will be reused when building
containers.
-#### install_dependencies
+### install_dependencies
Installs the packages needed to support lxc's containers.
-#### containers
+### containers
This recipe creates all of the containers defined in the `['lxc']['containers']`
hash. Here is an example of an `example` container:
```ruby
node['lxc']['containers']['example'] = {
'template' => 'ubuntu',
- 'trim' => , false,
- 'debug' => , true
+ 'initialize_commands' => ['apt-get update']
}
```
-You may set `trim` and `debug` to `true` if you need them (default is `false`).
+### knife
-Backing store file system and template options are not yet supported.
+Install and manage containers via the knife-remotelxc plugin.
-#### knife
+## LWRPs
-Install and manage containers via the knife-remotelxc plugin.
+### lxc
-### Example
+Allows for creation, deletion, and cloning of containers
+### lxc_config
+
+Allows configuration of the LXC configuration file
+
+### lxc_fstab
+
+Allows defining mounts to be used within the container
+
+### lxc_interface
+
+Allows configurations of network interfaces within a container
+
+### lxc_ephemeral
+
+Run a command within an ephemeral container
+
+### lxc_container
+
+Creates a container using the `lxc` LWRP and configures the container
+as requested. This resource also allows nesting `lxc_fstab` and
+`lxc_interface` within the container resource.
+
+## Example
+
```ruby
include_recipe 'lxc'
lxc_container 'my_container' do
action :create
validation_client 'my-validator'
server_uri 'https://api.opscode.com/organizations/myorg'
validator_pem content_from_encrypted_dbag
run_list ['role[base]']
chef_enabled true
+ fstab_mount "Persist" do
+ file_system '/opt/file_store'
+ mount_point '/opt/file_store'
+ type 'none'
+ options 'bind,rw'
+ end
end
lxc_container 'my_container_clone' do
- action :clone
- base_container 'my_container'
+ action :create
+ clone 'my_container'
chef_enabled true
end
lxc_service 'my_container_clone' do
action :start