Merge "snmp MF readout"
[docs.git] / docs / getting-started-guide / project-specific-guides / opflex.rst
index b63db141d1348959c17ad69796570833ed6f4370..9c732221727455ad35072c225098b8eb91b610e1 100644 (file)
@@ -1,3 +1,5 @@
+.. _opflex-agent-ovs-install-guide:
+
 OpFlex agent-ovs Install Guide
 ==============================
 
@@ -7,9 +9,7 @@ Required Packages
 You'll need to install the following packages and their dependencies:
 
 * libuv
-* openvswitch-gbp
-* openvswitch-gbp-lib
-* openvswitch-gbp-kmod
+* openvswitch
 * libopflex
 * libmodelgbp
 * agent-ovs
@@ -149,25 +149,25 @@ need to modify)::
    "opflex": {
        // The globally unique policy domain for this agent.
        "domain": "[CHANGE ME]",
-   
+
        // The unique name in the policy domain for this agent.
        "name": "[CHANGE ME]",
-   
+
        // a list of peers to connect to, by hostname and port.  One
-       // peer, or an anycast pseudo-peer, is sufficient to bootstrap 
+       // peer, or an anycast pseudo-peer, is sufficient to bootstrap
        // the connection without needing an exhaustive list of all
        // peers.
        "peers": [
            {"hostname": "10.0.0.30", "port": 8009}
        ],
-   
+
        "ssl": {
            // SSL mode.  Possible values:
            // disabled: communicate without encryption
            // encrypted: encrypt but do not verify peers
            // secure: encrypt and verify peer certificates
            "mode": "encrypted",
-   
+
            // The path to a directory containing trusted certificate
            // authority public certificates, or a file containing a
            // specific CA certificate.
@@ -188,22 +188,22 @@ console, but unless the configuration is unusual, it will be
        // hardware fabric such as ACI
        "stitched-mode": {
            "ovs-bridge-name": "br0",
-       
+
            // Set encapsulation type.  Must set either vxlan or vlan.
            "encap": {
                // Encapsulate traffic with VXLAN.
                "vxlan" : {
                    // The name of the tunnel interface in OVS
                    "encap-iface": "br0_vxlan0",
-       
+
                    // The name of the interface whose IP should be used
                    // as the source IP in encapsulated traffic.
                    "uplink-iface": "eth0.4093",
-       
+
                    // The vlan tag, if any, used on the uplink interface.
                    // Set to zero or omit if the uplink is untagged.
                    "uplink-vlan": 4093,
-   
+
                    // The IP address used for the destination IP in
                    // the encapsulated traffic.  This should be an
                    // anycast IP address understood by the upstream
@@ -218,11 +218,11 @@ console, but unless the configuration is unusual, it will be
                    // Enable virtual distributed router.  Set to true
                    // to enable or false to disable.  Default true.
                    "enabled": true,
-      
+
                    // Override MAC address for virtual router.
                    // Default is "00:22:bd:f8:19:ff"
                    "mac": "00:22:bd:f8:19:ff",
-      
+
                    // Configure IPv6-related settings for the virtual
                    // router
                    "ipv6" : {
@@ -232,20 +232,20 @@ console, but unless the configuration is unusual, it will be
                        "router-advertisement": true
                    }
                },
-      
+
                // Configure virtual distributed DHCP server
                "virtual-dhcp": {
                    // Enable virtual distributed DHCP server.  Set to
                    // true to enable or false to disable.  Default
                    // true.
                    "enabled": true,
-      
+
                    // Override MAC address for virtual dhcp server.
                    // Default is "00:22:bd:f8:19:ff"
                    "mac": "00:22:bd:f8:19:ff"
                }
            },
-   
+
            // Location to store cached IDs for managing flow state
            "flowid-cache-dir": "DEFAULT_FLOWID_CACHE_DIR"
        }