23 Commits

Author SHA1 Message Date
jiapei
016b7dd6c5 Fix ironic developer quickstart document
The running tempest section has a deprecated option "all-plugin",
if developer follows the steps, he will get an InvocationError.
This patch is going to fix it and a broken URL.

Change-Id: I7874817d06309287cba27d2a3d3ec7fe7c8122a2
Story: 2004139
Task: 27605
Co-Authored-By: Iury Gregory Melo Ferreira <iurygregory@gmail.com>
2018-10-22 14:49:59 +00:00
Iury Gregory Melo Ferreira
7a551c4f4a Remove Vagrant
The files for Vagrants are too outdated, this patch removes the
information about Vagrant in the documentation and the old files
used to set up a Vagrant environment.

Change-Id: Ieee7b76172874e67bb31055c0c40beb41785f7bb
2018-10-16 10:49:19 -04:00
Kaifeng Wang
f409a869ef Reformat instructions related with various OS
Follow up to "Ironic behind mod wsgi" documentation [1].

This reformats instructions and clears TODOs in the document,
similar places were found and fixed in this patch as well.

References to Fedora 21 are removed.

[1] https://review.openstack.org/#/c/407327

Change-Id: I3ded2614306df3f6ce4b1d14526b061dcaa7b829
2018-08-13 09:05:50 +08:00
Will Szumski
a033b250ad Document locale requirement for local testing
locale for tests is explicily set to en_US.UTF8 in tox.ini

Change-Id: I0e52720406bceaedd4c33b988ab3da131fc95cb1
Story: 2003177
Task: 23323
2018-07-31 10:37:30 +01:00
Hironori Shiina
2822e05673 Doc: Remove -r option for running a specific unit test
Now that os-testr was replaced with stestr for running unit tests, -r
options is no longer necessary to pass a regex to the test runner.

Change-Id: I2d3738e3af47a4a01db3223941e07e68537b5a5c
2018-06-18 12:06:16 +09:00
Julia Kreger
d2f2afa249 Install OSC during quickstart
The quickstart doc was missing the step of installing
python-openstackclient which has become necessary to provide
the `openstack` command. This was not required when the doc
was originally written as we then used the `ironic` command.

Change-Id: Ia529a37730b1df6c6574e10d97a25bc2e547647a
2018-05-08 14:33:36 -07:00
melissaml
909c2678be Trivial: Update pypi url to new url
Pypi url changed from [1] to [2]

[1] https://pypi.python.org/pypi/<package>
[2] https://pypi.org/project/<package>

Change-Id: I43637859b8c183c8ca17200b337845385e546973
2018-04-21 04:02:09 +08:00
Dmitry Tantsur
152f45c993 Switch contributor documentation to hardware types
Also write a bit more meaningful documentation on writing drivers with
helpful links to move forward.

Change-Id: Id76705efabaf93a76a1370bc2e1d998622e82ac9
Partial-Bug: #1690185
2018-02-14 14:40:38 -08:00
Vladyslav Drok
3363fce3be Remove unnecessary lines from sample local.conf
Nova network service does not exist anymore, so no need to disable
it, as well as enable neutron as it is enabled by default. Heat is
not enabled by default, so there is no need to disable it.

Change-Id: I6dea2ec9bde717462b6974c001bc23b2ad8c6d94
2018-02-07 21:14:11 +00:00
Dmitry Tantsur
f02ef8ad7a Rework drivers page in the admin documentation
First, "Enabling Drivers" is a really confusing title, since this page
links to complete driver documentation. It also links to IPA docs and
the PXE driver interface.

Next, our documentation is full of remarks about e.g. "pxe_* family of
drivers", which are misleading in the presence of hardware types and
the pxe_agent_cimc driver. We also have mentions of "iscsi deploy method"
without detailed explanation of how this method relates to hardware types
and classic drivers.

This change consolidates drivers and interfaces documentation under
the more clearly named root page. A new page is created with sections for
both deploy interfaces to use for linking from wherever a link to
a particular deploy interface is required.

Change-Id: Ifb8328ccaaac443fac276873e2c375ebcf983f03
2017-11-22 14:59:57 +01:00
Pavlo Shchelokovskyy
ca14146e03 Migrate to stestr as unit tests runner
Recent update brought os-testr 1.0.0 that already uses stestr test
runner instead of testrepository.

This patch migrates those places using testrepository to using stestr.

Change-Id: I793617e042b38aea4cb177b51b6a7ba4a9268f3c
2017-09-22 08:56:34 +00:00
Ruby Loo
a2f504e9c9 [contributor docs] ironic -> OSC baremetal CLI
For the contributor documents, all the 'ironic' CLI commands are
replaced with their equivalent 'openstack baremetal' CLI commands.

Change-Id: I5b97e4bb8fc15a9544c1b8fa9b9603c4568020c7
Partial-Bug: #1711235
2017-08-30 13:13:58 -04:00
chao liu
4296c9371e Fix to use "." to source script files
Adhering to coding conventions. Refer to ``Code conventions`` at
https://docs.openstack.org/contributor-guide/ for details.

Change-Id: Ifc19ac8bf788a137436e7b957798583bdbbeef79
2017-08-28 09:10:57 +00:00
Ruby Loo
ca1fe6cc84 correct URLs in contributor docs & main index
This corrects the URLs in the contributor documentation as well as the
main index. The changes include:
- changing http to https
- changing absolute links to relative links (where applicable)

Change-Id: Iea392f8108ca4b5203682609dd78b980c1540b89
2017-08-22 23:54:18 +00:00
gaozx
1df3dff00b Fix incorrect documentation urls
Change-Id: Ifc39a856251c18077bc1c3820bffd3c2e9eed9a1
2017-08-22 15:59:43 +01:00
Hironori Shiina
90d1ac43c2 Add a guide for Devstack configuration for boot-from-volume
This patch adds a guide for Devstack configuration to build a
environment to test boot-from-volume feature with VMs.

Change-Id: If1a2f1a712af61618ec6e96ce3bad67295ddcff3
Partial-Bug: #1559691
2017-08-07 21:54:54 +09:00
Jenkins
beb14094d4 Merge "Remove SSH-based driver interfaces and drivers" 2017-08-04 02:20:49 +00:00
Jenkins
f15934eb8d Merge "Enable OSProfiler support in Ironic" 2017-08-02 16:26:57 +00:00
Pavlo Shchelokovskyy
3d9895cc0b Remove SSH-based driver interfaces and drivers
SSH drivers are being unsupported for about a year now. All current
stable branches of ironic are officially supporting IPMI-capable HW
simulation via virtualbmc.
All ironic-related gate jobs have already been switched
to not use or enable those drivers.

This patch finally removes SSH-based power and managemtnt driver interfaces
and all classic drivers using those from ironic code and documentation.
Related exceptions and `ssh_connect` function, together with dependency
on `paramiko` package are removed as well.

Change-Id: Ieda7249b9cd78e3be1eff37804996295fc8d3969
Closes-Bug: #1570301
Depends-On: I9b60c9fa24652e9e64e787cd4e5b0152f51e7a28
2017-08-01 12:39:39 +00:00
Vladyslav Drok
b8f6d35d00 Remove _ssh drivers from dev-quickstart
IRONIC_ENABLED_DRIVERS from sample devstack plugin still lists the
deprecated drivers.

Change-Id: I869d6197d34e6a0ec9ed1fe396409e8ed9f02d86
2017-07-10 12:46:24 +03:00
Ramamani Yeleswarapu
3773f17403 Enable OSProfiler support in Ironic
This patch does the following:
* Adds osprofiler wsgi middleware
  This middleware is used for 2 things:
  - It checks that person who wants to trace is trusted and knows
    secret HMAC key.
  - It starts tracing in case of proper trace headers
    and adds first wsgi trace point, with info about HTTP request.

* Adds initialization of osprofiler at start of service
  - Initialize and set an oslo.messaging based notifier instance
    to osprofiler, which will be used to send notifications to Ceilometer.

* Traces HTTP/RPC/DB API calls and SQL requests

NOTE to test this patch:
1) Make the following changes in localrc to configure DevStack to enable
   OSProfiler:

   enable_plugin panko https://git.openstack.org/openstack/panko
   enable_plugin ceilometer https://git.openstack.org/openstack/ceilometer
   enable_plugin osprofiler https://git.openstack.org/openstack/osprofiler

   # Enable the following services
   CEILOMETER_NOTIFICATION_TOPICS=notifications,profiler
   ENABLED_SERVICES+=,ceilometer-acompute,ceilometer-acentral
   ENABLED_SERVICES+=,ceilometer-anotification,ceilometer-collector
   ENABLED_SERVICES+=,ceilometer-alarm-evaluator,ceilometer-alarm-notifier
   ENABLED_SERVICES+=,ceilometer-api

NOTE: the order of enabling plugins matters.

2) Run stack.sh. Once DevStack environment is setup, enable profiler options
   in ironic.conf and restart ironic services:
   [profiler]
   enabled = true
   hmac_keys = SECRET_KEY
   trace_sqlalchemy = true

3) Use openstackclient and run baremetal command with
   --os-profile SECRET_KEY
   [--profile can be used, but it is deprecated.]
   For example, the following will cause the <trace-id> to be printed
   after node list:

   $ openstack --os-profile SECRET_KEY baremetal node list
   .....
   .....
   Trace ID: <trace-id>
   Display trace with command:
   osprofiler trace show --html <trace-id>

4) The trace results can be saved using this command:

   $ osprofiler trace show --html <trace-id> --out trace.html

OSprofiler spec: https://review.openstack.org/#/c/103825/

Co-Authored-By: Tovin Seven <vinhnt@vn.fujitsu.com>
Co-Authored-By: Hieu LE <hieulq@vn.fujitsu.com>

Partial-Bug: #1560704

Change-Id: Icd3d7c62cf7442de8a77fc67f119ae9b03725f02
2017-07-07 15:58:28 -07:00
Ilya Etingof
8e48156488 Removed nonexistent option from quickstart snippet
Neither `ironic-api` nor `ironic-conductor` tools accept
the `-v` option. Although the developer's quickstart guide
has it in the example what makes cut&paste failing.

This quick fix removes the offending option from the doc.

Change-Id: I31e3657f12f7a9cf64697b362cc168333752184c
2017-07-07 14:11:49 +02:00
Sam Betts
5647bfc246 Move doc/source/dev to doc/source/contributor
Change-Id: I6a3d143cff31348c62d8825f29f7484bafb9c8f0
2017-07-06 12:59:24 +01:00