From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from tama500.ecl.ntt.co.jp (tama500.ecl.ntt.co.jp [129.60.39.148]) by dpdk.org (Postfix) with ESMTP id 4A7FB5F32 for ; Mon, 18 Feb 2019 12:50:49 +0100 (CET) Received: from vc1.ecl.ntt.co.jp (vc1.ecl.ntt.co.jp [129.60.86.153]) by tama500.ecl.ntt.co.jp (8.13.8/8.13.8) with ESMTP id x1IBomU3011811; Mon, 18 Feb 2019 20:50:48 +0900 Received: from vc1.ecl.ntt.co.jp (localhost [127.0.0.1]) by vc1.ecl.ntt.co.jp (Postfix) with ESMTP id 98268EA815C; Mon, 18 Feb 2019 20:50:48 +0900 (JST) Received: from localhost.localdomain (lobster.nslab.ecl.ntt.co.jp [129.60.13.95]) by vc1.ecl.ntt.co.jp (Postfix) with ESMTP id 7CED5EA817A; Mon, 18 Feb 2019 20:50:48 +0900 (JST) From: ogawa.yasufumi@lab.ntt.co.jp To: spp@dpdk.org, ferruh.yigit@intel.com, ogawa.yasufumi@lab.ntt.co.jp Date: Mon, 18 Feb 2019 20:48:15 +0900 Message-Id: <1550490511-31683-5-git-send-email-ogawa.yasufumi@lab.ntt.co.jp> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1550490511-31683-1-git-send-email-ogawa.yasufumi@lab.ntt.co.jp> References: <1550490511-31683-1-git-send-email-ogawa.yasufumi@lab.ntt.co.jp> X-TM-AS-MML: disable Subject: [spp] [PATCH 04/20] docs: move virsh setup section X-BeenThere: spp@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: Soft Patch Panel List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 18 Feb 2019 11:50:51 -0000 From: Yasufumi Ogawa This patch is to move virsh setup section from `SPP VF` to `Getting Started Guide`. Signed-off-by: Yasufumi Ogawa --- docs/guides/gsg/howto_use.rst | 171 +++++++++++++++++++++++++- docs/guides/spp_vf/gsg/setup.rst | 163 ------------------------ docs/guides/spp_vf/use_cases/vf_ssh_login.rst | 2 +- docs/guides/use_cases/spp_nfv.rst | 4 +- 4 files changed, 173 insertions(+), 167 deletions(-) diff --git a/docs/guides/gsg/howto_use.rst b/docs/guides/gsg/howto_use.rst index cc3dd9b..d3b0ceb 100644 --- a/docs/guides/gsg/howto_use.rst +++ b/docs/guides/gsg/howto_use.rst @@ -1,7 +1,7 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright(c) 2010-2014 Intel Corporation -.. _spp_setup_howto_use: +.. _spp_gsg_howto_use: How to Use ========== @@ -26,6 +26,8 @@ If you just patch two DPDK applications on host, it is enough to use one How to use of these secondary processes is described in next chapters. +.. _spp_gsg_howto_controller: + SPP Controller -------------- @@ -226,6 +228,8 @@ Here is an example for changing command prompt. $ spp +.. _spp_gsg_howto_pri: + SPP Primary ----------- @@ -324,6 +328,8 @@ secondary processes. - -s: IP address of controller and port prepared for primary. +.. _spp_gsg_howto_sec: + SPP Secondary ------------- @@ -576,3 +582,166 @@ applications with SPP. SPP enables users to configure service function chaining between applications running on host and VMs. Usecases of network configuration are explained in the next chapter. + + +.. _spp_gsg_howto_virsh: + +Using virsh +~~~~~~~~~~~ + +First of all, please check version of qemu-kvm. + +.. code-block:: console + + $ qemu-system-x86_64 --version + +If your system does not have qemu-kvm or the version of qemu is less than 2.7, +then please install qemu following +the instruction of https://wiki.qemu.org/index.php/Hosts/Linux +to install qemu 2.7. +You may need to install libvirt-bin, +virtinst, bridge-utils packages via ``apt-get`` install to run +``virt-install``. + + +``virsh`` is a command line interface that can be used to create, destroy, +stop start and edit VMs and configure. After create an image file, +you can setup it with ``virt-install``. +``--location`` is a URL of installer and it should be +``http://archive.ubuntu.com/ubuntu/dists/xenial/main/installer-amd64/`` +for amd64. + +.. code-block:: console + + virt-install \ + --name [VM_NAME] \ + --ram 4096 \ + --disk path=/var/lib/libvirt/images/[VM_NAME].img,size=30 \ + --vcpus 4 \ + --os-type linux \ + --os-variant ubuntu16.04 \ + --network network=default \ + --graphics none \ + --console pty,target_type=serial \ + --location '[LOCATION]' \ + --extra-args 'console=ttyS0,115200n8 serial' + +You may need type the following commands through ssh to activate console. + +.. code-block:: console + + $sudo systemctl enable serial-getty@ttyS0.service + $sudo systemctl start serial-getty@ttyS0.service + + +Edit VM configuration with virsh. + +.. code-block:: console + + $ virsh edit [VM_NAME] + +You need to add ``xmlns:qemu='http://libvirt.org/schemas/domain/qemu/1.0'`` +into the domain tag because of adding ```` tag. +In addition, you need to add the tag enclosed by ```` and +````, ```` and ```` +because SPP uses vhost-user as interface with VM. +Note that number used in those tags should be the same value +(e.g. chr0,sock0,vhost-net0) and these values should correspond +to "add vhost N" (in this example 0). +MAC address used in +```` +can be specified when registering MAC address to classifier +using Secondary command. + + The following is an example of modified xml file: + +.. code-block:: xml + + + spp-vm1 + d90f5420-861a-4479-8559-62d7a1545cb9 + 4194304 + 4194304 + + + + 4 + + hvm + + + + + + + + + destroy + restart + restart + + /usr/local/bin/qemu-system-x86_64 + + + + +
+ + + + + +
+ + +
+ + + +
+ + + + + +
+ + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/guides/spp_vf/gsg/setup.rst b/docs/guides/spp_vf/gsg/setup.rst index 426033e..f0b8274 100644 --- a/docs/guides/spp_vf/gsg/setup.rst +++ b/docs/guides/spp_vf/gsg/setup.rst @@ -62,169 +62,6 @@ PCI number is inspected $ sudo $RTE_SDK/usertools/dpdk-devbind.py --bind=igb_uio PCI_NUM -.. _spp_vf_gsg_virsh_setup: - -virsh setup ------------ - -First of all, please check version of qemu-kvm. - -.. code-block:: console - - $ qemu-system-x86_64 --version - -If your system does not have qemu-kvm or the version of qemu is less than 2.7, -then please install qemu following -the instruction of https://wiki.qemu.org/index.php/Hosts/Linux -to install qemu 2.7. -You may need to install libvirt-bin, -virtinst, bridge-utils packages via ``apt-get`` install to run -``virt-install``. - - -``virsh`` is a command line interface that can be used to create, destroy, -stop start and edit VMs and configure. After create an image file, -you can setup it with ``virt-install``. -``--location`` is a URL of installer and it should be -``http://archive.ubuntu.com/ubuntu/dists/xenial/main/installer-amd64/`` -for amd64. - -.. code-block:: console - - virt-install \ - --name [VM_NAME] \ - --ram 4096 \ - --disk path=/var/lib/libvirt/images/[VM_NAME].img,size=30 \ - --vcpus 4 \ - --os-type linux \ - --os-variant ubuntu16.04 \ - --network network=default \ - --graphics none \ - --console pty,target_type=serial \ - --location '[LOCATION]' \ - --extra-args 'console=ttyS0,115200n8 serial' - -You may need type the following commands through ssh to activate console. - -.. code-block:: console - - $sudo systemctl enable serial-getty@ttyS0.service - $sudo systemctl start serial-getty@ttyS0.service - - -Edit VM configuration with virsh. - -.. code-block:: console - - $ virsh edit [VM_NAME] - -You need to add ``xmlns:qemu='http://libvirt.org/schemas/domain/qemu/1.0'`` -into the domain tag because of adding ```` tag. -In addition, you need to add the tag enclosed by ```` and -````, ```` and ```` -because SPP uses vhost-user as interface with VM. -Note that number used in those tags should be the same value -(e.g. chr0,sock0,vhost-net0) and these values should correspond -to "add vhost N" (in this example 0). -MAC address used in -```` -can be specified when registering MAC address to classifier -using Secondary command. - - The following is an example of modified xml file: - -.. code-block:: xml - - - spp-vm1 - d90f5420-861a-4479-8559-62d7a1545cb9 - 4194304 - 4194304 - - - - 4 - - hvm - - - - - - - - - destroy - restart - restart - - /usr/local/bin/qemu-system-x86_64 - - - - -
- - - - - -
- - -
- - - -
- - - - - -
- - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - Setup spp_mirror ---------------- diff --git a/docs/guides/spp_vf/use_cases/vf_ssh_login.rst b/docs/guides/spp_vf/use_cases/vf_ssh_login.rst index 719d673..a116a86 100644 --- a/docs/guides/spp_vf/use_cases/vf_ssh_login.rst +++ b/docs/guides/spp_vf/use_cases/vf_ssh_login.rst @@ -230,7 +230,7 @@ Setup for VMs ------------- Launch VM1 and VM2 with virsh command. -Setup for virsh is described in :ref:`spp_vf_gsg_virsh_setup`. +Setup for virsh is described in :ref:`spp_gsg_howto_virsh`. .. code-block:: console diff --git a/docs/guides/use_cases/spp_nfv.rst b/docs/guides/use_cases/spp_nfv.rst index 31ca4ea..c4e3f0c 100644 --- a/docs/guides/use_cases/spp_nfv.rst +++ b/docs/guides/use_cases/spp_nfv.rst @@ -309,7 +309,7 @@ Vhost PMD Vhost PMD is an interface for communicating between on hsot and guest VM. As described in -:ref:`How to Use`, +:ref:`How to Use`, vhost must be created by ``add`` subcommand before the VM is launched. @@ -344,7 +344,7 @@ Setup Network Configuration in spp_nfv Launch a VM by using the vhost interface created in the previous step. Lauunching VM is described in -:ref:`How to Use`. +:ref:`How to Use`. Patch ``phy:0`` to ``vhost:0`` and ``vhost:1`` to ``phy:1`` from ``nfv 1`` running on host. -- 2.7.4