Hardware introspection daemon for OpenStack Ironic
Go to file
Steve Baker 196c019771 Enable Basic HTTP authentication middleware.
When the config option ``auth_strategy`` is set to ``http_basic`` then
non-public API calls require a valid HTTP Basic authentication header to be
set. The config option ``http_basic_auth_user_file`` defaults to
``/etc/ironic-inspector/htpasswd`` and points to a file which supports the
Apache htpasswd syntax[1]. This file is read for every request, so no
service restart is required when changes are made.

The only password digest supported is bcrypt, and the ``bcrypt``
python library is used for password checks since it supports ``$2y$``
prefixed bcrypt passwords as generated by the Apache htpasswd utility.

To try basic authentication, the following can be done:

* Set ``/etc/ironic-inspector/inspector.conf`` ``DEFAULT`` ``auth_strategy``
  to ``http_basic``
* Populate the htpasswd file with entries, for example:
  ``htpasswd -nbB myName myPassword >> /etc/ironic-inspector/htpasswd``
* Make basic authenticated HTTP requests, for example:
  ``curl --user myName:myPassword http://localhost:6385/v1/introspection``

[1] https://httpd.apache.org/docs/current/misc/password_encryptions.html

Change-Id: If50dfbfc18445ad9fe27e17cb0ee1b317ff25a0b
Depends-On: https://review.opendev.org/729070
Story: 2007656
Task: 39826
2020-06-05 01:28:40 +12:00
api-ref/source Switch to newer openstackdocstheme and reno versions 2020-05-20 10:59:56 +02:00
devstack Merge "Update local.conf example file." 2020-05-08 15:02:10 +00:00
doc Switch to newer openstackdocstheme and reno versions 2020-05-20 10:59:56 +02:00
ironic_inspector Enable Basic HTTP authentication middleware. 2020-06-05 01:28:40 +12:00
releasenotes Enable Basic HTTP authentication middleware. 2020-06-05 01:28:40 +12:00
rootwrap.d Support ip6tables for iptables pxe filter 2018-11-07 09:53:47 +08:00
tools Adds bandit template and exclude some of tests 2019-06-20 14:35:43 +08:00
zuul.d Set default timeouts for ironic inspector base job 2020-05-27 14:19:57 +02:00
.gitignore Add request context and policy enforcement 2017-10-13 11:55:52 +00:00
.gitreview OpenDev Migration Patch 2019-04-19 19:36:56 +00:00
.stestr.conf Use ostestr unit test runner 2017-10-02 14:28:58 +00:00
CONTRIBUTING.rst Update ironic inspector document for dropping py2.x 2020-02-03 22:41:51 +08:00
LICENSE Apache license 2014-10-03 17:15:55 +02:00
README.rst update source link in readme 2019-10-15 19:08:28 +08:00
bindep.txt Add librsvg2* to bindep and bindep env 2019-12-24 13:03:35 +05:30
ironic-inspector.8 Trivial: Update pypi url to new url 2018-04-24 09:57:43 +08:00
lower-constraints.txt Enable Basic HTTP authentication middleware. 2020-06-05 01:28:40 +12:00
requirements.txt Enable Basic HTTP authentication middleware. 2020-06-05 01:28:40 +12:00
rootwrap.conf TrivialFix: Fix typo in the configuration file 2016-09-30 10:56:53 +07:00
setup.cfg Add py38 package metadata 2020-05-25 10:55:05 +08:00
setup.py Cleanup py27 support 2020-04-20 08:18:51 +02:00
test-requirements.txt Bump hacking min version to 3.0.1 2020-05-21 07:47:46 +08:00
tox.ini Stop configuring install_command in tox. 2020-05-14 14:56:26 +02:00

README.rst

Hardware introspection for OpenStack Bare Metal

Introduction

image

This is an auxiliary service for discovering hardware properties for a node managed by Ironic. Hardware introspection or hardware properties discovery is a process of getting hardware parameters required for scheduling from a bare metal node, given its power management credentials (e.g. IPMI address, user name and password).

Note

ironic-inspector was called ironic-discoverd before version 2.0.0.

Release Notes

For information on any current or prior version, see the release notes.