Browse code

Add Quantum NEC OpenFlow plugin support

NEC OpenFlow plugin supports several OpenFlow controllers. This commit
also adds a third party script to support Trema Sliceable Switch,
one of open source OpenFlow controllers.

Change-Id: I5dddf04a25bc275c3119d751ca79b482e1875902

Akihiro MOTOKI authored on 2013/01/13 05:01:08
Showing 3 changed files
1 1
new file mode 100644
... ...
@@ -0,0 +1,15 @@
0
+# Trema
1
+gcc
2
+make
3
+ruby1.8
4
+rubygems1.8
5
+ruby1.8-dev
6
+libpcap-dev
7
+libsqlite3-dev
8
+
9
+# Sliceable Switch
10
+sqlite3
11
+libdbi-perl
12
+libdbd-sqlite3-perl
13
+apache2
14
+libjson-perl
0 15
new file mode 100644
... ...
@@ -0,0 +1,122 @@
0
+# Quantum NEC OpenFlow plugin
1
+# ---------------------------
2
+
3
+# Save trace setting
4
+MY_XTRACE=$(set +o | grep xtrace)
5
+set +o xtrace
6
+
7
+# Configuration parameters
8
+OFC_HOST=${OFC_HOST:-127.0.0.1}
9
+OFC_PORT=${OFC_PORT:-8888}
10
+
11
+OFC_API_HOST=${OFC_API_HOST:-$OFC_HOST}
12
+OFC_API_PORT=${OFC_API_PORT:-$OFC_PORT}
13
+OFC_OFP_HOST=${OFC_OFP_HOST:-$OFC_HOST}
14
+OFC_OFP_PORT=${OFC_OFP_PORT:-6633}
15
+OFC_DRIVER=${OFC_DRIVER:-trema}
16
+OFC_RETRY_MAX=${OFC_RETRY_MAX:-0}
17
+OFC_RETRY_INTERVAL=${OFC_RETRY_INTERVAL:-1}
18
+
19
+OVS_BRIDGE=${OVS_BRIDGE:-br-int}
20
+
21
+# Main logic
22
+# ---------------------------
23
+
24
+source $TOP_DIR/lib/quantum_plugins/ovs_base
25
+
26
+function quantum_plugin_create_nova_conf() {
27
+    _quantum_ovs_base_configure_nova_vif_driver
28
+}
29
+
30
+function quantum_plugin_install_agent_packages() {
31
+    # SKIP_OVS_INSTALL is useful when we want to use Open vSwitch whose
32
+    # version is different from the version provided by the distribution.
33
+    if [[ "$SKIP_OVS_INSTALL" = "True" ]]; then
34
+        echo "You need to install Open vSwitch manually."
35
+        return
36
+    fi
37
+    _quantum_ovs_base_install_agent_packages
38
+}
39
+
40
+function quantum_plugin_configure_common() {
41
+    Q_PLUGIN_CONF_PATH=etc/quantum/plugins/nec
42
+    Q_PLUGIN_CONF_FILENAME=nec.ini
43
+    Q_DB_NAME="quantum_nec"
44
+    Q_PLUGIN_CLASS="quantum.plugins.nec.nec_plugin.NECPluginV2"
45
+}
46
+
47
+function quantum_plugin_configure_debug_command() {
48
+    _quantum_ovs_base_configure_debug_command
49
+}
50
+
51
+function quantum_plugin_configure_dhcp_agent() {
52
+    :
53
+}
54
+
55
+function quantum_plugin_configure_l3_agent() {
56
+    _quantum_ovs_base_configure_l3_agent
57
+}
58
+
59
+function quantum_plugin_configure_plugin_agent() {
60
+    if [[ "$SKIP_OVS_BRIDGE_SETUP" = "True" ]]; then
61
+        return
62
+    fi
63
+    # Set up integration bridge
64
+    _quantum_ovs_base_setup_bridge $OVS_BRIDGE
65
+    sudo ovs-vsctl --no-wait set-controller $OVS_BRIDGE tcp:$OFC_OFP_HOST:$OFC_OFP_PORT
66
+    # Generate datapath ID from HOST_IP
67
+    local dpid=$(printf "0x%07d%03d%03d%03d\n" ${HOST_IP//./ })
68
+    sudo ovs-vsctl --no-wait set Bridge $OVS_BRIDGE other-config:datapath-id=$dpid
69
+    sudo ovs-vsctl --no-wait set-fail-mode $OVS_BRIDGE secure
70
+    if [ -n "$OVS_INTERFACE" ]; then
71
+        sudo ovs-vsctl --no-wait -- --may-exist add-port $OVS_BRIDGE $OVS_INTERFACE
72
+    fi
73
+    _quantum_setup_ovs_tunnels $OVS_BRIDGE
74
+    AGENT_BINARY="$QUANTUM_DIR/bin/quantum-nec-agent"
75
+
76
+    _quantum_ovs_base_configure_firewall_driver
77
+}
78
+
79
+function quantum_plugin_configure_service() {
80
+    iniset $QUANTUM_CONF DEFAULT api_extensions_path quantum/plugins/nec/extensions/
81
+    iniset /$Q_PLUGIN_CONF_FILE OFC host $OFC_API_HOST
82
+    iniset /$Q_PLUGIN_CONF_FILE OFC port $OFC_API_PORT
83
+    iniset /$Q_PLUGIN_CONF_FILE OFC driver $OFC_DRIVER
84
+    iniset /$Q_PLUGIN_CONF_FILE OFC api_retry_max OFC_RETRY_MAX
85
+    iniset /$Q_PLUGIN_CONF_FILE OFC api_retry_interval OFC_RETRY_INTERVAL
86
+}
87
+
88
+function quantum_plugin_setup_interface_driver() {
89
+    local conf_file=$1
90
+    iniset $conf_file DEFAULT interface_driver quantum.agent.linux.interface.OVSInterfaceDriver
91
+    iniset $conf_file DEFAULT ovs_use_veth True
92
+}
93
+
94
+# Utility functions
95
+# ---------------------------
96
+
97
+# Setup OVS tunnel manually
98
+function _quantum_setup_ovs_tunnels() {
99
+    local bridge=$1
100
+    local id=0
101
+    GRE_LOCAL_IP=${GRE_LOCAL_IP:-$HOST_IP}
102
+    if [ -n "$GRE_REMOTE_IPS" ]; then
103
+         for ip in ${GRE_REMOTE_IPS//:/ }
104
+         do
105
+             if [[ "$ip" == "$GRE_LOCAL_IP" ]]; then
106
+                 continue
107
+             fi
108
+             sudo ovs-vsctl --no-wait add-port $bridge gre$id -- \
109
+                 set Interface gre$id type=gre options:remote_ip=$ip
110
+             id=`expr $id + 1`
111
+         done
112
+    fi
113
+}
114
+
115
+function has_quantum_plugin_security_group() {
116
+    # 0 means True here
117
+    return 0
118
+}
119
+
120
+# Restore xtrace
121
+$MY_XTRACE
0 122
new file mode 100644
... ...
@@ -0,0 +1,113 @@
0
+# Trema Sliceable Switch
1
+# ----------------------
2
+
3
+# Trema is a Full-Stack OpenFlow Framework in Ruby and C
4
+# https://github.com/trema/trema
5
+#
6
+# Trema Sliceable Switch is an OpenFlow controller which provides
7
+# virtual layer-2 network slices.
8
+# https://github.com/trema/apps/wiki
9
+
10
+# Trema Sliceable Switch (OpenFlow Controller)
11
+TREMA_APPS_REPO=${TREMA_APPS_REPO:-https://github.com/trema/apps.git}
12
+TREMA_APPS_BRANCH=${TREMA_APPS_BRANCH:-master}
13
+
14
+# Save trace setting
15
+MY_XTRACE=$(set +o | grep xtrace)
16
+set +o xtrace
17
+
18
+TREMA_DIR=${TREMA_DIR:-$DEST/trema}
19
+TREMA_SS_DIR="$TREMA_DIR/apps/sliceable_switch"
20
+
21
+TREMA_DATA_DIR=${TREMA_DATA_DIR:-$DATA_DIR/trema}
22
+TREMA_SS_ETC_DIR=$TREMA_DATA_DIR/sliceable_switch/etc
23
+TREMA_SS_DB_DIR=$TREMA_DATA_DIR/sliceable_switch/db
24
+TREMA_SS_SCRIPT_DIR=$TREMA_DATA_DIR/sliceable_switch/script
25
+TREMA_TMP_DIR=$TREMA_DATA_DIR/trema
26
+
27
+TREMA_LOG_LEVEL=${TREMA_LOG_LEVEL:-info}
28
+
29
+TREMA_SS_CONFIG=$TREMA_SS_ETC_DIR/sliceable.conf
30
+TREMA_SS_APACHE_CONFIG=/etc/apache2/sites-available/sliceable_switch
31
+
32
+# configure_trema - Set config files, create data dirs, etc
33
+function configure_trema() {
34
+    # prepare dir
35
+    for d in $TREMA_SS_ETC_DIR $TREMA_SS_DB_DIR $TREMA_SS_SCRIPT_DIR; do
36
+        sudo mkdir -p $d
37
+        sudo chown -R `whoami` $d
38
+    done
39
+    sudo mkdir -p $TREMA_TMP_DIR
40
+}
41
+
42
+# init_trema - Initialize databases, etc.
43
+function init_trema() {
44
+    local _pwd=$(pwd)
45
+
46
+    # Initialize databases for Sliceable Switch
47
+    cd $TREMA_SS_DIR
48
+    rm -f filter.db slice.db
49
+    ./create_tables.sh
50
+    mv filter.db slice.db $TREMA_SS_DB_DIR
51
+    # Make sure that apache cgi has write access to the databases
52
+    sudo chown -R www-data.www-data $TREMA_SS_DB_DIR
53
+    cd $_pwd
54
+
55
+    # Setup HTTP Server for sliceable_switch
56
+    cp $TREMA_SS_DIR/{Slice.pm,Filter.pm,config.cgi} $TREMA_SS_SCRIPT_DIR
57
+    sed -i -e "s|/home/sliceable_switch/db|$TREMA_SS_DB_DIR|" \
58
+        $TREMA_SS_SCRIPT_DIR/config.cgi
59
+
60
+    sudo cp $TREMA_SS_DIR/apache/sliceable_switch $TREMA_SS_APACHE_CONFIG
61
+    sudo sed -i -e "s|/home/sliceable_switch/script|$TREMA_SS_SCRIPT_DIR|" \
62
+        $TREMA_SS_APACHE_CONFIG
63
+    sudo a2enmod rewrite actions
64
+    sudo a2ensite sliceable_switch
65
+
66
+    cp $TREMA_SS_DIR/sliceable_switch_null.conf $TREMA_SS_CONFIG
67
+    sed -i -e "s|^\$apps_dir.*$|\$apps_dir = \"$TREMA_DIR/apps\"|" \
68
+           -e "s|^\$db_dir.*$|\$db_dir = \"$TREMA_SS_DB_DIR\"|" \
69
+           $TREMA_SS_CONFIG
70
+}
71
+
72
+function gem_install() {
73
+    [[ "$OFFLINE" = "True" ]] && return
74
+    [ -n "$RUBYGEMS_CMD" ] || get_gem_command
75
+
76
+    local pkg=$1
77
+    $RUBYGEMS_CMD list | grep "^${pkg} " && return
78
+    sudo $RUBYGEMS_CMD install $pkg
79
+}
80
+
81
+function get_gem_command() {
82
+    # Trema requires ruby 1.8, so gem1.8 is checked first
83
+    RUBYGEMS_CMD=$(which gem1.8 || which gem)
84
+    if [ -z "$RUBYGEMS_CMD" ]; then
85
+        echo "Warning: ruby gems command not found."
86
+    fi
87
+}
88
+
89
+function install_trema() {
90
+    # Trema
91
+    gem_install trema
92
+    # Sliceable Switch
93
+    git_clone $TREMA_APPS_REPO $TREMA_DIR/apps $TREMA_APPS_BRANCH
94
+    make -C $TREMA_DIR/apps/topology
95
+    make -C $TREMA_DIR/apps/flow_manager
96
+    make -C $TREMA_DIR/apps/sliceable_switch
97
+}
98
+
99
+function start_trema() {
100
+    # APACHE_NAME is defined in init_horizon (in lib/horizon)
101
+    restart_service $APACHE_NAME
102
+
103
+    sudo LOGGING_LEVEL=$TREMA_LOG_LEVEL TREMA_TMP=$TREMA_TMP_DIR \
104
+        trema run -d -c $TREMA_SS_CONFIG
105
+}
106
+
107
+function stop_trema() {
108
+    sudo TREMA_TMP=$TREMA_TMP_DIR trema killall
109
+}
110
+
111
+# Restore xtrace
112
+$MY_XTRACE