Daniel Park | a7d6e9f | 2016-01-18 17:54:14 +0900 | [diff] [blame] | 1 | /* |
Brian O'Connor | ce2a03d | 2017-08-03 19:21:03 -0700 | [diff] [blame^] | 2 | * Copyright 2016-present Open Networking Foundation |
Daniel Park | a7d6e9f | 2016-01-18 17:54:14 +0900 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | package org.onosproject.openstacknode; |
| 17 | |
Hyunsun Moon | 34bbe17 | 2016-06-28 19:18:40 -0700 | [diff] [blame] | 18 | import org.onlab.packet.IpAddress; |
daniel park | e49eb38 | 2017-04-05 16:48:28 +0900 | [diff] [blame] | 19 | import org.onosproject.core.GroupId; |
Hyunsun Moon | 05d9b26 | 2016-07-03 18:38:44 -0700 | [diff] [blame] | 20 | import org.onosproject.event.ListenerService; |
Hyunsun Moon | 34bbe17 | 2016-06-28 19:18:40 -0700 | [diff] [blame] | 21 | import org.onosproject.net.DeviceId; |
| 22 | import org.onosproject.net.PortNumber; |
| 23 | |
Daniel Park | a7d6e9f | 2016-01-18 17:54:14 +0900 | [diff] [blame] | 24 | import java.util.List; |
Hyunsun Moon | 34bbe17 | 2016-06-28 19:18:40 -0700 | [diff] [blame] | 25 | import java.util.Optional; |
| 26 | import java.util.Set; |
Daniel Park | a7d6e9f | 2016-01-18 17:54:14 +0900 | [diff] [blame] | 27 | |
| 28 | /** |
| 29 | * Handles the bootstrap request for compute/gateway node. |
| 30 | */ |
Hyunsun Moon | 05d9b26 | 2016-07-03 18:38:44 -0700 | [diff] [blame] | 31 | public interface OpenstackNodeService |
| 32 | extends ListenerService<OpenstackNodeEvent, OpenstackNodeListener> { |
Daniel Park | a7d6e9f | 2016-01-18 17:54:14 +0900 | [diff] [blame] | 33 | |
Hyunsun Moon | 34bbe17 | 2016-06-28 19:18:40 -0700 | [diff] [blame] | 34 | enum NodeType { |
Daniel Park | a7d6e9f | 2016-01-18 17:54:14 +0900 | [diff] [blame] | 35 | /** |
| 36 | * Compute or Gateway Node. |
| 37 | */ |
Hyunsun Moon | 34bbe17 | 2016-06-28 19:18:40 -0700 | [diff] [blame] | 38 | COMPUTE, |
| 39 | GATEWAY |
Daniel Park | a7d6e9f | 2016-01-18 17:54:14 +0900 | [diff] [blame] | 40 | } |
Hyunsun Moon | 34bbe17 | 2016-06-28 19:18:40 -0700 | [diff] [blame] | 41 | |
daniel park | ee8700b | 2017-05-11 15:50:03 +0900 | [diff] [blame] | 42 | enum NetworkMode { |
| 43 | /** |
| 44 | * VxLAN or VLAN mode. |
| 45 | */ |
| 46 | VXLAN, |
| 47 | VLAN |
| 48 | } |
| 49 | |
Daniel Park | a7d6e9f | 2016-01-18 17:54:14 +0900 | [diff] [blame] | 50 | /** |
Hyunsun Moon | 34bbe17 | 2016-06-28 19:18:40 -0700 | [diff] [blame] | 51 | * Adds or updates a new node to the service. |
Daniel Park | a7d6e9f | 2016-01-18 17:54:14 +0900 | [diff] [blame] | 52 | * |
| 53 | * @param node openstack node |
| 54 | */ |
Hyunsun Moon | 34bbe17 | 2016-06-28 19:18:40 -0700 | [diff] [blame] | 55 | void addOrUpdateNode(OpenstackNode node); |
Daniel Park | a7d6e9f | 2016-01-18 17:54:14 +0900 | [diff] [blame] | 56 | |
| 57 | /** |
Hyunsun Moon | 05d9b26 | 2016-07-03 18:38:44 -0700 | [diff] [blame] | 58 | * Bootstraps node with INIT state. |
| 59 | * |
| 60 | * @param node openstack node |
| 61 | */ |
| 62 | void processInitState(OpenstackNode node); |
| 63 | |
| 64 | /** |
| 65 | * Bootstraps node with DEVICE_CREATED state. |
| 66 | * |
| 67 | * @param node openstack node |
| 68 | */ |
| 69 | void processDeviceCreatedState(OpenstackNode node); |
| 70 | |
| 71 | /** |
| 72 | * Bootstraps node with COMPLETE state. |
| 73 | * |
| 74 | * @param node openstack node |
| 75 | */ |
| 76 | void processCompleteState(OpenstackNode node); |
| 77 | |
| 78 | /** |
| 79 | * Bootstraps node with INCOMPLETE state. |
| 80 | * |
| 81 | * @param node openstack node |
| 82 | */ |
| 83 | void processIncompleteState(OpenstackNode node); |
| 84 | |
| 85 | /** |
Daniel Park | a7d6e9f | 2016-01-18 17:54:14 +0900 | [diff] [blame] | 86 | * Deletes a node from the service. |
| 87 | * |
| 88 | * @param node openstack node |
| 89 | */ |
| 90 | void deleteNode(OpenstackNode node); |
| 91 | |
| 92 | /** |
Hyunsun Moon | 34bbe17 | 2016-06-28 19:18:40 -0700 | [diff] [blame] | 93 | * Returns all nodes known to the service. |
Daniel Park | a7d6e9f | 2016-01-18 17:54:14 +0900 | [diff] [blame] | 94 | * |
Daniel Park | a7d6e9f | 2016-01-18 17:54:14 +0900 | [diff] [blame] | 95 | * @return list of nodes |
| 96 | */ |
Hyunsun Moon | 34bbe17 | 2016-06-28 19:18:40 -0700 | [diff] [blame] | 97 | List<OpenstackNode> nodes(); |
Daniel Park | a7d6e9f | 2016-01-18 17:54:14 +0900 | [diff] [blame] | 98 | |
| 99 | /** |
Hyunsun Moon | 34bbe17 | 2016-06-28 19:18:40 -0700 | [diff] [blame] | 100 | * Returns all nodes in complete state. |
Daniel Park | a7d6e9f | 2016-01-18 17:54:14 +0900 | [diff] [blame] | 101 | * |
Hyunsun Moon | 34bbe17 | 2016-06-28 19:18:40 -0700 | [diff] [blame] | 102 | * @return set of nodes |
Daniel Park | a7d6e9f | 2016-01-18 17:54:14 +0900 | [diff] [blame] | 103 | */ |
Hyunsun Moon | 34bbe17 | 2016-06-28 19:18:40 -0700 | [diff] [blame] | 104 | Set<OpenstackNode> completeNodes(); |
| 105 | |
| 106 | /** |
Hyunsun Moon | 34bbe17 | 2016-06-28 19:18:40 -0700 | [diff] [blame] | 107 | * Returns data network IP address of a given integration bridge device. |
| 108 | * |
| 109 | * @param intBridgeId integration bridge device id |
| 110 | * @return ip address; empty value otherwise |
| 111 | */ |
| 112 | Optional<IpAddress> dataIp(DeviceId intBridgeId); |
| 113 | |
| 114 | /** |
| 115 | * Returns tunnel port number of a given integration bridge device. |
| 116 | * |
| 117 | * @param intBridgeId integration bridge device id |
| 118 | * @return port number; or empty value |
| 119 | */ |
| 120 | Optional<PortNumber> tunnelPort(DeviceId intBridgeId); |
| 121 | |
| 122 | /** |
daniel park | a792cf7 | 2017-04-14 16:25:35 +0900 | [diff] [blame] | 123 | * Returns vlan port number of a given integration bridge device. |
| 124 | * |
| 125 | * @param intBridgeId integration bridge device id |
| 126 | * @return port number; or empty value |
| 127 | */ |
| 128 | Optional<PortNumber> vlanPort(DeviceId intBridgeId); |
| 129 | |
| 130 | /** |
Hyunsun Moon | 34bbe17 | 2016-06-28 19:18:40 -0700 | [diff] [blame] | 131 | * Returns router bridge device ID connected to a given integration bridge. |
| 132 | * It returns valid value only if the node type is GATEWAY. |
| 133 | * |
| 134 | * @param intBridgeId device id of the integration bridge |
| 135 | * @return device id of a router bridge; or empty value |
| 136 | */ |
| 137 | Optional<DeviceId> routerBridge(DeviceId intBridgeId); |
| 138 | |
| 139 | /** |
| 140 | * Returns port number connected to the router bridge. |
| 141 | * It returns valid value only if the node type is GATEWAY. |
| 142 | * |
| 143 | * @param intBridgeId integration bridge device id |
| 144 | * @return port number; or empty value |
| 145 | */ |
| 146 | Optional<PortNumber> externalPort(DeviceId intBridgeId); |
daniel park | a792cf7 | 2017-04-14 16:25:35 +0900 | [diff] [blame] | 147 | |
daniel park | e49eb38 | 2017-04-05 16:48:28 +0900 | [diff] [blame] | 148 | /** |
| 149 | * Returns gateway node with the given device identifier. |
| 150 | * |
| 151 | * @param deviceId The gateway node deviceId |
| 152 | * @return The gateway node information |
| 153 | */ |
| 154 | OpenstackNode gatewayNode(DeviceId deviceId); |
| 155 | |
| 156 | /** |
| 157 | * Returns group id for gateway load balance. |
| 158 | * If the group does not exist in the supplied source device, creates one. |
| 159 | * |
| 160 | * @param srcDeviceId source device id |
daniel park | ee8700b | 2017-05-11 15:50:03 +0900 | [diff] [blame] | 161 | * @param networkMode network mode |
| 162 | * @return group id |
daniel park | e49eb38 | 2017-04-05 16:48:28 +0900 | [diff] [blame] | 163 | */ |
daniel park | ee8700b | 2017-05-11 15:50:03 +0900 | [diff] [blame] | 164 | GroupId gatewayGroupId(DeviceId srcDeviceId, NetworkMode networkMode); |
daniel park | e49eb38 | 2017-04-05 16:48:28 +0900 | [diff] [blame] | 165 | |
| 166 | /** |
| 167 | * Returns the list of gateway node information with the given device identifier. |
| 168 | * |
| 169 | * @return The list of gateway node information |
| 170 | */ |
| 171 | List<OpenstackNode> gatewayNodes(); |
| 172 | |
| 173 | /** |
| 174 | * Returns the list of gateway`s device identifiers. |
| 175 | * |
| 176 | * @return The list of device identifier] |
| 177 | */ |
| 178 | List<DeviceId> gatewayDeviceIds(); |
Daniel Park | a7d6e9f | 2016-01-18 17:54:14 +0900 | [diff] [blame] | 179 | } |