Browse Source

Final discoverd -> inspector rename/move pass

Change-Id: I12b431525f755172d398d1b6e60ad2b69edb52d4
changes/96/191796/1
Dmitry Tantsur 7 years ago
parent
commit
dc70218bc5
  1. 12
      CONTRIBUTING.rst
  2. 4
      HTTP-API.rst
  3. 18
      README.rst
  4. 2
      ironic-inspector.8
  5. 2
      setup.py

12
CONTRIBUTING.rst

@ -5,7 +5,7 @@ How To Contribute
Basics
~~~~~~
* Our source code is hosted on StackForge_ GitHub, but please do not send pull
* Our source code is hosted on `OpenStack GitHub`_, but please do not send pull
requests there.
* Please follow usual OpenStack `Gerrit Workflow`_ to submit a patch.
@ -23,7 +23,7 @@ Basics
* Please file a launchpad_ blueprint for any significant code change and a bug
for any significant bug fix.
.. _StackForge: https://github.com/stackforge/ironic-discoverd
.. _OpenStack GitHub: https://github.com/openstack/ironic-inspector
.. _Gerrit Workflow: http://docs.openstack.org/infra/manual/developers.html#development-workflow
.. _launchpad: https://bugs.launchpad.net/ironic-inspector
@ -36,8 +36,8 @@ from PyPI.
Next checkout and create environments::
git clone https://github.com/stackforge/ironic-discoverd.git
cd ironic-discoverd
git clone https://github.com/openstack/ironic-inspector.git
cd ironic-inspector
tox
Repeat *tox* command each time you need to run tests. If you don't have Python
@ -85,7 +85,7 @@ Example local.conf
enable_service neutron q-svc q-agt q-dhcp q-l3 q-meta
disable_service heat h-api h-api-cfn h-api-cw h-eng
enable_plugin ironic-inspector https://github.com/stackforge/ironic-discoverd
enable_plugin ironic-inspector https://github.com/openstack/ironic-inspector
IRONIC_BAREMETAL_BASIC_OPS=True
IRONIC_VM_COUNT=2
@ -143,7 +143,7 @@ Writing a Plugin
**ironic-inspector** allows to hook your code into data processing chain after
introspection. Inherit ``ProcessingHook`` class defined in
`ironic_inspector.plugins.base
<https://github.com/stackforge/ironic-discoverd/blob/master/ironic_inspector/plugins/base.py>`_
<https://github.com/openstack/ironic-inspector/blob/master/ironic_inspector/plugins/base.py>`_
module and overwrite any or both of the following methods:
``before_processing(node_info)``

4
HTTP-API.rst

@ -102,5 +102,5 @@ body will contain the following keys:
* ``ipmi_username`` new IPMI user name
* ``ipmi_password`` new IPMI password
.. _Setting IPMI Credentials: https://github.com/stackforge/ironic-discoverd#setting-ipmi-credentials
.. _Plugins: https://github.com/stackforge/ironic-discoverd#plugins
.. _Setting IPMI Credentials: https://github.com/openstack/ironic-inspector#setting-ipmi-credentials
.. _Plugins: https://github.com/openstack/ironic-inspector#plugins

18
README.rst

@ -24,8 +24,8 @@ CONTRIBUTING.rst_ for instructions on how to contribute.
.. _Tuskar UI: https://pypi.python.org/pypi/tuskar-ui
.. _TripleO: https://wiki.openstack.org/wiki/TripleO
.. _launchpad: https://bugs.launchpad.net/ironic-inspector
.. _PyPI: https://pypi.python.org/pypi/ironic-discoverd
.. _CONTRIBUTING.rst: https://github.com/stackforge/ironic-discoverd/blob/master/CONTRIBUTING.rst
.. _PyPI: https://pypi.python.org/pypi/ironic-inspector
.. _CONTRIBUTING.rst: https://github.com/openstack/ironic-inspector/blob/master/CONTRIBUTING.rst
.. note::
**ironic-inspector** was called *ironic-discoverd* before version 2.0.0.
@ -131,7 +131,7 @@ Fill in at least these configuration values:
other cases).
See comments inside `example.conf
<https://github.com/stackforge/ironic-discoverd/blob/master/example.conf>`_
<https://github.com/openstack/ironic-inspector/blob/master/example.conf>`_
for the other possible configuration options.
.. note::
@ -205,13 +205,7 @@ Here is *inspector.conf* you may end up with::
Running
~~~~~~~
If you installed **ironic-inspector** from the RPM, you might already have
a *systemd* unit, so you can::
systemctl enable openstack-ironic-inspector
systemctl start openstack-ironic-inspector
Otherwise run as ``root``::
Run as ``root``::
ironic-inspector --config-file /etc/ironic-inspector/inspector.conf
@ -267,8 +261,8 @@ CLI tool is based on OpenStackClient_ with prefix
Refer to HTTP-API.rst_ for information on the HTTP API.
.. _OpenStackClient: http://docs.openstack.org/developer/python-openstackclient/
.. _HTTP-API.rst: https://github.com/stackforge/ironic-discoverd/blob/master/HTTP-API.rst
.. _HTTP API: https://github.com/stackforge/ironic-discoverd/blob/master/HTTP-API.rst
.. _HTTP-API.rst: https://github.com/openstack/ironic-inspector/blob/master/HTTP-API.rst
.. _HTTP API: https://github.com/openstack/ironic-inspector/blob/master/HTTP-API.rst
Using from Ironic API
~~~~~~~~~~~~~~~~~~~~~

2
ironic-inspector.8

@ -12,7 +12,7 @@ boot service (usually dnsmasq).
The ironic-inspector does not take any options. However, you should supply
path to the configuration file.
.SH SEE ALSO
README page located at https://pypi.python.org/pypi/ironic-discoverd
README page located at https://pypi.python.org/pypi/ironic-inspector
provides some information about how to configure and use the service.
.SH BUGS
No known bugs.

2
setup.py

@ -23,7 +23,7 @@ setup(
description = open('README.rst', 'r').readline().strip(),
author = "Dmitry Tantsur",
author_email = "dtantsur@redhat.com",
url = "https://pypi.python.org/pypi/ironic-discoverd",
url = "https://pypi.python.org/pypi/ironic-inspector",
packages = ['ironic_inspector', 'ironic_inspector.plugins',
'ironic_inspector.test', 'ironic_inspector.common',
'ironic_inspector_ramdisk', 'ironic_inspector_ramdisk.test'],

Loading…
Cancel
Save