Commit Graph

12 Commits

Author SHA1 Message Date
Sean Mooney 33a56781f4 fix sphinx-lint errors in docs and add ci
This change mainly fixes incorrect use of backticks
but also adress some other minor issues like unbalanced
backticks, incorrect spacing or missing _ in links.

This change add a tox target to run sphinx-lint
as well as adding it to the relevent tox envs to enforce
it in ci. pre-commit is leveraged to install and execute
sphinx-lint but it does not reqiure you to install the
hooks locally into your working dir.

Change-Id: Ib97b35c9014bc31876003cef4362c47a8a3a4e0e
2024-04-17 13:33:47 +01:00
Stephen Finucane d88fe2895b docs: Replace 'nova boot' with 'openstack server create'
Replace references to novaclient with OSC in the boot from volume guide.

This is essentially a revert of commit aa3964118, which was a revert of
an earlier attempt at doing this that fell down because it didn't
reflect the changes in CLI parameters between the different tools.

Change-Id: Ic99440dd618243517f64506e3da88885fc2c44c9
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2021-07-07 13:29:07 +00:00
Archit Modi aa39641182 Revert "openstack server create" to "nova boot" in nova docs
When this patch [1] was introduced, it didn't take into consideration,
the updated/changed/modified parameters when using OSC vs nova CLI, so not
every option can be used in "openstack server create" which was used in "nova boot"
and vice versa. This bug would track reverting some of these incorrect commands usage.

For example- "nova boot --block device <params1>" can be translated as
"openstack server create --block-device-mapping <params2>" where params1 and
params2 are formatted differently (hence needs more than a simple search/replace)

[1] https://review.opendev.org/#/c/404623/

Related-To: https://review.opendev.org/#/c/404623/
Change-Id: I8e400da9445101b9ff5240511c56105e26e16e4c
Closes-Bug: #1851425
2019-11-06 16:25:52 +00:00
Zuul 34e595f2a7 Merge "doc: fix and clarify --block-device usage in user docs" 2019-02-21 00:29:11 +00:00
melanie witt bb0906f4f3 Add configuration of maximum disk devices to attach
This adds a new config option to control the maximum number of disk
devices allowed to attach to a single instance, which can be set per
compute host.

The configured maximum is enforced when device names are generated
during server create, rebuild, evacuate, unshelve, live migrate, and
attach volume. When the maximum is exceeded during server create,
rebuild, evacuate, unshelve, or live migrate, the server will go into
ERROR state and the server fault will contain the reason. When the
maximum is exceeded during an attach volume request, the request fails
fast in the API with a 403 error.

The configured maximum on the destination is not enforced before cold
migrate because the maximum is enforced in-place only (the destination
is not checked over RPC). The configured maximum is also not enforced
on shelved offloaded servers because they have no compute host, and the
option is implemented at the nova-compute level.

Part of blueprint conf-max-attach-volumes

Change-Id: Ia9cc1c250483c31f44cdbba4f6342ac8d7fbe92b
2019-01-30 15:47:10 +00:00
Matt Riedemann 16027094eb doc: fix and clarify --block-device usage in user docs
The docs on create a volume-backed server from the command
line were wrong in a few ways:

* The openstack server create command does not currently allow
  booting from a volume where a source image is provided and
  nova creates the volume from the image and uses that volume
  as the root disk. The nova boot command supports that, so the
  docs are updated to call out the nova boot command since that
  is the appropriate command in this case (even the syntax with
  the openstack server create --block-device was wrong).

* When creating a server from a bootable volume with the OSC CLI,
  either the --volume or --block-device options should be used
  for a single volume, but not both. The docs were using both, so
  the latter is dropped and a note is added which links to the CLI
  documentation for more details on --block-device option usage.

Change-Id: I985b870759d6c21ef9357b04f39099c02354f135
Closes-Bug: #1794827
2018-10-03 10:27:22 -04:00
tianhui e80b2a2393 Update doc
Update the response of openstack volume list

Change-Id: I394d570f1d710c5fccf1dfa8d531dfaa2aa0e13c
2018-09-28 02:14:18 +00:00
zhufl fbc86f8844 Fix none-ascii char in doc
There exist some none-ascii chars in doc, which may cause trouble
in displaying.

Change-Id: I1ebf83fb4e8cc853fd7f3065ecf420a064c9983f
2018-08-07 00:13:00 +00:00
Stephen Finucane dd1a416bc9 doc: Start using openstackdoctheme's extlink extension
This ensures we have version-specific references to other projects [1].
Note that this doesn't mean the URLs are actually valid - we need to do
more work (linkcheck?) here, but it's an improvement nonetheless.

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

Change-Id: Ifb99e727110c4904a85bc4a13366c2cae300b8df
2018-05-03 14:34:47 +01:00
Bruce Benjamin efb966ad64 docs: Add booting from an encrypted volume
Now that the instructions for booting from a volume
have been migrated to nova, the instructions for
booting from an encrypted volume can be added as
well.

This commit adds instructions for how to import an
image into an encrypted volume.

Closes-Bug: 1701614

Change-Id: Ida4cf70a7e53fd37ceeadb5629e3221072219689
2018-02-02 15:41:28 -05:00
Matt Riedemann 49b1bf8c54 Cleanup launch instance and manage IPs docs
This is a follow up to Ie039322660fd0e2e0403843448379b78114c425b.

A few things are changed here:

* The note about using file injection is removed. File injection
  was deprecated in the API in Queens and not something that we
  really want users using.
* Mention that creating a flavor is typically admin-only.
* Link to the BDM docs for more details about BDM parameter values.
* Update the manage-ip-address docs to make the examples rely on
  using the networking resource CLIs rather than any proxy APIs
  that were available in nova.

Change-Id: Ifa2e2bbb4c5f51f13d1a5832bd7dbf9f690fcad7
2018-02-01 15:12:10 -05:00
Matt Riedemann 4ed5e81ee0 Migrate "launch instance" user guide docs
This imports the "launch instance" end user guide docs from
the openstack-manuals repo. As part of the docs migration
in Pike, these were forgotten. The copied contents come from
the stable/ocata branch of openstack-manuals, and therefore
likely need some updating, but that could be done in follow up
changes. This is an initial import to (1) publish the content
again somewhere and (2) fix broken links in the cinder docs
for booting from volume.

Change-Id: Ie039322660fd0e2e0403843448379b78114c425b
Partial-Bug: #1714017
Related-Bug: #1711267
2018-02-01 14:28:18 -05:00