Jian Li | 9e43ec1 | 2019-01-21 23:04:23 +0900 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2019-present Open Networking Foundation |
| 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.k8snode.api; |
| 17 | |
| 18 | import org.onlab.packet.IpAddress; |
| 19 | import org.onosproject.net.DeviceId; |
| 20 | import org.onosproject.net.PortNumber; |
| 21 | |
| 22 | /** |
| 23 | * Representation of a node used in k8s-networking service. |
| 24 | */ |
| 25 | public interface K8sNode { |
| 26 | |
| 27 | /** |
| 28 | * Lists of kubernetes node types. |
| 29 | */ |
| 30 | enum Type { |
| 31 | /** |
| 32 | * Signifies that this is a kubernetes master node. |
| 33 | */ |
| 34 | MASTER, |
| 35 | |
| 36 | /** |
| 37 | * Signifies that this is a kubernetes minion node. |
| 38 | */ |
| 39 | MINION |
| 40 | } |
| 41 | |
| 42 | /** |
| 43 | * Returns hostname of the node. |
| 44 | * |
| 45 | * @return hostname |
| 46 | */ |
| 47 | String hostname(); |
| 48 | |
| 49 | /** |
| 50 | * Returns the type of the node. |
| 51 | * |
| 52 | * @return node type |
| 53 | */ |
| 54 | Type type(); |
| 55 | |
| 56 | /** |
| 57 | * Returns the OVSDB device ID of the node. |
| 58 | * |
| 59 | * @return ovsdb device id |
| 60 | */ |
| 61 | DeviceId ovsdb(); |
| 62 | |
| 63 | /** |
| 64 | * Returns the device ID of the integration bridge at the node. |
| 65 | * |
| 66 | * @return device id |
| 67 | */ |
| 68 | DeviceId intgBridge(); |
| 69 | |
| 70 | /** |
Jian Li | 1cee988 | 2019-02-13 11:25:25 +0900 | [diff] [blame] | 71 | * Returns new kubernetes node instance with given integration bridge. |
| 72 | * |
| 73 | * @param deviceId integration bridge device ID |
| 74 | * @return updated kubernetes node |
| 75 | */ |
| 76 | K8sNode updateIntgBridge(DeviceId deviceId); |
| 77 | |
| 78 | /** |
Jian Li | 9e43ec1 | 2019-01-21 23:04:23 +0900 | [diff] [blame] | 79 | * Returns the management network IP address of the node. |
| 80 | * |
| 81 | * @return ip address |
| 82 | */ |
| 83 | IpAddress managementIp(); |
| 84 | |
| 85 | /** |
| 86 | * Returns the data network IP address used for tunneling. |
| 87 | * |
| 88 | * @return ip address; null if vxlan mode is not enabled |
| 89 | */ |
| 90 | IpAddress dataIp(); |
| 91 | |
| 92 | /** |
| 93 | * Returns the initialization state of the node. |
| 94 | * |
| 95 | * @return node state |
| 96 | */ |
| 97 | K8sNodeState state(); |
| 98 | |
| 99 | /** |
Jian Li | 49109b5 | 2019-01-22 00:17:28 +0900 | [diff] [blame] | 100 | * Returns new kubernetes node instance with given state. |
| 101 | * |
| 102 | * @param newState updated state |
| 103 | * @return updated kubernetes node |
| 104 | */ |
| 105 | K8sNode updateState(K8sNodeState newState); |
| 106 | |
| 107 | /** |
Jian Li | 9e43ec1 | 2019-01-21 23:04:23 +0900 | [diff] [blame] | 108 | * Returns the GRE tunnel port number. |
| 109 | * |
| 110 | * @return GRE port number; null if the GRE tunnel port does not exist |
| 111 | */ |
| 112 | PortNumber grePortNum(); |
| 113 | |
| 114 | /** |
| 115 | * Returns the VXLAN tunnel port number. |
| 116 | * |
| 117 | * @return VXLAN port number; null if tunnel port does not exist |
| 118 | */ |
| 119 | PortNumber vxlanPortNum(); |
| 120 | |
| 121 | /** |
| 122 | * Returns the GENEVE tunnel port number. |
| 123 | * |
| 124 | * @return GENEVE port number; null if the GRE tunnel port does not exist |
| 125 | */ |
| 126 | PortNumber genevePortNum(); |
| 127 | |
| 128 | /** |
Jian Li | 4aa1764 | 2019-01-30 00:01:11 +0900 | [diff] [blame] | 129 | * Returns the host port number. |
| 130 | * |
| 131 | * @return host port number; null if the host port does not exist |
| 132 | */ |
| 133 | PortNumber intBridgePortNum(); |
| 134 | |
| 135 | /** |
Jian Li | 9e43ec1 | 2019-01-21 23:04:23 +0900 | [diff] [blame] | 136 | * Builder of new node entity. |
| 137 | */ |
| 138 | interface Builder { |
| 139 | |
| 140 | /** |
| 141 | * Builds an immutable kubernetes node instance. |
| 142 | * |
| 143 | * @return kubernetes node instance |
| 144 | */ |
| 145 | K8sNode build(); |
| 146 | |
| 147 | /** |
| 148 | * Returns kubernetes node builder with supplied hostname. |
| 149 | * |
| 150 | * @param hostname hostname of the node |
| 151 | * @return kubernetes node builder |
| 152 | */ |
| 153 | Builder hostname(String hostname); |
| 154 | |
| 155 | /** |
| 156 | * Returns kubernetes node builder with supplied type. |
| 157 | * |
| 158 | * @param type kubernetes node type |
| 159 | * @return kubernetes node builder |
| 160 | */ |
| 161 | Builder type(Type type); |
| 162 | |
| 163 | /** |
| 164 | * Returns kubernetes node builder with supplied bridge name. |
| 165 | * |
| 166 | * @param deviceId integration bridge device ID |
| 167 | * @return kubernetes node builder |
| 168 | */ |
| 169 | Builder intgBridge(DeviceId deviceId); |
| 170 | |
| 171 | /** |
| 172 | * Returns kubernetes node builder with supplied management IP address. |
| 173 | * |
| 174 | * @param managementIp management IP address |
| 175 | * @return kubernetes node builder |
| 176 | */ |
| 177 | Builder managementIp(IpAddress managementIp); |
| 178 | |
| 179 | /** |
| 180 | * Returns kubernetes node builder with supplied data IP address. |
| 181 | * |
| 182 | * @param dataIp data IP address |
| 183 | * @return kubernetes node builder |
| 184 | */ |
| 185 | Builder dataIp(IpAddress dataIp); |
| 186 | |
| 187 | /** |
| 188 | * Returns kubernetes node builder with supplied node state. |
| 189 | * |
| 190 | * @param state kubernetes node state |
| 191 | * @return kubernetes node builder |
| 192 | */ |
| 193 | Builder state(K8sNodeState state); |
| 194 | } |
| 195 | } |