77 Commits

Author SHA1 Message Date
Julia Kreger
cf870ae510 Fix apidoc build
Change-Id: Id7c5686cdbdc79812e06eb4a5f87eddc75005cc3
2020-06-15 11:30:02 -07:00
Jay Faulkner
3dd929eb92 Document how to output journal to console
Having all logs from the device visible on console may be useful for
deployers who do not enable login access to IPA ramdisks as a matter of
policy.

Change-Id: If9d29dd00a8c35fe679e1f54d1574eed0a79470c
2020-06-09 14:30:18 +00:00
Andreas Jaeger
f108b7a2d0 Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.

Disable openstackdocs_auto_name to use 'project' variable as name.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.
This repo uses storyboard, configure the proper variables.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: Id084bfc9d5ae7a95d3cba22a00b4c03a35967ee4
2020-05-23 18:29:40 +02:00
Arne Wiebalck
b5e25760af [doc] How to pause the IPA for debugging
This patch adds two handy methods to pause the IPA when it needs
to be debugged.

Change-Id: I6ab4d6707fce340ee447355c717b19a12f3fe1ec
2020-02-28 11:03:25 +01:00
Dmitry Tantsur
31b73b4984 Expose collector and hardware manager names via introspection data
This change adds a new introspection data field 'configuration'
with two lists: managers and collectors.

Change-Id: Ice0d7e6ecff3f319bc3a4f41617059fd6914e31c
2020-01-22 11:15:38 +01:00
Dmitry Tantsur
4b602771e9 Document introspection data and collectors
Change-Id: Ie51ec8fbae3848ad8a913b05cc3f0f80f33b5f95
2020-01-21 15:40:40 +01:00
Madhuri Kumari
22ab827796 Remove deprecated ironic-agent element
ironic-agent is deprecated. Also replace disk-image-create
with ironic-python-agent-builder.

Change-Id: I6a3b5a31eda66b122a310119539fad6f8600ed80
2019-12-27 10:13:51 +05:30
Dmitry Tantsur
f1b2df908a Replace WSME and Pecan with Werkzeug
WSME is no longer maintained and Pecan is an overkill for our (purely
internal) API. This change rewrites the API in Werkzeug (the library
underneath Flask). I don't use Flask here since it's also an overkill
for API with 4 meaningful endpoints.

Change-Id: Ifed45f70869adf00e795202a53a2a53c9c57ef30
2019-12-04 16:50:47 +01:00
Pierre Riteau
11862ccae9 Fix instructions for enabling SSH on recent tinyipa images
We need to use AUTHORIZE_SSH since ENABLE_SSH was fully removed in
change I4256c8e89923c7104cb4191f3381312c1593b535.

Change-Id: I5c643b1ae8819b02b667b2df13241753ddca5743
2019-11-11 15:04:46 +01:00
Dmitry Tantsur
16d15931f6 Refer to ironic-python-agent-builder for image building
To avoid duplication, remove image building information from IPA docs.
Instead, add information about pre-built images.

Change-Id: I63fd3da36ed2acbd91d365465dec10d96c979035
2019-09-26 14:42:47 +02:00
Zuul
03713c5644 Merge "Remove support for CoreOS images" 2019-09-09 08:32:59 +00:00
Kaifeng Wang
cef3bac3dc Build pdf doc
The is one of community goals that each project could produce a
single PDF file. The pdf should be in the output of openstack-tox-docs
job.

TeX packages are required to build PDF locally, following is recommended:

* inkscape
* texlive-latex-base
* texlive-latex-extra
* texlive-fonts-recommended

More about the goal:
https://governance.openstack.org/tc/goals/train/pdf-doc-generation.html
https://etherpad.openstack.org/p/train-pdf-support-goal
https://etherpad.openstack.org/p/pdf-goal-train-common-problems

Change-Id: If5446ce4ceee7e38a0052503aa8fc2b6c5d7de66
2019-09-06 10:48:58 +08:00
Dmitry Tantsur
e446a5e6c4 Remove support for CoreOS images
Change-Id: Id9737067c678d4d01b20eae0b4a681c6cf9171a8
2019-08-28 19:46:37 +02:00
Shivanand Tendulker
8d3fc928b6 Follow-up of 74339f6da2276a125ace6966d3730f2f2dd8213d
Addreses the minor comments in commit 74339f6da2276a125ace6966d3730f2f2dd8213d

Change-Id: I8c83bbc07c2d678b0ac24eb4e25e231285480ace
2019-07-16 03:07:35 -04:00
Zuul
aebbc93f19 Merge "Modify Tiny IPA image build" 2019-07-16 05:35:49 +00:00
Zuul
f827bfb46c Merge "Bump openstackdocstheme to 1.20.0" 2019-07-15 18:45:34 +00:00
Dongcan Ye
74339f6da2 Modify Tiny IPA image build
Commit dd7e7fdd1acb819a933b905e99ae701abf774788 removes tinyipa
from IPA, this patch reword Tiny IPA image build docs.

Change-Id: Ibad6407ea37b0bd2082487da6ac112c54703bc94
2019-07-15 06:53:42 +00:00
Julia Kreger
696606f682 manual introspection trigger command
Change-Id: I64e66682c1e54f6edc260a22f46f5f6df8e85af1
Story: 2005896
Task: 33756
2019-07-08 07:43:40 -07:00
翟小君
8e219cd51d Bump openstackdocstheme to 1.20.0
Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.

Change-Id: I38d3f05ce9d6a32a0c4e5d44df13e527aa629b2e
2019-07-03 17:45:43 +08:00
Brad P. Crochet
7b3469ee0f Get the hostname of the introspected host
This will retrieve the hostname of the host being introspected, and
return it as part of the introspection data.

Change-Id: I54084251e1b0f3a40fe5ac760b2a7e45199c9fdb
Story: #2005867
Task: #33674
2019-06-12 13:00:21 +00:00
Dongcan Ye
dcffadc196 Docs: Add bmc_v6address hardware inventory
Change-Id: I2cc621ac1e442ba262d76af7fa4e9598ecc2da5a
2019-05-30 15:22:17 +00:00
zhulingjie
b15d5d580c Replace git.openstack.org URLs with opendev.org URLs
Change-Id: I7473b96d47d959fc4c02cecbfaf4785d5f92996a
2019-04-25 09:23:11 +08:00
Zuul
97504b07a6 Merge "Change HTTP links to HTTPS" 2018-12-18 10:01:10 +00:00
zhouxinyong
68ad3661a3 Change HTTP links to HTTPS
Change-Id: I963c32407c109c840d59f4dcf945f2fc78e096f2
2018-12-18 09:41:33 +00:00
chenjiao
27d4e6b2cc Update http link to https
Change-Id: I5cf2627d999d4f3cf7bc2367f4d9cfddf6391146
2018-12-08 18:03:59 +08:00
zhangdebo
391636c289 Update link addresses
Change-Id: I52f275917be720b1e48f17876deb10cd4e6d2501
2018-11-24 14:58:49 +08:00
Shivanand Tendulker
a1d2b2ad0f Follow-up patch for documentation of rescue mode
This is the follow-up patch addresses outstanding comments for
commit 689dbf6b5c6ec1dcaf1fa37d288518c91eedf4ec.

Change-Id: I72c189988c5c274c32d61a2b9aea5a84da2b2c6e
Related-Bug: #1526449
2018-02-12 14:05:14 -05:00
Mario Villaplana
689dbf6b5c Add documentation for rescue mode
This adds documentation for rescue mode, including the finalize_rescue
command as well as upstream support in agent images.

Change-Id: Id0834941ee4dacf2e7c0feaa65126d63e8a97c39
Partial-Bug: 1526449
2018-02-07 11:08:15 -05:00
Dmitry Tantsur
ad3c7ad75d Release notes clean up for the upcoming release
Also adds a missing documentation bit and specific versions for pike notes.

Change-Id: I186fe35cdd7a03702c993cae6468ef2d8151778a
2017-10-17 16:18:39 +02:00
Nguyen Van Trung
9ed2677c9d Fix wrong link about Hardware Managers
Change-Id: Ie7d43313692e5f0bd7794ae38e7b86f2204ef90b
2017-09-21 09:13:09 +07:00
Jenkins
e626cd744f Merge "Removes unnecessary utf-8 encoding" 2017-07-25 19:40:23 +00:00
Julia Kreger
7ae28c66bd Correct/update links
Correct instances of http to https and fix any remaining links
that were broken due to the document migration.

Change-Id: I492f7972839e63efdde469a1e16840d9be6d8b31
2017-07-14 20:28:08 +00:00
Julia Kreger
da95c4a891 Move content to admin
Change-Id: Ibffc7407addbdabb9121117366484f907d82f719
2017-07-11 13:45:45 +00:00
Julia Kreger
cace396783 Move install related content
Change-Id: Ib9a3897795993e7bce9a43d4028e1c9a90d47302
2017-07-11 13:33:46 +00:00
Julia Kreger
537dbcd03a Move contributor documentation
Change-Id: I43890d380b3cb6b19cfb84bf5d9dcad4f19c0062
2017-07-10 19:57:58 +00:00
Arundhati Surpur
2d1bff8f0d Removes unnecessary utf-8 encoding
This patches removes unnecessary utf-8
encoding in doc/source/conf.py

Change-Id: I864658137f58e78cd275cf8de7b0774a8d7991cb
2017-07-04 14:19:21 +05:30
Julia Kreger
774d995b7f Switch from oslosphinx to openstackdocstheme
Change-Id: I1aecf894955e8095c11b8fb82d60488e5d0aca5f
2017-07-04 01:10:43 +00:00
Vu Cong Tuan
667ad45615 Remove pbr warnerrors in favor of sphinx check
This change removes the now unused "warnerrors" setting,
which is replaced by "warning-is-error" in sphinx
releases >= 1.5 [1].

[1] http://lists.openstack.org/pipermail/openstack-dev/
2017-March/113085.html

Change-Id: I9bf18ff72f36dfd3496b9672604e8bb98999b133
2017-06-11 18:18:28 +07:00
Annie Lezil
fdcb0922a5 Collect NIC name given by BIOS
Adds an extra field ``biosdevname`` to network interface inventory
collected by ``default`` inspection collector (which collects the whole
inventory returned by hardware manager) of ironic-python-agent.

This feature requires biosdevname utility to collect the bios given NIC
names. The tooling module for tinyIPA is created for the same purpose.
For CoreOS IPA pxe images, biosdevname tooling module is limited,
because Docker repository is created and embedded into CoreOS pxe
images. The Docker repository uses debian to download the packages.
Debian does not have biosdevname package.

Adds an export variable TINYIPA_REQUIRE_BIOSDEVNAME. Set this
variable to ``true`` in your shell before building tinyIPA.

Closes-Bug: #1635351
Change-Id: Ia96af59e2a74868cac59e5a88cfbb3be60d85687
2017-05-18 14:44:11 -07:00
Jenkins
fd7f10b993 Merge "Configure and use SSL-related requests options" 2017-02-07 09:57:49 +00:00
Ramamani Yeleswarapu
73f316d804 Remove switch_port_descr and switch_chassis_descr
Removes two reserved fields ``switch_port_descr`` and
``switch_chassis_descr`` that were deprecated in the Newton cycle.

Change-Id: Icd2251af63a69d60d1e72eddf651a168fdae94fa
2017-02-02 07:01:04 -08:00
Mathieu Mitchell
5b1a217195 Remove vendor_passthru mentions from lookup/heartbeat documentation
Currently, the documentation index provides the old lookup/heartbeat
URLs. Commit b033bfd9 removed usage for these URLs.

This commit replaces old URLs from docs with the ones actually used.

Change-Id: I375045c23663768e4971d76162c87b731ee82eb3
Related-bug: #1640533
2017-01-31 07:02:59 -05:00
Pavlo Shchelokovskyy
fdd11b54a5 Configure and use SSL-related requests options
This patch adds standard SSL options to IPA config and makes use of them
when making HTTP requests.

For now, a single set of certificates is used when needed.
In the future configuration can be expanded to allow per-service
certificates.

Besides, the 'insecure' option (defaults to False) can be overridden
through kernel command line parameter 'ipa-insecure'.
This will allow running IPA in CI-like environments with self-signed SSL
certificates.

Change-Id: I259d9b3caa9ba1dc3d7382f375b8e086a5348d80
Closes-Bug: #1642515
2017-01-13 11:33:44 +02:00
Lucas Alvares Gomes
b272426562 Add HCTL to BlockDevices
This patch is adding a "hctl" attribute to the BlockDevices. HCTL stands
for: Host, Channel, Target and Lun, which is basically the SCSI address.

The idea behind this patch is to allow root device hints to find the
disk for deployment based on the SCSI address.

Partial-Bug: #1648036
Change-Id: If8897c68609e0df0378ee919b803ca5e497def02
2016-12-07 16:51:30 +00:00
Jenkins
bf3c4fb38c Merge "Fixed typo in doc file" 2016-10-05 02:15:36 +00:00
Dao Cong Tien
c2b305513a Invalid URL and typo in .rst files
Change-Id: I17377b4b7b2e8ecc0ce3dbc4ac7de9398912ada9
2016-10-03 13:38:07 +07:00
Anh Tran
8f8e9f921e Fixed typo in doc file
TrivialFix

Change-Id: I6e680ccae6c169eae433f376890a8f2e5a19849a
2016-09-28 08:45:07 +07:00
Pavlo Shchelokovskyy
1dcb656886 Add info on tinyipa to docs
Mention tinyipa in Image Builders section and in troubleshooting.

Change-Id: Ic6cfe64255aba0460cc960a98b18580b7798b204
2016-09-22 14:16:28 +03:00
Moshe Levi
fe3b630360 Add vendor, product to interface information
This patch updates the interfaces JSON to include
vendor and  product
u'interfaces': [
    {
        u'mac_address': u'00:0c:29:8c:11:b1',
        u'name': u'eth0',
        u'ipv4_address': None,
        u'switch_chassis_descr': None,
        u'switch_port_descr': None,
        u'lldp': None,
        u'vendor': u'0x15b3',
        u'product': u'0x1014,
    }]

Co-Authored-By: yogananth subramanian <ysubrama@redhat.com>

Closes-Bug: #1611856

Change-Id: I8fa58dde29601abee959f74b69b692ed9eaffb94
2016-09-21 10:14:26 -04:00
Ruby Loo
ad7926365e Minor updates to metrics documentation
This is a follow up to Ic08d4ff78b6fb614b474b956a32eac352a14262a.
It enhances an example, fixes a spelling error, and modifies some
sentences for better readability.

Change-Id: Icfc89edd426ddee6a93be40c5b2f56d9d78fbd0c
2016-08-11 23:09:12 -04:00