Commit Graph

57 Commits

Author SHA1 Message Date
Cenne 072ebdc1f1 Fix broken links in CONTRIBUTING.rst
* turn on apidocs option for individual module docs
* crosslink to information using :doc: and :ref:

Change-Id: Ie8016623251fb0f55335c64252060d4ce966dc96
2021-07-01 19:50:56 +02:00
ANURADHAJHA99 a06687e39b Replaced openstack baremetal to baremetal in the documentation
Changed osc_plugin_cli.html to index.html

Story: #2008194
Task: #40963

Change-Id: I1ef1a72b5d2b461939a76448177f0d827df585b2
2020-10-19 14:11:36 +05:30
Harald Jensås a1f8926cd1 Remove non-inclusive language in pxe filter
Replaces the use of black/white-list with deny/allow-list
in the pxe filter.

Change-Id: I84e6343fc13e4c4c02521499632a07e782088057
2020-07-09 12:06:03 +02:00
junyiwan-gtc e964b18b99 Update ironic inspector document for dropping py2.x
Support for python2 was dropped during the Ussuri development
cycle.

Change-Id: Ibe7514b0fbd7619f24a75cf3f0230f652a6243cf
2020-02-03 22:41:51 +08:00
Dao Cong Tien 7c5d147fc1 Invalid links in doc file
Change-Id: I2eae6f8fa492f9f7db233dc85abe673942dadcf7
2018-07-05 16:36:29 +07:00
Julia Kreger 47e4e40030 Update launchpad to storyboard references
Change-Id: I9c23727e2c9ecbb21e253fcc8a66ca1e64109cdc
2018-03-28 13:55:05 +00:00
Jim Rollenhagen 5c54c0938e 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
2018-02-06 10:36:12 -08:00
shangxiaobj d0edef14f1 Replace http with https for doc links
Use https instead of http for docs links in ironic-inspector

Change-Id: Ibc6700af5114ef64d3fe9803a4433d19b1223456
2018-01-02 06:25:34 +00:00
dparalen 7b27585463 Refactoring the firewall
Adopting the PXE filter interface/driver concept

Related-Bug: 1665666
Change-Id: If83db978080b9c4e5d51ba50bbe8ed26e29abe83
2017-10-19 16:38:15 +02:00
dparalen 552b3ef946 PXE filter options have no effect yet
Updating the CONTRIBUTING.rst, config.py and example.conf to inform the
Operator (and Developer) that the PXE filter options have no effect yet.

Change-Id: I032114934e300af1e1908369552f1b06c939002f
2017-08-15 16:02:43 +02:00
chenxing c28dd315bf Update the documentation link for doc migration
Change-Id: Ie3d175b4d910f49f8a54812926131448ff1ab4d5
2017-08-03 14:29:06 +00:00
dparalen c38ac86d53 Introducing the user content
Moving the user content down the mandatory directory path.

Change-Id: Icccf00cb22eab01c9ae7626f0997b9c362471e4d
Partial-Bug: 1702142
2017-07-24 17:29:40 +01:00
dparalen cc7b98aa10 Introducing the contributor content
Moving the contributor "link" and API down the mandatory directory
structure.

Change-Id: I111cd55a06e40dc4db649728a5025354a85b3e1d
Partial-Bug: 1702142
2017-07-21 10:22:33 +02:00
dparalen e02bc755a6 PXE boot filtering drivers
Introduce a driver concept for PXE filtering

Change-Id: I73297771c4118f368b80a5f1021a0d5c3fc8b96e
Closes-Bug: 1665666
2017-06-28 12:25:37 +02:00
Dmitry Tantsur 10522e0963 Allow hooks to have dependencies on other hooks
Also refactored hooks and got rid of compatibility layer with old
stevedore.

Change-Id: I81f21df7ebad4df893539ec5f0a03064e7c0a263
Closes-Bug: #1681751
2017-04-26 19:13:52 +02:00
Anton Arefiev 758d88c8d9 Update `create migration` manual
We have dropped downgrade migration support a while ago, but there
are some notes left in contributing guide.

Change-Id: I02131aa9e2d3c9a682cb29403abe8823ac6e1ffb
2017-04-07 14:48:12 +03:00
Anton Arefiev d03a8cc932 Mention state machine diagram generation in contrib guide
Change-Id: I92cd5eb5d503c8294c30c22eab2b01899e2d5d88
2017-03-20 15:24:59 +02:00
Anton Arefiev 62dbe132a7 Update broken alembic links in contributing guide
Change-Id: I64bbc9c10b1f45650c244d6f946b3ee975028bd9
2017-03-14 10:30:09 +02:00
Ramamani Yeleswarapu 83e94c21cd Minor update to CONTRIBUTING.rst
This is a follow up to

I0a4a5198246e3ca69d2bd050dd31c6b468094fcf.

Change-Id: I89d7afed09c85269bb4b435c2196164bee783361
2017-02-15 15:38:26 -08:00
Jenkins dc8408bcd9 Merge "Update documentation to deploy Ironic Inspector with DevStack" 2017-02-15 12:43:26 +00:00
Ramamani Yeleswarapu c56e43b65d Update documentation to deploy Ironic Inspector with DevStack
Current documentation to deploy ironic-inspector with DevStack needs
an update similar to the ironic project.

This patch modifies/updates a section "DevStack Support". Also, it
updates the example.local.conf to a configuration that can be used
as-is to deploy ironic-inspector with DevStack.

Change-Id: I0a4a5198246e3ca69d2bd050dd31c6b468094fcf
2017-02-14 08:59:37 -08:00
Andreas Jaeger ffcb93e03b Prepare for using standard python tests
Add simple script to setup mysql and postgresql databases, this script
can be run by users during testing and will be run by CI systems for
specific setup before running unit tests. This is exactly what is
currently done by OpenStack CI in project-config.

This allows to change in project-config the python-db jobs to
python-jobs since python-jobs will call this script initially.

See also
http://lists.openstack.org/pipermail/openstack-dev/2016-November/107784.html

Update CONTRIBUTING for this.

Change-Id: Ifc16055770e7bf765630814981e3d273876907a7
Needed-By: Icc2a8115cd0b5de165cab2076dbed890f28de172
2017-02-03 20:35:17 +01:00
Dmitry Tantsur cac5ab136e devstack: remove old exercise scripts
Now that our gate is using tempest, these are no longer needed and
maintained. Also stop recommending them in CONTRIBUTING.

Change-Id: I6bd10cf1052b5cd66fc0580439801171739bf7e0
2016-10-06 13:21:29 +02:00
Dmitry Tantsur 6e458b6332 Create devstack/example.local.conf and include it in the docs
It's convenient to have a downloadable example of local.conf.
This change extracts the example from the contributing documentation.

Also removes the noop variable.

Change-Id: I18a7f9969a9820fa8c736dede5f39c70f9c85b6a
2016-06-27 13:15:42 +02:00
Dmitry Tantsur 0b58e31e3e Remove support for the old bash ramdisk
From now on only rely on the IPA inventory and 2 additional fields:
boot_interface and root_device.

Also updated unit tests to use one inventory example.
Also removed duplicating unit tests and checks in test_process.
Also removed devstack support for the old ramdisk.

Change-Id: Ib382328295fc2c1b9143171b1047304febadcaca
2016-06-06 13:36:05 +02:00
Marcellin Fom Tchassem 16594518f3 Make tox respect upper-constraints.txt
This will force pip install to use the upper-constraints.txt specified
version of pip modules. When you don't do this, you are out on the
bleeding edge and become unstable everytime some python library in the
wide world changes in a way that you don't expect.

Post jobs are not yet compatible with the upper-constraints file, so
override the install_command there to skip upper-constraints.

Credit to the equivalent Ironic patch
https://review.openstack.org/#/c/300146/

Change-Id: Ica668afedf622a0be8e8566ac88e1d0020ed9bc7
Closes-Bug: #1563038
2016-04-08 00:33:07 +00:00
Dmitry Tantsur 01a726a245 Update links to existing documentation
* Link to module autodoc instead of github
* Link to the new IPA inventory documentation

Change-Id: I4ed7db13f0f890fcbec553935861f4dbeb712a03
2016-03-16 13:41:28 +01:00
Dmitry Tantsur 3471ec993c Officially deprecate rollback for introspection rules
This was designed to clean up action effects, but proved too confusing.
We should recommend using explicit clean up action instead.

Change-Id: Ia414979956cc0cbd5ed040831c49dba18671f86d
2016-03-08 15:12:47 +01:00
Anton Arefiev a5c8c2aeb1 Add db migrations tests
Tests for database migrations. There are "opportunistic" tests here,
supported backends are sqlite (used in test environment by default),
mysql and postgresql, which are required properly configured unit
test environment.

Change-Id: I660fad241c71f2e73b41f317d00adf97551579c6
2016-03-01 15:04:59 +02:00
Jenkins 8a6936773a Merge "Remove deprecated support for passing patches lists into hooks" 2016-02-11 10:29:14 +00:00
Anton Arefiev 7cbbd2d1fd Remove "ramdisk" mentioning in func test contrib
Functional tests don't rely on ramdisk anymore, so remove it's
mentioning from contribution guide.

Change-Id: I22d7574cc43080dbdb99315565c6bd316cd04f85
2016-02-09 18:44:24 +02:00
Dmitry Tantsur cc422c0a5e Remove deprecated support for passing patches lists into hooks
Long time ago we had an idea of batching node updates. However,
it fails miserably when a plugin or an introspection rule has to inspect
existing node properties, because it receives possibly stale values.
We've deprecated support for batching patches back in Liberty, this
patch removes the associated bits from the hook interface.

Change-Id: Ia482ff50ca276ce1ffec631f016c6a6b54d5a4ab
Closes-Bug: #1506348
2016-02-09 12:36:07 +01:00
Dmitry Tantsur 2a1807af0a Switch to IPA as a primary ramdisk
* Stop requiring memory_mb, local_gb, cpu, cpu_arch, ipmi_address, interfaces;
  take them from inventory instead
* Issue a warning when inventory is not supplied
* Raise an error when root device hints are requested but inventory
  is not supplied
* Logging improvement around network interfaces handling

Closes-Bug: #1528831
Change-Id: Iaa1c34092463ff216379e30bcef55235517f6c92
2016-01-13 17:30:56 +01:00
Dmitry Tantsur 4ad1a9b772 Update IPA section of CONTRIBUTING.rst to match gate
Change-Id: I39a9a8f9f8bfce7271c413d959f813b9b97f162b
2015-11-24 16:33:54 +01:00
Jenkins 57f2225410 Merge "Enable migration autogenerate" 2015-11-11 14:11:34 +00:00
Jenkins 11dd9451ef Merge "Support IPA for devstack-plugin" 2015-11-05 18:01:51 +00:00
Yuiko Takada 29f29eab70 Support IPA for devstack-plugin
Change-Id: Idff4374aad1609ebfce8e9affe0b4692155012b6
2015-11-04 16:33:29 +09:00
Sam Betts c07cfc6655 Enable migration autogenerate
These changes allow a developer to generate migrations using the
autogenerate function without the need to pass in a config file that
includes sql connection information.

Change-Id: I6b3942f7747e8f73e52925c24340e20daeb78911
2015-11-02 17:24:52 +00:00
Sam Betts aa3b8ba777 Add alembic migrations for the inspector database
This patch adds a new command ironic-inspector-dbsync which can be used
to sync the ironic inspector database using alembic migrations. It adds
a migration to match the current required db schema.

Change-Id: I21188b3f5003c8ab43d82903473e2a6ef7f755a0
Closes-Bug: #1495620
2015-09-23 14:44:46 +01:00
Jenkins 88277664f1 Merge "Deprecate returning patches from plugins" 2015-09-16 16:51:18 +00:00
Dmitry Tantsur 105aa64f60 Deprecate returning patches from plugins
This approach was an optimization, but it proved to bring more
troubles than benefits - see LP issue for details.

Precautions are made to avoid breakage. Still, some 3rdparty
hooks might get broken by this change.

Change-Id: I5a84512758e92c87091d6306c8d5baa944955e55
Closes-Bug: #1492946
2015-09-14 16:53:04 +02:00
Dmitry Tantsur eb9b3da67a Add introspection rules support
This patch introduces a simple JSON-based DSL to run on introspected
data. Conditions and actions are provided via new plugin entry points.

This patch is missing PUT operation on a rule, this can be added later.

Also not all planned conditions and actions are added in this patch,
will also follow up.

Implements: blueprint rules
Change-Id: If4d17b5f1462d03879cb4c2ff4e5cb3ea364b697
2015-09-14 14:56:09 +02:00
John Trowbridge 6eb9f58c87 Store and expose introspection data
This adds the ability to store all of the data collected
during introspection. The configuration option
"[processing] store_data" (defaults to 'none'), determines
this behavior. Initially, only 'none' and 'swift' are
supported. If 'swift' is used, the data is stored in Swift
with the object name of "inspector_data-<UUID>".

Adds an endpoint /v1/introspection/<UUID>/data which
retrieves the data according to the method in
"[processing] store_data". Returns 404 if this option
is disabled.

There is a further option to store the location of the data
in the Ironic Node.extra column. For 'swift', this will be
the name of the swift object. The option,
"[processing] store_data_location" determines the key
name in the Node.extra column. (defaults to not storing
the location).

Change-Id: Ibc38064f7ea56f85b9f5a77ef6f62a50f0381ff4
Implements: blueprint store-introspection-data
2015-08-27 20:18:54 -04:00
Dmitry Tantsur 11517d2345 Fix and enhance contributing documentation on writing plugins
Also fixes a wrong example for node_node_found hook.

Closes-Bug: #1473103
Change-Id: I62ce922e8c2981d210f52796ee7f2fbb6b00b464
2015-07-17 13:08:11 +02:00
Jenkins cc40c54427 Merge "Recommend disabling cinder in local.conf" 2015-07-02 09:19:01 +00:00
Dmitry Tantsur 9d22eb5abc Recommend disabling cinder in local.conf
It didn't work previously, but is fixed now.

Change-Id: I61469a2060c7624f7f4acf28ab84daecc2fbed2b
2015-07-02 10:38:08 +02:00
Dmitry Tantsur 7847511b4f Drop unused functest directory
Change-Id: Id41a18c8e0496e59f5700ac64f283a7f93cb1faf
2015-07-02 09:45:03 +02:00
Dmitry Tantsur dc70218bc5 Final discoverd -> inspector rename/move pass
Change-Id: I12b431525f755172d398d1b6e60ad2b69edb52d4
2015-06-15 15:34:00 +02:00
Dmitry Tantsur 8d97cdd77b Launchpad project was renamed
Change-Id: I256e54f6dd52fede2fc8995457f4913a91239434
2015-06-03 10:53:14 +02:00
Dmitry Tantsur 823aa71972 Repair devstack plugin after rename
Also move documentation here from always broken etherpad.

Depends on https://review.openstack.org/#/c/186772/
for Ironic inspection to work.

Change-Id: I795aa9405e6141cc82ad0f37b90a3cc6f0d402c0
2015-06-01 11:15:41 +02:00