openstack/bifrost
Code Issues Proposed changes

Merge "ironic-inspector install doc polish"

Browse Source
This commit is contained in:
Jenkins 2015-12-04 16:18:39 +00:00 committed by Gerrit Code Review
commit 72373c1ea3
1 changed files with 27 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
playbooks/roles/bifrost-ironic-install/README.md
View File

@ -131,43 +131,43 @@ enable_cors_credential_support: Boolean value, default false. This variable
### Hardware Inspection Support ### Hardware Inspection Support
Bifrost also supports the installation of the ironic-inspector in standalone Bifrost also supports the installation of ironic-inspector in standalone
mode, which enables the user to allow for identification of the system mode, which enables the user to allow for identification of the system
properties via a workflow. properties via a workflow.
enable_inspector: Boolean value, default false. This controls the enable_inspector: Boolean value, default false. Set this value to true to
installation and configuration of the ironic- install ironic-inspector.
inspector.
inspector_auth: Inspector authentication mode, defaulted to "noauth". inspector_auth: Sets ironic-inspector's authentication method. Possible values
are `keystone` and `noauth`. `noauth` is recommended since
bifrost by default installs ironic as standalone without
keystone. The default value is `noauth`.
inspector_debug: Boolean Value, default true, this controls if the ironic inspector_debug: Boolean value, default true. Enables debug level logging
inspector is writing debug logging. This may change for inspector. Note that this default may change in
in the future, however it is the default for initial future.
testing.
inspector_manage_firewall: Boolean value, default false, that controls inspector_manage_firewall: Boolean value, default false. Controls whether
if the ironic-inspector is to manage the firewall ironic-inspector should manage the firewall
rules of the host. This is un-necessary in the rules of the host. Bifrost's installation playbook
bifrost use case since the installation playbook adds the rule to permit the callback traffic,
adds the record to permit the callback traffic. so you shouldn't need to enable this.
ironic_auth_strategy: Boolean Value, default "noauth", controls the config ironic_auth_strategy: Sets the `auth_strategy` ironic-inspector should use
of the ironic-inspector for it to understand that ironic with ironic. Possible values are `noauth` and
is operating in noauth mode. `keystone`. The default value is `noauth`.
inspector_data_dir: Defaults to "/opt/stack/ironic-inspector/var", Base folder inspector_data_dir: Base path for ironic-inspector's temporary data and log
for inspector temporary data and log files. files. The default location is
`/opt/stack/ironic-inspector/var`.
inspector_port_addition: Default value, 'pxe' of three possible values, inspector_port_addition: Defines which MAC addresses to add as ports during
'all', 'active', and 'pxe'. Controls the logic introspection. Possible values are `all`, `active`,
utilized for the addition of new port records and `pxe`. The default value is `pxe`.
associated with the ironic node.
inspector_keep_ports: Default value, 'present' of three possible values, inspector_keep_ports: Defines which ports on a node to keep after
'all', 'present', and 'added'. Controls the logic introspection. Possible values are `all`, `present`,
utilized by inspector for setting ports to be and `added`. The default value is `present`.
kept in association with an ironic node.
inspector_store_ramdisk_logs: Boolean value, default true. Controls if the inspector_store_ramdisk_logs: Boolean value, default true. Controls if the
inspector agent will retain logs from the inspector agent will retain logs from the