From patchwork Tue Oct 6 19:35:59 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ben Pfaff X-Patchwork-Id: 526950 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from archives.nicira.com (unknown [IPv6:2600:3c00::f03c:91ff:fe6e:bdf7]) by ozlabs.org (Postfix) with ESMTP id 445DD140D8B for ; Wed, 7 Oct 2015 06:36:13 +1100 (AEDT) Received: from archives.nicira.com (localhost [127.0.0.1]) by archives.nicira.com (Postfix) with ESMTP id 25464106D5; Tue, 6 Oct 2015 12:36:12 -0700 (PDT) X-Original-To: dev@openvswitch.org Delivered-To: dev@openvswitch.org Received: from mx1e3.cudamail.com (mx1.cudamail.com [69.90.118.67]) by archives.nicira.com (Postfix) with ESMTPS id 9AAE210674 for ; Tue, 6 Oct 2015 12:36:11 -0700 (PDT) Received: from bar2.cudamail.com (localhost [127.0.0.1]) by mx1e3.cudamail.com (Postfix) with ESMTPS id 45F6E4203ED for ; Tue, 6 Oct 2015 13:36:10 -0600 (MDT) X-ASG-Debug-ID: 1444160169-03dc537fe2cca850001-byXFYA Received: from mx1-pf2.cudamail.com ([192.168.24.2]) by bar2.cudamail.com with ESMTP id omQUz4Gz2nbfqZeH (version=TLSv1 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO) for ; Tue, 06 Oct 2015 13:36:09 -0600 (MDT) X-Barracuda-Envelope-From: blp@nicira.com X-Barracuda-RBL-Trusted-Forwarder: 192.168.24.2 Received: from unknown (HELO mail-pa0-f54.google.com) (209.85.220.54) by mx1-pf2.cudamail.com with ESMTPS (RC4-SHA encrypted); 6 Oct 2015 19:36:09 -0000 Received-SPF: unknown (mx1-pf2.cudamail.com: Multiple SPF records returned) X-Barracuda-RBL-Trusted-Forwarder: 209.85.220.54 Received: by pablk4 with SMTP id lk4so217944639pab.3 for ; Tue, 06 Oct 2015 12:36:08 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=rgsfD245Ox5w2/Zd7Mw9MwWFWsbqAHfspl47602zGmE=; b=cS3CmOWQfYj8YUVstx2SOyiqx2EmIpKmm/ig4BGXyqxSPLQCWqjhUO7EeyDT83eCx9 j0N24mrBCfKYOCaTkkF7RMS4cWEcZfjtAYNiP0GHkToAU3GK0h4F3AndkhzKjWBZ1uNr tjjQNlAejgOp6OE7KqLD30i2SXQHOM6/asWWkPY2iEsJr2I6F98FwP3+dCA8v9S02tUA LRd0Cjh6aW9jx00KHMtpVm4czNNqlJhWDyHEa1h49KmnVYFtsR/NKhLiG6Jp8hctpMYe //9qcfuqljwr1uLRJFor+l68aFUxT79mO/RIilPjPxQ5oItZLCvgiHO5F7IQfHQ9gTEF utmw== X-Gm-Message-State: ALoCoQnTyiIp7r4gQOzmObhzbmtrxc5nTmLeP3oMBQ7LB9HexFMoi83M0En72Dh9E4DuWHrDbBQC X-Received: by 10.66.147.38 with SMTP id th6mr48552224pab.94.1444160168590; Tue, 06 Oct 2015 12:36:08 -0700 (PDT) Received: from sigabrt.gateway.sonic.net (173-228-112-165.dsl.dynamic.fusionbroadband.com. [173.228.112.165]) by smtp.gmail.com with ESMTPSA id qa5sm34960564pbc.70.2015.10.06.12.36.07 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 06 Oct 2015 12:36:07 -0700 (PDT) X-CudaMail-Envelope-Sender: blp@nicira.com X-Barracuda-Apparent-Source-IP: 173.228.112.165 From: Ben Pfaff To: dev@openvswitch.org X-CudaMail-Whitelist-To: dev@openvswitch.org X-CudaMail-MID: CM-E2-1005082999 X-CudaMail-DTE: 100615 X-CudaMail-Originating-IP: 209.85.220.54 Date: Tue, 6 Oct 2015 12:35:59 -0700 X-ASG-Orig-Subj: [##CM-E2-1005082999##][PATCH 2/2] ovn-controller: Document database keys used by ovn-controller. Message-Id: <1444160159-7425-2-git-send-email-blp@nicira.com> X-Mailer: git-send-email 2.1.3 In-Reply-To: <1444160159-7425-1-git-send-email-blp@nicira.com> References: <1444160159-7425-1-git-send-email-blp@nicira.com> X-Barracuda-Connect: UNKNOWN[192.168.24.2] X-Barracuda-Start-Time: 1444160169 X-Barracuda-Encrypted: DHE-RSA-AES256-SHA X-Barracuda-URL: https://web.cudamail.com:443/cgi-mod/mark.cgi X-ASG-Whitelist: Header =?UTF-8?B?eFwtY3VkYW1haWxcLXdoaXRlbGlzdFwtdG8=?= X-Virus-Scanned: by bsmtpd at cudamail.com X-Barracuda-BRTS-Status: 1 Cc: Ben Pfaff Subject: [ovs-dev] [PATCH 2/2] ovn-controller: Document database keys used by ovn-controller. X-BeenThere: dev@openvswitch.org X-Mailman-Version: 2.1.16 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: dev-bounces@openvswitch.org Sender: "dev" Signed-off-by: Ben Pfaff Acked-by: Justin Pettit --- ovn/controller/ovn-controller.8.xml | 39 +++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/ovn/controller/ovn-controller.8.xml b/ovn/controller/ovn-controller.8.xml index 99d2d18..aadec15 100644 --- a/ovn/controller/ovn-controller.8.xml +++ b/ovn/controller/ovn-controller.8.xml @@ -122,8 +122,47 @@ physnet1:br-eth0,physnet2:br-eth1. + +

Open vSwitch Database Usage

+ +

+ ovn-controller uses a number of external-ids + keys in the Open vSwitch database to keep track of ports and interfaces. + For proper operation, users should not change or clear these keys:

+
+
+ external_ids:ovn-chassis-id in the Port table +
+
+ The presence of this key identifies a tunnel port within the + integration bridge as one created by ovn-controller to + reach a remote chassis. Its value is the chassis ID of the remote + chassis. +
+ +
+ external-ids:ovn-patch-port in the Port table +
+
+

+ The presence of this key identifies a patch port as one created by + ovn-controller to connect the integration bridge and + another bridge to implement a localnet logical port. + Its value is the name of the physical network that the port + implements. See external_ids:ovn-bridge-mappings, + above, for more information. +

+ +

+ Each localnet logical port is implemented as a pair of + patch ports, one in the integration bridge, one in a different + bridge, with the same external-ids:ovn-patch-port value. +

+
+
+

RUNTIME MANAGEMENT COMMANDS

ovs-appctl can send commands to a running