From patchwork Fri Mar 3 04:01:42 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Darrell Ball X-Patchwork-Id: 734930 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from mail.linuxfoundation.org (mail.linuxfoundation.org [140.211.169.12]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 3vZFr76TW9z9s73 for ; Fri, 3 Mar 2017 15:02:15 +1100 (AEDT) Authentication-Results: ozlabs.org; dkim=fail reason="signature verification failed" (2048-bit key; unprotected) header.d=gmail.com header.i=@gmail.com header.b="UljQLIm8"; dkim-atps=neutral Received: from mail.linux-foundation.org (localhost [127.0.0.1]) by mail.linuxfoundation.org (Postfix) with ESMTP id 89768B65; Fri, 3 Mar 2017 04:02:12 +0000 (UTC) X-Original-To: dev@openvswitch.org Delivered-To: ovs-dev@mail.linuxfoundation.org Received: from smtp1.linuxfoundation.org (smtp1.linux-foundation.org [172.17.192.35]) by mail.linuxfoundation.org (Postfix) with ESMTPS id E71128A6 for ; Fri, 3 Mar 2017 04:02:10 +0000 (UTC) X-Greylist: whitelisted by SQLgrey-1.7.6 Received: from mail-pg0-f67.google.com (mail-pg0-f67.google.com [74.125.83.67]) by smtp1.linuxfoundation.org (Postfix) with ESMTPS id 1E73216C for ; Fri, 3 Mar 2017 04:02:10 +0000 (UTC) Received: by mail-pg0-f67.google.com with SMTP id 1so11336110pgz.2 for ; Thu, 02 Mar 2017 20:02:10 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id; bh=OJ9qO/ZgBPux0FTfFPsRcQ2Cc8edMh2GMF+G6uYVyAA=; b=UljQLIm8nXUHvvxSvFJkmMu8uddsjLoE3Yp6BsCHXkfrsYx7d2hMPe2ex2vpmp2Oov c3kWzCYTil375tqh0MO6MMWH4YLdMb8QsN5Zq7Eq7leJI8rUQdyOUXOi9f8Bs6jlFWNI G15wDirefRSfIgCfX+gU0M/FB2oAh0AgbwYq68cC/XnG08reJchakWjqzAVbIWr3jUvY zjIACw1FwOSzprxMKd4hQUTGUrRoB+GEtxNwaI4teQ3jhUH/aeGvogYD7YvcrOjq2neq BlsZiq+KJOc3icsCdgG8aHTUitlBlHPWhmEF9oRJJWQdwxdffv+jY63kW3qluY68HFi5 rZGw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=OJ9qO/ZgBPux0FTfFPsRcQ2Cc8edMh2GMF+G6uYVyAA=; b=Q4DQnkekonpYQ1ZaAWdkCU53IxJSpoZ6bFM88efx8y0J4Fg97Mthhsrp9vRNj+5ILM MegBt5mgjEvUcK/0P81zWltYrMkETYvSMVrU5GtWdzkWYK2wREFjsnGTh4Kb8MQ2itTE t+cF27s0dpKZ8XOUGh04qONB8oCylrqMddwPg/+iWGF7dpeSE0+OaGqksj6Rrh72vKcT Fo10SVzLCL3xku07Xdo4ha6y7Sn4RnpMp+w+IOagelIgxhnxiNca7HChJQh9r+90JLck UFK+HBXoRTR+nHVA/DpX5fha6ZJOqy1eKTHNOgME0extHXAMUQPj7Mh0yFzV4RvKs0pV dn6w== X-Gm-Message-State: AMke39ltEX2bVk0BKtLugVOaFenLJsste+O1ul9XOP8U8GHoD/jRkTwASS/Dag1CJnfY0w== X-Received: by 10.99.134.199 with SMTP id x190mr888914pgd.194.1488513729346; Thu, 02 Mar 2017 20:02:09 -0800 (PST) Received: from localhost.localdomain ([208.91.2.3]) by smtp.gmail.com with ESMTPSA id b67sm19799222pfj.81.2017.03.02.20.02.08 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Thu, 02 Mar 2017 20:02:08 -0800 (PST) From: Darrell Ball To: dev@openvswitch.org Date: Thu, 2 Mar 2017 20:01:42 -0800 Message-Id: <1488513702-100140-1-git-send-email-dlu998@gmail.com> X-Mailer: git-send-email 1.9.1 X-Spam-Status: No, score=-1.7 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_ENVFROM_END_DIGIT,FREEMAIL_FROM, RCVD_IN_DNSWL_NONE, T_FILL_THIS_FORM_SHORT autolearn=no version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on smtp1.linux-foundation.org Subject: [ovs-dev] [patch_v1] doc: Support building ovs with Trusty. X-BeenThere: ovs-dev@openvswitch.org X-Mailman-Version: 2.1.12 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Sender: ovs-dev-bounces@openvswitch.org Errors-To: ovs-dev-bounces@openvswitch.org Some code-block directives are not understood using Trusty (I was using 14.04.1 when the issue was found) default package versions, which blocks the build. An error example: writing output... [100%] topics/language-bindings Warning, treated as error: /home/dball/ovs/Documentation/topics/language-bindings.rst:39: WARNING: Pygments lexer name u'shell' is not known 14.04.1 has Sphinx 1.2.2 and Pygments 1.6. I expect Trusty to still be widely used, so we should be able to build ovs with it. requirements.rst indicates only: sphinx>=1.2,<2.0 ovs_sphinx_theme>=1.0,<1.1 Fixes: f150a8bafbf2 ("doc: Document various language bindings") Suggested-by: Daniele Di Proietto Signed-off-by: Darrell Ball CC: Stephen Finucane Acked-by: Stephen Finucane --- .../internals/contributing/documentation-style.rst | 2 +- Documentation/intro/install/windows.rst | 70 +++++++++++----------- Documentation/topics/language-bindings.rst | 2 +- 3 files changed, 37 insertions(+), 37 deletions(-) diff --git a/Documentation/internals/contributing/documentation-style.rst b/Documentation/internals/contributing/documentation-style.rst index ea41a07..184f728 100644 --- a/Documentation/internals/contributing/documentation-style.rst +++ b/Documentation/internals/contributing/documentation-style.rst @@ -259,7 +259,7 @@ Figures and Other Media - All images should be in PNG format and compressed where possible. For PNG files, use OptiPNG and AdvanceCOMP's ``advpng``: - .. code-block:: shell + .. code-block:: bash $ optipng -o7 -zm1-9 -i0 -strip all $ advpng -z4 diff --git a/Documentation/intro/install/windows.rst b/Documentation/intro/install/windows.rst index caa9f40..6cc8a6b 100644 --- a/Documentation/intro/install/windows.rst +++ b/Documentation/intro/install/windows.rst @@ -225,7 +225,7 @@ building on Linux, FreeBSD, or NetBSD. all MinGW sessions and then run the below command from MSVC developers command prompt.: - .. code-block:: doscon + .. code-block:: bat > mingw-get upgrade msys-core-bin=1.0.17-1 @@ -276,7 +276,7 @@ Now run ``./uninstall.cmd`` to remove the old extension. Once complete, run turn on ``TESTSIGNING`` boot option or 'Disable Driver Signature Enforcement' during boot. The following commands can be used: -.. code-block:: doscon +.. code-block:: bat > bcdedit /set LOADOPTIONS DISABLE_INTEGRITY_CHECKS > bcdedit /set TESTSIGNING ON @@ -294,7 +294,7 @@ to work (covered later). The command to create a new switch named 'OVS-Extended-Switch' using a physical NIC named 'Ethernet 1' is: -.. code-block:: ps1con +.. code-block:: ps1 PS > New-VMSwitch "OVS-Extended-Switch" -NetAdapterName "Ethernet 1" @@ -307,7 +307,7 @@ In the properties of any switch, you should should now see "Open vSwitch Extension" under 'Extensions'. Click the check box to enable the extension. An alternative way to do the same is to run the following command: -.. code-block:: ps1con +.. code-block:: ps1 PS > Enable-VMSwitchExtension "Open vSwitch Extension" OVS-Extended-Switch @@ -330,7 +330,7 @@ database, ovsdb-server. Each machine on which Open vSwitch is installed should run its own copy of ovsdb-server. Before ovsdb-server itself can be started, configure a database that it can use: -.. code-block:: doscon +.. code-block:: bat > ovsdb-tool create C:\openvswitch\etc\openvswitch\conf.db \ C:\openvswitch\usr\share\openvswitch\vswitch.ovsschema @@ -338,7 +338,7 @@ configure a database that it can use: Configure ovsdb-server to use database created above and to listen on a Unix domain socket: -.. code-block:: doscon +.. code-block:: bat > ovsdb-server -vfile:info --remote=punix:db.sock --log-file \ --pidfile --detach @@ -351,7 +351,7 @@ Initialize the database using ovs-vsctl. This is only necessary the first time after you create the database with ovsdb-tool, though running it at any time is harmless: -.. code-block:: doscon +.. code-block:: bat > ovs-vsctl --no-wait init @@ -359,14 +359,14 @@ harmless: If you would later like to terminate the started ovsdb-server, run: - .. code-block:: doscon + .. code-block:: bat > ovs-appctl -t ovsdb-server exit Start the main Open vSwitch daemon, telling it to connect to the same Unix domain socket: -.. code-block:: doscon +.. code-block:: bat > ovs-vswitchd -vfile:info --log-file --pidfile --detach @@ -374,7 +374,7 @@ domain socket: If you would like to terminate the started ovs-vswitchd, run: - .. code-block:: doscon + .. code-block:: bat > ovs-appctl exit @@ -394,7 +394,7 @@ Add bridges Let's start by creating an integration bridge, ``br-int`` and a PIF bridge, ``br-pif``: -.. code-block:: doscon +.. code-block:: bat > ovs-vsctl add-br br-int > ovs-vsctl add-br br-pif @@ -408,7 +408,7 @@ Let's start by creating an integration bridge, ``br-int`` and a PIF bridge, Validate that ports are added by dumping from both ovs-dpctl and ovs-vsctl: -.. code-block:: doscon +.. code-block:: bat > ovs-dpctl show system@ovs-system: @@ -457,7 +457,7 @@ enable them and set the corresponding values to it to make them IP-able. As a whole example, if we issue the following in a powershell console: -.. code-block:: ps1con +.. code-block:: ps1 PS > Get-NetAdapter | select Name,InterfaceDescription Name InterfaceDescription @@ -476,13 +476,13 @@ We can see that we have a switch(external) created upon adapter name 'Ethernet0' with the internal ports under name 'br-pif' and 'br-int'. Thus resulting into the following ovs-vsctl commands: -.. code-block:: doscon +.. code-block:: bat > ovs-vsctl add-port br-pif Ethernet0 Dumping the ports should show the additional ports that were just added: -.. code-block:: doscon +.. code-block:: bat > ovs-dpctl show system@ovs-system: @@ -525,7 +525,7 @@ is being addressed. After assigning the name ``ovs-port-a``, the VIF is connected back to the Hyper-V switch with name ``OVS-HV-Switch``, which is assumed to be the Hyper-V switch with OVS extension enabled.: -.. code-block:: ps1con +.. code-block:: ps1 PS > import-module .\datapath-windows\misc\OVS.psm1 PS > $vnic = Get-VMNetworkAdapter @@ -536,13 +536,13 @@ assumed to be the Hyper-V switch with OVS extension enabled.: Next, add the VIFs to ``br-int``: -.. code-block:: doscon +.. code-block:: bat > ovs-vsctl add-port br-int ovs-port-a Dumping the ports should show the additional ports that were just added: -.. code-block:: doscon +.. code-block:: bat > ovs-dpctl show system@ovs-system: @@ -582,7 +582,7 @@ found at technet_. For example, to set up a switch team combined from ``Ethernet0 2`` and ``Ethernet1 2`` named ``external``: -.. code-block:: ps1con +.. code-block:: ps1 PS > Get-NetAdapter Name InterfaceDescription @@ -602,7 +602,7 @@ For example, to set up a switch team combined from ``Ethernet0 2`` and This will result in a new adapter bound to the host called ``external``: -.. code-block:: ps1con +.. code-block:: ps1 PS > Get-NetAdapter Name InterfaceDescription @@ -617,7 +617,7 @@ This will result in a new adapter bound to the host called ``external``: Next we will set up the Hyper-V VMSwitch on the new adapter ``external``: -.. code-block:: ps1con +.. code-block:: ps1 PS > New-VMSwitch -Name external -NetAdapterName external \ -AllowManagementOS $false @@ -628,7 +628,7 @@ Under OVS the adapters under the team ``external``, ``Ethernet0 2`` and The following example shows how the bridges look with the NICs being separated: -.. code-block:: doscon +.. code-block:: bat > ovs-vsctl show 6cd9481b-c249-4ee3-8692-97b399dd29d8 @@ -653,7 +653,7 @@ Switch VLAN tagging along with patch ports between ``br-int`` and ``br-pif`` is used to configure VLAN tagging functionality between two VMs on different Hyper-Vs. To start, add a patch port from ``br-int`` to ``br-pif``: -.. code-block:: doscon +.. code-block:: bat > ovs-vsctl add-port br-int patch-to-pif > ovs-vsctl set interface patch-to-pif type=patch \ @@ -661,7 +661,7 @@ Hyper-Vs. To start, add a patch port from ``br-int`` to ``br-pif``: Add a patch port from ``br-pif`` to ``br-int``: -.. code-block:: doscon +.. code-block:: bat > ovs-vsctl add-port br-pif patch-to-int > ovs-vsctl set interface patch-to-int type=patch \ @@ -669,7 +669,7 @@ Add a patch port from ``br-pif`` to ``br-int``: Re-Add the VIF ports with the VLAN tag: -.. code-block:: doscon +.. code-block:: bat > ovs-vsctl add-port br-int ovs-port-a tag=900 > ovs-vsctl add-port br-int ovs-port-b tag=900 @@ -681,7 +681,7 @@ The Windows Open vSwitch implementation support VXLAN and STT tunnels. To add tunnels. For example, first add the tunnel port between 172.168.201.101 <-> 172.168.201.102: -.. code-block:: doscon +.. code-block:: bat > ovs-vsctl add-port br-int tun-1 > ovs-vsctl set Interface tun-1 type= @@ -692,7 +692,7 @@ tunnels. For example, first add the tunnel port between 172.168.201.101 <-> ...and the tunnel port between 172.168.201.101 <-> 172.168.201.105: -.. code-block:: doscon +.. code-block:: bat > ovs-vsctl add-port br-int tun-2 > ovs-vsctl set Interface tun-2 type= @@ -717,14 +717,14 @@ daemons via ``make install``. To start, create the database: -.. code-block:: doscon +.. code-block:: bat > ovsdb-tool create C:/openvswitch/etc/openvswitch/conf.db \ "C:/openvswitch/usr/share/openvswitch/vswitch.ovsschema" Create the ovsdb-server service and start it: -.. code-block:: doscon +.. code-block:: bat > sc create ovsdb-server \ binpath="C:/openvswitch/usr/sbin/ovsdb-server.exe \ @@ -739,25 +739,25 @@ Create the ovsdb-server service and start it: paths. You can make sure that the correct path has been registered with the Windows services manager by running: - .. code-block:: doscon + .. code-block:: bat > sc qc ovsdb-server Check that the service is healthy by running: -.. code-block:: doscon +.. code-block:: bat > sc query ovsdb-server Initialize the database: -.. code-block:: doscon +.. code-block:: bat > ovs-vsctl --no-wait init Create the ovs-vswitchd service and start it: -.. code-block:: doscon +.. code-block:: bat > sc create ovs-vswitchd \ binpath="C:/openvswitch/usr/sbin/ovs-vswitchd.exe \ @@ -766,13 +766,13 @@ Create the ovs-vswitchd service and start it: Check that the service is healthy by running: -.. code-block:: doscon +.. code-block:: bat > sc query ovs-vswitchd To stop and delete the services, run: -.. code-block:: doscon +.. code-block:: bat > sc stop ovs-vswitchd > sc stop ovsdb-server diff --git a/Documentation/topics/language-bindings.rst b/Documentation/topics/language-bindings.rst index 5114125..ff91bb8 100644 --- a/Documentation/topics/language-bindings.rst +++ b/Documentation/topics/language-bindings.rst @@ -36,7 +36,7 @@ Python The Python bindings are part of the `Open vSwitch package`__. You can install the bindings using ``pip``: -.. code-block:: shell +.. code-block:: bash $ pip install ovs