openstack/bifrost
Code Issues Proposed changes

Fix formatting of Role variables

Browse Source 
As can be seen here
(https://github.com/openstack/bifrost/blob/master/playbooks/roles/bifrost-configdrives-dynamic/README.md)
variables are not formatted correctly.

Change-Id: I4fbe0c2486c3e0246184238853b189842cb47dca
This commit is contained in:
Bradley Jones 2017-01-12 12:02:01 +00:00
parent c7adb13973
commit 95837a6ea6
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
playbooks/roles/bifrost-configdrives-dynamic/README.md
View File

@ -22,13 +22,17 @@ Additional key variables are:
addressing_mode: If defined and set to a value of "dhcp", this role sets the addressing_mode: If defined and set to a value of "dhcp", this role sets the
primary interface to utilize DHCP. primary interface to utilize DHCP.
ipv4_subnet_mask: This is the subnet mask(e.g. 255.255.255.0 or similar) that ipv4_subnet_mask: This is the subnet mask(e.g. 255.255.255.0 or similar) that
matches the static addressing which desires to be imprinted matches the static addressing which desires to be imprinted
into the configuration drive. into the configuration drive.
ipv4_gateway: This is the IPv4 default router address within the IPv4 subnet ipv4_gateway: This is the IPv4 default router address within the IPv4 subnet
being utilized for IP addresses for the nodes being deployed. being utilized for IP addresses for the nodes being deployed.
ipv4_interface_mac: Optional: The MAC address of the network interface to ipv4_interface_mac: Optional: The MAC address of the network interface to
assign the IPv4 address to. assign the IPv4 address to.
node_default_network_interface: This is the default network interface within node_default_network_interface: This is the default network interface within
the nodes to be deployed which the new IP the nodes to be deployed which the new IP
configuration will be applied to. configuration will be applied to.
@ -38,21 +42,30 @@ node_default_network_interface: This is the default network interface within
configuration into the configuration drive configuration into the configuration drive
sufficiently that this should no longer be sufficiently that this should no longer be
required. 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. initially in order to support name resolution.
ipv4_address: The IPv4 address of the node to be deployed, if applicable. ipv4_address: The IPv4 address of the node to be deployed, if applicable.
ironic_url: Defines URL to ironic API. Defaults to "http://localhost:6385/" ironic_url: Defines URL to ironic API. Defaults to "http://localhost:6385/"
ssh_public_key_path: Defines the path to the SSH public key file to be ssh_public_key_path: Defines the path to the SSH public key file to be
inserted into the configuration drive. inserted into the configuration drive.
ssh_public_key: If a user wishes to define an SSH public key as a string, ssh_public_key: If a user wishes to define an SSH public key as a string,
this variable can be utilized which overrides the this variable can be utilized which overrides the
ssh_public_key_path setting. ssh_public_key_path setting.
uuid: The UUID value for the node. uuid: The UUID value for the node.
http_boot_folder: The folder where to save the configuration drive file to. http_boot_folder: The folder where to save the configuration drive file to.
write_interfaces_file: Legacy option to write an debian style network write_interfaces_file: Legacy option to write an debian style network
interfaces configuration file. This is required for interfaces configuration file. This is required for
deployment where simple-init cannot be used, in deployment where simple-init cannot be used, in
particular when using Cirros. particular when using Cirros.
node_network_data: Optional: If defined, the contents are written out to the node_network_data: Optional: If defined, the contents are written out to the
network_data.json file, effectively allowing a user to network_data.json file, effectively allowing a user to
override the network configuration contents based on override the network configuration contents based on