bifrost/playbooks/roles/ironic-inspect-node/README.md
Julia Kreger 46a552c891 Test timeout extension for inspection
The default introspection time for shade may be too short for some
environments. As such, extending the timeout to be longer to provide
nodes an opportunity to boot, check-in, and reply with results.

The library default, which I believe is 900 seconds, was also based
on basic tests where I determined that _most_ systems should check-in
with-in based on:

 - 300 seconds to POST
 - 300 seconds to PXE
 - 300 seconds to Boot and start IPA.

Change-Id: If17c9d7c6acc19ec05a33fa57cb4bbbef1fa43d0
2016-11-28 15:52:41 +00:00

79 lines
2.6 KiB
Markdown

ironic-inspect-node
===================
Invokes ironic node introspection logic using the os_ironic_inspect module.
Requirements
------------
None at this time. See Dependencies.
Role Variables
--------------
uuid: The UUID of the node to invoke ironic node introspection upon.
This variable is not required if the node name is supplied as
ironic requires unique names.
name: A node name to invoke inspection upon. This variable is not
required if the node uuid value is supplied.
noauth_mode: Controls if the module is called in noauth mode.
By default, this is the standard mode of operation,
however if set to false, the role utilizes os_client_config
which expects a clouds.yml file. More information about
this file format can be found at:
http://docs.openstack.org/developer/os-client-config/
cloud_name: Optional: String value defining a clouds.yaml entry for
the ansible module to leverage.
inspection_wait_timeout: Integer value in seconds, defaults to 1800.
This value may need to be adjusted if the underlying
shade library's default timeout is insufficent for
a node to perform an inspection sequence with.
The timeout assumption in the library was
based upon there being three phases to complete
an inspection sequence, BIOS POST, (i)PXE,
and then booting of the ramdisk and IPA.
In most cases, each phase should be completed
under 300 seconds, although that will vary based
upon the hardware configuration.
Dependencies
------------
This role is dependent upon the os_ironic_inspect module being
available for use.
Example Playbook
----------------
hosts: testvm
name: "Introspect node"
become: no
gather_facts: no
roles:
- role: ironic-inspect-node
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
------------------
Ironic Developers