CINXE.COM
Admin Documentation — nova 30.0.1.dev5 documentation
<!DOCTYPE html> <html lang="en" data-content_root="../"> <head> <meta charset="utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" /> <title>Admin Documentation — nova 30.0.1.dev5 documentation</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=639405c8" /> <link rel="stylesheet" type="text/css" href="../_static/basic.css?v=fb9458d3" /> <link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=fd3f3429" /> <link rel="stylesheet" type="text/css" href="../_static/support-matrix.css" /> <link rel="stylesheet" type="text/css" href="../_static/feature-matrix.css?v=9b469096" /> <script src="../_static/documentation_options.js?v=8769bac8"></script> <script src="../_static/doctools.js?v=9a2dae69"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> <link rel="next" title="Host aggregates" href="aggregates.html" /> <link rel="prev" title="Using WSGI with Nova" href="../user/wsgi.html" /> <meta name="viewport" content="width=device-width, initial-scale=1"> <!-- Bootstrap CSS --> <link href="../_static/css/bootstrap.min.css" rel="stylesheet"> <!-- Fonts --> <link href="../_static/css/font-awesome.min.css" rel="stylesheet"> <!-- Custom CSS --> <link href="../_static/css/combined.css" rel="stylesheet"> <!-- Search CSS --> <link href="../_static/css/search.css" rel="stylesheet"> <!-- Pygments CSS --> <link href="../_static/pygments.css" rel="stylesheet"> <!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries --> <!-- WARNING: Respond.js doesn't work if you view the page via file:// --> <!--[if lt IE 9]> <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script> <script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script> <![endif]--> <!-- Google Analytics --> <script> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-17511903-1', 'auto'); ga('send', 'pageview'); </script> <!-- End Google Analytics --> </head><body> <!-- SOURCE_FILE: https://opendev.org/openstack/nova/src/doc/source/admin/index.rst --> <script> (function (window, document) { var loader = function () { var script = document.createElement("script"), tag = document.getElementsByTagName("script")[0]; script.src = "https://search.openstack.org/widget/embed.min.js?t="+Date.now(); tag.parentNode.insertBefore(script, tag); }; window.addEventListener ? window.addEventListener("load", loader, false) : window.attachEvent("onload", loader); })(window, document); </script> <nav class="navbar navbar-default" role="navigation"> <div class="container"> <!-- Brand and toggle get grouped for better mobile display --> <div class="navbar-header"> <button class="navbar-toggle" data-target="#bs-example-navbar-collapse-1" data-toggle="collapse" type="button"> <span class="sr-only">Toggle navigation</span> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button> <div class="brand-wrapper"> <a class="navbar-brand" href="https://www.openstack.org/"></a> </div> <div class="search-icon show"><i class="fa fa-search"></i> Search</div></div> <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1"> <div class="search-container tiny"> <div class="openstack-search-bar" data-baseUrl="search.openstack.org" data-context="docs-openstack"></div> </div> <ul class="nav navbar-nav navbar-main show"> <li class="search-container-mobile"> <div class="openstack-search-bar" data-baseUrl="search.openstack.org" data-context="docs-openstack"></div> </li> <li> <!--Software --> <a href="https://www.openstack.org/software/" class="drop" id="dropdownMenuSoftware">Software <i class="fa fa-caret-down"></i></a> <ul class="dropdown-menu" role="menu" aria-labelledby="dropdownMenuSoftware"> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/software/">Overview</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/software/project-navigator/openstack-components">OpenStack Components</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/software/project-navigator/sdks">SDKs</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/software/project-navigator/deployment-tools">Deployment Tools</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/assets/software/projectmap/openstack-map.pdf" target="_blank">OpenStack Map</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/software/sample-configs/">Sample Configs</a></li> </ul> </li> <li> <!-- Use Cases --> <a href="https://www.openstack.org/use-cases/" class="drop" id="dropdownMenuUsers">Use Cases <i class="fa fa-caret-down"></i></a> <ul class="dropdown-menu" role="menu" aria-labelledby="dropdownMenuUsers"> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/use-cases/">Users in Production</a></li> <li role="presentation" class="divider"></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/use-cases/bare-metal/">Ironic Bare Metal</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/use-cases/edge-computing/">Edge Computing</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/use-cases/telecoms-and-nfv/">Telecom & NFV</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/use-cases/science/">Science and HPC</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/use-cases/containers/">Containers</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/use-cases/enterprise/">Enterprise</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/surveys/landing">User Survey</a></li> </ul> </li> <li> <!-- Events --> <a href="https://openinfra.dev/summit" class="drop" id="dropdownMenuEvents">Events <i class="fa fa-caret-down"></i></a> <ul class="dropdown-menu" role="menu" aria-labelledby="dropdownMenuEvents"> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://openinfra.dev/summit">OpenInfra Summit</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/ptg/">Project Teams Gathering</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/events/opendev-2020/">OpenDev</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/events/community-events/">Community Events</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/events/openstackdays">OpenStack & OpenInfra Days</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/videos/">Summit Videos</a></li> </ul> </li> <li><!-- Community --> <a href="https://www.openstack.org/community/" class="drop" id="dropdownMenuCommunity">Community <i class="fa fa-caret-down"></i></a> <ul class="dropdown-menu" role="menu" aria-labelledby="dropdownMenuCommunity"> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/community/">Welcome! Start Here</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/community/tech-committee">OpenStack Technical Committee</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/community/speakers/">Speakers Bureau</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="http://wiki.openstack.org">OpenStack Wiki</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/coa/">Get Certified (COA)</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/community/jobs/">Jobs</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/marketing/">Marketing Resources</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/news/">Community News</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="http://superuser.openstack.org">Superuser Magazine</a></li> <li role="presentation" class="divider"></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/community/supporting-organizations/">OpenInfra Foundation Supporting Organizations</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://openinfra.dev">OpenInfra Foundation</a></li> </ul> </li> <li><!-- Marketplace --> <a href="https://www.openstack.org/marketplace/" class="drop" id="dropdownMenuLearn">Marketplace <i class="fa fa-caret-down"></i></a> <ul class="dropdown-menu dropdown-hover" role="menu" aria-labelledby="dropdownMenuEvents"> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/marketplace/training/">Training</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/marketplace/distros/">Distros & Appliances</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/marketplace/public-clouds/">Public Clouds</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/marketplace/hosted-private-clouds/">Hosted Private Clouds</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/marketplace/remotely-managed-private-clouds/">Remotely Managed Private Clouds</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/marketplace/consulting/">Consulting & Integrators</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/marketplace/drivers/">Drivers</a></li> </ul> </li> <li><!-- Blog --> <a href="https://www.openstack.org/blog/">Blog</a> </li> <li><!-- Docs --> <a href="http://docs.openstack.org/">Docs</a> </li> <li class="join-nav-section"> <!-- Join --> <a href="https://openinfra.dev/join/" id="dropdownMenuJoin">Join <i class="fa fa-caret-down"></i></a> <ul class="dropdown-menu dropdown-hover" role="menu" aria-labelledby="dropdownMenuJoin" style="display: none;"> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://openinfra.dev/join/">Sign up for Foundation Membership</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://openinfra.dev/join/">Sponsor the Foundation</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://openinfra.dev">More about the Foundation</a></li> </ul> </li> <li> <!-- Login --> <a href="https://www.openstack.org/Security/login/?BackURL=/home/" class="sign-in-btn">Log In</a> </li> </ul> </div> </div> <!-- /.container --> </nav> <div class="container docs-book-wrapper"> <div class="row"> <div class="col-lg-9 col-md-8 col-sm-8 col-lg-push-3 col-md-push-4 col-sm-push-4"> <div class="row docs-title"> <div class="col-lg-8"> <h1>Admin Documentation</h1> </div> <div class="docs-actions"> <a href="../user/wsgi.html"><i class="fa fa-angle-double-left" data-toggle="tooltip" data-placement="top" title="Previous: Using WSGI with Nova"></i></a> <a href="aggregates.html"><i class="fa fa-angle-double-right" data-toggle="tooltip" data-placement="top" title="Next: Host aggregates"></i></a> <a id="pdfLink1" href="" target="_blank" title="Download the manuals as PDF"><i class="fa fa-file-pdf-o" data-toggle="tooltip" data-placement="top" title="Download PDF"></i></a> <a id="logABugLink1" href="" target="_blank" title="Found an error? Report a bug against this page"><i class="fa fa-bug" data-toggle="tooltip" data-placement="top" title="Report a Bug"></i></a> </div> </div> <div class="row"> <div class="col-lg-12"> <div class="docs-body" role="main"> <section id="admin-documentation"> <h1>Admin Documentation<a class="headerlink" href="#admin-documentation" title="Link to this heading">¶</a></h1> <p>The OpenStack Compute service allows you to control an Infrastructure-as-a-Service (IaaS) cloud computing platform. It gives you control over instances and networks, and allows you to manage access to the cloud through users and projects.</p> <p>Compute does not include virtualization software. Instead, it defines drivers that interact with underlying virtualization mechanisms that run on your host operating system, and exposes functionality over a web-based API.</p> <section id="overview"> <h2>Overview<a class="headerlink" href="#overview" title="Link to this heading">¶</a></h2> <p>To effectively administer compute, you must understand how the different installed nodes interact with each other. Compute can be installed in many different ways using multiple servers, but generally multiple compute nodes control the virtual servers and a cloud controller node contains the remaining Compute services.</p> <p>The Compute cloud works using a series of daemon processes named <code class="docutils literal notranslate"><span class="pre">nova-*</span></code> that exist persistently on the host machine. These binaries can all run on the same machine or be spread out on multiple boxes in a large deployment. The responsibilities of services and drivers are:</p> <p class="rubric">Services</p> <dl class="simple"> <dt><a class="reference internal" href="../cli/nova-api-metadata.html"><span class="doc">nova-api-metadata</span></a></dt><dd><p>A server daemon that serves the Nova Metadata API.</p> </dd> <dt><a class="reference internal" href="../cli/nova-api-os-compute.html"><span class="doc">nova-api-os-compute</span></a></dt><dd><p>A server daemon that serves the Nova OpenStack Compute API.</p> </dd> <dt><a class="reference internal" href="../cli/nova-api.html"><span class="doc">nova-api</span></a></dt><dd><p>A server daemon that serves the metadata and compute APIs in separate greenthreads.</p> </dd> <dt><a class="reference internal" href="../cli/nova-compute.html"><span class="doc">nova-compute</span></a></dt><dd><p>Manages virtual machines. Loads a Service object, and exposes the public methods on ComputeManager through a Remote Procedure Call (RPC).</p> </dd> <dt><a class="reference internal" href="../cli/nova-conductor.html"><span class="doc">nova-conductor</span></a></dt><dd><p>Provides database-access support for compute nodes (thereby reducing security risks).</p> </dd> <dt><a class="reference internal" href="../cli/nova-scheduler.html"><span class="doc">nova-scheduler</span></a></dt><dd><p>Dispatches requests for new virtual machines to the correct node.</p> </dd> <dt><a class="reference internal" href="../cli/nova-novncproxy.html"><span class="doc">nova-novncproxy</span></a></dt><dd><p>Provides a VNC proxy for browsers, allowing VNC consoles to access virtual machines.</p> </dd> <dt><a class="reference internal" href="../cli/nova-spicehtml5proxy.html"><span class="doc">nova-spicehtml5proxy</span></a></dt><dd><p>Provides a SPICE proxy for browsers, allowing SPICE consoles to access virtual machines.</p> </dd> <dt><a class="reference internal" href="../cli/nova-serialproxy.html"><span class="doc">nova-serialproxy</span></a></dt><dd><p>Provides a serial console proxy, allowing users to access a virtual machine’s serial console.</p> </dd> </dl> <p>The architecture is covered in much greater detail in <a class="reference internal" href="architecture.html"><span class="doc">Nova System Architecture</span></a>.</p> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="architecture.html">Nova System Architecture</a><ul> <li class="toctree-l2"><a class="reference internal" href="architecture.html#components">Components</a></li> <li class="toctree-l2"><a class="reference internal" href="architecture.html#hypervisors">Hypervisors</a></li> <li class="toctree-l2"><a class="reference internal" href="architecture.html#projects-users-and-roles">Projects, users, and roles</a></li> <li class="toctree-l2"><a class="reference internal" href="architecture.html#block-storage">Block storage</a></li> <li class="toctree-l2"><a class="reference internal" href="architecture.html#building-blocks">Building blocks</a></li> <li class="toctree-l2"><a class="reference internal" href="architecture.html#nova-service-architecture">Nova service architecture</a></li> </ul> </li> </ul> </div> <div class="admonition note"> <p class="admonition-title">Note</p> <p>Some services have drivers that change how the service implements its core functionality. For example, the <code class="docutils literal notranslate"><span class="pre">nova-compute</span></code> service supports drivers that let you choose which hypervisor type it can use.</p> </div> </section> <section id="deployment-considerations"> <h2>Deployment Considerations<a class="headerlink" href="#deployment-considerations" title="Link to this heading">¶</a></h2> <p>There is information you might want to consider before doing your deployment, especially if it is going to be a larger deployment. For smaller deployments the defaults from the <a class="reference internal" href="../install/index.html"><span class="doc">install guide</span></a> will be sufficient.</p> <ul class="simple"> <li><p><strong>Compute Driver Features Supported</strong>: While the majority of nova deployments use libvirt/kvm, you can use nova with other compute drivers. Nova attempts to provide a unified feature set across these, however, not all features are implemented on all backends, and not all features are equally well tested.</p> <ul> <li><p><a class="reference internal" href="../user/feature-classification.html"><span class="doc">Feature Support by Use Case</span></a>: A view of what features each driver supports based on what’s important to some large use cases (General Purpose Cloud, NFV Cloud, HPC Cloud).</p></li> <li><p><a class="reference internal" href="../user/support-matrix.html"><span class="doc">Feature Support full list</span></a>: A detailed dive through features in each compute driver backend.</p></li> </ul> </li> <li><p><a class="reference internal" href="cells.html"><span class="doc">Cells v2 configuration</span></a>: For large deployments, cells v2 cells allow sharding of your compute environment. Upfront planning is key to a successful cells v2 layout.</p></li> <li><p><a class="reference internal" href="availability-zones.html"><span class="doc">Availability Zones</span></a>: Availability Zones are an end-user visible logical abstraction for partitioning a cloud without knowing the physical infrastructure.</p></li> <li><p><a class="extlink-placement reference external" href="https://docs.openstack.org/placement/2024.2/">Placement service</a>: Overview of the placement service, including how it fits in with the rest of nova.</p></li> <li><p><a class="reference internal" href="../user/wsgi.html"><span class="doc">Running nova-api on wsgi</span></a>: Considerations for using a real WSGI container instead of the baked-in eventlet web server.</p></li> </ul> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="cells.html">Cells (v2)</a><ul> <li class="toctree-l2"><a class="reference internal" href="cells.html#overview">Overview</a></li> <li class="toctree-l2"><a class="reference internal" href="cells.html#service-layout">Service layout</a></li> <li class="toctree-l2"><a class="reference internal" href="cells.html#database-layout">Database layout</a></li> <li class="toctree-l2"><a class="reference internal" href="cells.html#usage">Usage</a></li> <li class="toctree-l2"><a class="reference internal" href="cells.html#design">Design</a></li> <li class="toctree-l2"><a class="reference internal" href="cells.html#comparison-with-cells-v1">Comparison with cells v1</a></li> <li class="toctree-l2"><a class="reference internal" href="cells.html#caveats">Caveats</a></li> <li class="toctree-l2"><a class="reference internal" href="cells.html#handling-cell-failures">Handling cell failures</a></li> <li class="toctree-l2"><a class="reference internal" href="cells.html#faqs">FAQs</a></li> <li class="toctree-l2"><a class="reference internal" href="cells.html#references">References</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="aggregates.html">Host aggregates</a><ul> <li class="toctree-l2"><a class="reference internal" href="aggregates.html#configure-scheduler-to-support-host-aggregates">Configure scheduler to support host aggregates</a></li> <li class="toctree-l2"><a class="reference internal" href="aggregates.html#aggregates-in-placement">Aggregates in Placement</a></li> <li class="toctree-l2"><a class="reference internal" href="aggregates.html#tenant-isolation-with-placement">Tenant Isolation with Placement</a></li> <li class="toctree-l2"><a class="reference internal" href="aggregates.html#usage">Usage</a></li> <li class="toctree-l2"><a class="reference internal" href="aggregates.html#configuration">Configuration</a></li> <li class="toctree-l2"><a class="reference internal" href="aggregates.html#image-caching">Image Caching</a></li> <li class="toctree-l2"><a class="reference internal" href="aggregates.html#references">References</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="default-ports.html">Compute service node firewall requirements</a></li> <li class="toctree-l1"><a class="reference internal" href="availability-zones.html">Availability Zones</a><ul> <li class="toctree-l2"><a class="reference internal" href="availability-zones.html#availability-zones-with-placement">Availability Zones with Placement</a></li> <li class="toctree-l2"><a class="reference internal" href="availability-zones.html#implications-for-moving-servers">Implications for moving servers</a></li> <li class="toctree-l2"><a class="reference internal" href="availability-zones.html#using-availability-zones-to-select-hosts">Using availability zones to select hosts</a></li> <li class="toctree-l2"><a class="reference internal" href="availability-zones.html#usage">Usage</a></li> <li class="toctree-l2"><a class="reference internal" href="availability-zones.html#configuration">Configuration</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="configuration/index.html">Configuration</a><ul> <li class="toctree-l2"><a class="reference internal" href="configuration/service-user-token.html">Service User Tokens</a></li> <li class="toctree-l2"><a class="reference internal" href="configuration/api.html">Compute API configuration</a></li> <li class="toctree-l2"><a class="reference internal" href="configuration/resize.html">Resize</a></li> <li class="toctree-l2"><a class="reference internal" href="configuration/cross-cell-resize.html">Cross-cell resize</a></li> <li class="toctree-l2"><a class="reference internal" href="configuration/fibre-channel.html">Configuring Fibre Channel Support</a></li> <li class="toctree-l2"><a class="reference internal" href="configuration/iscsi-offload.html">Configuring iSCSI interface and offload support</a></li> <li class="toctree-l2"><a class="reference internal" href="configuration/hypervisors.html">Hypervisors</a></li> <li class="toctree-l2"><a class="reference internal" href="configuration/logs.html">Compute log files</a></li> <li class="toctree-l2"><a class="reference internal" href="configuration/samples/index.html">Compute service sample configuration files</a></li> </ul> </li> </ul> </div> </section> <section id="basic-configuration"> <h2>Basic configuration<a class="headerlink" href="#basic-configuration" title="Link to this heading">¶</a></h2> <p>Once you have an OpenStack deployment up and running, you will want to manage it. The below guides cover everything from creating initial flavor and image to log management and live migration of instances.</p> <ul class="simple"> <li><p><a class="reference internal" href="unified-limits.html"><span class="doc">Quotas</span></a>: Managing project quotas in nova.</p></li> <li><p><a class="reference internal" href="scheduling.html"><span class="doc">Scheduling</span></a>: How the scheduler is configured, and how that will impact where compute instances land in your environment. If you are seeing unexpected distribution of compute instances in your hosts, you’ll want to dive into this configuration.</p></li> <li><p><a class="reference internal" href="vendordata.html"><span class="doc">Exposing custom metadata to compute instances</span></a>: How and when you might want to extend the basic metadata exposed to compute instances (either via metadata server or config drive) for your specific purposes.</p></li> </ul> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="manage-the-cloud.html">Manage the cloud</a><ul> <li class="toctree-l2"><a class="reference internal" href="common/nova-show-usage-statistics-for-hosts-instances.html">Show usage statistics for hosts and instances</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="services.html">Manage Compute services</a></li> <li class="toctree-l1"><a class="reference internal" href="service-groups.html">Configure Compute service groups</a><ul> <li class="toctree-l2"><a class="reference internal" href="service-groups.html#database-servicegroup-driver">Database ServiceGroup driver</a></li> <li class="toctree-l2"><a class="reference internal" href="service-groups.html#memcache-servicegroup-driver">Memcache ServiceGroup driver</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="manage-logs.html">Logging</a><ul> <li class="toctree-l2"><a class="reference internal" href="manage-logs.html#logging-module">Logging module</a></li> <li class="toctree-l2"><a class="reference internal" href="manage-logs.html#syslog">Syslog</a></li> <li class="toctree-l2"><a class="reference internal" href="manage-logs.html#rsyslog">Rsyslog</a></li> <li class="toctree-l2"><a class="reference internal" href="manage-logs.html#serial-console">Serial console</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="root-wrap-reference.html">Secure with rootwrap</a><ul> <li class="toctree-l2"><a class="reference internal" href="root-wrap-reference.html#configure-rootwrap">Configure rootwrap</a></li> <li class="toctree-l2"><a class="reference internal" href="root-wrap-reference.html#configure-the-rootwrap-daemon">Configure the rootwrap daemon</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="ssh-configuration.html">Configure SSH between compute nodes</a></li> <li class="toctree-l1"><a class="reference internal" href="configuring-migrations.html">Configure live migrations</a><ul> <li class="toctree-l2"><a class="reference internal" href="configuring-migrations.html#libvirt">Libvirt</a></li> <li class="toctree-l2"><a class="reference internal" href="configuring-migrations.html#vmware">VMware</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="live-migration-usage.html">Live-migrate instances</a><ul> <li class="toctree-l2"><a class="reference internal" href="live-migration-usage.html#manual-selection-of-the-destination-host">Manual selection of the destination host</a></li> <li class="toctree-l2"><a class="reference internal" href="live-migration-usage.html#automatic-selection-of-the-destination-host">Automatic selection of the destination host</a></li> <li class="toctree-l2"><a class="reference internal" href="live-migration-usage.html#monitoring-the-migration">Monitoring the migration</a></li> <li class="toctree-l2"><a class="reference internal" href="live-migration-usage.html#what-to-do-when-the-migration-times-out">What to do when the migration times out</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="secure-live-migration-with-qemu-native-tls.html">Secure live migration with QEMU-native TLS</a><ul> <li class="toctree-l2"><a class="reference internal" href="secure-live-migration-with-qemu-native-tls.html#context">Context</a></li> <li class="toctree-l2"><a class="reference internal" href="secure-live-migration-with-qemu-native-tls.html#prerequisites">Prerequisites</a></li> <li class="toctree-l2"><a class="reference internal" href="secure-live-migration-with-qemu-native-tls.html#validating-your-tls-environment-on-compute-nodes">Validating your TLS environment on compute nodes</a></li> <li class="toctree-l2"><a class="reference internal" href="secure-live-migration-with-qemu-native-tls.html#other-tls-environment-related-checks-on-compute-nodes">Other TLS environment related checks on compute nodes</a></li> <li class="toctree-l2"><a class="reference internal" href="secure-live-migration-with-qemu-native-tls.html#performing-the-migration">Performing the migration</a></li> <li class="toctree-l2"><a class="reference internal" href="secure-live-migration-with-qemu-native-tls.html#related-information">Related information</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="manage-volumes.html">Manage volumes</a><ul> <li class="toctree-l2"><a class="reference internal" href="manage-volumes.html#volume-multi-attach">Volume multi-attach</a></li> <li class="toctree-l2"><a class="reference internal" href="manage-volumes.html#managing-volume-attachments">Managing volume attachments</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="flavors.html">Manage Flavors</a><ul> <li class="toctree-l2"><a class="reference internal" href="flavors.html#create-a-flavor">Create a flavor</a></li> <li class="toctree-l2"><a class="reference internal" href="flavors.html#modify-a-flavor">Modify a flavor</a></li> <li class="toctree-l2"><a class="reference internal" href="flavors.html#delete-a-flavor">Delete a flavor</a></li> <li class="toctree-l2"><a class="reference internal" href="flavors.html#default-flavors">Default Flavors</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="admin-password-injection.html">Injecting the administrator password</a></li> <li class="toctree-l1"><a class="reference internal" href="remote-console-access.html">Configure remote console access</a><ul> <li class="toctree-l2"><a class="reference internal" href="remote-console-access.html#overview">Overview</a></li> <li class="toctree-l2"><a class="reference internal" href="remote-console-access.html#consoleauth-configuration">Consoleauth configuration:</a></li> <li class="toctree-l2"><a class="reference internal" href="remote-console-access.html#supported-consoles">Supported consoles:</a></li> <li class="toctree-l2"><a class="reference internal" href="remote-console-access.html#novnc-based-vnc-console">noVNC-based VNC console</a></li> <li class="toctree-l2"><a class="reference internal" href="remote-console-access.html#spice-console">SPICE console</a></li> <li class="toctree-l2"><a class="reference internal" href="remote-console-access.html#serial-console">Serial console</a></li> <li class="toctree-l2"><a class="reference internal" href="remote-console-access.html#mks-console">MKS console</a></li> <li class="toctree-l2"><a class="reference internal" href="remote-console-access.html#about-nova-consoleauth">About <code class="docutils literal notranslate"><span class="pre">nova-consoleauth</span></code></a></li> <li class="toctree-l2"><a class="reference internal" href="remote-console-access.html#frequently-asked-questions">Frequently Asked Questions</a></li> <li class="toctree-l2"><a class="reference internal" href="remote-console-access.html#references">References</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="scheduling.html">Compute schedulers</a><ul> <li class="toctree-l2"><a class="reference internal" href="scheduling.html#prefilters">Prefilters</a></li> <li class="toctree-l2"><a class="reference internal" href="scheduling.html#the-filter-scheduler">The Filter Scheduler</a></li> <li class="toctree-l2"><a class="reference internal" href="scheduling.html#filters">Filters</a></li> <li class="toctree-l2"><a class="reference internal" href="scheduling.html#computefilter"><code class="docutils literal notranslate"><span class="pre">ComputeFilter</span></code></a></li> <li class="toctree-l2"><a class="reference internal" href="scheduling.html#differenthostfilter"><code class="docutils literal notranslate"><span class="pre">DifferentHostFilter</span></code></a></li> <li class="toctree-l2"><a class="reference internal" href="scheduling.html#weights">Weights</a></li> <li class="toctree-l2"><a class="reference internal" href="scheduling.html#utilization-aware-scheduling">Utilization-aware scheduling</a></li> <li class="toctree-l2"><a class="reference internal" href="scheduling.html#allocation-ratios">Allocation ratios</a></li> <li class="toctree-l2"><a class="reference internal" href="scheduling.html#cells-considerations">Cells considerations</a></li> <li class="toctree-l2"><a class="reference internal" href="scheduling.html#compute-capabilities-as-traits">Compute capabilities as traits</a></li> <li class="toctree-l2"><a class="reference internal" href="scheduling.html#writing-your-own-filter">Writing Your Own Filter</a></li> <li class="toctree-l2"><a class="reference internal" href="scheduling.html#writing-your-own-weigher">Writing your own weigher</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="config-drive.html">Config drives</a><ul> <li class="toctree-l2"><a class="reference internal" href="config-drive.html#requirements-and-guidelines">Requirements and guidelines</a></li> <li class="toctree-l2"><a class="reference internal" href="config-drive.html#configuration">Configuration</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="image-caching.html">Image Caching</a><ul> <li class="toctree-l2"><a class="reference internal" href="image-caching.html#what-is-image-caching">What is Image Caching?</a></li> <li class="toctree-l2"><a class="reference internal" href="image-caching.html#image-caching-resource-accounting">Image Caching Resource Accounting</a></li> <li class="toctree-l2"><a class="reference internal" href="image-caching.html#image-pre-caching">Image pre-caching</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="metadata-service.html">Metadata service</a><ul> <li class="toctree-l2"><a class="reference internal" href="metadata-service.html#configuration">Configuration</a></li> <li class="toctree-l2"><a class="reference internal" href="metadata-service.html#config-drives">Config drives</a></li> <li class="toctree-l2"><a class="reference internal" href="metadata-service.html#vendordata">Vendordata</a></li> <li class="toctree-l2"><a class="reference internal" href="metadata-service.html#user-data">User data</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="unified-limits.html">Manage Unified Limits Quotas</a><ul> <li class="toctree-l2"><a class="reference internal" href="unified-limits.html#quotas">Quotas</a></li> <li class="toctree-l2"><a class="reference internal" href="unified-limits.html#unified-limits">Unified limits</a></li> <li class="toctree-l2"><a class="reference internal" href="unified-limits.html#configuration">Configuration</a></li> <li class="toctree-l2"><a class="reference internal" href="unified-limits.html#setting-quota-limits-on-resources">Setting quota limits on resources</a></li> <li class="toctree-l2"><a class="reference internal" href="unified-limits.html#quota-enforcement">Quota enforcement</a></li> <li class="toctree-l2"><a class="reference internal" href="unified-limits.html#quota-usage-from-placement">Quota usage from Placement</a></li> <li class="toctree-l2"><a class="reference internal" href="unified-limits.html#migration-to-unified-limits-quotas">Migration to unified limits quotas</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="networking.html">Networking with neutron</a><ul> <li class="toctree-l2"><a class="reference internal" href="networking.html#sr-iov">SR-IOV</a></li> <li class="toctree-l2"><a class="reference internal" href="networking.html#numa-affinity">NUMA Affinity</a></li> <li class="toctree-l2"><a class="reference internal" href="networking.html#virtio-net-multiqueue">virtio-net Multiqueue</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="security.html">Security hardening</a><ul> <li class="toctree-l2"><a class="reference internal" href="security.html#encrypt-compute-metadata-traffic">Encrypt Compute metadata traffic</a></li> <li class="toctree-l2"><a class="reference internal" href="security.html#securing-live-migration-streams-with-qemu-native-tls">Securing live migration streams with QEMU-native TLS</a></li> <li class="toctree-l2"><a class="reference internal" href="security.html#mitigation-for-mds-microarchitectural-data-sampling-security-flaws">Mitigation for MDS (Microarchitectural Data Sampling) security flaws</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="vendordata.html">Vendordata</a><ul> <li class="toctree-l2"><a class="reference internal" href="vendordata.html#staticjson"><code class="docutils literal notranslate"><span class="pre">StaticJSON</span></code></a></li> <li class="toctree-l2"><a class="reference internal" href="vendordata.html#dynamicjson"><code class="docutils literal notranslate"><span class="pre">DynamicJSON</span></code></a></li> <li class="toctree-l2"><a class="reference internal" href="vendordata.html#references">References</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="notifications.html">Notifications</a><ul> <li class="toctree-l2"><a class="reference internal" href="notifications.html#legacy-unversioned-notifications">Legacy (unversioned) notifications</a></li> <li class="toctree-l2"><a class="reference internal" href="notifications.html#versioned-notifications">Versioned notifications</a></li> <li class="toctree-l2"><a class="reference internal" href="notifications.html#configuration">Configuration</a></li> <li class="toctree-l2"><a class="reference internal" href="notifications.html#reference">Reference</a></li> </ul> </li> </ul> </div> </section> <section id="advanced-configuration"> <h2>Advanced configuration<a class="headerlink" href="#advanced-configuration" title="Link to this heading">¶</a></h2> <p>OpenStack clouds run on platforms that differ greatly in the capabilities that they provide. By default, the Compute service seeks to abstract the underlying hardware that it runs on, rather than exposing specifics about the underlying host platforms. This abstraction manifests itself in many ways. For example, rather than exposing the types and topologies of CPUs running on hosts, the service exposes a number of generic CPUs (virtual CPUs, or vCPUs) and allows for overcommitting of these. In a similar manner, rather than exposing the individual types of network devices available on hosts, generic software-powered network ports are provided. These features are designed to allow high resource utilization and allows the service to provide a generic cost-effective and highly scalable cloud upon which to build applications.</p> <p>This abstraction is beneficial for most workloads. However, there are some workloads where determinism and per-instance performance are important, if not vital. In these cases, instances can be expected to deliver near-native performance. The Compute service provides features to improve individual instance for these kind of workloads.</p> <div class="admonition important"> <p class="admonition-title">Important</p> <p>In deployments older than Train, or in mixed Stein/Train deployments with a rolling upgrade in progress, unless <a class="reference internal" href="../configuration/config.html#workarounds.enable_numa_live_migration" title="enable_numa_live_migration"><code class="xref oslo.config oslo.config-option docutils literal notranslate"><span class="pre">specifically</span> <span class="pre">enabled</span></code></a>, live migration is not possible for instances with a NUMA topology when using the libvirt driver. A NUMA topology may be specified explicitly or can be added implicitly due to the use of CPU pinning or huge pages. Refer to <a class="reference external" href="https://bugs.launchpad.net/nova/+bug/1289064">bug #1289064</a> for more information. As of Train, live migration of instances with a NUMA topology when using the libvirt driver is fully supported.</p> </div> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="pci-passthrough.html">Attaching physical PCI devices to guests</a><ul> <li class="toctree-l2"><a class="reference internal" href="pci-passthrough.html#enabling-pci-passthrough">Enabling PCI passthrough</a></li> <li class="toctree-l2"><a class="reference internal" href="pci-passthrough.html#configuring-a-flavor-or-image">Configuring a flavor or image</a></li> <li class="toctree-l2"><a class="reference internal" href="pci-passthrough.html#pci-numa-affinity-policies">PCI-NUMA affinity policies</a></li> <li class="toctree-l2"><a class="reference internal" href="pci-passthrough.html#pci-tracking-in-placement">PCI tracking in Placement</a></li> <li class="toctree-l2"><a class="reference internal" href="pci-passthrough.html#virtual-iommu-support">Virtual IOMMU support</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="cpu-topologies.html">CPU topologies</a><ul> <li class="toctree-l2"><a class="reference internal" href="cpu-topologies.html#smp-numa-and-smt">SMP, NUMA, and SMT</a></li> <li class="toctree-l2"><a class="reference internal" href="cpu-topologies.html#pcpu-and-vcpu">PCPU and VCPU</a></li> <li class="toctree-l2"><a class="reference internal" href="cpu-topologies.html#customizing-instance-numa-placement-policies">Customizing instance NUMA placement policies</a></li> <li class="toctree-l2"><a class="reference internal" href="cpu-topologies.html#customizing-instance-cpu-pinning-policies">Customizing instance CPU pinning policies</a></li> <li class="toctree-l2"><a class="reference internal" href="cpu-topologies.html#customizing-instance-cpu-topologies">Customizing instance CPU topologies</a></li> <li class="toctree-l2"><a class="reference internal" href="cpu-topologies.html#configuring-libvirt-compute-nodes-for-cpu-pinning">Configuring libvirt compute nodes for CPU pinning</a></li> <li class="toctree-l2"><a class="reference internal" href="cpu-topologies.html#configuring-cpu-power-management-for-dedicated-cores">Configuring CPU power management for dedicated cores</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="real-time.html">Real Time</a><ul> <li class="toctree-l2"><a class="reference internal" href="real-time.html#enabling-real-time">Enabling Real-Time</a></li> <li class="toctree-l2"><a class="reference internal" href="real-time.html#configuring-a-flavor-or-image">Configuring a flavor or image</a></li> <li class="toctree-l2"><a class="reference internal" href="real-time.html#references">References</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="huge-pages.html">Huge pages</a><ul> <li class="toctree-l2"><a class="reference internal" href="huge-pages.html#pages-the-tlb-and-huge-pages">Pages, the TLB and huge pages</a></li> <li class="toctree-l2"><a class="reference internal" href="huge-pages.html#enabling-huge-pages-on-the-host">Enabling huge pages on the host</a></li> <li class="toctree-l2"><a class="reference internal" href="huge-pages.html#customizing-instance-huge-pages-allocations">Customizing instance huge pages allocations</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="virtual-gpu.html">Attaching virtual GPU devices to guests</a><ul> <li class="toctree-l2"><a class="reference internal" href="virtual-gpu.html#enable-gpu-types-compute">Enable GPU types (Compute)</a></li> <li class="toctree-l2"><a class="reference internal" href="virtual-gpu.html#configure-a-flavor-controller">Configure a flavor (Controller)</a></li> <li class="toctree-l2"><a class="reference internal" href="virtual-gpu.html#create-instances-with-virtual-gpu-devices">Create instances with virtual GPU devices</a></li> <li class="toctree-l2"><a class="reference internal" href="virtual-gpu.html#how-to-discover-a-gpu-type">How to discover a GPU type</a></li> <li class="toctree-l2"><a class="reference internal" href="virtual-gpu.html#checking-allocations-and-inventories-for-virtual-gpus">Checking allocations and inventories for virtual GPUs</a></li> <li class="toctree-l2"><a class="reference internal" href="virtual-gpu.html#optional-provide-custom-traits-for-multiple-gpu-types">(Optional) Provide custom traits for multiple GPU types</a></li> <li class="toctree-l2"><a class="reference internal" href="virtual-gpu.html#caveats">Caveats</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="file-backed-memory.html">File-backed memory</a><ul> <li class="toctree-l2"><a class="reference internal" href="file-backed-memory.html#prerequisites-and-limitations">Prerequisites and Limitations</a></li> <li class="toctree-l2"><a class="reference internal" href="file-backed-memory.html#configure-the-backing-store">Configure the backing store</a></li> <li class="toctree-l2"><a class="reference internal" href="file-backed-memory.html#configure-nova-compute-for-file-backed-memory">Configure Nova Compute for file-backed memory</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="ports-with-resource-requests.html">Using ports with resource request</a><ul> <li class="toctree-l2"><a class="reference internal" href="ports-with-resource-requests.html#resource-allocation">Resource allocation</a></li> <li class="toctree-l2"><a class="reference internal" href="ports-with-resource-requests.html#resource-group-policy">Resource Group policy</a></li> <li class="toctree-l2"><a class="reference internal" href="ports-with-resource-requests.html#virt-driver-support">Virt driver support</a></li> <li class="toctree-l2"><a class="reference internal" href="ports-with-resource-requests.html#extended-resource-request">Extended resource request</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="vdpa.html">Using ports vnic_type=’vdpa’</a><ul> <li class="toctree-l2"><a class="reference internal" href="vdpa.html#vdpa-device-tracking">vDPA device tracking</a></li> <li class="toctree-l2"><a class="reference internal" href="vdpa.html#virt-driver-support">Virt driver support</a></li> <li class="toctree-l2"><a class="reference internal" href="vdpa.html#vdpa-lifecycle-operations">vDPA lifecycle operations</a></li> <li class="toctree-l2"><a class="reference internal" href="vdpa.html#vdpa-live-migration">vDPA live migration</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="virtual-persistent-memory.html">Attaching virtual persistent memory to guests</a><ul> <li class="toctree-l2"><a class="reference internal" href="virtual-persistent-memory.html#dependencies">Dependencies</a></li> <li class="toctree-l2"><a class="reference internal" href="virtual-persistent-memory.html#configure-pmem-namespaces-compute">Configure PMEM namespaces (Compute)</a></li> <li class="toctree-l2"><a class="reference internal" href="virtual-persistent-memory.html#configure-a-flavor">Configure a flavor</a></li> <li class="toctree-l2"><a class="reference internal" href="virtual-persistent-memory.html#verify-inventories-and-allocations">Verify inventories and allocations</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="emulated-tpm.html">Emulated Trusted Platform Module (vTPM)</a><ul> <li class="toctree-l2"><a class="reference internal" href="emulated-tpm.html#enabling-vtpm">Enabling vTPM</a></li> <li class="toctree-l2"><a class="reference internal" href="emulated-tpm.html#configuring-a-flavor-or-image">Configuring a flavor or image</a></li> <li class="toctree-l2"><a class="reference internal" href="emulated-tpm.html#limitations">Limitations</a></li> <li class="toctree-l2"><a class="reference internal" href="emulated-tpm.html#security">Security</a></li> <li class="toctree-l2"><a class="reference internal" href="emulated-tpm.html#references">References</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="uefi.html">UEFI</a><ul> <li class="toctree-l2"><a class="reference internal" href="uefi.html#enabling-uefi">Enabling UEFI</a></li> <li class="toctree-l2"><a class="reference internal" href="uefi.html#configuring-a-flavor-or-image">Configuring a flavor or image</a></li> <li class="toctree-l2"><a class="reference internal" href="uefi.html#references">References</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="secure-boot.html">Secure Boot</a><ul> <li class="toctree-l2"><a class="reference internal" href="secure-boot.html#enabling-secure-boot">Enabling Secure Boot</a></li> <li class="toctree-l2"><a class="reference internal" href="secure-boot.html#configuring-a-flavor-or-image">Configuring a flavor or image</a></li> <li class="toctree-l2"><a class="reference internal" href="secure-boot.html#references">References</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="sev.html">AMD SEV (Secure Encrypted Virtualization)</a><ul> <li class="toctree-l2"><a class="reference internal" href="sev.html#enabling-sev">Enabling SEV</a></li> <li class="toctree-l2"><a class="reference internal" href="sev.html#configuring-a-flavor-or-image">Configuring a flavor or image</a></li> <li class="toctree-l2"><a class="reference internal" href="sev.html#limitations">Limitations</a></li> <li class="toctree-l2"><a class="reference internal" href="sev.html#references">References</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="managing-resource-providers.html">Managing Resource Providers Using Config Files</a><ul> <li class="toctree-l2"><a class="reference internal" href="managing-resource-providers.html#placing-files">Placing Files</a></li> <li class="toctree-l2"><a class="reference internal" href="managing-resource-providers.html#examples">Examples</a></li> <li class="toctree-l2"><a class="reference internal" href="managing-resource-providers.html#schema-example">Schema Example</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="compute-node-identification.html">Compute Node Identification</a><ul> <li class="toctree-l2"><a class="reference internal" href="compute-node-identification.html#self-provisioning-of-the-node-identity">Self-provisioning of the node identity</a></li> <li class="toctree-l2"><a class="reference internal" href="compute-node-identification.html#deployment-provisioning-of-the-node-identity">Deployment provisioning of the node identity</a></li> <li class="toctree-l2"><a class="reference internal" href="compute-node-identification.html#upgrading-from-pre-2023-1">Upgrading from pre-2023.1</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="resource-limits.html">Resource Limits</a><ul> <li class="toctree-l2"><a class="reference internal" href="resource-limits.html#configuring-resource-limits">Configuring resource limits</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="cpu-models.html">CPU models</a><ul> <li class="toctree-l2"><a class="reference internal" href="cpu-models.html#cpu-modes">CPU modes</a></li> <li class="toctree-l2"><a class="reference internal" href="cpu-models.html#id3">CPU models</a></li> <li class="toctree-l2"><a class="reference internal" href="cpu-models.html#cpu-feature-flags">CPU feature flags</a></li> <li class="toctree-l2"><a class="reference internal" href="cpu-models.html#mitigation-for-mds-microarchitectural-data-sampling-security-flaws">Mitigation for MDS (“Microarchitectural Data Sampling”) Security Flaws</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="libvirt-misc.html">Other libvirt features</a><ul> <li class="toctree-l2"><a class="reference internal" href="libvirt-misc.html#guest-agent-support">Guest agent support</a></li> <li class="toctree-l2"><a class="reference internal" href="libvirt-misc.html#watchdog-behavior">Watchdog behavior</a></li> <li class="toctree-l2"><a class="reference internal" href="libvirt-misc.html#random-number-generator">Random number generator</a></li> <li class="toctree-l2"><a class="reference internal" href="libvirt-misc.html#performance-monitoring-unit-vpmu">Performance Monitoring Unit (vPMU)</a></li> <li class="toctree-l2"><a class="reference internal" href="libvirt-misc.html#hiding-hypervisor-signature">Hiding hypervisor signature</a></li> <li class="toctree-l2"><a class="reference internal" href="libvirt-misc.html#locked-memory-allocation">Locked memory allocation</a></li> </ul> </li> </ul> </div> </section> <section id="maintenance"> <h2>Maintenance<a class="headerlink" href="#maintenance" title="Link to this heading">¶</a></h2> <p>Once you are running nova, the following information is extremely useful.</p> <ul class="simple"> <li><p><a class="reference internal" href="upgrades.html"><span class="doc">Upgrades</span></a>: How nova is designed to be upgraded for minimal service impact, and the order you should do them in.</p></li> </ul> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="support-compute.html">Troubleshoot Compute</a><ul> <li class="toctree-l2"><a class="reference internal" href="troubleshooting/orphaned-allocations.html">Orphaned resource allocations</a></li> <li class="toctree-l2"><a class="reference internal" href="troubleshooting/rebuild-placement-db.html">Rebuild placement DB</a></li> <li class="toctree-l2"><a class="reference internal" href="troubleshooting/affinity-policy-violated.html">Affinity policy violated with parallel requests</a></li> <li class="toctree-l2"><a class="reference internal" href="support-compute.html#compute-service-logging">Compute service logging</a></li> <li class="toctree-l2"><a class="reference internal" href="support-compute.html#guru-meditation-reports">Guru Meditation reports</a></li> <li class="toctree-l2"><a class="reference internal" href="support-compute.html#common-errors-and-fixes-for-compute">Common errors and fixes for Compute</a></li> <li class="toctree-l2"><a class="reference internal" href="support-compute.html#credential-errors-401-and-403-forbidden-errors">Credential errors, 401, and 403 forbidden errors</a></li> <li class="toctree-l2"><a class="reference internal" href="support-compute.html#live-migration-permission-issues">Live migration permission issues</a></li> <li class="toctree-l2"><a class="reference internal" href="support-compute.html#instance-errors">Instance errors</a></li> <li class="toctree-l2"><a class="reference internal" href="support-compute.html#empty-log-output-for-linux-instances">Empty log output for Linux instances</a></li> <li class="toctree-l2"><a class="reference internal" href="support-compute.html#reset-the-state-of-an-instance">Reset the state of an instance</a></li> <li class="toctree-l2"><a class="reference internal" href="support-compute.html#injection-problems">Injection problems</a></li> <li class="toctree-l2"><a class="reference internal" href="support-compute.html#cannot-find-suitable-emulator-for-x86-64">Cannot find suitable emulator for x86_64</a></li> <li class="toctree-l2"><a class="reference internal" href="support-compute.html#failed-to-attach-volume-after-detaching">Failed to attach volume after detaching</a></li> <li class="toctree-l2"><a class="reference internal" href="support-compute.html#failed-to-attach-volume-systool-is-not-installed">Failed to attach volume, systool is not installed</a></li> <li class="toctree-l2"><a class="reference internal" href="support-compute.html#failed-to-connect-volume-in-fc-san">Failed to connect volume in FC SAN</a></li> <li class="toctree-l2"><a class="reference internal" href="support-compute.html#multipath-call-failed-exit">Multipath call failed exit</a></li> <li class="toctree-l2"><a class="reference internal" href="support-compute.html#failed-to-attach-volume-missing-sg-scan">Failed to Attach Volume, Missing sg_scan</a></li> <li class="toctree-l2"><a class="reference internal" href="support-compute.html#requested-microversions-are-ignored">Requested microversions are ignored</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="evacuate.html">Evacuate instances</a><ul> <li class="toctree-l2"><a class="reference internal" href="evacuate.html#evacuate-a-single-instance">Evacuate a single instance</a></li> <li class="toctree-l2"><a class="reference internal" href="evacuate.html#evacuate-all-instances">Evacuate all instances</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="migration.html">Migrate instances</a><ul> <li class="toctree-l2"><a class="reference internal" href="migration.html#example">Example</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="migrate-instance-with-snapshot.html">Use snapshots to migrate instances</a><ul> <li class="toctree-l2"><a class="reference internal" href="migrate-instance-with-snapshot.html#create-a-snapshot-of-the-instance">Create a snapshot of the instance</a></li> <li class="toctree-l2"><a class="reference internal" href="migrate-instance-with-snapshot.html#download-the-snapshot-as-an-image">Download the snapshot as an image</a></li> <li class="toctree-l2"><a class="reference internal" href="migrate-instance-with-snapshot.html#import-the-snapshot-to-the-new-environment">Import the snapshot to the new environment</a></li> <li class="toctree-l2"><a class="reference internal" href="migrate-instance-with-snapshot.html#boot-a-new-instance-from-the-snapshot">Boot a new instance from the snapshot</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="upgrades.html">Upgrades</a><ul> <li class="toctree-l2"><a class="reference internal" href="upgrades.html#minimal-downtime-upgrade-process">Minimal Downtime Upgrade Process</a></li> <li class="toctree-l2"><a class="reference internal" href="upgrades.html#current-database-upgrade-types">Current Database Upgrade Types</a></li> <li class="toctree-l2"><a class="reference internal" href="upgrades.html#concepts">Concepts</a></li> <li class="toctree-l2"><a class="reference internal" href="upgrades.html#testing">Testing</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="node-down.html">Recover from a failed compute node</a><ul> <li class="toctree-l2"><a class="reference internal" href="node-down.html#evacuate-instances">Evacuate instances</a></li> <li class="toctree-l2"><a class="reference internal" href="node-down.html#manual-recovery">Manual recovery</a></li> <li class="toctree-l2"><a class="reference internal" href="node-down.html#recover-from-a-uid-gid-mismatch">Recover from a UID/GID mismatch</a></li> <li class="toctree-l2"><a class="reference internal" href="node-down.html#recover-cloud-after-disaster">Recover cloud after disaster</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="hw-machine-type.html">hw_machine_type - Configuring and updating QEMU instance machine types</a><ul> <li class="toctree-l2"><a class="reference internal" href="hw-machine-type.html#introduction">Introduction</a></li> <li class="toctree-l2"><a class="reference internal" href="hw-machine-type.html#configure">Configure</a></li> <li class="toctree-l2"><a class="reference internal" href="hw-machine-type.html#update">Update</a></li> <li class="toctree-l2"><a class="reference internal" href="hw-machine-type.html#device-bus-and-model-image-properties">Device bus and model image properties</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="hw-emulation-architecture.html">hw_emulation_architecture - Configuring QEMU instance emulation architecture</a><ul> <li class="toctree-l2"><a class="reference internal" href="hw-emulation-architecture.html#introduction">Introduction</a></li> <li class="toctree-l2"><a class="reference internal" href="hw-emulation-architecture.html#configure">Configure</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="soft-delete-shadow-tables.html">Soft Delete and Shadow Tables</a><ul> <li class="toctree-l2"><a class="reference internal" href="soft-delete-shadow-tables.html#soft-delete-instances-that-can-be-restored">Soft delete instances that can be restored</a></li> <li class="toctree-l2"><a class="reference internal" href="soft-delete-shadow-tables.html#soft-delete-database-rows-to-shadow-tables">Soft delete database rows to shadow tables</a></li> </ul> </li> </ul> </div> </section> </section> </div> </div> </div> <div class="docs-actions"> <a href="../user/wsgi.html"><i class="fa fa-angle-double-left" data-toggle="tooltip" data-placement="top" title="Previous: Using WSGI with Nova"></i></a> <a href="aggregates.html"><i class="fa fa-angle-double-right" data-toggle="tooltip" data-placement="top" title="Next: Host aggregates"></i></a> <a id="pdfLink2" href="" target="_blank" title="Download the manuals as PDF"><i class="fa fa-file-pdf-o" data-toggle="tooltip" data-placement="top" title="Download PDF"></i></a> <a id="logABugLink3" href="" target="_blank" title="Found an error? Report a bug against this page"><i class="fa fa-bug" data-toggle="tooltip" data-placement="top" title="Report a Bug"></i></a> </div> <div class="row docs-byline bottom"> <div class="docs-updated">this page last updated: 2023-12-12 14:27:00</div> </div> <div class="row"> <div class="col-lg-8 col-md-8 col-sm-8 docs-license"> <a href="https://creativecommons.org/licenses/by/3.0/"> <img src="../_static/images/docs/license.png" alt="Creative Commons Attribution 3.0 License"/> </a> <p> Except where otherwise noted, this document is licensed under <a href="https://creativecommons.org/licenses/by/3.0/">Creative Commons Attribution 3.0 License</a>. See all <a href="https://www.openstack.org/legal"> OpenStack Legal Documents</a>. </p> </div> <div class="col-lg-4 col-md-4 col-sm-4 docs-actions-wrapper"> <!-- ID buglinkbottom added so that pre-filled doc bugs are sent to Launchpad projects related to the document --> <a href="#" id="logABugLink2" class="docs-footer-actions"><i class="fa fa-bug"></i> found an error? report a bug</a> </div> </div> </div> <div class="col-lg-3 col-md-4 col-sm-4 col-lg-pull-9 col-md-pull-8 col-sm-pull-8 docs-sidebar"> <div class="btn-group docs-sidebar-releases"> <button onclick="location.href='/'" class="btn docs-sidebar-home" data-toggle="tooltip" data-placement="top" title="OpenStack Docs Home"><i class="fa fa-arrow-circle-o-left"></i></button> <button type="button" data-toggle="dropdown" class="btn docs-sidebar-release-select">OpenStack Documentation<i class="fa fa-caret-down"></i></button> <ul class="dropdown-menu docs-sidebar-dropdown" role="menu"> <li role="presentation" class="dropdown-header">Guides</li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/index.html#install-guides">Install Guides</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/index.html#user-guides">User Guides</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/index.html#configuration-guides">Configuration Guides</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/index.html#ops-and-admin-guides">Operations and Administration Guides</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/index.html#api-guides">API Guides</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/index.html#contributor-guides">Contributor Guides</a></li> <li role="presentation" class="dropdown-header">Languages</li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/de/">Deutsch (German)</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/fr/">Français (French)</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/id/">Bahasa Indonesia (Indonesian)</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/it/">Italiano (Italian)</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/ja/">日本語 (Japanese)</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/ko_KR/">한국어 (Korean)</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/pt_BR/">Português (Portuguese)</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/tr_TR/">Türkçe (Türkiye)</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/zh_CN/">简体中文 (Simplified Chinese)</a></li> </ul> </div> <div class="docs-sidebar-toc"> <div class="docs-sidebar-section" id="table-of-contents"> <a href="../index.html" class="docs-sidebar-section-title"><h4>nova 30.0.1.dev5</h4></a> <ul> <li class="toctree-l1"><a class="reference internal" href="../install/index.html">Compute service</a></li> </ul> </div> <div class="docs-sidebar-toc"> <div class="docs-sidebar-section" id="local-table-of-contents"> <h4 class="docs-sidebar-section-title">Page Contents</h4> <ul> <li><a class="reference internal" href="#">Admin Documentation</a><ul> <li><a class="reference internal" href="#overview">Overview</a></li> <li><a class="reference internal" href="#deployment-considerations">Deployment Considerations</a></li> <li><a class="reference internal" href="#basic-configuration">Basic configuration</a></li> <li><a class="reference internal" href="#advanced-configuration">Advanced configuration</a></li> <li><a class="reference internal" href="#maintenance">Maintenance</a></li> </ul> </li> </ul> </div> </div> </div> </div> </div> </div> <footer> <div class="container"> <div class="row footer-links"> <div class="col-lg-2 col-sm-2"> <h3>OpenStack</h3> <ul> <li><a href="https://www.openstack.org/software/project-navigator/">Projects</a></li> <li><a href="https://security.openstack.org/">OpenStack Security</a></li> <li><a href="https://openstack.org/blog/">Blog</a></li> <li><a href="https://openstack.org/news/">News</a></li> </ul> </div> <div class="col-lg-2 col-sm-2"> <h3>Community</h3> <ul> <li><a href="https://www.meetup.com/pro/openinfradev/">User Groups</a></li> <li><a href="https://openstack.org/community/events/">Events</a></li> <li><a href="https://openstack.org/community/jobs/">Jobs</a></li> <li><a href="https://openinfra.dev/members/">Companies</a></li> <li><a href="https://docs.openstack.org/contributors">Contribute</a></li> </ul> </div> <div class="col-lg-2 col-sm-2"> <h3>Documentation</h3> <ul> <li><a href="https://docs.openstack.org">OpenStack Manuals</a></li> <li><a href="https://openstack.org/software/start/">Getting Started</a></li> <li><a href="https://developer.openstack.org">API Documentation</a></li> <li><a href="https://wiki.openstack.org">Wiki</a></li> </ul> </div> <div class="col-lg-2 col-sm-2"> <h3>Branding & Legal</h3> <ul> <li><a href="https://openinfra.dev/legal">Legal Docs</a></li> <li><a href="https://openstack.org/brand/">Logos & Guidelines</a></li> <li><a href="https://openinfra.dev/legal/trademark-policy">Trademark Policy</a></li> <li><a href="https://openinfra.dev/privacy-policy">Privacy Policy</a></li> <li><a href="https://docs.openstack.org/contributors/common/setup-gerrit.html#individual-contributor-license-agreement">OpenInfra CLA</a></li> </ul> </div> <div class="col-lg-4 col-sm-4"> <h3>Stay In Touch</h3> <a href="https://twitter.com/OpenStack" target="_blank" class="social-icons footer-twitter"></a> <a href="https://www.facebook.com/openinfradev" target="_blank" class="social-icons footer-facebook"></a> <a href="https://www.linkedin.com/company/open-infrastructure-foundation" target="_blank" class="social-icons footer-linkedin"></a> <a href="https://www.youtube.com/user/OpenStackFoundation" target="_blank" class="social-icons footer-youtube"></a> <p class="fine-print"> The OpenStack project is provided under the <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache 2.0 license</a>. Docs.openstack.org is powered by <a href="https://rackspace.com" target="_blank">Rackspace Cloud Computing</a>. </p> </div> </div> </div> </footer> <!-- jQuery --> <script src="../_static/js/jquery-3.2.1.min.js"></script> <!-- Bootstrap JavaScript --> <script src="../_static/js/bootstrap.min.js"></script> <!-- The rest of the JS --> <script src="../_static/js/navigation.js"></script> <!-- Docs JS --> <script src="../_static/js/docs.js"></script> <!-- Javascript for page --> <script> /* Build a description of this page including SHA, source location on git * repo, build time and the project's launchpad bug tag. Set the HREF of the * bug buttons */ var lineFeed = "%0A"; var gitURL = "Source: Can't derive source file URL"; /* there have been cases where "pagename" wasn't set; better check for it */ /* "giturl" is the URL of the source file on Git and is auto-generated by * openstackdocstheme. * * "pagename" is a standard sphinx parameter containing the name of * the source file, without extension. */ var sourceFile = "admin/index" + ".rst"; gitURL = "Source: https://opendev.org/openstack/nova/src/doc/source" + "/" + sourceFile; /* gitsha, project and bug_tag rely on variables in conf.py */ var gitSha = "SHA: 89c07d735319801b192ddc1db0d6a8ce7abea2fc"; var repositoryName = "openstack/nova"; var bugProject = "nova"; var bugTitle = "Admin Documentation in nova"; var fieldTags = "doc"; var useStoryboard = ""; /* "last_updated" is the build date and time. It relies on the conf.py variable "html_last_updated_fmt", which should include year/month/day as well as hours and minutes */ var buildstring = "Release: 30.0.1.dev5 on 2023-12-12 14:27:00"; var fieldComment = encodeURI(buildstring) + lineFeed + encodeURI(gitSha) + lineFeed + encodeURI(gitURL) ; logABug(bugTitle, bugProject, fieldComment, fieldTags, repositoryName, useStoryboard); var currentSourceFile = "admin/index"; var pdfFileName = "doc-nova.pdf"; pdfLink(currentSourceFile, pdfFileName); </script> <script> $(document).ready(function(){ $.ajax({ context: this, dataType : "html", url : "https://docs.openstack.org/2024.2/badge.html", success : function(results) { $('#deprecated-badge-container').html(results); } }); }); </script> <div id="deprecated-badge-container"></div> </body> </html>