15 Commits

Author SHA1 Message Date
Dmitry Tantsur
41484988ef Stop documenting netboot and the boot_option capability
Both will be removed soon. The documentation change is separated
to reduce the size of the final patch.

Change-Id: If4b9b0d095500101ca71a453d71ad95252dd8c0c
2022-08-01 16:36:25 +02:00
Julia Kreger
c8be82c525 Deprecate syslinux
Syslinux is a functionally abandoned Legacy BIOS boot mode bootloader
which has not seen updates since 2019, and is starting to see
discussion amongst linux distributions to remove explicit support
and packaging for Syslinux. Syslinux's relevance is also disappearing
as UEFI booting is becoming the standard. While syslinux did go ahead
and ensure their bootloader *could* be built and support UEFI,
distributions also didn't uniformly adopt packaging and support for
this bootloader.

This change proposes to deprecate it and notates the areas in which
functionality is deprecated.

Change-Id: Ic52007fa4f207561d282eb5ae54273885c0ab0c0
2022-07-13 06:50:55 -07:00
Dmitry Tantsur
a813c769e8 Explicit parameter to distinguish partition/whole-disk images
Using kernel/ramdisk makes no sense with local boot, we need a better
way. We already have an internal image_type instance parameter, let's
make it public.

Glance support will be added in the next patch.

Change-Id: I4ce5f7a2317d952f976194d2022328f4afbb0258
2022-01-28 19:13:13 +01:00
Dmitry Tantsur
6a4e33eb0d Move provision states documentation to the user guide
Not only is this concept user-facing, it's arguably the most important
user-facing concept to grasp, and such it belongs to the user guide.

Add state aliases and provide helpful links for the features.

Change-Id: I2717953b71df63a9a640c8a45dd7149e6d132bf3
2021-06-01 12:59:31 +02:00
Dmitry Tantsur
c70b858769 Expand the deployment guide
* Add optional Glance and Neutron integration.
* Migrate and expand the configdrive section from the install guide.
* Explain how to use cloud-init boot scripts.
* Explain allocations and mention metalsmith as an easy CLI.
* Use more realistic URLs and checksums in the examples.
* Remove a reference to local boot, it's the default nowadays.
* Replace the iLO note with a more generic one.
* Small fixes and clean ups.

Change-Id: I28ac60da6722b9ca2c2b571511070010145958f6
2021-05-12 17:24:04 +02:00
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
929907d684 Bye-bye iSCSI deploy, you served us well
The iSCSI deploy was very easy to start with, but it has since become
apparently that it suffers from scalability and maintenance issues.
It was deprecated in the Victoria cycle and can now be removed.

Hide the guide to upgrade to hardware types since it's very outdated.

I had to remove the iBMC diagram since my SVG-fu is not enough to fix it.

Change-Id: I2cd6bf7b27fe0be2c08104b0cc37654b506b2e62
2021-05-04 14:28:25 +02:00
Dmitry Tantsur
382a43627e Mark the iSCSI deploy as deprecated in the docs
Also move it to the bottom of the user guide and fix some ancient
bits (more fixing required).

Change-Id: I118d3385110c85cb6e5f1beacb7c5d1887bda616
2020-12-29 17:34:35 +01:00
Dao Cong Tien
a60233ccf4 Update the doc regarding the removal of calssic drivers
This patch updates the remaining doc that relates to
the removal of classic drivers.

Change-Id: I82b1ee18ea90bfdf8ab9b24e610fb5db766068a0
2018-07-09 16:13:54 +07:00
Dmitry Tantsur
c9e079da68 Rework Bare Metal service overview in the install guide
Currently we have a detailed explanation of how ironic is architected,
but it resides in the user guide for some reason. This change moves
relevant bits to the install guide to the existing "Bare Metal service
overview" section. The text is cleaned up (e.g. s/ironic/Bare Metal/)
and ordered to simplify reading. A link to ironic-ui is added.

The user guide still contains the bits that are helpful for users
to understand the bare metal deployment process.

Change-Id: I17e38454f7893c00b71ac29328bd80d3978ed1f4
2018-03-19 17:30:18 +01: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
chenxing
4f726f356a Fix the format issues of User guide
Change-Id: Ic4cf6d9f57ab612d3b4220ef3d6ad9365093df51
Closes-Bug: #1353688
2017-10-30 16:55:20 +08:00
Vladyslav Drok
9280560752 Revise deploy process documentation
Add more details about the node deployment process, when an instance
is booted by nova. This change covers iscsi and direct deploy methods
with PXE boot. This change also updates the sequence diagrams for
deploy process.

Co-Authored-By: Galyna Zholtkevych <galynazholtkevych1991@gmail.com>

Change-Id: Icaec14d10e702627bab0763e40efa77131564dec
2017-10-24 21:37:40 +03:00
Ilya Etingof
af8f46b7f4 Configuration documentation migrated
Documentation layout aligned with the OS standards.

The admin page cleaned up - unrelated references moved
elsewhere linking merely admin pages.

The configuration page refactored, ironic.conf
and policy.conf documentation and samples
automatically generated by oslo_config.sphinxext.

Change-Id: I9075e2688f59ecd8ab5c489679f2c53d6294f28d
2017-08-23 15:39:29 +02:00
Sam Betts
02015a4be6 Move operator docs into into doc/source/admin
Change-Id: I13f90a0b183b7799b4c8b5c340052d96f717fa9f
2017-07-05 12:16:37 +01:00