This is a quick and easy way to get Ironic up for testing; updated to be
even quicker and easier if you don't need multiprocess or mysql.
Co-Authored-By: CID <cid@gr-oss.io>
Change-Id: Ibef8a24868fd1f507e69e6d615d6327031d11495
This is largely inspired by the excellent feedback we got from David
Welsch, although this patch is only a very early first step towards
where we want to be with the documentation.
First, I'm splitting the large administrator guide into several large
sections: features, operation, architecture. Some of their topic might
actually find a better home outside of the administrator guide, but I
don't go that far in this change.
Second, I'm grouping several separate things together with the larger
topics:
- API topics are relevant for users and are grouped with the user guide
- Configuration guide and release notes are grouped with the
administrator guide.
- The command reference is renamed for clarity and also grouped with the
administrator guide since these are not user-visible commands.
- I'm dropping the "Advanced topics" subsection. While I like its
intention (and I think it was me who added it in the first place),
it's clear that such separation makes these topics much less
discoverable.
Third, I'm playing with :maxdepth: here to make the sub-pages more
informative.
Change-Id: Icd0a35b252136b7da107c6346c48473cf1b99bcb
The goal here is to give newcomers an easier overview of the contributor
guide. Currently, the index page only points at a couple of sections in
the contributor index, which may be confusing. So:
1) Expand the contributor reference from the index page one more level.
2) Update headings in the contributor guide to match the toctrees and
their expected level.
3) Expand toctrees in the contributor index one more level.
4) Move references to the development enviroment to a higher level
toctree to make them visible in the index.
5) Apply consistent upper case heading.
Change-Id: Ifb9fdc96b368095437771217090120e83eaa0fa7
The syntax we're using there is not valid, change to a definition list,
add double ticks and change a mention of an option to a link.
Change-Id: Idf37436d034fe8bb65bff92eddadfd82d7431df0
This commit introduces support for provisioning ARM (aarch64)
fake-bare-metal VMs in Ironic for the purpose of eventually supporting
CI testing on ARM64 architecture-based hardware.
Change-Id: Ie4bff8892228275ad0fb940c30e8071f7f4c423f
There has been no testing of this hardware type in quite some time,
and the last we heard the vendor was moving towards redfish.
Change-Id: Ib32db463981ec54430884ac760956b7c7b40b17f
Provides a complete documentation for metrics that the Redfish
management interface can collect.
The Power payload refers to InputRanges in a broken way: this field is a
list, but the code treats it as a singular resource. No hardware I have
access to provides it this way. Since input ranges are constants and
thus arguably don't qualify as runtime metrics, removing them instead of
fixing.
Change-Id: Ida1be1341346df917073e649a23a2f116b262e66
This page is huge and keeps growing. So:
* Move additional topics to sub-documents.
* Move ESP creation to the install guide (it's not even
Redfish-specific).
* Create a generic firmware updates document.
Provide a feature listing at the top for easier navigation.
Change-Id: Ic58c139da5e1e60f5ce4d2cec18972ebee9e2485
A quick review of the security documentation yielded a need
to revise and clarify the security documentation a little,
which includes a couple security related features.
And also fix the syntax on the example policy entries while
adding a missing third, ! results in a "default false" response.
Change-Id: I3d10ca4631703051109c443d5591a7e86f858c66
This highlights:
- The dev-quickstart guide, which is more up to date than most
contributor docs.
- Common docs (OpenDev / OpenStack contributor guides)
- Bug information (also very up to date)
This removes:
- Top-level link to BfV and multitenant devstacks; these configs are
linked from devstack-guide
- Hilariously out of date information around branch support
Change-Id: If47d9776c65c91b972a3fab8364eacc50a29b2bb
Depends-On: https://review.opendev.org/c/openstack/ironic/+/920365
The state digram is constrainted into a frame of the page rendering
and the prior configuration set it to be a maximum of 660 pixels,
however we should allow the image to be aligned to page size which
can result in a larger image, but still constrained slightly so
spinx includes a link to the image.
Change-Id: I19350fc010bd5aac798b2d57ea3d2eb98239a457
Good news, pydot (original) is maintained again and pydot2 apparently is
not. By switching to pydot instead of the fork, svg generation works
now.
This adds states for servicing, and swaps us back to svg for the
regenerated diagram.
Change-Id: I410182ee04293434d889747ddec229870c908d91
pre-commit is a git hooks framework which does lots of useful things
before you commit, like validating lint and codespell -- easy things to
forget, especially in a post-codespell world.
Related-bug: 2047654
Change-Id: I22738f9dceebe194e5aedff8815cd786013de456
Had someone try to boot the tinycore ISO on a UEFI machine, and they
got a nice error. Just turns out we needed to update our docs a little
bit to provide appropriate clarity.
Change-Id: I1adfb62ea22d0b58740ceadc8c338fc04d9b78de
These are detected as errors since the clean up was done[1] in
the requirements repository.
[1] 314734e938f107cbd5ebcc7af4d9167c11347406
Also remove the note about old pip's behavior because the resolver
in recent pip no longer requires specific order.
Change-Id: I742ea0192398b9e9b78b969fa81f65621d9490de
