From mboxrd@z Thu Jan  1 00:00:00 1970
From: "Iremonger, Bernard" <bernard.iremonger@intel.com>
Subject: Re: [PATCH v3 1/2] doc: live migration of VM with Virtio
	and VF
Date: Fri, 15 Jul 2016 11:31:31 +0000
Message-ID: <8CEF83825BEC744B83065625E567D7C21A04EC8A@IRSMSX108.ger.corp.intel.com>
References: <1467820863-10223-1-git-send-email-bernard.iremonger@intel.com>
 <1467888154-5898-1-git-send-email-bernard.iremonger@intel.com>
 <1467888154-5898-2-git-send-email-bernard.iremonger@intel.com>
 <B27915DBBA3421428155699D51E4CFE20259E704@IRSMSX103.ger.corp.intel.com>
Mime-Version: 1.0
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: quoted-printable
Cc: "Liu, Yong" <yong.liu@intel.com>, "Xu, Qian Q" <qian.q.xu@intel.com>
To: "Mcnamara, John" <john.mcnamara@intel.com>, "dev@dpdk.org" <dev@dpdk.org>
Return-path: <dev-bounces@dpdk.org>
Received: from mga09.intel.com (mga09.intel.com [134.134.136.24])
 by dpdk.org (Postfix) with ESMTP id 4AE795587
 for <dev@dpdk.org>; Fri, 15 Jul 2016 13:31:34 +0200 (CEST)
In-Reply-To: <B27915DBBA3421428155699D51E4CFE20259E704@IRSMSX103.ger.corp.intel.com>
Content-Language: en-US
List-Id: patches and discussions about DPDK <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>

Hi John,

<snip>

> > Subject: [PATCH v3 1/2] doc: live migration of VM with Virtio and VF
> >
> > This patch describes the procedure to be be followed to perform Live
> > Migration of a VM with Virtio and VF PMD's using the bonding PMD.
> >
> > It includes sample host and VM scripts used in the procedure, and a
> > sample switch configuration.
>=20
> Hi Bernard,
>=20
> Thanks for the doc. It is a complicated process so it is good to have thi=
s
> detailed how-to. Some comments below.
>=20
>=20
> > +
> > +Live Migration of VM with SR-IOV VF:
> > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
>=20
>=20
> I wouldn't include a colon in the heading. Something like this may be bet=
ter:

Ok, I will remove colons from headings.
=20
>      Live Migration of a VM with SR-IOV VF
>      =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
>=20
>=20
> > +
> > +Live Migration overview for VM with Virtio and VF PMD's:
> > +--------------------------------------------------------
>=20
>=20
> Also, I wouldn't include the "Live Migration ... for VM with Virtio ..."
> in each heading. The context should be clear from the main sections of th=
e
> doc. I this case I would just call the heading "Overview"

Ok, will change.
=20
>=20
> > +
> > +It is not possible to migrate a Virtual Machine which has an SR-IOV
> > Virtual Function.
>=20
> Add (VF) in brackets at the first mention of Virtual Function here. Also =
for PF
> below.

Ok, I will add (VF) and (PF)

>=20
> > +To get around this problem the bonding PMD is used.
>=20
> I would add to the end of this paragraph:
>=20
>     The following sections show an example of how to do this.

Ok, will add.
>=20
>=20
> Also I think the "Test Setup" header from below should be moved up to thi=
s
> point.
>=20
> > +
> > +A bonded device is created in the VM.
> > +The virtio and VF PMD's are added as slaves to the bonded device.
> > +The VF is set as the primary slave of the bonded device.
> > +
> > +A bridge must be set up on the Host connecting the tap device, which
> > +is the backend of the Virtio device and the Physical Function device.
> > +
> > +To test the Live Migration two servers with identical operating
> > +systems
> > installed are used.
> > +KVM and Qemu 2.3 is also required on the servers.
> > +
> > +The servers have Niantic and or Fortville NIC's installed.
> > +The NIC's on both servers are connected to a switch which is also
> > +connected to the traffic generator.
>=20
> I would prefix this paragraph with: "In this example, the servers have Ni=
antic
> and .."

Ok, will do.
>=20
>=20
> > +The switch is configured to broadcast traffic on all the NIC ports.
> > +
> > +Live Migration with SR-IOV VF test setup:
> > +-----------------------------------------
>=20
> Just "Test Setup" would be better. And move up, I think.

Ok, will do.
>=20
>=20
> > +
> > +Live Migration steps for VM with Virtio and VF PMD's:
> > +-----------------------------------------------------
>=20
> Again "Live Migration steps" would be fine.

Ok, will change.

>=20
>=20
> Also I would change this paragraph to link forward to the scripts like:
>=20
>=20
>     The sample scripts mentioned in the steps below can be found in the
>     :ref:`lm_bond_virtio_sriov_host_scripts`
>     and :ref:`lm_bond_virtio_sriov_host_scripts` sections.
>=20
>=20
> And then put the targets in the relevant sections of the docs.
>=20
>     .. _lm_bond_virtio_sriov_host_scripts:
>=20
>     .. _lm_bond_virtio_sriov_vm_scripts:
>=20
>=20
Ok will do.

> > +
> > +The host is running the Kernel Physical Function driver (ixgbe or i40e=
).
> > +
> > +The ip address of host_server_1 is 10.237.212.46
> > +
> > +The ip address of host_server_2 is 10.237.212.131
> > +
> > +The sample scripts mentioned in the steps below can be found in the
> > +host_scripts and vm_scripts sections.
> > +
> > +On host_server_1: Terminal 1
> > +^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>=20
> The documentation guidelines say to use ~~~~~~ as the third level heading
> underline. It doesn't really matter since the RST parsers figure it out.
> Up to you if you want to change it.

I will leave as is.

>=20
> http://dpdk.org/doc/guides/contributing/documentation.html#section-
> headers
>=20
> > +The following command only works with kernel PF for Niantic
> > +
> > +.. code-block:: console
> > +
> > +    testpmd> mac_addr add port 1 vf 0 AA:BB:CC:DD:EE:FF
> > +
> > +create bonded device(mode) (socket)
>=20
> Should be a space after device.

Ok, will add a space.

> Also these lines describing the state or state
> change should be written have capital letters and full stops so they read=
 like
> sentences. Also, if describing a state change you could add "now" so the
> reader is aware of the change. For example:
>=20
>   - primary is port 1, 2 active slaves
>   + Primary is now port1. There are 2 active slaves.

Ok, will change.

>=20
> > +
> > +Setup Virtual Machine on host_server_1
> > +
> > +.. code-block:: sh
> > +
> > +  #!/bin/sh
> > +
>=20
>=20
> I thought that the code block had to be indented 3 spaces but the RST
> parsers didn't complain. Might be worth changing them anyway to a
> consistent 3 or 4 space indent.

I think 2 spaces are enough (if I remember correctly)

>=20
> John

Thanks for the review.

Regards,

Bernard.