summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Add network interface speed to the inventoryDmitry Tantsur2023-05-031-1/+2
| | | | | | | This is another fact that Metal3's baremetal-operator is currently consuming from extra-hardware. Change-Id: I2ec9d5e9369f5508e7583a4e13c2083f5c8b28ba
* Merge "Disable MD5 image checksums"Zuul2023-05-021-0/+33
|\
| * Disable MD5 image checksumsJulia Kreger2023-04-241-0/+33
| | | | | | | | | | | | | | | | | | | | | | | | MD5 image checksums have long been supersceeded by the use of a ``os_hash_algo`` and ``os_hash_value`` field as part of the properties of an image. In the process of doing this, we determined that checksum via URL usage was non-trivial and determined that an appropriate path was to allow the checksum type to be determined as needed. Change-Id: I26ba8f8c37d663096f558e83028ff463d31bd4e6
* | Deprecate LLDP in inventory in favour of a new collectorDmitry Tantsur2023-04-261-4/+14
|/ | | | | | | | | | | | | Binary LLDP data is bloating inventory causing us to disable its collection by default. For other similar low-level information, such as PCI devices or DMI data, we already use inspection collectors instead. Now that the inventory format is shared with out-of-band inspection, having LLDP there makes even less sense. This change adds a new collector ``lldp`` to replace the now-deprecated inventory field. Change-Id: I56be06a7d1db28407e1128c198c12bea0809d3a3
* Report system firmware information in the inventoryDmitry Tantsur2023-03-311-1/+3
| | | | Change-Id: I5b6ceb9cdcf4baa97a6f0482d1030d14f3f2ecff
* Trivial: formatting issue in the inventory docsDmitry Tantsur2023-03-301-1/+1
| | | | | | Double ticks don't work if followed by a symbol without space. Change-Id: Ia455650b5e601dadb2b0ab91f71e1d9286d26071
* modify error word nodeliuyuanfeng2022-12-301-1/+1
| | | | Change-Id: Ie5c9fa7489eb891ef1bbe57c7d51ecb64e1c0db8
* SoftwareRAID: Enable skipping RAIDSJakub Jelinek2022-09-051-0/+9
| | | | | | | | | | | | | | Extend the ability to skip disks to RAID devices This allows users to specify the volume name of a logical device in the skip list which is then not cleaned or created again during the create/apply configuration phase The volume name can be specified in target raid config provided the change https://review.opendev.org/c/openstack/ironic-python-agent/+/853182/ passes Story: 2010233 Change-Id: Ib9290a97519bc48e585e1bafb0b60cc14e621e0f
* remove unicode prefix from codeniuke2022-08-231-3/+3
| | | | Change-Id: I70f0112f1ee3066ffd9316d10b84b9ea5b7fc306
* Improve function list_block_devices_check_skip_listJakub Jelinek2022-08-161-3/+6
| | | | | | | | | Fix minor issues suggested by dtantsur Add an example of skip list specification to the documentation A follow-up patch to I3bdad3cca8acb3e0a69ebb218216e8c8419e9d65 Change-Id: Ic94a33b7bc0572a1cc8f92b330474ec63a173e81
* Enable skipping disks for cleaningJakub Jelinek2022-08-111-0/+8
| | | | | | | | | | | | Introduce a field skip_block_devices in properties - this is a list of dictionaries Create a helper function list_block_devices_check_skip_list Update tests of erase_devices_express to use node when calling _list_erasable_devices Add tests covering various options of the skip list definition Use the helper function in get_os_install_device when node is cached Story: 2009914 Change-Id: I3bdad3cca8acb3e0a69ebb218216e8c8419e9d65
* Guard shared device/cluster filesystemsJulia Kreger2022-07-193-3/+132
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Certain filesystems are sometimes used in specialty computing environments where a shared storage infrastructure or fabric exists. These filesystems allow for multi-host shared concurrent read/write access to the underlying block device by *not* locking the entire device for exclusive use. Generally ranges of the disk are reserved for each interacting node to write to, and locking schemes are used to prevent collissions. These filesystems are common for use cases where high availability is required or ability for individual computers to collaborate on a given workload is critical, such as a group of hypervisors supporting virtual machines because it can allow for nearly seamless transfer of workload from one machine to another. Similar technologies are also used for cluster quorum and cluster durable state sharing, however that is not specifically considered in scope. Where things get difficult is becuase the entire device is not exclusively locked with the storage fabrics, and in some cases locking is handled by a Distributed Lock Manager on the network, or via special sector interactions amongst the cluster members which understand and support the filesystem. As a reult of this IO/Interaction model, an Ironic-Python-Agent performing cleaning can effectively destroy the cluster just by attempting to clean storage which it percieves as attached locally. This is not IPA's fault, often this case occurs when a Storage Administrator forgot to update LUN masking or volume settings on a SAN as it relates to an individual host in the overall computing environment. The net result of one node cleaning the shared volume may include restoration from snapshot, backup storage, or may ultimately cause permenant data loss, depending on the environment and the usage of that environment. Included in this patch: - IBM GPFS - Can be used on a shared block device... apparently according to IBM's documentation. The standard use of GPFS is more Ceph like in design... however GPFS is also a specially licensed commercial offering, so it is a red flag if this is encountered, and should be investigated by the environment's systems operator. - Red Hat GFS2 - Is used with shared common block devices in clusters. - VMware VMFS - Is used with shared SAN block devices, as well as local block devices. With shared block devices, ranges of the disk are locked instead of the whole disk, and the ranges are mapped to virtual machine disk interfaces. It is unknown, due to lack of information, if this will detect and prevent erasure of VMFS logical extent volumes. Co-Authored-by: Jay Faulkner <jay@jvf.cc> Change-Id: Ic8cade008577516e696893fdbdabf70999c06a5b Story: 2009978 Task: 44985
* Fix passing kwargs in clean stepswaleedm2022-07-011-0/+36
| | | | | | | | Pass kwargs to dispatch_to_managers method in execute_clean_step Change-Id: Ida4ed4646659b2ee3f8f92b0a4d73c0266dd5a99 Story: 2010123 Task: 45705
* Burn-in: Add network stepArne Wiebalck2021-07-131-0/+3
| | | | | | | | | | Add a clean step for network burn-in via fio. Get basic run parameters from the node's driver_info. Story: #2007523 Task: #42385 Change-Id: I2861696740b2de9ec38f7e9fc2c5e448c009d0bf
* Burn-in: Add disk stepArne Wiebalck2021-05-211-0/+2
| | | | | | | | | | Add a clean step for disk burn-in via fio. Get basic run parameters from the node's driver_info. Story: #2007523 Task: #42384 Change-Id: I5f5e336bd629846b3d779fd0fc7a2060b385b035
* Burn-in: Add memory stepArne Wiebalck2021-05-011-0/+3
| | | | | | | | | | Add a clean step for memory burn-in via stress-ng. Get basic run parameters from the node's driver_info. Story: #2007523 Task: #42383 Change-Id: I33a83968c9f87cf795ec7ec922bce98b52c5181c
* Burn-in: Add CPU stepArne Wiebalck2021-05-011-0/+3
| | | | | | | | | | Add a clean step for CPU burn-in via stress-ng. Get basic run parameters from the node's driver_info. Story: #2007523 Task: #42382 Change-Id: I14fd4164991fb94263757244f716b6bfe8edf875
* Do not permit IPA standalone to be enabled by confJay Faulkner2021-03-251-7/+0
| | | | | | | | | | IPA standalone mode is a developer-only option, and if enabled accidentally on a production agent could cause undesired behavior. Developers who need this behavior should build a purpose-built agent, with standalone hardcoded to True in cmd/agent.py. Change-Id: Icc67dbe15acbbf6fee886f274d2169a0769a5053
* Added comment about IPA logs being uploaded to IronicMohammed Naser2021-03-011-1/+3
| | | | Change-Id: I983ad3bd6fff539e877844e54788f63689ce8a84
* New deploy step for injecting arbitrary filesDmitry Tantsur2021-02-161-0/+46
| | | | | | | | | This change adds a deploy step inject_files that adds a flexible way to inject files into the instance. Change-Id: I0e70a2cbc13744195c9493a48662e465ec010dbe Story: #2008611 Task: #41794
* Merge "Add clean step 'erase_pstore'"Zuul2020-11-181-0/+3
|\
| * Add clean step 'erase_pstore'Arne Wiebalck2020-11-171-0/+3
| | | | | | | | | | | | | | | | | | | | Add an automatic clean step to clean the Linux kernel's pstore. The step is disabled by default. Story: #2008317 Task: #41214 Change-Id: Ie1a42dfff4c7e1c7abeaf39feca956bb9e2ea497
* | Add UUID to BlockDevice objectVladyslav Drok2020-11-111-2/+2
|/ | | | | | | | | It'd allow for example custom ansible playbooks to use UUIDs of the introspected node's disks. In future it might also enable agent to use UUID (or by_path value) to refer to a device instead of name, as it happens currently. Change-Id: Id00437d2295c39fb12f3c25a92b30b56a58eef13
* Document ramdisk TLS and update existing TLS docsDmitry Tantsur2020-09-231-7/+58
| | | | | | Story: #2007214 Task: #40945 Change-Id: I1a930a0e52ab860edcd597df4d95a4e4eb51da96
* Documentation: fix incorrect step namesDmitry Tantsur2020-09-211-2/+2
| | | | | | I can never remember if it's "device" or "devices". Change-Id: Ib1388f0425ec4c02fbeacb26ad55bc90b0f3483c
* [doc] Clarify custom hardware manager inheritanceArne Wiebalck2020-09-151-6/+7
| | | | Change-Id: I94657967763f058fccd4f19656925d02cd8973b8
* Document in-band deploy steps and add more docs for custom stepsDmitry Tantsur2020-08-245-18/+155
| | | | | | Change-Id: I304a460f88f3f8ee33cf642355f0e659184db724 Story: #2006963 Task: #40727
* Refactor and fix documentationDmitry Tantsur2020-08-249-115/+49
| | | | | | | | | | | | Currently the index page contains a brief introduction and 3 links. Expand the table of contents to show more subheadings. Clean up the install, admin and contributing docs of unnecessary and wrong content and redundant headings. Update URLs throughout the text. Change-Id: I03279ffc9faf387b08f727dee3b8898a69918460
* Import example hardware managers from ipa-example-hardware-managersDmitry Tantsur2020-07-311-0/+5
| | | | | | | | | | They're not easily discoverable there, let's keep them in tree. The examples have been restructured to have two different projects ready to be copied and adjusted. PEP8 failures have been fixed. Change-Id: I2af04f4b7f9a2109fe83ec517e716159331a48bb Co-Authored-By: Jay Faulkner <jay@jvf.cc>
* Fix apidoc buildJulia Kreger2020-06-153-1/+15
| | | | Change-Id: Id7c5686cdbdc79812e06eb4a5f87eddc75005cc3
* Document how to output journal to consoleJay Faulkner2020-06-091-0/+3
| | | | | | | | 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
* Switch to newer openstackdocstheme and reno versionsAndreas Jaeger2020-05-231-5/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* [doc] How to pause the IPA for debuggingArne Wiebalck2020-02-281-0/+14
| | | | | | | This patch adds two handy methods to pause the IPA when it needs to be debugged. Change-Id: I6ab4d6707fce340ee447355c717b19a12f3fe1ec
* Expose collector and hardware manager names via introspection dataDmitry Tantsur2020-01-221-0/+6
| | | | | | | This change adds a new introspection data field 'configuration' with two lists: managers and collectors. Change-Id: Ice0d7e6ecff3f319bc3a4f41617059fd6914e31c
* Document introspection data and collectorsDmitry Tantsur2020-01-211-0/+67
| | | | Change-Id: Ie51ec8fbae3848ad8a913b05cc3f0f80f33b5f95
* Remove deprecated ironic-agent elementMadhuri Kumari2019-12-271-5/+10
| | | | | | | ironic-agent is deprecated. Also replace disk-image-create with ironic-python-agent-builder. Change-Id: I6a3b5a31eda66b122a310119539fad6f8600ed80
* Replace WSME and Pecan with WerkzeugDmitry Tantsur2019-12-041-10/+0
| | | | | | | | | 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
* Fix instructions for enabling SSH on recent tinyipa imagesPierre Riteau2019-11-111-2/+2
| | | | | | | We need to use AUTHORIZE_SSH since ENABLE_SSH was fully removed in change I4256c8e89923c7104cb4191f3381312c1593b535. Change-Id: I5c643b1ae8819b02b667b2df13241753ddca5743
* Refer to ironic-python-agent-builder for image buildingDmitry Tantsur2019-09-261-40/+13
| | | | | | | To avoid duplication, remove image building information from IPA docs. Instead, add information about pre-built images. Change-Id: I63fd3da36ed2acbd91d365465dec10d96c979035
* Merge "Remove support for CoreOS images"Zuul2019-09-093-122/+14
|\
| * Remove support for CoreOS imagesDmitry Tantsur2019-08-283-122/+14
| | | | | | | | Change-Id: Id9737067c678d4d01b20eae0b4a681c6cf9171a8
* | Build pdf docKaifeng Wang2019-09-061-1/+2
|/ | | | | | | | | | | | | | | | | | | | 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
* Follow-up of 74339f6da2276a125ace6966d3730f2f2dd8213dShivanand Tendulker2019-07-161-2/+2
| | | | | | Addreses the minor comments in commit 74339f6da2276a125ace6966d3730f2f2dd8213d Change-Id: I8c83bbc07c2d678b0ac24eb4e25e231285480ace
* Merge "Modify Tiny IPA image build"Zuul2019-07-163-6/+9
|\
| * Modify Tiny IPA image buildDongcan Ye2019-07-153-6/+9
| | | | | | | | | | | | | | Commit dd7e7fdd1acb819a933b905e99ae701abf774788 removes tinyipa from IPA, this patch reword Tiny IPA image build docs. Change-Id: Ibad6407ea37b0bd2082487da6ac112c54703bc94
* | Merge "Bump openstackdocstheme to 1.20.0"Zuul2019-07-151-18/+3
|\ \ | |/ |/|
| * Bump openstackdocstheme to 1.20.0翟小君2019-07-031-18/+3
| | | | | | | | | | | | | | | | | | | | | | | | 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
* | manual introspection trigger commandJulia Kreger2019-07-081-0/+27
| | | | | | | | | | | | Change-Id: I64e66682c1e54f6edc260a22f46f5f6df8e85af1 Story: 2005896 Task: 33756
* | Get the hostname of the introspected hostBrad P. Crochet2019-06-121-0/+7
|/ | | | | | | | | 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
* Docs: Add bmc_v6address hardware inventoryDongcan Ye2019-05-301-1/+4
| | | | Change-Id: I2cc621ac1e442ba262d76af7fa4e9598ecc2da5a
View Lorry Controller Status