From e421478fad055e64ddc5cbd5c691aa9609ca389a Mon Sep 17 00:00:00 2001 From: Sean Dague Date: Tue, 10 Jul 2012 19:36:21 -0400 Subject: [PATCH] connection_type => compute_driver Convert examples that use connection_type to compute_driver with appropriate driver strings. There probably needs to be slightly more explanation of the change. Also, there are additional tables that are not modified by this patch, as I was unclear if they were autogenerated or not. Patchset does an include for updates to the hypervisor config table and common config table with the new compute_driver settings. Change-Id: I5cdfb1a59c9029760de4796127bfbe16f4306d4c --- doc/src/docbkx/common/introduction-to-xen.xml | 5 +- doc/src/docbkx/common/kvm.xml | 3 +- doc/src/docbkx/common/lxc.xml | 3 +- doc/src/docbkx/common/qemu.xml | 7 +- .../computeconfigure.xml | 29 ++-- .../computehypervisors.xml | 124 +----------------- .../tables/common-nova-conf.xml | 25 +++- .../tables/hypervisors-nova-conf.xml | 12 +- .../openstack-install/samples/nova.conf | 2 +- 9 files changed, 60 insertions(+), 150 deletions(-) diff --git a/doc/src/docbkx/common/introduction-to-xen.xml b/doc/src/docbkx/common/introduction-to-xen.xml index 28a472df5c..8c7da057b2 100644 --- a/doc/src/docbkx/common/introduction-to-xen.xml +++ b/doc/src/docbkx/common/introduction-to-xen.xml @@ -9,7 +9,7 @@ The recommended way to use Xen with OpenStack is through the XenAPI driver. To enable the XenAPI driver, add the following configuration options /etc/nova/nova.conf: -connection_type=xenapi +compute_driver=xenapi.XenAPIDriver xenapi_connection_url=http://your_xenapi_management_ip_address xenapi_connection_username=root xenapi_connection_password=your_password @@ -39,7 +39,7 @@ Linux or Oracle Linux. Unfortunately, this is not well tested or supported as of the Essex release. To experiment using Xen through libvirt add the following configuration options /etc/nova/nova.conf: -connection_type=libvirt +compute_driver=libvirt.LibvirtDriver libvirt_type=xen The rest of this section describes Xen, XCP, and XenServer, the @@ -344,3 +344,4 @@ XenAPI plugins Readme. + diff --git a/doc/src/docbkx/common/kvm.xml b/doc/src/docbkx/common/kvm.xml index 442da1909b..593960483d 100644 --- a/doc/src/docbkx/common/kvm.xml +++ b/doc/src/docbkx/common/kvm.xml @@ -7,7 +7,7 @@ KVM KVM is configured as the default hypervisor for Compute. To enable KVM explicitly, add the following configuration options - /etc/nova/nova.conf:connection_type=libvirt + /etc/nova/nova.conf:compute_driver=libvirt.LibvirtDriver libvirt_type=kvm The KVM hypervisor supports the following virtual machine image formats: @@ -127,3 +127,4 @@ kvm-amd This is a symptom that the KVM kernel modules have not been loaded. + diff --git a/doc/src/docbkx/common/lxc.xml b/doc/src/docbkx/common/lxc.xml index c6db4f507f..179318f4c3 100644 --- a/doc/src/docbkx/common/lxc.xml +++ b/doc/src/docbkx/common/lxc.xml @@ -16,9 +16,10 @@ xml:id="lxc"> To enable LXC, ensure the following options are set in /etc/nova/nova.conf on all hosts running the nova-compute - service.connection_type=libvirt + service.compute_driver=libvirt.LibvirtDriver libvirt_type=lxc On Ubuntu 12.04, enable LXC support in OpenStack by installing the nova-compute-lxc package. + diff --git a/doc/src/docbkx/common/qemu.xml b/doc/src/docbkx/common/qemu.xml index 10fbb4575c..cc9279a03f 100644 --- a/doc/src/docbkx/common/qemu.xml +++ b/doc/src/docbkx/common/qemu.xml @@ -24,7 +24,7 @@ (e.g., if you are running Compute inside of a VM and the hypervisor does not expose the required hardware support), you can use QEMU instead. KVM and QEMU have the same level of support in OpenStack, but KVM will provide better performance. To enable - QEMU:connection_type=libvirt + QEMU:compute_driver=libvirt.LibvirtDriver libvirt_type=qemu The QEMU hypervisor supports the following virtual machine image formats: @@ -47,7 +47,8 @@ libvirt_type=qemu $> setsebool -P virt_use_execmem on $> sudo ln -s /usr/libexec/qemu-kvm /usr/bin/qemu-system-x86_64 $> sudo service libvirtd restart - - + + + diff --git a/doc/src/docbkx/openstack-compute-admin/computeconfigure.xml b/doc/src/docbkx/openstack-compute-admin/computeconfigure.xml index 4c2cabd3de..43cb828eb4 100644 --- a/doc/src/docbkx/openstack-compute-admin/computeconfigure.xml +++ b/doc/src/docbkx/openstack-compute-admin/computeconfigure.xml @@ -11,10 +11,10 @@ The OpenStack system has several key projects that are separate installations but can work together depending on your cloud needs: OpenStack - Compute, OpenStack Object Storage, and OpenStack Image Store. There are basic configuration - decisions to make, and the OpenStack Install Guide + Compute, OpenStack Object Storage, and OpenStack Image Store. There are basic configuration + decisions to make, and the OpenStack Install Guide covers a basic walkthrough. - +
Post-Installation Configuration for OpenStack Compute @@ -332,10 +332,10 @@ $ sudo service nova-compute restart $ nova-manage version list
- +
Diagnose your compute nodes - + You can obtain extra informations about the running virtual machines : their CPU usage, the memory, the disk io or network io, per instance, by running the nova @@ -493,7 +493,7 @@ sql_connection=mysql://root:<password>@127.0.0.1/nova network_manager=nova.network.manager.FlatManager image_service=nova.image.glance.GlanceImageService flat_network_bridge=xenbr0 -connection_type=xenapi +compute_driver=xenapi.XenAPIDriver xenapi_connection_url=https://<XenServer IP> xenapi_connection_username=root xenapi_connection_password=supersecret @@ -561,7 +561,7 @@ xenapi_remap_vbd_dev=true for additional information. To customize authorization settings for Compute, see these configuration settings in nova.conf. - + To customize certificate authority settings for Compute, see these configuration settings in nova.conf. @@ -597,7 +597,7 @@ xenapi_remap_vbd_dev=true networking: $ sudo apt-get install -y radvd -$ sudo bash -c "echo 1 > /proc/sys/net/ipv6/conf/all/forwarding" +$ sudo bash -c "echo 1 > /proc/sys/net/ipv6/conf/all/forwarding" $ sudo bash -c "echo 0 > /proc/sys/net/ipv6/conf/all/accept_ra" Edit the nova.conf file on all nodes to @@ -628,7 +628,7 @@ xenapi_remap_vbd_dev=true Note that vlan_start and vpn_start parameters are not used by FlatDHCPManager. - +
@@ -669,7 +669,7 @@ xenapi_remap_vbd_dev=true Shared storage: NOVA-INST-DIR/instances/ (eg /var/lib/nova/instances) has to be - mounted by shared storage. This guide uses NFS but other options, + mounted by shared storage. This guide uses NFS but other options, including the OpenStack Gluster Connector are available. @@ -687,7 +687,7 @@ xenapi_remap_vbd_dev=true This guide assumes the default value for instances_path in your nova.conf - ("NOVA-INST-DIR/instances"). If you have changed the state_path or + ("NOVA-INST-DIR/instances"). If you have changed the state_path or instances_path variables, please modify accordingly This feature for cloud administrators only, since the use of nova-manage is necessary. @@ -742,12 +742,12 @@ xenapi_remap_vbd_dev=true the Ubuntu NFS HowTo to setup an NFS server on HostA, and NFS Clients on HostB and HostC. - Our aim is to export NOVA-INST-DIR/instances from HostA, + Our aim is to export NOVA-INST-DIR/instances from HostA, and have it readable and writable by the nova user on HostB and HostC. - Using your knowledge from the Ubuntu documentation, configure the + Using your knowledge from the Ubuntu documentation, configure the NFS server at HostA by adding a line to /etc/exports $ NOVA-INST-DIR/instances HostA/255.255.0.0(rw,sync,fsid=0,no_root_squash) @@ -864,7 +864,7 @@ root 1145 1 0 Nov27 ? 00:00:03 /usr/sbin/libvirtd -d -l - +
@@ -1463,3 +1463,4 @@ limits =(POST, "*", .*, 10, MINUTE);(POST, "*/servers", ^/servers, 50, DAY);(PUT
+ diff --git a/doc/src/docbkx/openstack-compute-admin/computehypervisors.xml b/doc/src/docbkx/openstack-compute-admin/computehypervisors.xml index b59f63cbe9..a127f46408 100644 --- a/doc/src/docbkx/openstack-compute-admin/computehypervisors.xml +++ b/doc/src/docbkx/openstack-compute-admin/computehypervisors.xml @@ -7,7 +7,7 @@ This section assumes you have a working installation of OpenStack Compute and want to select a particular hypervisor or run with multiple hypervisors. Before you try to get a VM running within OpenStack Compute, be sure you have installed a hypervisor and used the - hypervisor's documentation to run a test VM and get it working. + hypervisor's documentation to run a test VM and get it working.
Selecting a Hypervisor OpenStack Compute supports many hypervisors, an array of which must provide a bit of @@ -34,132 +34,17 @@ VMWare ESX/ESXi 4.1 update 1, runs VMWare-based Linux and Windows images through a connection with the ESX server. - Xen - XenServer, + Xen - XenServer, Xen Cloud Platform (XCP), use to run Linux or Windows virtual machines. You must install the nova-compute service in a para-virtualized VM. -
+
Hypervisor Configuration Basics The node where the nova-compute service is installed and running is the machine that runs all the virtual machines, referred to as the compute node in this guide. By default, the selected hypervisor is KVM. To change to another hypervisor, change the libvirt_type option in nova.conf and restart the nova-compute service. Here are the nova.conf options that are used to configure the compute node. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Description of nova.conf configuration options for the compute - node
Configuration OptionDefaultDescription
connection_typedefault: 'libvirt'libvirt, xenapi, or fake; Value that indicates the virtualization - connection type
compute_managerdefault: 'nova.compute.manager.ComputeManager'String value; Manager to use for nova-compute
compute_driverdefault: 'nova.virt.connection.get_connection'String value; Driver to use for controlling virtualization
images_pathdefault: '$state_path/images'Directory; Location where decrypted images are stored on disk (when not - using Glance)
instances_pathdefault: '$state_path/instances'Directory; Location where instances are stored on disk (when not using - Glance)
libvirt_typedefault: 'kvm'String; Libvirt domain type (valid options are: kvm, qemu, uml, xen)
allow_project_net_trafficdefault: 'true'true or false; Indicates whether to allow in-project network traffic
firewall_driverdefault: 'nova.virt.libvirt_conn.IptablesFirewallDriver'String; Firewall driver for instances, defaults to iptables
injected_network_templatedefault: ''Directory and file name; Template file for injected network - information
libvirt_uridefault: empty stringString; Override the default libvirt URI (which is dependent on libvirt_type)
libvirt_xml_templatedefault: ''Directory and file name; Libvirt XML template
libvirt_inject_passworddefault: 'false'When set, libvirt will inject the admin password into instances before startup. - An agent is not required in the instance. - The admin password is specified as part of the server create API call. If no password is - specified, then a randomly generated password is used.
use_cow_imagesdefault: 'true'true or false; Indicates whether to use copy-on-write (qcow2) images. - If set to false and using qemu or kvm, backing files will not be used.
force_raw_imagesdefault: 'true'true or false; If true, backing image files will be converted to - raw image format.
rescue_image_iddefault: 'ami-rescue'String; AMI image to use for rescue
rescue_kernel_iddefault: 'aki-rescue'String; AKI image to use for rescue
rescue_ramdisk_iddefault: 'ari-rescue'String; ARI image to use for rescue
libvirt_nonblockingdefault: 'false'When set to 'true', libvirt APIs will be called in a seperate OS thread pool to avoid blocking the main thread. - This feature is especially desirable if you use the snapshot feature, which has a notably long execution time, or have many instances in a given compute node. - The feature is experimental and is disabled by default. -
- +
@@ -168,3 +53,4 @@ + diff --git a/doc/src/docbkx/openstack-compute-admin/tables/common-nova-conf.xml b/doc/src/docbkx/openstack-compute-admin/tables/common-nova-conf.xml index 834f81a14e..322a2f8105 100644 --- a/doc/src/docbkx/openstack-compute-admin/tables/common-nova-conf.xml +++ b/doc/src/docbkx/openstack-compute-admin/tables/common-nova-conf.xml @@ -83,9 +83,28 @@ default files used are: [] - connection_type=<None> - (StrOpt) Virtualization API connection type : - libvirt, xenapi, or fake + compute_driver + default: 'nova.virt.connection.get_connection' + String value; Driver to use for controlling + virtualization. For convenience if the driver + exists under the nove.virt namespace, nova.virt + can be removed. There are 5 drivers in core + openstack: fake.FakeDriver, + libvirt.LibvirtDriver, + baremetal.BareMetalDriver, xenapi.XenAPIDriver, + vmwareapi.VMWareESXDriver. If nothing is + specified the older connection_type mechanism + will be used. Be aware that method will be + removed post Folsom release. + + + + connection_type (Deprecated) + default: 'libvirt' + libvirt, xenapi, or fake; Value that + indicates the virtualization connection + type. Deprecated as of Folsom, will be removed in + G release. diff --git a/doc/src/docbkx/openstack-compute-admin/tables/hypervisors-nova-conf.xml b/doc/src/docbkx/openstack-compute-admin/tables/hypervisors-nova-conf.xml index 9e0e663e4e..54eab4ddf1 100644 --- a/doc/src/docbkx/openstack-compute-admin/tables/hypervisors-nova-conf.xml +++ b/doc/src/docbkx/openstack-compute-admin/tables/hypervisors-nova-conf.xml @@ -151,31 +151,31 @@ vmwareapi_api_retry_count=10 (FloatOpt) The number of times we retry on failures, e.g., socket error, etc. Used only if - connection_type is vmwareapi + compute_driver is vmwareapi.VMWareESXDriver. vmwareapi_host_ip=<None> (StrOpt) URL for connection to VMWare ESX - host.Required if connection_type is vmwareapi. + host.Required if compute_driver is vmwareapi.VMWareESXDriver. vmwareapi_host_password=<None> (StrOpt) Password for connection to VMWare ESX - host. Used only if connection_type is vmwareapi. + host. Used only if compute_driver is vmwareapi.VMWareESXDriver. vmwareapi_host_username=<None> (StrOpt) Username for connection to VMWare ESX - host. Used only if connection_type is vmwareapi. + host. Used only if compute_driver is vmwareapi.VMWareESXDriver. vmwareapi_task_poll_interval=5.0 (FloatOpt) The interval used for polling of - remote tasks. Used only if connection_type is - vmwareapi + remote tasks. Used only if compute_driver is + vmwareapi.VMWareESXDriver, vmwareapi_vlan_interface=vmnic0 diff --git a/doc/src/docbkx/openstack-install/samples/nova.conf b/doc/src/docbkx/openstack-install/samples/nova.conf index a2e042774d..2030468067 100644 --- a/doc/src/docbkx/openstack-install/samples/nova.conf +++ b/doc/src/docbkx/openstack-install/samples/nova.conf @@ -19,7 +19,7 @@ sql_connection=mysql://nova:yourpassword@192.168.206.130/nova # COMPUTE libvirt_type=qemu -connection_type=libvirt +compute_driver=libvirt.LibvirtDriver instance_name_template=instance-%08x api_paste_config=/etc/nova/api-paste.ini allow_resize_to_same_host=True