37 Commits

Author SHA1 Message Date
Dmitry Tantsur
6243a4b280 Rework the user guide
Currently it only contains (outdated) explanations how Ironic works.
Move them one level deeper and migrate the content relevant to users:
* Preparing instance images from the installation guide
* Deploying nodes from the standalone guide

Compatibility shims are provided for migrated pages.

Change-Id: I8468da377b7878eb3d1a61e6a6bcd4ac8a5f06d7
2021-05-10 17:18:13 +02:00
Dmitry Tantsur
49fcbd4910 Rework the standalone guide
Split the monolithic guide into several pages: configuration, enrollment
and deployment. Merge duplicating docs into the common locations.
Use code-block for nicer highlighting.

Change-Id: Iaeef9e0cf8deba20a125d3cfacd4ca8ca2f52e84
2021-03-08 18:40:26 +01:00
Dmitry Tantsur
472ffca269 docs: move overriding interfaces to the standalone documentation
Chances are much higher the users will find it there. Also correct some
wording (node interfaces -> hardware interfaces), use double ticks for
field names and mention the Wallaby release.

Story: #2008652
Task: #42015
Change-Id: I33956976a9420ade836ab8d37a9488b9a207cef0
2021-03-08 18:01:50 +01:00
Dmitry Tantsur
ccc6c551c3 Make boot_mode more consistent with other capabilities
All capabilities, except for boot_mode, are read from instance_info.
This change makes instance_info.capabilities[boot_mode] work as well
and deprecates instance_info.deploy_boot_mode.

Note that the special handling of properties.capabilities[boot_mode]
is kept in this patch.

Change-Id: Ic2e7fd4c71b7a7bc2950d17f7e1bbdad73bbb8a7
2021-02-02 12:06:17 +01:00
Dmitry Tantsur
0a68622187 Allow passing rootfs_uuid for the standalone case
Using software RAID with whole disk images requires specifying
a root partition UUID, but it is only possible through Glance.
This change adds an explicit field for that.

Change-Id: I55e3727aab3960ef472ec2db1f23c25db405e801
2020-10-20 18:22:25 +02:00
Kafilat Adeleke
acdf1dc772 Updates ironic documentation
Updates ironic documentation to change "openstack baremetal" to "baremetal"

Change-Id: I95afa010aeb4fb08aff05adf0cfb7a200db8a53f
Story: #2008194
Task: #40962
2020-10-07 09:46:34 -07:00
Zuul
eb648c1df0 Merge "documentation: follow-up to file:// support in direct deploy" 2020-09-03 13:50:53 +00:00
Dmitry Tantsur
958f15a079 documentation: follow-up to file:// support in direct deploy
Change-Id: Id31aaaccbb8ca1e6c4e26365bd37d3f3e866592b
2020-09-03 11:55:06 +02:00
Dmitry Tantsur
840ce16668 Allow setting image_download_source per node
Allows certain flexibility when it comes to low RAM vs high RAM nodes,
and large vs small images. Also deploy_interface is settable per node,
so this feature makes it easier to migrate from the iscsi deploy.

Story: #2008075
Task: #40766
Change-Id: Idf3bbc6d24042ce1d9a895095b5cb0979dd3183d
2020-09-02 15:39:53 +02:00
Dmitry Tantsur
c31cb7d99a Support file:/// images for the direct deploy
Implemented via the same mechanism as for image_download_source=http.
Forcing raw format (and thus streaming) is supported as well.

Since we always re-calculate checksums for such images, the requirement
on providing them via the API is lifted.

Change-Id: Ife385c3b363c28559c90e5a54e9c6f6807d207ff
Story: #2008075
Task: #40764
2020-09-02 15:15:11 +02:00
douyali
abed175fc8 Fix error word presistent in docs
Change-Id: I4ffe8dd71b6735b5ae714557e78578c0b6816e14
2020-08-03 22:41:27 -04:00
Dmitry Tantsur
52b567e7d5 Trivial: fix a minor issue in standalone docs and improve formatting
Follow-up to commit 74e9e1d82a09b5255d2dd326387ac624ac1ba447

Change-Id: I60f7ee85ee7ead430dfe216bfea5392355098bd2
2020-07-29 10:23:29 +02:00
Zuul
3670be1283 Merge "Deprecate http_basic_username and http_basic_password in [json_rpc]" 2020-07-28 19:14:00 +00:00
Dmitry Tantsur
946087020a Add subsections to the standalone documentation
Change-Id: I51da88d32e5e42c0c4e0e489c888d38b31517b59
2020-07-24 12:18:13 +02:00
Dmitry Tantsur
74e9e1d82a Deprecate http_basic_username and http_basic_password in [json_rpc]
It's very confusing that we use username/password everywhere, except
for [json_rpc]. Just use the standard options.

Also the version if keystoneauth is bumpted to one that supports
http_basic.

Change-Id: Icc834c3f8febd45c2548314ee00b85a7f9cebd2c
2020-07-24 11:51:41 +02:00
Julia Kreger
0cbb0397b1 iPXE ISO Ramdisk booting
Adds an iPXE interface to boot via a virtual media ISO as if it
was virtual media.

Story: 2007644
Task: 39823
Change-Id: Ie7971692758f3a5421f0826fdaf3d2366f652236
2020-07-16 14:36:45 -07:00
Steve Baker
350d84ed41 Enable HTTP Basic authentication for JSON-RPC
Change-Id: I90c4d5ef925c1dbb120948e3c0fe5982c9d997a0
Story: 2007656
Task: 39827
2020-06-18 09:35:47 +12:00
Steve Baker
62408b32ae Document http_basic auth strategy
Change-Id: Iafb3e22e7fae84b733e2996c2512d1c9b4577359
Story: 2007656
Task: 39753
2020-06-15 13:05:37 +12:00
Dmitry Tantsur
80cdb9abd7 Document deploy_boot_mode and boot_option for standalone deployments
Change-Id: Iad04779cc8c782b20d6636dd2bbb602bc89255b2
2020-03-30 13:43:08 +02:00
Dmitry Tantsur
530ec9d0b1 Docs: split away user image building and highlight whole disk images
The user image documentation applies to both standalone and glance
usage, but we keep it in the glance section. This change creates
a new page to talk about user images.

We also don't emphasize the difference between partition and whole
disk images enough, resulting in users trying whole disk images
with kernel/ramdisk set. Make the difference clearer.

Change-Id: I7185679203e0f9aa7ebe9c69971009cd59271b89
2020-03-03 13:25:40 +01:00
Dmitry Tantsur
9050098e32 Follow up to root device hints in instance_info
Follow-up to commit 42dc9787e52670bb1e1baa36f08703dd802804f4:
* Refactor root device checking code to be in one place and extend
  the error message.
* Extend unit tests to cover the actual override.
* Update documentation.

Change-Id: I1d73f2233c766ff52268e242b8071dec12b2daca
2020-01-21 16:30:34 +01:00
Riccardo Pittau
a25589b20f docs: use openstackdocstheme extlink extension
The extlink extension [1] ensures the urls have version-specific
references to other projects.

[1] https://docs.openstack.org/openstackdocstheme/latest/#external-link-helper

Change-Id: I0d5d445fae8a7ec60f6a9caacede7cc77770b36e
Story: 2006621
Task: 36825
2019-10-08 11:12:05 +02:00
Manuel Buil
cad66b0323 Update env. variables in the documentation
This patch:
6df83e0bc5

changes the variables that must be exported to use ironic in standalone
mode. The old env. variables:

export OS_URL=http://localhost:6385/
export OS_TOKEN='fake-token'

must be replaced by:

export OS_ENDPOINT=http://localhost:6385/
export OS_AUTH_TYPE=none

Change-Id: Ia2ae95af66f701198d5e3174a7cb5564664ae038
Signed-off-by: Manuel Buil <mbuil@suse.com>
2019-09-23 15:14:42 +02:00
Julia Kreger
ada6611858 Add note for alternative checksums
Change-Id: I16353fa27f8899502ce033255f87e4523a3b167f
2019-04-18 12:30:34 -07:00
Dmitry Tantsur
40b55416a8 Stop requiring root_gb for whole-disk images
This parameter makes no sense for them and is actually ignored after
validation. This change makes it optional (still allowed for backward
compatibility). Also cleanly separate validation code for partition and
whole-disk images.

Change-Id: I98da7d54cc6dd158d415e83c61659badc83fbeda
Story: #2005165
Task: #29895
2019-03-08 14:01:27 +01:00
Dmitry Tantsur
77ee49f21c Document using a URL for image_checksum
Added in https://review.openstack.org/#/c/639079/

Change-Id: I82800ba5c3379634f6f2583933f37aa4da60c33a
Story: #2005061
Task: #29770
2019-03-07 11:08:26 +01:00
Dmitry Tantsur
7efbbcc2d9 Support using JSON-RPC instead of oslo.messaging
Using AMQP-based RPC can be an overkill in case of ironic, especially
when used standalone. This change allows using a built-in JSON RPC
implementation instead.

This implementation does not currently support the object indirection
API, which does not seem to be used anywhere anyway.

The standalone and API test jobs are changed to use JSON RPC.

Story: #2004874
Task: #29141
Change-Id: I7cc95935d6bdae43fab5dfbd544c8e6d65fcc38d
2019-02-14 12:56:20 +01:00
Shivanand Tendulker
75d3692c86 Update to standalone ironic doc
This commit removes reference of need for Object Storage
service for using virtual media based iLO drivers in
standalone Ironic. One can use these drivers by setting
up web server on the host where conductor is running.
The documentation for same is available in iLO drivers
documentation page.

Change-Id: I0b0493373949e552677137ce0b6d5e44efc0268f
2018-02-14 05:13:29 -05:00
wangzhengwei
28a50d8a49 Fix ironic node create cli
Change-Id: Ief59bc5c498de70dec94743c25b68888acffc549
2017-12-27 09:57:35 +00:00
Dmitry Tantsur
e824e490a3 Switch emphasis to hardware types in the installation guide
This change updates the installation guide to talk in terms of hardware types
and hardware interfaces, only briefly mentioning classic drivers, when needed.

Also fixes incorrect information about instance_info fields in the standalone
guide.

Change-Id: I5e8a0de79c247535fd599318540fb8bbd2fc5df0
2017-12-14 16:24:01 +01:00
Nguyen Van Trung
b219699e9d Update validating node information docs
eg:
    +------------+--------+--------+
    | Interface  | Result | Reason |
    +------------+--------+--------+
    | boot       | True   |        |
    | console    | True   |        |
    | deploy     | True   |        |
    | inspect    | True   |        |
    | management | True   |        |
    | network    | True   |        |
    | power      | True   |        |
    | raid       | True   |        |
    | storage    | True   |        |
    +------------+--------+--------+

Change-Id: I7f93b866cf4b50047e8666c3c5c01a201f18ef4b
2017-10-23 13:29:08 +07:00
Ruby Loo
df686019f1 [install docs] ironic -> openstack baremetal CLI
For the install documents, all the 'ironic' CLI commands are
replaced with their equivalent 'openstack baremetal' CLI commands.

Change-Id: Ic49cfd8d94366acb36c9a20b5c76885d7440f8d5
Partial-Bug: #1711235
2017-09-07 10:17:35 -04:00
Jenkins
cc79484e86 Merge "Update the documentation links - install guide" 2017-08-15 07:42:32 +00:00
Pavlo Shchelokovskyy
5ff1e90e93 Update the documentation links - install guide
This patch updates the old links existing in install guide.

Change-Id: I3a9b4d896ecd7dff2cdc118d3612d5fbd4d32fc9
Co-Authored-By: Chason Chan <chen.xing@99cloud.net>
2017-08-15 09:46:59 +03: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
Dmitry Tantsur
fe295ffb5a Fix small issues in the installation documentation
Fixes nits spotted on the following reviews:
* https://review.openstack.org/#/c/461834/
* https://review.openstack.org/#/c/462151/
* https://review.openstack.org/#/c/466741/
* https://review.openstack.org/#/c/466734/

Also updated links in the touched files.

Related-Bug: #1524745
Change-Id: I12cfbbd4cbdd9423f86d0b3d9f4209427313c472
2017-07-25 19:30:29 +02:00
Sam Betts
aeb5306093 Move install guide into new doc/source/install location
Change-Id: I7d853142aaf794869466a1ba1bfaa82fd8851b7a
2017-07-05 12:16:37 +01:00