227 Commits

Author SHA1 Message Date
Dmitry Tantsur
133dac255f Allow overriding an external URL for virtual media
Virtual media deployments can be conducted outside of the provisioning
network as long as the node gets an IP address somehow and can reach
ironic and its HTTP server. This changes adds new configuration that
allows to use public IP addresses for virtual media while keeping PXE
boots working and constrained to the provisioning network.

Change-Id: I8b859b2812160ff3911eb7d648eab835ef61d934
Story: #2008566
Task: #41706
2021-03-24 16:53:56 +00: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
Zuul
fd34d3c437 Merge "Add centralized secure boot documentation" 2021-01-27 13:36:39 +00:00
Dmitry Tantsur
4c4c7a869a Add a few words about UEFI user images
Change-Id: I37a686e6f48a422d38ac5921a188d894519b7530
2021-01-26 21:22:56 +01:00
Dmitry Tantsur
04400eea47 Add centralized secure boot documentation
Move the bits from iLO and iRMC, clean them up a bit.

Change-Id: I5b6da854ae0214141ae25a17b8ea3c7874636372
2021-01-26 17:00:50 +01:00
Julia Kreger
2404d486ac Policy json to yaml migration
Adds the status upgrade check for the JSON to YAML migration
effort and updates the documentation where it seems appropriate
to move from "policy.json" to "policy.yaml"

Mostly shamelessly copied from https://review.opendev.org/#/c/748059/
however is in-line with ironic's configuration and patching methods.

Related Blueprint: policy-json-to-yaml

Change-Id: I1d5b3892451579ebfd4d75a0f7185e0ef3c984c8
2021-01-04 13:40:54 -08:00
ericxiett
4cb406b8f7 Update outdated descripton for default_boot_option
The default value of `default_boot_option` has already been
'local', so update the note.

Change-Id: Ia846fa82121cda942697a240eec5bbd7bd93e68e
2020-12-17 01:57:55 +00:00
Michelle (Shelly) Mutu-Grigg
20886329e7 Update .rst files
This commit follows up the observations in review 756708, updates
`$node_ident`, `$uuid` & `${node_uuid}` to <node>.

Story: 2008194
Task: 40964

Change-Id: I7cd08a37071ce330b4c254595d0745ca154ced2b
2020-11-16 20:27:13 +13:00
Dmitry Tantsur
31f3f9fca1 Document how to build an ESP image for redfish-virtual-media
Also update the devstack plugin to use the same procedure.

Based on https://review.opendev.org/760423.

Change-Id: I8e20ad0fbc7e62e418b24ef56425328ec3a201b0
2020-11-10 19:19:07 +01:00
Zuul
ce05137960 Merge "Allow passing rootfs_uuid for the standalone case" 2020-10-23 00:18:45 +00:00
Zuul
219d72543c Merge "Update .rst files" 2020-10-22 08:46:45 +00: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
Zane Bitter
ab77c5b176 Document by_path root device hint
Support for this was added in https://review.opendev.org/500524 but
never documented.

Change-Id: Icc67ea11bd3dde08bfdc1e46d8c32d425f9ae4ac
2020-10-15 14:51:04 -04:00
Michelle (Shelly) Mutu-Grigg
d5ca2ac7f0 Update .rst files
This commit removes `--os-baremetal-api-version` from CLI examples,
updates some `openstack baremetal` commands to be `baremetal` and
removes -uuid from <node-uuid>

Story: 2008194
Task: 40964

Change-Id: I4421e98afdee9ed97506cb7e5d69da966cffd963
2020-10-15 23:03:55 +13:00
Kaifeng Wang
ade35dab2d Remove obsolete trusted boot doc
The OAT project was gone for a long time, the successor opencit was
also in an unmaintained state for a few years, let's remove this
piece from the doc as it can't provide meaningful instructions to be
useful.

Change-Id: If77e1125c05e2351c757c4397ea524617e91926d
2020-10-11 23:33:04 +08: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
05f47eb3e3 Merge "Add L3 boot section to the docs" 2020-09-03 13:54:53 +00: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
Ilya Etingof
747753f911 Add L3 boot section to the docs
Describes virtual media based L3/DHCP-less ramdisk booting in the
`redfish` hardware type documentation.

Added warning to the deploy-ramdisk docs since the images
we publish will not work.

Co-Authored: Iury Gregory Melo Ferreira <iurygregory@gmail.com>
Change-Id: If9ead46db30ce519f128550f1071a1f01f7a5ccf
Story: 2006691
Task: 37073
2020-09-02 16:57:18 +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
Zuul
3e92fd054b Merge "iPXE ISO Ramdisk booting" 2020-07-23 21:10:53 +00: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
Julia Kreger
ba0dc574bc Follow-up on blocking port deletions
A recent comment on https://review.opendev.org/#/c/665835
pointed out that we should likely make some changes and a fix
a missing check for the introspection_vif_port_id which was
likely introduced after this functionality was originally
written.

Also adds some documentation on the subject since we lack
docs even pointing out how to delete a port. :\

Change-Id: I0ba8a3741eefa80eb56e25a1b339f8433b3fc0dc
2020-07-16 12:47:07 -07:00
Julia Kreger
5f7d84f483 Provide a path to set explicit ipxe bootloaders
I did something stupid when started driving forth the split of ipxe
from the pxe interface: I didn't think about the need to actually
separate bootloaders. In part, because the use case was a mixed
Power8/Power9 and x86 cluster. Mainly because the Power hardware
does not honor or care about the bootfile name provided over DHCP.
The firmware knows how to read the PXELINUX boot file format
and the machines are able to boot from there.

Where this all goes sideways is when:
* Enabled boot interfaces are set to ipxe,pxe
* No default boot interface is set
* Node is created without a default for x86 hardware.
* Node uses ipxe boot_interface, and creates files under /httpboot
* bootfile transmitted via DHCP is pxelinux.0.

Fun right?

The simple workaround for the power user is to just define the iPXE
loader, or maybe use UEFI. But that is neither here nor there, this
is still a bug and a possible use case is GRUB2 via PXE and iPXE.
Not that would really work via ipxe, but hopefully people get the
idea.

The solution kind of seems clear, duplicate configuration and
fallback if not defined.

Story: #2007003
Task: #40282
Change-Id: I4419254c23095929e52a0fda11789f2f5167dc6b
2020-07-07 12:38:33 -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
Harald Jensås
69739715ca Doc - IPv6 Provisioning
Add documentation for provisioning with IPv6.

Story: 2007315
Task: 39162
Change-Id: I8abd2b8eda6e7b207471f1a15d61b6f921587433
2020-04-02 17:26:48 +02:00
Zuul
281634dc4e Merge "Document deploy_boot_mode and boot_option for standalone deployments" 2020-03-30 14:24:30 +00: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
Kaifeng Wang
cc17246d2b Expand user-image doc
Adds some text on the general instruction on how to build
user-image by virtual machine software.

See also: https://review.opendev.org/#/c/710966/

Change-Id: Ic84bc14ff0bce609009455c644a1601f990a7b45
2020-03-16 09:38:12 +08: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
Andreas Jaeger
5cebea361b Cleanup docs building
* Remove doc/source/install/conf.py, it's unused.
* Remove settings that are provided by openstackdocstheme from conf.py
  files. Switch to newer openstackdocstheme for this.
* Remove unused deps from tox.ini: releasenotes and api-refonly need
  doc/requirements but not requirements.

Change-Id: Iab5ad6cde40c3342770c0112155fe5e1d262d1e8
2020-02-29 15:12:04 +01:00
Zuul
8c4571acf7 Merge "Remove references to 'firewall_driver'" 2020-02-07 12:12:10 +00:00
Zuul
8169f2532b Merge "Follow up to root device hints in instance_info" 2020-01-27 16:35:42 +00:00
Dmitry Tantsur
4504bd5a8d Make ironic-api compatible with WSGI containers other than mod_wsgi
Using ironic-api-wsgi implies mod_wsgi, some other containers require
an importable module. This patch modifies ironic.api.wsgi to be usable
this way and documents it.

Change-Id: I8493eb36293a0214081e0adb59c3a267c9688819
2020-01-24 12:22:46 +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
Dmitry Tantsur
9be5b37296 Document using CentOS 8 DIB IPA images for Ussuri and newer
Change-Id: I2e5e32da2c0a6c13c7174dcf2aa990ddc7e70c43
2020-01-14 13:09:57 +01:00
Kaifeng Wang
9a6344d03c Add notes on the pxe template for aarch64
On verifying deployment on aarch64 bare metals, the linuxefi and
initrdefi are not available in grubaa64.efi, update doc to note
the potential change required on multi-architecture setup.

Change-Id: I92786eaed2c3bf6fb9f25672183bd9511e7a6e6e
2019-12-23 13:56:28 +08:00
Stephen Finucane
9a5e6ead2a Remove references to 'firewall_driver'
This option has been removed from nova. Drop references to it from the
documentation.

Change-Id: If6efd14ba28f6cb1eee2ce0c3cd9bbb89549c252
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
Depends-On: https://review.opendev.org/#/c/696514/
2019-11-28 12:44:00 +00: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
Dmitry Tantsur
dae6caca5c Document pre-built ramdisk images (including DIB)
Change-Id: Id4ba0992982788a03f960095e564df4fe7f3f518
2019-09-26 14:31:23 +02:00