cookbooks/kata-containers/README.md

   1 kata-containers Cookbook
   2 ===================
   3
   4 This cookbook installs Kata Containers.
   5
   6 ## Contents
   7
   8 - [Requirements](#requirements)
   9     - [platforms](#platforms)
  10     - [packages](#packages)
  11 - [Attributes](#attributes)
  12 - [Usage](#usage)
  13     - [Recipes](#recipes)
  14         - [kata-containers::default](#kata-containersdefault)
  15     - [Role Examples](#role-examples)
  16 - [License and Authors](#license-and-authors)
  17
  18 ## Requirements
  19
  20 ### platforms
  21
  22 - CentOS, RHEL >= 7
  23 - Ubuntu >= 16.04
  24
  25 ### packages
  26 - none.
  27
  28 ## Attributes
  29
  30 |Key|Type|Description, example|Default|
  31 |:--|:--|:--|:--|
  32 |`['kata-containers']['repo']['update']`|Boolean|Repository update flag.|`false`|
  33
  34 ## Usage
  35
  36 ### Recipes
  37
  38 #### kata-containers::default
  39
  40 This recipe installs Kata Containers.
  41
  42 ### Role Examples
  43
  44 - `roles/kata-containers.rb`
  45
  46 ```ruby
  47 name 'kata-containers'
  48 description 'Kata Containers'
  49
  50 run_list(
  51   'recipe[kata-containers::default]',
  52   # with docker-grid cookbook
  53   'recipe[docker-grid::engine]',
  54 )
  55
  56 override_attributes(
  57   # with docker-grid cookbook
  58   'docker-grid' => {
  59     'engine' => {
  60       'daemon_extra_options' => [
  61         '--add-runtime kata-runtime=/usr/bin/kata-runtime',
  62         '--default-runtime=kata-runtime',
  63       ].join(' '),
  64     },
  65   },
  66 )
  67 ```
  68
  69 ## License and Authors
  70
  71 - Author:: whitestar at osdn.jp
  72
  73 ```text
  74 Copyright 2018, whitestar
  75
  76 Licensed under the Apache License, Version 2.0 (the "License");
  77 you may not use this file except in compliance with the License.
  78 You may obtain a copy of the License at
  79
  80     http://www.apache.org/licenses/LICENSE-2.0
  81
  82 Unless required by applicable law or agreed to in writing, software
  83 distributed under the License is distributed on an "AS IS" BASIS,
  84 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  85 See the License for the specific language governing permissions and
  86 limitations under the License.
  87 ```