Remove sample policy and config files

Now we have docs, lets point people there rather than attempting to
maintain a copy in tree.

Also update the devstack plugin to build ironic.conf from scratch rather
than from the sample.

Change-Id: Id65a4f803832fefe467d59147c39d2dea604ed3c
This commit is contained in:
Jim Rollenhagen 2018-02-02 09:35:32 -05:00
parent 81de9dc06e
commit 5c54c0938e
7 changed files with 39 additions and 1163 deletions

View File

@ -78,7 +78,8 @@ Run the service with::
.tox/py27/bin/ironic-inspector --config-file example.conf
Of course you may have to modify ``example.conf`` to match your OpenStack
environment.
environment. See the `install guide <../install#sample-configuration-files>`_
for information on generating or downloading an example configuration file.
You can develop and test **ironic-inspector** using DevStack - see
`Deploying Ironic Inspector with DevStack`_ for the current status.

View File

@ -252,7 +252,9 @@ function configure_inspector {
create_service_user "$IRONIC_INSPECTOR_ADMIN_USER" "admin"
cp "$IRONIC_INSPECTOR_DIR/example.conf" "$IRONIC_INSPECTOR_CONF_FILE"
# start with a fresh config file
rm -f "$IRONIC_INSPECTOR_CONF_FILE"
inspector_iniset DEFAULT debug $IRONIC_INSPECTOR_DEBUG
inspector_configure_auth_for ironic
configure_auth_token_middleware $IRONIC_INSPECTOR_CONF_FILE $IRONIC_INSPECTOR_ADMIN_USER $IRONIC_INSPECTOR_AUTH_CACHE_DIR/api

View File

@ -55,10 +55,29 @@ Ocata+ 5.0 - 5.X 5.0 - 5.X
``3.X`` means there are no specific plans to deprecate support for this
ironic version. This does not imply that it will be supported forever.
Sample Configuration Files
--------------------------
To generate a sample configuration file, run the following command from the
top level of the code tree::
tox -egenconfig
For a pre-generated sample configuration file, see
:doc:`/configuration/sample-config`.
To generate a sample policy file, run the following command from the
top level of the code tree::
tox -egenpolicy
For a pre-generated sample configuration file, see
:doc:`/configuration/sample-policy`.
Configuration
-------------
Copy ``example.conf`` to some permanent place
Copy the sample configuration files to some permanent place
(e.g. ``/etc/ironic-inspector/inspector.conf``).
Fill in these minimum configuration values:
@ -79,9 +98,8 @@ Fill in these minimum configuration values:
* if you wish to use the ``dnsmasq`` PXE/DHCP filter driver rather than the
default ``iptables`` driver, see the :ref:`dnsmasq_pxe_filter` description.
See comments inside `example.conf
<https://github.com/openstack/ironic-inspector/blob/master/example.conf>`_
for other possible configuration options.
See comments inside :doc:`the sample configuration
</configuration/sample-config>` for other possible configuration options.
.. note::
Configuration file contains a password and thus should be owned by ``root``

View File

@ -37,7 +37,8 @@ Usual hardware introspection flow is as follows:
NIC's found on the node. **ironic-inspector** is also capable of
deleting ports that should not be present. There are two important
configuration options that affect this behavior: ``add_ports`` and
``keep_ports`` (please refer to ``example.conf`` for detailed explanation).
``keep_ports`` (please refer to :doc:`the sample configuration file
</configuration/sample-config>` for a detailed explanation).
Default values as of **ironic-inspector** 1.1.0 are ``add_ports=pxe``,
``keep_ports=all``, which means that only one port will be added, which is

File diff suppressed because it is too large Load Diff

View File

@ -1,59 +0,0 @@
# Full read/write API access
#"is_admin": "role:admin or role:administrator or role:baremetal_admin"
# Read-only API access
#"is_observer": "role:baremetal_observer"
# Internal flag for public API routes
#"public_api": "is_public_api:True"
# Default API access policy
#"default": "!"
# Access the API root for available versions information
# GET /
#"introspection": "rule:public_api"
# Access the versioned API root for version information
# GET /{version}
#"introspection:version": "rule:public_api"
# Ramdisk callback to continue introspection
# POST /continue
#"introspection:continue": "rule:public_api"
# Get introspection status
# GET /introspection
# GET /introspection/{node_id}
#"introspection:status": "rule:is_admin or rule:is_observer"
# Start introspection
# POST /introspection/{node_id}
#"introspection:start": "rule:is_admin"
# Abort introspection
# POST /introspection/{node_id}/abort
#"introspection:abort": "rule:is_admin"
# Get introspection data
# GET /introspection/{node_id}/data
#"introspection:data": "rule:is_admin"
# Reapply introspection on stored data
# POST /introspection/{node_id}/data/unprocessed
#"introspection:reapply": "rule:is_admin"
# Get introspection rule(s)
# GET /rules
# GET /rules/{rule_id}
#"introspection:rule:get": "rule:is_admin"
# Delete introspection rule(s)
# DELETE /rules
# DELETE /rules/{rule_id}
#"introspection:rule:delete": "rule:is_admin"
# Create introspection rule
# POST /rules
#"introspection:rule:create": "rule:is_admin"

View File

@ -0,0 +1,10 @@
---
other:
- |
The sample configuration file located at ``example.conf``
and the sample policy file located at ``policy.yaml.sample``
were removed in this release, as they are now published with documentation.
See `the sample configuration file
<https://docs.openstack.org/ironic-inspector/latest/configuration/sample-config.html>`_
and `the sample policy file
<https://docs.openstack.org/ironic-inspector/latest/configuration/sample-policy.html>`_.