<commit_before>bifrost-create-dib-image
========================

This role uses diskimage-builder to create a bootable disk image or ramdisk.

Requirements
------------

This role requires:

- Ansible 1.9

Role Variables
--------------

The role can use the disk-image-create or ramdisk-image-create scripts. Which script is used is controlled by the build_ramdisk variable. The default is false.

build_ramdisk: false

The dib_env_vars are settings for the diskimage-builder environment variables which allow settings to be passed to elements that are being utilized to build a disk image.  More information on diskimage-builder can be found at http://git.openstack.org/cgit/openstack/diskimage-builder/.  Additionally, an extra_dib_elements setting exists which is a space separated list of elements to incorporate into the image.

dib_env_vars:
  DIB_CLOUD_INIT_DATASOURCES: "ConfigDrive"
  ELEMENTS_PATH: "/opt/stack/diskimage-builder/elements"
extra_dib_elements: ""

http_boot_folder, deploy_image_filename, and deploy_image all control the final destination of the built image.

http_boot_folder: /httpboot
deploy_image_filename: "deployment_image.qcow2"
deploy_image: "{{http_boot_folder}}/{{deploy_image_filename}}"

dib_os_element controls which OS will be used to build the image.

dib_os_element: "ubuntu"

Dependencies
------------

dib-utils must be installed from pip for the image creation to work.

Example Playbook
----------------

- hosts: localhost
  connection: local
  name: "Build DIB image"
  sudo: yes
  gather_facts: yes
  roles:
    - role: bifrost-create-dib-image


License
-------

Copyright (c) 2015 Hewlett-Packard Development Company, L.P.

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.

Author Information
------------------
<commit_msg>Documentation reformatting<commit_after>bifrost-create-dib-image
========================

This role uses diskimage-builder to create a bootable disk image or ramdisk.

Requirements
------------

This role requires:

- Ansible 1.9

Role Variables
--------------

The role can use the disk-image-create or ramdisk-image-create scripts. Which
script is used is controlled by the build_ramdisk variable. The default is
false.

build_ramdisk: false

The dib_env_vars are settings for the diskimage-builder environment variables
which allow settings to be passed to elements that are being utilized to build
a disk image.  More information on diskimage-builder can be found at
http://git.openstack.org/cgit/openstack/diskimage-builder/.  Additionally, an
extra_dib_elements setting exists which is a space separated list of elements
to incorporate into the image.

dib_env_vars:
  DIB_CLOUD_INIT_DATASOURCES: "ConfigDrive"
  ELEMENTS_PATH: "/opt/stack/diskimage-builder/elements"
extra_dib_elements: ""

http_boot_folder, deploy_image_filename, and deploy_image all control the final
destination of the built image.

http_boot_folder: /httpboot
deploy_image_filename: "deployment_image.qcow2"
deploy_image: "{{http_boot_folder}}/{{deploy_image_filename}}"

dib_os_element controls which OS will be used to build the image.

dib_os_element: "ubuntu"

Dependencies
------------

dib-utils must be installed from pip for the image creation to work.

Example Playbook
----------------

- hosts: localhost
  connection: local
  name: "Build DIB image"
  sudo: yes
  gather_facts: yes
  roles:
    - role: bifrost-create-dib-image


License
-------

Copyright (c) 2015 Hewlett-Packard Development Company, L.P.

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.

Author Information
------------------
{'fraction_non_alphanumeric': 0.09924678777137794, 'fraction_numerical': 0.004873726185201595, 'mean_word_length': 3.977949283351709, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1210457', 'n_tokens_mistral': 1285, 'n_tokens_neox': 1225, 'n_words': 511}