Adoptable Cookbooks List

Looking for a cookbook to adopt? You can now see a list of cookbooks available for adoption!
List of Adoptable Cookbooks

Supermarket Belongs to the Community

Supermarket belongs to the community. While Chef has the responsibility to keep it running and be stewards of its functionality, what it does and how it works is driven by the community. The chef/supermarket repository will continue to be where development of the Supermarket application takes place. Come be part of shaping the direction of Supermarket by opening issues and pull requests or by joining us on the Chef Mailing List.

Select Badges

Select Supported Platforms

RSS

lxcs (7) Versions 0.1.6

Installs/Configures LinuxContainers.org products

Berkshelf/Librarian
Policyfile
Knife
cookbook 'lxcs', '~> 0.1.6'
cookbook 'lxcs', '~> 0.1.6', :supermarket
knife cookbook site install lxcs
knife cookbook site download lxcs
README
Dependencies
Changelog
Quality

lxcs Cookbook

This cookbook sets up LinuxContainers.org products (LXC, LXD).

Contents

Requirements

Platforms

  • Ubuntu >= 16.04

Cookbooks

  • None.

Attributes

Key Type Description, example Default
['lxcs']['lxc']['env']['lxc'] Hash Content in the /etc/default/lxc. See attributes/default.rb
['lxcs']['lxc']['env']['lxc-net'] Hash Content in the /etc/default/lxc-net. See attributes/default.rb
['lxcs']['lxc']['unprivileged_container']['enabled'] Boolean Enable unprivileged containers or not false
['lxcs']['lxc']['unprivileged_container']['users_allow'] Array root, general users allowed to launch unprivileged_containers on LXC. e.g. ['root', 'alice'] []
['lxcs']['lxc']['lxc-usernet'] Array, String Content (line strings or single string) in the /etc/lxc/lxc-usernet. [], See attributes/default.rb
['lxcs']['lxc']['default.conf'] Array, String Default initial configuration (profile) file. Content (line strings or single string) in the /etc/lxc/default.conf. See attributes/default.rb
['lxcs']['lxc']['extra-default.conf'] Hash Additional container configuration (profile) files. {}, See attributes/default.rb
['lxcs']['lxd']['verbose'] Boolean Verbose mode. false
['lxcs']['lxd']['with_zfs'] Boolean with ZFS utility. false
['lxcs']['lxd']['users_allow'] Array Non-root users allowed to manage Linux containers on LXD. []
['lxcs']['lxd']['init']['enabled'] Boolean execute lxd init or not false
['lxcs']['lxd']['init']['force'] Boolean re-execute lxd init forcely. false
['lxcs']['lxd']['init']['options'] String lxd init command options string. ''
['lxcs']['lxd']['init']['trust_password_vault_item'] Hash derive LXD server trust password from Chef Vault. {}, See attributes/default.rb
['lxcs']['lxd']['config'] Hash lxd configurations. {}, See attributes/default.rb
['lxcs']['lxd']['network'] Hash lxd network configurations. Ubuntu >= 16.10 {}, See attributes/default.rb
['lxcs']['lxd']['network_force_update'] Boolean update lxd network configuration forcely. false
['lxcs']['lxd']['bridge']['enabled'] Boolean lxd bridge network configurations. Ubuntu <= 16.04 false
['lxcs']['lxd']['bridge']['conf'] Hash content in the /etc/default/lxd-bridge. See attributes/default.rb
['lxcs']['lxd']['profile'] Hash lxd container profile configurations. {}, See attributes/default.rb

Usage

Recipes

lxcs::default

This recipe does nothing.

lxcs::lxc

This recipe installs LXC.

lxcs::lxd

This recipe sets up LXD.

Role Examples

  • roles/lxc.rb
name 'lxc'
description 'LXC role.'

run_list(
  'recipe[lxcs::lxc]',
)

override_attributes(
  'lxcs' => {
    'lxc' => {
      'unprivileged_container' => {
        'enabled' => true,
        'users_allow' => [
          'alice',
          'bob',
        ],
      },
      'lxc-usernet' => [
        'alice veth lxcbr0 10',
        'bob veth lxcbr0 10',
      ],
      'env' => {
        'lxc' => {
          'LXC_AUTO' => 'true',
          'BOOTGROUPS' => 'onboot,',
          'SHUTDOWNDELAY' => '5',
          'OPTIONS' => '',
          'STOPOPTS' => '-a -A -s',
          'USE_LXC_BRIDGE' => 'false',
        },
        'lxc-net' => {
          'USE_LXC_BRIDGE' => 'true',
          'LXC_BRIDGE' => 'lxcbr0',
          'LXC_ADDR' => '10.0.3.1',
          'LXC_NETMASK' => '255.255.255.0',
          'LXC_NETWORK' => '10.0.3.0/24',
          'LXC_DHCP_RANGE' => '10.0.3.2,10.0.3.254',
          'LXC_DHCP_MAX' => '253',
        },
      },
      'default.conf' => [
        'lxc.network.type = veth',
        'lxc.network.link = lxcbr0',
        'lxc.network.flags = up',
        'lxc.network.hwaddr = 00:16:3e:xx:xx:xx',
      ],
      'extra-default.conf' => {
        'default-br0.conf' => [
          'lxc.network.type = veth',
          'lxc.network.link = br0',
          'lxc.network.flags = up',
          'lxc.network.hwaddr = 00:16:3e:xx:xx:xx',
        ],
        'default-br0-unpriv.conf' => [
          'lxc.network.type = veth',
          'lxc.network.link = br0',
          'lxc.network.flags = up',
          'lxc.network.hwaddr = 00:16:3e:xx:xx:xx',
          'lxc.id_map = u 0 100000 65536',
          'lxc.id_map = g 0 100000 65536',
        ],
      },
    },
  },
)
  • roles/lxd.rb
name 'lxd'
description 'LXD role.'

run_list(
  'recipe[lxcs::lxd]',
)

override_attributes(
  'lxcs' => {
    'lxd' => {
      'with_zfs' => true,
      'users_allow' => [
        'alice',
        'bob',
      ],
      'init' => {
        'enabled' => true,
        'options' => [
          #"--network-address #{node['ipaddress']}",
          #'--network-port 8443',
          '--storage-backend dir',
          #'--storage-backend zfs',
          #'--storage-create-loop 20',  # 20GB file
          #'--storage-pool lxd',
          # NOT recommended, use 'trust_password_vault_item' attribute.
          #'--trust-password secret',   
        ].join(' '),
      },
      'config' => {
        'core.https_address' => '192.168.1.50:8443',
        'core.trust_password' => true,
        #'storage.zfs_pool_name' => 'lxd',
      },
      # Ubuntu >= 16.10
      'network' => {
        'lxdbr0' => {
          'config' => {
            'dns.mode' => 'dynamic',
            'ipv4.address' => '10.1.3.1/24',
            'ipv4.dhcp.ranges' => '10.1.3.100-10.1.3.254',
            'ipv4.nat' => 'true',
            'ipv6.address' => 'none',
          },
          'managed' => 'true',
          'type' => 'bridge',
        },
      },
      # Deprecated: Ubuntu <= 16.04
      # use `lxc network set` command on 16.10 (yakkety) or later
      'bridge' => {
        'enabled' => true,
        'conf' => {
          'USE_LXD_BRIDGE' => 'true',
          'LXD_BRIDGE' => 'lxdbr0',
          'UPDATE_PROFILE' => 'true',
          'LXD_CONFILE' => '',
          'LXD_DOMAIN' => 'lxd',
          'LXD_IPV4_ADDR' => '10.1.3.1',
          'LXD_IPV4_NETMASK' => '255.255.255.0',
          'LXD_IPV4_NETWORK' => '10.1.3.1/24',
          'LXD_IPV4_DHCP_RANGE' => '10.1.3.100,10.1.3.254',
          'LXD_IPV4_DHCP_MAX' => '155',
          'LXD_IPV4_NAT' => 'true',
          'LXD_IPV6_ADDR' => '',
          'LXD_IPV6_MASK' => '',
          'LXD_IPV6_NETWORK' => '',
          'LXD_IPV6_NAT' => 'false',
          'LXD_IPV6_PROXY' => 'false',
        },
      },
      'profile' => {
        'default-br0' => {
          'config' => {
            'user.user-data' => <<-EOS,
#cloud-config
users:
  - name: alice
    groups: sudo,wheel
    shell: /bin/bash
    ssh-authorized-keys:
      - ssh-rsa AAAAB3Nz ...
EOS
          },
          'description' => 'Default LXD profile for real NIC bridged',
          'devices' => {
            'eth0' => {
              'name' => 'eth0',
              'nictype' => 'bridged',
              'parent' => 'br0',
              'type' => 'nic',
            },
          },
        },
        'docker-lxdbr0' => {
          'config' => {
            'linux.kernel_modules' => 'overlay, nf_nat',
            'security.nesting' => 'true',
          },
          'description' => 'Profile supporting docker in containers',
          'devices' => {
            'aadisable' => {
              'path' => '/sys/module/apparmor/parameters/enabled',
              'source' => '/dev/null',
              'type' => 'disk',
            },
            'eth0' => {
              'name' => 'eth0',
              'nictype' => 'bridged',
              'parent' => 'lxdbr0',
              'type' => 'nic',
            },
            'fuse' => {
              'path' => '/dev/fuse',
              'type' => 'unix-char',
            },
          },
        },
      },
    },
  },
)

License and Authors

  • Author:: whitestar at osdn.jp
Copyright 2017, whitestar

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Dependent cookbooks

ssl_cert >= 0.3.7
platform_utils >= 0.3.1

Contingent cookbooks

There are no cookbooks that are contingent upon this one.

lxcs CHANGELOG

0.1.6

  • adds the ssl_cert cookbook dependency.

0.1.5

  • bug fix: LXD profile and network management.
  • revises documents.

0.1.4

  • adds the ['lxcs']['lxd']['config'] attribute.
  • adds the ['lxcs']['lxd']['verbose'] attribute.

0.1.3

  • updates OS support.
  • updates documents.

0.1.2

  • adds LXD container profile setup feature.
  • refactoring.

0.1.1

  • adds settings for unprivileged containers on LXC.
  • adds the platform_utils cookbook dependency.

0.1.0

  • Initial release of lxcs

Collaborator Number Metric
            

0.1.6 failed this metric

Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.

Contributing File Metric
            

0.1.6 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file

Foodcritic Metric
            

0.1.6 failed this metric

FC066: Ensure chef_version is set in metadata: lxcs/metadata.rb:1
FC069: Ensure standardized license defined in metadata: lxcs/metadata.rb:1
Run with Foodcritic Version 11.1.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any

License Metric
            

0.1.6 passed this metric

No Binaries Metric
            

0.1.6 passed this metric

Publish Metric
            

0.1.6 passed this metric

Supported Platforms Metric
            

0.1.6 passed this metric

Testing File Metric
            

0.1.6 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file

Version Tag Metric
            

0.1.6 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number