Merge "Cleanups on role README files"
This commit is contained in:
Jenkins
Gerrit Code Review
commit
5bd442ad77
@ -1,13 +1,13 @@
|
||||
bifrost-configdrives
|
||||
====================
|
||||
|
||||
Creates configdrives for nodes being provisioned in Bifrost.
|
||||
Creates configdrives for nodes being provisioned in bifrost.
|
||||
|
||||
Requirements
|
||||
------------
|
||||
|
||||
This playbook is intended to be executed prior to the deployments of nodes
|
||||
via the bifrost-setup-nodes role, as part of Bifrost. It creates a basic
|
||||
via the bifrost-setup-nodes role, as part of bifrost. It creates a basic
|
||||
configuration drive containing network configuration and an SSH key
|
||||
permitting the user to login to the host.
|
||||
|
||||
@ -33,15 +33,15 @@ node_default_network_interface: This is the default network interface within
|
||||
the nodes to be deployed which the new IP
|
||||
configuration will be applied to.
|
||||
Note: This is likely to be deprecated and
|
||||
removed in the future as Bifrost will likely
|
||||
removed in the future as bifrost will likely
|
||||
change methods utilized to include networking
|
||||
configuration into the configuration drive
|
||||
sufficiently that this should no longer be
|
||||
required.
|
||||
ipv4_nameserver: Defines the IPv4 Nameserver to configure the node with
|
||||
ipv4_nameserver: Defines the IPv4 nameserver to configure the node with
|
||||
initially in order to support name resolution.
|
||||
ipv4_address: The IPv4 address of the node to be deployed, if applicable.
|
||||
ssh_public_key_path: Defines the path to the file to be SSH public key to be
|
||||
ssh_public_key_path: Defines the path to the SSH public key file to be
|
||||
inserted into the configuration drive.
|
||||
ssh_public_key: If a user wishes to define an SSH public key as a string,
|
||||
this variable can be utilized which overrides the
|
||||
@ -81,7 +81,7 @@ although this carries with it some risks if the filesystem is always
|
||||
treated as a source of truth upon system boot.
|
||||
|
||||
One final note. The size of the configuration drives is limited to 64MB.
|
||||
This is not a limit of Bifrost, but a limit due to the code utilized to
|
||||
This is not a limit of bifrost, but a limit due to the code utilized to
|
||||
write the configuration drive out.
|
||||
|
||||
Dependencies
|
||||
|
||||
@ -109,3 +109,5 @@ limitations under the License.
|
||||
|
||||
Author Information
|
||||
------------------
|
||||
|
||||
Ironic Developers
|
||||
|
||||
@ -11,7 +11,7 @@ This role is expected to be executed on a node that the
|
||||
"bifrost-ironic-install" node has been executed upon.
|
||||
|
||||
This role expects to be executed in a sequence with
|
||||
bifrost-configdrives-dynamic, however that is un-necessary IF the host has a
|
||||
bifrost-configdrives-dynamic, however that is unnecessary IF the host has a
|
||||
dictionary named instance_info defined as that will be used as overriding
|
||||
values.
|
||||
|
||||
@ -29,16 +29,16 @@ network_interface: This is the network interface that the nodes receive
|
||||
|
||||
deploy_image_filename: This is the filename of the image to deploy, which is
|
||||
combined with the network_interface variable to generate
|
||||
a URL used to set the Ironic instance image_source. This
|
||||
a URL used to set the ironic instance image_source. This
|
||||
variable does not have a default in this role and
|
||||
expects to receive this information from the calling
|
||||
playbook.
|
||||
|
||||
deploy_image: This is the full path to the image to be deployed to the system.
|
||||
This is as Ironic requires the MD5 hash of the file to be
|
||||
This is as ironic requires the MD5 hash of the file to be
|
||||
deployed for validation during the deployment process. As a
|
||||
result of this requirement, the hash is automatically collected
|
||||
and submitted to Ironic with the node deployment request. This
|
||||
and submitted to ironic with the node deployment request. This
|
||||
variable does not have a default in this role and expects to
|
||||
receive this information from the calling playbook.
|
||||
|
||||
|
||||
@ -2,7 +2,8 @@ bifrost-ironic-install
|
||||
======================
|
||||
|
||||
This role installs a standalone ironic deployment with all required substrate
|
||||
in order for it to be utilized, including MySQL, RabbitMQ, dnsmasq, nginx.
|
||||
in order for it to be utilized, including MySQL, RabbitMQ, dnsmasq, and
|
||||
nginx.
|
||||
|
||||
Requirements
|
||||
------------
|
||||
@ -17,10 +18,10 @@ doc/source/offline-install.rst for details on installing without it.
|
||||
Role Variables
|
||||
--------------
|
||||
|
||||
Testing mode is intended to help facilitate testing of the Bifrost roles and
|
||||
Testing mode is intended to help facilitate testing of the bifrost roles and
|
||||
ironic by utilizing virtual machines on the localhost and the agent_ssh
|
||||
driver. This variable should be set globally for playbooks utilizing the
|
||||
install-ironic role.
|
||||
bifrost-ironic-install role.
|
||||
|
||||
testing: false
|
||||
|
||||
@ -35,7 +36,7 @@ should be enabled.
|
||||
cleaning: false
|
||||
|
||||
The ironic python client and shade libraries can be installed directly from
|
||||
GIT. The default is to utilize pip to install the current versions in pypi,
|
||||
Git. The default is to utilize pip to install the current versions in pypi,
|
||||
however testing may require master branch or custom patches.
|
||||
|
||||
ironicclient_source_install: false
|
||||
@ -110,7 +111,7 @@ Example Playbook
|
||||
|
||||
- hosts: localhost
|
||||
connection: local
|
||||
name: "Install Ironic Locally"
|
||||
name: "Install ironic locally"
|
||||
sudo: yes
|
||||
gather_facts: yes
|
||||
roles:
|
||||
|
||||
@ -3,7 +3,7 @@ bifrost-openstack-ci-prep
|
||||
|
||||
This role is intended to be utilized in order to set the installation
|
||||
environment and various job settings that are specific to OpenStack CI
|
||||
such that the Bifrost CI job is able to complete successfully.
|
||||
such that the bifrost CI job is able to complete successfully.
|
||||
|
||||
Requirements
|
||||
------------
|
||||
@ -88,3 +88,4 @@ limitations under the License.
|
||||
Author Information
|
||||
------------------
|
||||
|
||||
Ironic Developers
|
||||
|
||||
@ -85,3 +85,4 @@ limitations under the License.
|
||||
Author Information
|
||||
------------------
|
||||
|
||||
Ironic Developers
|
||||
|
||||
@ -1,7 +1,8 @@
|
||||
bifrost-test-vm
|
||||
===============
|
||||
|
||||
Gathers facts from nodes in the testvm group which is added by the bifrost-prepare-for-test role.
|
||||
Gathers facts from nodes in the testvm group which is added by the
|
||||
bifrost-prepare-for-test role.
|
||||
|
||||
Requirements
|
||||
------------
|
||||
@ -16,7 +17,8 @@ None at this time. See Dependencies.
|
||||
Dependencies
|
||||
------------
|
||||
|
||||
This role is intended to be executed as part of BiFrost, after the bifrost-prepare-for-test role, as part of the test sequence.
|
||||
This role is intended to be executed as part of bifrost, after the
|
||||
bifrost-prepare-for-test role, as part of the test sequence.
|
||||
|
||||
Example Playbook
|
||||
----------------
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
ironic-delete-dynamic
|
||||
=====================
|
||||
|
||||
Removes nodes from Ironic utilizing the os_ironic Ansible module that is
|
||||
installed by Bifrost.
|
||||
Removes nodes from ironic utilizing the os_ironic Ansible module that is
|
||||
installed by bifrost.
|
||||
|
||||
Requirements
|
||||
------------
|
||||
@ -28,7 +28,7 @@ Dependencies
|
||||
------------
|
||||
|
||||
This role has no direct role dependencies although is expected to be
|
||||
executed as part of Bifrost's test sequence.
|
||||
executed as part of bifrost's test sequence.
|
||||
|
||||
Example Playbook
|
||||
----------------
|
||||
|
||||
Loading…
Reference in New Issue
Block a user