Commit Graph

302 Commits

Author SHA1 Message Date
Matt Riedemann d780216c6a doc: fix physets typo
I'm pretty sure this was meant to be physnets given the
context and this was added with Ide262733ffd7714fdc702b31c61bdd42dbf7acc3
which is about provider physical network affinity to NUMA nodes.

Change-Id: Ia9282325441ec42af6b03cda704b1cc7bac8d9f4
2019-08-05 14:07:59 -04:00
Wang Huaqiang 4945e6dbd4 doc: correct the information of 'cpu_map'
libvirt has split the CPU feature flags file 'cpu_map.xml' into
a bunch of flag files for each CPU model, which are stored under
directory 'src/cpu_map/'.

Update this change accordingly.

Change-Id: Id45587adb6ecd8e0bdef344c90979eaea61e61b8
2019-08-02 20:19:18 +08:00
Dongcan Ye e8f5641aef Fix wrong huge pages in doc
Change-Id: Ic3839eeca02c50451c884d23d313a135f04994ba
Related-Bug: #1816454
2019-07-29 09:53:38 +00:00
Zuul 054bf13a78 Merge "Remove 'nova.virt.driver.ComputeDriver.estimate_instance_overhead'" 2019-07-25 18:16:39 +00:00
Stephen Finucane 97096c8e4a Remove 'nova.virt.driver.ComputeDriver.estimate_instance_overhead'
With the removal of the Core, Ram and Disk filters in change
I8a0d332877fbb9794700081e7954f2501b7e7c09, there's now only a single
caller for the 'estimate_instance_overhead' function. This call results
in the 'memory_mb_used', 'local_gb_used', 'vcpus_used', 'free_ram_mb'
and 'free_disk_gb' fields of a compute nodes 'ComputeNode' object being
modified when calculating usage as part of the resource tracker to
include driver-specific overhead. However, these fields are no longer
used for for anything except logging and the 'os-hypervisors' API. Since
overhead is not reflected in placement (and therefore the scheduler),
reporting them as part of the various usage values for both logging and
that API is actually a bit of a lie and is likely to cause confusion
among users. Remove the whole thing and make our logs and the
'os-hypervisors' API better match what's stored in placement.

Change-Id: I033e8269194de54432079cbc970431e3dcea7ce5
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-07-24 16:26:01 +01:00
Zuul ab34c941be Merge "Remove deprecated Core/Ram/DiskFilter" 2019-07-23 23:36:06 +00:00
Zuul 383a4cf371 Merge "Update api-ref location" 2019-07-23 16:22:27 +00:00
Stephen Finucane 78645e61c6 Remove deprecated Core/Ram/DiskFilter
These were deprecated during Stein [1] and can now be removed, lest they
cause hassle with the PCPU work. As noted in [1], the aggregate
equivalents of same are left untouched for now.

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

Change-Id: I8a0d332877fbb9794700081e7954f2501b7e7c09
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-07-23 07:49:41 -07:00
Zuul 4781ef3321 Merge "Update AZ admin doc to mention the new way to specify hosts" 2019-07-23 13:28:31 +00:00
Andreas Jaeger dbe6321537 Update api-ref location
The api documentation is now published on docs.openstack.org instead
of developer.openstack.org. Update all links that are changed to the
new location.

Note that Neutron publishes to api-ref/network, not networking anymore.

Note that redirects will be set up as well but let's point now to the
new location.

For details, see:
http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007828.html

Change-Id: Id2cf3aa252df6db46575b5988e4937ecfc6792bb
2019-07-22 19:17:28 +02:00
Stephen Finucane 426790237e docs: Correct issues with 'openstack quota set' commands
Change Ic857918b15496049b5ccacde9515f130cc0bd7e9 against
openstack-manuals updated the quotas document to use openstackclient
commands in place of novaclient commands. It missed the fact that you
need to pass the '--class' parameter if you wish to set a quota for a
class rather than a project. Correct this.

Change-Id: I5dc65924fee65f6340d1495a9b1b992001c30731
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
Closes-Bug: #1834057
2019-07-10 17:41:57 +01:00
zhu.boxiang fd480a7a3d Update AZ admin doc to mention the new way to specify hosts
Mention the new way to specify hosts where instances are launched.
Compare with these two ways.

Also fixed a few things in the existing docs:

1. Fixed the policy rule name for forced_host.
2. Updated the "openstack availability zone list" command to use the
   --compute option.
3. Replaced the "openstack host list" example with
   "openstack compute service list --service nova-compute"
   since the os-hosts API was deprecated in 2.43.

Depends-On: https://review.opendev.org/#/c/669609/

Part of Blueprint: add-host-and-hypervisor-hostname-flag-to-create-server

Change-Id: Ic471c0621e15aa497d33ef010c7f87890508fbeb
2019-07-09 15:18:55 -04:00
Matt Riedemann 12a6fe57b9 Follow up for pre-filter-disabled-computes series
This is a collection of follow up changes from the
patches in the series.

* https://review.opendev.org/#/c/668565/1/nova/tests/unit/compute/test_resource_tracker.py
* https://review.opendev.org/#/c/668707/1/nova/virt/libvirt/driver.py
* https://review.opendev.org/#/c/668743/1/nova/compute/manager.py@5020
* https://review.opendev.org/#/c/668752/1/doc/source/admin/configuration/schedulers.rst
* https://review.opendev.org/#/c/654596/8/nova/compute/api.py

Related to blueprint pre-filter-disabled-computes

Change-Id: I2efb833c6f18b13f86abc6c62bcf2c6f77aa15c1
2019-07-03 15:53:06 -04:00
Matt Riedemann 168d34c8d1 Add placement request pre-filter compute_status_filter
This adds a new mandatory placement request pre-filter
which is used to exclude compute node resource providers
with the COMPUTE_STATUS_DISABLED trait. The trait is
managed by the nova-compute service when the service's
disabled status changes.

Change I3005b46221ac3c0e559e1072131a7e4846c9867c makes
the compute service sync the trait during the
update_available_resource flow (either on start of the
compute service or during the periodic task run).

Change Ifabbb543aab62b917394eefe48126231df7cd503 makes
the libvirt driver's _set_host_enabled callback reflect
the trait when the hypervisor goes up or down out of band.

Change If32bca070185937ef83f689b7163d965a89ec10a will add
the final piece which is the os-services API calling the
compute service to add/remove the trait when a compute
service is disabled or enabled.

Since this series technically functions without the API
change, the docs and release note are added here.

Part of blueprint pre-filter-disabled-computes

Change-Id: I317cabbe49a337848325f96df79d478fd65811d9
2019-07-02 16:01:02 -04:00
Stephen Finucane 81e4d13c32 conf: Rename 'configuration drive' to 'config drive'
Keeps dansmith happy.

Change-Id: Ifd8537692de98ee02ff7333812d2877273a0a388
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-06-20 18:23:14 +01:00
Stephen Finucane 92a432fde7 docs: Rework all things metadata'y
Turns out we've a *lot* of disparate metadata systems. Attempt to both
link them somewhat through extensive cross-referencing and extract out
deployment-specific stuff from user-facing docs. Lots of changes here,
but in summary:

- Split out admin-focused content from the metadata API, config drive,
  user data and vendordata docs.

- Merge the config drive, metadata service, vendordata and user-data
  user docs, which are mostly talking about the same thing and are
  fairly barren without the deployment components

- Make use of various oslo.config and Sphinx roles

Side note: I miss when we have tech writers to do this stuff for us :(

Change-Id: I4fb2b628bd93358a752e2397ae353221758e2984
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-06-20 18:22:34 +01:00
Zuul ed8412f702 Merge "docs: Remove references to nova-consoleauth" 2019-06-18 23:21:42 +00:00
Matt Riedemann 257ef9573f Deprecate RetryFilter
Since blueprint return-alternate-hosts in Queens, the scheduler
returns a primary selected host and some alternate hosts based
on the max_attempts config option. The only reschedules we have
are during server create and resize/cold migrate. The list of
alternative hosts are passed down from conductor through compute
and back to conductor on reschedule and if conductor gets a list
of alternate hosts on reschedule it will not call the scheduler
again. This means the RetryFilter is effectively useless now since
it shouldn't ever filter out hosts on the first schedule attempt
and because we're using alternates for reschedules, we shouldn't
go back to the scheduler on a reschedule. As a result this change
deprecates the RetryFilter and removes it from the default list
of enabled filters.

Change-Id: Ic0a03e89903bf925638fa26cca3dac7db710dca3
2019-06-17 15:27:11 -04:00
Matt Riedemann 7c9641266f Fix enabled_filters default value in admin config docs
This fixes a couple of places in the admin scheduler config
docs that were listing out the enabled_filters default value
incorrectly because the ComputeFilter was missing. Rather than
try to keep the docs mirrored with the actual default value,
this change references the config option in one spot and avoids
listing the defaults in another.

Change-Id: I837aefcd37556a7b66b523529c5ca1f3dee8ac7f
Closes-Bug: #1833120
2019-06-17 15:24:24 -04:00
Stephen Finucane 009fd0f35b docs: Remove references to nova-consoleauth
We're going to remove all the code, but first, remove the docs.

Part of blueprint remove-consoleauth

Change-Id: Ie96e18ea7762b93b4116b35d7ebcfcbe53c55527
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-06-17 15:18:31 +01:00
Zuul c27809d50d Merge "Add 'path' query parameter to console access url" 2019-06-17 12:14:35 +00:00
Zuul c2b5ac9b8e Merge "Document restrictions for moving servers between availability zones" 2019-06-15 00:15:10 +00:00
Mohammed Naser 9606c80402 Add 'path' query parameter to console access url
Starting in noVNC v1.1.0, the token query parameter is no longer
forwarded via cookie [1]. We must instead use the 'path' query
parameter to pass the token through to the websocketproxy [2].
This means that if someone deploys noVNC v1.1.0, VNC consoles will
break in nova because the code is relying on the cookie functionality
that v1.1.0 removed.

This modifies the ConsoleAuthToken.access_url property to include the
'path' query parameter as part of the returned access_url that the
client will use to call the console proxy service.

This change is backward compatible with noVNC < v1.1.0. The 'path' query
parameter is a long supported feature in noVNC.

Co-Authored-By: melanie witt <melwittt@gmail.com>

Closes-Bug: #1822676

[1] https://github.com/novnc/noVNC/commit/51f9f0098d306bbc67cc8e02ae547921b6f6585c
[2] https://github.com/novnc/noVNC/pull/1220

Change-Id: I2ddf0f4d768b698e980594dd67206464a9cea37b
2019-06-14 18:01:24 +00:00
Matt Riedemann 7abc21b6b2 Update quota known issues docs
This removes the old reference to the nova-manage
command to refresh quota usage which no longer
applies since we started counting quotas in the
Pike release.

This replaces with a reference to the down-cell
known issue for counting quotas.

Change-Id: I2765f3ca3dc95345d4e4c4db43ac3dff4a509259
2019-06-06 12:22:07 -04:00
Zuul 520fed1d91 Merge "Document mitigation for Intel MDS security flaws" 2019-06-06 09:16:11 +00:00
Kashyap Chamarthy f394703f7e Document mitigation for Intel MDS security flaws
In May 2019, four new microprocessor security flaws, known as "MDS"
(Microarchitectural Data Sampling) have been discovered.  These flaws
affect unpatched Nova Compute nodes and instances running on Intel
x86_64 CPUs.  The said security flaws are also referred to as "RIDL"
(Rogue In-Flight Data Load) and "Fallout".

Refer to the following pages for further details:

 - https://access.redhat.com/security/vulnerabilities/mds
 - https://mdsattacks.com/
 - https://zombieloadattack.com/

            * * *

If we're adding the guide for "MDS" flaws, then it begs the
question: "What about mitigation guides for previous vulnerabilities?"

Two points:

(a) Write the mitigation document for rest of the previous
    vulnerabilities too, for completeness' sake. (In April 2018 I wrote
    this doc[1] for Meltdown — polish it and submit it. Parts of that
    document's content is already incorporated into the help text for
    the config attribute `cpu_model_extra_flags`.)

(b) For now, we can live with the cliché, "something is better than
    nothing"; we'll add the other docs "when we get to it".  Meanwhile,
    operators get mitigation details from various other places —
    processor vendors, Linux distributions, etc.

[1] https://kashyapc.fedorapeople.org/Reducing-OpenStack-Guest-Perf-Impact-from-Meltdown.txt

Change-Id: I1bb472c3438cc9a91945999d2350b2c59fa6a1f3
Signed-off-by: Kashyap Chamarthy <kchamart@redhat.com>
2019-06-05 15:55:24 +00:00
Zuul 1459e8edb9 Merge "Add documentation for counting quota usage from placement" 2019-06-01 02:32:32 +00:00
melanie witt e3aadaf17f Add documentation for counting quota usage from placement
Part of blueprint count-quota-usage-from-placement

Change-Id: I88919634551b654b6cfdd377ac5de78106bc894f
2019-05-31 18:08:45 +00:00
Dan Smith d4c8725940 Add docs for image type support request filter
This adds the missing "prefilter" stage to the description of the
scheduling process, and adds information about the image type
filter.

Related to blueprint request-filter-image-types

Change-Id: I07eef048cf2c85a3fdb8adbe38e362878e4e177e
2019-05-07 10:24:21 -07:00
Adam Spiers 752b135ec4 Add Venn diagram showing taxonomy of traits and capabilities
This was put together while working on the mechanism for converting
driver capabilities to traits in I15364d37fb7426f4eec00ca4eaf99bec50e964b6:

    https://review.openstack.org/538498

and may help other developers working on this area in the future.

Change-Id: I395e386ee713769d4c105be0dd6e821382945866
2019-04-26 22:54:31 +01:00
ZhongShengping 7ecaa3fcf8 Replace git.openstack.org URLs with opendev.org URLs
Thorough replacement of git.openstack.org URLs with their opendev.org
counterparts.

Change-Id: I3e0af55e0707f04428a422b973d016ad30c82a12
2019-04-24 13:59:57 +08:00
Zuul 647eb3911c Merge "Update docs: User token times out during long-running operations" 2019-04-06 11:21:32 +00:00
Matt Riedemann abe041ae1c Document restrictions for moving servers between availability zones
There was nothing clearly documented about move operations with
respect to AZ restrictions, i.e. when a server can move between
zones or not, and how forcing a target host during evacuate or
live migration can break tracking of the instance for it's orginally
intended zone. This adds documentation around that topic.

Change-Id: I7466826780ea8a6b3d3df93f0e85f009a437b743
Closes-Bug: #1823043
2019-04-05 17:47:05 -04:00
Zara 3ed1e88bd2 Explain why disk_available_least can be negative
This commit adds a paragaph to explain the circumstances in which
disk_available_least will have a negative value, and why this behaviour is
preferred.

Change-Id: Iaa33c35a14a6f0dc8b1d11803a885dce26722e52
2019-03-28 17:23:10 +00:00
Takashi NATSUME b71a5bae88 doc: Fix openstack CLI command
Replace 'openstack placement aggregate set' with
'openstack resource provider aggregate set'.

Change-Id: If085efd0cfb417764e24e9c7eeb23a4d34bf250f
Closes-Bug: #1821916
2019-03-28 09:45:16 +09:00
Zuul 38ce9d8a11 Merge "Add doc on VGPU allocs and inventories for nrp" 2019-03-27 16:14:00 +00:00
Matt Riedemann 75d4ba6752 Document a warning about using the JsonFilter
People hit problems using the JsonFilter from time to time
and at least I always have to re-learn what it does and am
somewhat horrified to find how flexible it is based on using
HostState attributes as filtering variables, not to mention
we don't do any functional testing with it. The docs are also
misleading in stating it only supports a subset of variables
when it's really anything on the HostState object. A common
case is people filtering on the hypervisor_hostname attribute
to schedule directly to a specific baremetal node with ironic.

This change adds a warning recommending to not use the filter
if possible and find alternatives, like traits. It also mentions
the HostState object as defining the variables that can be used
along with adding the commonly-used hypervisor_hostname variable
to the list.

Change-Id: Ib2b1395715b6bdb25f53ee7c68df44e2d84b895b
Related-Bug: #1821764
2019-03-26 12:13:42 -04:00
Matt Riedemann 45cecbb427 Fix JsonFilter query hint examples in docs
The API reference and part of the scheduler filter docs for
the JsonFilter query hint are using invalid json strings
in the examples.

This fixes both invalid locations using the same json string
used in the openstack server create command example in the
scheduler admin docs.

Change-Id: Iaab8608c7ffa6fbbea40a838dd02d8096f632f7a
Closes-Bug: #1821764
2019-03-26 12:05:30 -04:00
Sylvain Bauza 44490142be Add doc on VGPU allocs and inventories for nrp
Now that we reshape inventories and allocations for VGPU resources in Stein,
we think it's good for operators to know how to verify the resources using
osc-placement.

Change-Id: Ic58709aac2dd1f20f1b8440a3cea4f29eed9a965
Closes-Bug: #1821015
2019-03-26 15:17:39 +01:00
Sylvain Bauza 10234d5926 Remove expiremental note in the VGPU docs
FWIW, we already say in the feature classification documentation that the
feature is experimental [1] but we also now have functional tests that help
to verify that the feature is working.
I think we can just remove the note about this then.

[1] https://docs.openstack.org/nova/latest/user/feature-classification.html#operation_virtual_gpu

Change-Id: I705b3aeb1da33ddc41d4306ad91ad7cb70fcf4e4
2019-03-25 15:11:31 +01:00
Zuul acbbc3eb8b Merge "Documentation for bandwidth support" 2019-03-21 15:59:23 +00:00
Matt Riedemann c16c3062e7 Add docs for compute capabilities as traits
Change I15364d37fb7426f4eec00ca4eaf99bec50e964b6 added the
ability for the compute service to report a subset of driver
capabilities as standard COMPUTE_* traits on the compute node
resource provider.

This adds administrator documentation to the scheduler docs
about the feature and how it could be used with flavors. There
are also some rules and semantic behavior around how these traits
work so that is also documented.

Note that for cases #3 and #4 in the "Rules" section the
update_available_resource periodic task in the compute service
may add the compute-owned traits again automatically but it
depends on the [compute]/resource_provider_association_refresh
configuration option, which if set to 0 will disable that auto
refresh and a restart or SIGHUP is required. To avoid confusion
in these docs, I have opted to omit the mention of that option
and just document the action that will work regardless of
configuration which is to restart or SIGHUP the compute service.

Change-Id: Iaeec92e0b25956b0d95754ce85c68c2d82c4a7f1
2019-03-19 10:09:55 -04:00
Balazs Gibizer 47287f6f94 Documentation for bandwidth support
blueprint: bandwidth-resource-provider
Depends-On: https://review.openstack.org/#/c/640390
Depends-On: https://review.openstack.org/#/c/621494

Change-Id: I166787e092e16857d20f89fba965be2a5509fb4b
2019-03-18 11:24:56 +01:00
Zuul f7af48363f Merge "docs: Fix nits in remote console guide" 2019-03-13 21:03:32 +00:00
ya.wang fa07df1e99 Update docs: User token times out during long-running operations
Keystonemiddleware compares the roles of the service_user with
[Keystone_authtoken]/service_token_roles, we need to explain this so
that users don't get confused.

For example:
Nova send request to neutron with both service_user_token and
user_token, neutron first sends them to Keystonemiddleware for
authenrication, Keystonemiddleware will compare service_user's role
with [Keystone_authtoken]/service_token_roles which configured in
neutron, then decide whether to fetch user_token based on the result.

Change-Id: I024885adad2d14bc2568382c677198132dc88a13
2019-03-12 16:41:44 +08:00
Takashi NATSUME 892ead1438 doc: Fix a typo
Replace 'listeing' with 'listening'.

TrivialFix
Change-Id: I0fe3b75c5005e3ca83b3e6bcc2998327595635ab
2019-03-11 17:45:25 +09:00
Zuul c756e868b6 Merge "Remove cells v1 (for the most part) from the docs" 2019-03-08 01:29:10 +00:00
Stephen Finucane fbb3b53a3b docs: Fix nits in remote console guide
These were missed in I08991796aaced2abc824f608108c0c786181eb65.

Change-Id: Ibb31d7d8460c6376f42bcb65c94796d5e68f3d9d
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-03-07 17:44:55 +00:00
Zuul 4ae7fb4ec7 Merge "doc: cleanup pci.alias references" 2019-03-07 00:52:18 +00:00
Matt Riedemann fbfb1a25df doc: cleanup pci.alias references
The admin and user flavor docs on pci.alias were not super
helpful by just throwing the user to the config docs or
flavor docs and letting them figure it out. This change
helps the reader by linking directly to the things being
referenced.

Also cleans up a pci.passthrough config option reference
while in here.

Change-Id: Ie2e28a14ff4655e38a5db3925adcd605ac773843
2019-03-06 17:59:26 +00:00