Merge remote-tracking branch 'apache/4.15' into main

Author: davidjumani

source/adminguide/virtual_machines.rst

@@ -127,33 +127,35 @@ To create a VM from a template:
 
 #. Log in to the CloudStack UI as an administrator or user.
 
-#. In the left navigation bar, click Instances.
+#. In the left navigation bar, click Compute -> Instances.
 
-#. Click Add Instance.
+#. Click the Add Instance button.
 
 #. Select a zone. Admin users will have the option to select a pod, cluster or host.
 
-#. Select a template, then follow the steps in the wizard. For more
-   information about how the templates came to be in this list, see
-   `*Working with Templates* <templates.html>`_.
+#. Select a template or ISO. For more information about how the templates came
+   to be in this list, see `*Working with Templates* <templates.html>`_.
 
 #. Be sure that the hardware you have allows starting the selected
    service offering.
 
+#. Select a disk offering.
+
+#. Select/Add a network.
+
+
    .. note::
       VMware only: If the selected template contains OVF properties, different deployment options or configurations,
       multiple NICs or end-user license agreements, then the wizard will display these properties.
 
       See `“Support for Virtual Appliances” <virtual_machines.html#support-for-virtual-appliances>`_.
 
-#. Click Submit and your VM will be created and started.
+#. Click Launch Virtual Machine and your VM will be created and started.
 
    .. note::
       For security reason, the internal name of the VM is visible
       only to the root admin.
 
-To create a VM from an ISO:
-
 .. note::
    **XenServer**
 
@@ -163,19 +165,6 @@ To create a VM from an ISO:
    functions such as mounting additional volumes and ISO images,
    live migration, and graceful shutdown.
 
-#. Log in to the CloudStack UI as an administrator or user.
-
-#. In the left navigation bar, click Instances.
-
-#. Click Add Instance.
-
-#. Select a zone. Admin users will have the option to select a pod, cluster or host.
-
-#. Select ISO Boot, and follow the steps in the wizard.
-
-#. Click Submit and your VM will be created and started.
-
-
 
 Install Required Tools and Drivers
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -217,7 +206,7 @@ To access a VM through the CloudStack UI:
 
 #. Log in to the CloudStack UI as a user or admin.
 
-#. Click Instances, then click the name of a running VM.
+#. Click Compute -> Instances, then click the name of a running VM.
 
 #. Click the View Console button |console-icon.png|.
 
@@ -272,7 +261,7 @@ To delete a virtual machine:
 
 #. Log in to the CloudStack UI as a user or admin.
 
-#. In the left navigation, click Instances.
+#. In the left navigation, click Compute -> Instances.
 
 #. Choose the VM that you want to delete.
 

source/plugins/ovs-plugin.rst

@@ -17,12 +17,21 @@
 The OVS Plugin
 ==============
 
+.. warning::
+   The OVS Plugin was not maintained in some CloudStack versions. Please use CloudStack
+   4.16.0.0 and later. If you wish to use OVS as the default networking backend on Linux,
+   only follow the Agent Configuration part of this guide.
+   CloudStack will automatically detect it up based on the configuration in the
+   agent.properties file. This in spite of the OVS Plugin not being shown in the
+   Network Service Providers.
+
+
 Introduction to the OVS Plugin
 ------------------------------
 
 The OVS plugin is the native SDN
-implementations in CloudStack, using GRE isolation method. The plugin can be 
-used by CloudStack to implement isolated guest networks and to provide 
+implementations in CloudStack, using GRE isolation method. The plugin can be
+used by CloudStack to implement isolated guest networks and to provide
 additional services like NAT, port forwarding and load balancing.
 
 
@@ -48,12 +57,6 @@ the OVS Plugin.
 
 Table: Supported Services
 
-.. note::
-   If you wish to use OVS as the default networking backend on Linux,
-   just follow this guide and CloudStack will automatically pick it up
-   based on the configuration in the agent.properties file. This in spite
-   of the OVS Plugin not being shown in the Network Service Providers.
-
 .. note::
    The Virtual Networking service was originally called 'Connectivity'
    in CloudStack 4.0
@@ -79,20 +82,19 @@ Configuring the OVS Plugin
 Prerequisites
 ~~~~~~~~~~~~~
 
-Before enabling the OVS plugin the hypervisor needs to be install OpenvSwitch. 
-Default, XenServer has already installed OpenvSwitch. However, you must 
-install OpenvSwitch manually on KVM. CentOS 6.4 and OpenvSwitch 1.10 are 
+Before enabling the OVS plugin the hypervisor needs to be install OpenvSwitch.
+Default, XenServer has already installed OpenvSwitch. However, you must
+install OpenvSwitch manually on KVM. CentOS 6.4 and OpenvSwitch 1.10 are
 recommended.
 
 KVM hypervisor:
 
 -  CentOS 6.4 is recommended.
 
--  To make sure that the native bridge module will not interfere with 
-   openvSwitch the bridge module should be added to the denylist. See the 
-   modprobe documentation for your distribution on where to find the denylist
-   (likely named 'denylist'). 
-   Make sure the module is not loaded either by rebooting or executing rmmod 
+-  To make sure that the native bridge module will not interfere with
+   openvSwitch the bridge module should be added to the blacklist. See the
+   modprobe documentation for your distribution on where to find the blacklist.
+   Make sure the module is not loaded either by rebooting or executing rmmod
    bridge before executing next steps.
 
 
@@ -105,7 +107,7 @@ traffic type.
 
 .. note::
    With KVM, the traffic type should be configured with the traffic label
-   that matches the name of the Integration Bridge on the hypervisor. For 
+   that matches the name of the Integration Bridge on the hypervisor. For
    example, you should set the traffic label as following:
 
    -  Management & Storage traffic: cloudbr0
@@ -128,7 +130,7 @@ Agent Configuration
 -  Configure network interfaces:
 
    ::
-      
+
       /etc/sysconfig/network-scripts/ifcfg-eth0
       DEVICE=eth0
       BOOTPROTO=none
@@ -138,7 +140,7 @@ Agent Configuration
       TYPE=OVSPort
       DEVICETYPE=ovs
       OVS_BRIDGE=cloudbr0
-    
+
       /etc/sysconfig/network-scripts/ifcfg-eth1
       DEVICE=eth1
       BOOTPROTO=none
@@ -148,7 +150,7 @@ Agent Configuration
       TYPE=OVSPort
       DEVICETYPE=ovs
       OVS_BRIDGE=cloudbr1
-    
+
       /etc/sysconfig/network-scripts/ifcfg-cloudbr0
       DEVICE=cloudbr0
       ONBOOT=yes
@@ -159,15 +161,15 @@ Agent Configuration
       GATEWAY=172.16.10.1
       NETMASK=255.255.255.0
       HOTPLUG=no
-    
+
       /etc/sysconfig/network-scripts/ifcfg-cloudbr1
       DEVICE=cloudbr1
       ONBOOT=yes
       DEVICETYPE=ovs
       TYPE=OVSBridge
       BOOTPROTO=none
       HOTPLUG=no
-    
+
       /etc/sysconfig/network
       NETWORKING=yes
       HOSTNAME=testkvm1
@@ -176,7 +178,7 @@ Agent Configuration
 -  Edit /etc/cloudstack/agent/agent.properties
 
    ::
-      
+
       network.bridge.type=openvswitch
       libvirt.vif.driver=com.cloud.hypervisor.kvm.resource.OvsVifDriver
 
@@ -287,7 +289,7 @@ Agent configuration
 -  Edit /etc/cloudstack/agent/agent.properties to enable DPDK support on the agent and on ovs-vstcl commands for port creations as well as the path to OVS ports (usually: /var/run/openvswitch)
 
    ::
-      
+
       openvswitch.dpdk.enabled=true
       openvswitch.dpdk.ovs.path=OVS_PATH
 
@@ -296,15 +298,15 @@ Agent should be restarted for actions to take effect.
 When the host agent connects to the management server, it sends the list of hosts capabilities. When DPDK support is enabled on the host, the capability with name 'dpdk' is sent to the management server. The list of host capabilities are persisted on the 'capabilities' column on 'hosts' table, and can be retrieved by the 'listHosts' API method:
 
 ::
-      
+
       list hosts id=HOST_ID filter=capabilities
 
 Additional VM configurations
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 In order to enable DPDK on VM deployments, users should pass addition configuration to VMs. The required configurations are listed on the next section. Administrators can allow users to pass additional configurations to their VMs by the account scoped setting:
 
 ::
-      
+
       enable.additional.vm.configuration
 
 Users are able to pass extra configurations as part of the 'deployVirtualMachine' or 'updateVirtualMachine' API methods.
@@ -324,7 +326,7 @@ Example:
 In order to pass the below extra configuration to the VM, named 'config-1'
 
 ::
-      
+
       config-1:
       <tag>
          <inner-tag>VALUE</inner-tag>
@@ -333,26 +335,26 @@ In order to pass the below extra configuration to the VM, named 'config-1'
 The 'extraconfig' parameter should receive the UTF-8 URL encoded string:
 
 ::
-      
+
       config-1%3A%0A%3Ctag%3E%0A%20%20%20%3Cinner-tag%3EVALUE%3C%2Finner-tag%3E%0A%3C%2Ftag%3E
 
 On 'user_vm_details' table the additional configuration is persisted with key: 'extraconfig-config-1'
 
 
-Additional configurations to enable DPDK on VMs 
+Additional configurations to enable DPDK on VMs
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 To enable DPDK on VM deployments:
 
 -  Set the global configuration to 'true' (as global setting or account setting)
 
    ::
-      
+
       enable.additional.vm.configuration
 
 -  Generate the UTF-8 URL encoded additional configuration to enable huge pages and NUMA, examples below:
 
    ::
-      
+
       dpdk-hugepages:
       <memoryBacking>
          <hugepages>
@@ -369,13 +371,13 @@ To enable DPDK on VM deployments:
 - Pass the 'extraconfig' parameter to 'deployVirtualMachine' or 'updateVirtualMachine' API methods as a single UTF-8 URL encoded string containing multiple extra configurations (as shown above). Note: if multiple extra configurations are needed, follow the example above and add new sections separated by an empty line, encode the whole string and pass it as a single string to the APIs as 'extraconfig' parameter.
 
    ::
-      
+
       deployVirtualMachine extraconfig=dpdk-hugepages%3A%0A%3CmemoryBacking%3E%0A%20%20%20%3Chugepages%3E%0A%20%20%20%20%3C%2Fhugepages%3E%0A%3C%2FmemoryBacking%3E%0A%0Adpdk-numa%3A%0A%3Ccpu%20mode%3D%22host-passthrough%22%3E%0A%20%20%20%3Cnuma%3E%0A%20%20%20%20%20%20%20%3Ccell%20id%3D%220%22%20cpus%3D%220%22%20memory%3D%229437184%22%20unit%3D%22KiB%22%20memAccess%3D%22shared%22%2F%3E%0A%20%20%20%3C%2Fnuma%3E%0A%3C%2Fcpu%3E%0A
 
 - Additionally, users can pass extra configuration named 'dpdk-interface-TAG' to be included on VMs interfaces definition. Example below:
 
    ::
-      
+
       dpdk-interface-model:
       <model type='virtio'/>
 
@@ -404,7 +406,7 @@ It is possible to avoid passing additional configuration on each VM deployment,
 For example, applying DPDK additional configurations via service offering:
 
 ::
-   
+
    create serviceoffering name=<NAME> displaytext=<NAME> serviceofferingdetails[0].key=extraconfig-dpdk-hugepages serviceofferingdetails[0].value=%3CmemoryBacking%3E%20%3Chugepages%2F%3E%20%3C%2FmemoryBacking%3E serviceofferingdetails[1].key=extraconfig-dpdk-numa serviceofferingdetails[1].value=%3Ccpu%20mode%3D%22host-passthrough%22%3E%20%3Cnuma%3E%20%3Ccell%20id%3D%220%22%20cpus%3D%220%22%20memory%3D%229437184%22%20unit%3D%22KiB%22%20memAccess%3D%22shared%22%2F%3E%20%3C%2Fnuma%3E%20%3C%2Fcpu%3E
 
 The preferred DPDK vHost User Mode must be passed as a service offering detail, with special key name: "DPDK-VHOSTUSER". Possible values are: "client" or "server". The following table illustrates the expected behaviour on DPDK ports and VM guest interfaces.
@@ -420,7 +422,7 @@ By default, the server mode is assumed if it is not passed as a service offering
 +----------------------+------------------------+-------------------------+
 
 ::
-   
+
    create serviceoffering name=<NAME> displaytext=<NAME> serviceofferingdetails[0].key=DPDK-VHOSTUSER serviceofferingdetails[0].value=client serviceofferingdetails[1].key=extraconfig-dpdk-hugepages serviceofferingdetails[1].value=%3CmemoryBacking%3E%20%3Chugepages%2F%3E%20%3C%2FmemoryBacking%3E serviceofferingdetails[2].key=extraconfig-dpdk-numa serviceofferingdetails[2].value=%3Ccpu%20mode%3D%22host-passthrough%22%3E%20%3Cnuma%3E%20%3Ccell%20id%3D%220%22%20cpus%3D%220%22%20memory%3D%229437184%22%20unit%3D%22KiB%22%20memAccess%3D%22shared%22%2F%3E%20%3C%2Fnuma%3E%20%3C%2Fcpu%3E
 
 DPDK VMs live migrations