1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547
|
package network
import (
"context"
"errors"
"fmt"
"maps"
"net"
"slices"
"strconv"
"github.com/lxc/incus/v6/internal/server/cluster/request"
"github.com/lxc/incus/v6/internal/server/db"
"github.com/lxc/incus/v6/internal/server/ip"
"github.com/lxc/incus/v6/internal/server/network/ovs"
"github.com/lxc/incus/v6/shared/api"
"github.com/lxc/incus/v6/shared/logger"
"github.com/lxc/incus/v6/shared/revert"
"github.com/lxc/incus/v6/shared/util"
"github.com/lxc/incus/v6/shared/validate"
)
// physical represents a physical network.
type physical struct {
common
}
// DBType returns the network type DB ID.
func (n *physical) DBType() db.NetworkType {
return db.NetworkTypePhysical
}
// Validate network config.
func (n *physical) Validate(config map[string]string, clientType request.ClientType) error {
rules := map[string]func(value string) error{
// gendoc:generate(entity=network_physical, group=common, key=parent)
//
// ---
// type: string
// condition: -
// shortdesc: Existing interface to use for network
"parent": validate.Required(validate.IsNotEmpty, validate.IsInterfaceName),
// gendoc:generate(entity=network_physical, group=common, key=mtu)
//
// ---
// type: integer
// condition: -
// shortdesc: The MTU of the new interface
"mtu": validate.Optional(validate.IsNetworkMTU),
// gendoc:generate(entity=network_physical, group=common, key=vlan)
//
// ---
// type: integer
// condition: -
// shortdesc: The VLAN ID to attach to
"vlan": validate.Optional(validate.IsNetworkVLAN),
// gendoc:generate(entity=network_physical, group=common, key=gvrp)
//
// ---
// type: bool
// condition: -
// defaultdesc: 'false'
// shortdesc: Register VLAN using GARP VLAN Registration Protocol
"gvrp": validate.Optional(validate.IsBool),
// gendoc:generate(entity=network_physical, group=ipv4, key=ipv4.gateway)
//
// ---
// type: string
// condition: standard mode
// shortdesc: IPv4 address for the gateway and network (CIDR)
"ipv4.gateway": validate.Optional(validate.IsNetworkAddressCIDRV4),
// gendoc:generate(entity=network_physical, group=ipv6, key=ipv6.gateway)
//
// ---
// type: string
// condition: standard mode
// shortdesc: IPv6 address for the gateway and network (CIDR)
"ipv6.gateway": validate.Optional(validate.IsNetworkAddressCIDRV6),
// gendoc:generate(entity=network_physical, group=ipv4, key=ipv4.gateway.hwaddr)
//
// ---
// type: string
// shortdesc: MAC address of the gateway (to avoid discovery)
"ipv4.gateway.hwaddr": validate.Optional(validate.IsNetworkMAC),
// gendoc:generate(entity=network_physical, group=ipv6, key=ipv6.gateway.hwaddr)
//
// ---
// type: string
// shortdesc: MAC address of the gateway (to avoid discovery)
"ipv6.gateway.hwaddr": validate.Optional(validate.IsNetworkMAC),
// gendoc:generate(entity=network_physical, group=ipv4, key=ipv4.ovn.ranges)
//
// ---
// type: string
// condition: -
// shortdesc: Comma-separated list of IPv4 ranges to use for child OVN network routers (FIRST-LAST format)
"ipv4.ovn.ranges": validate.Optional(validate.IsListOf(validate.IsNetworkRangeV4)),
// gendoc:generate(entity=network_physical, group=ipv6, key=ipv6.ovn.ranges)
//
// ---
// type: string
// condition: -
// shortdesc: Comma-separated list of IPv6 ranges to use for child OVN network routers (FIRST-LAST format)
"ipv6.ovn.ranges": validate.Optional(validate.IsListOf(validate.IsNetworkRangeV6)),
// gendoc:generate(entity=network_physical, group=ipv4, key=ipv4.routes)
//
// ---
// type: string
// condition: IPv4 address
// shortdesc: Comma-separated list of additional IPv4 CIDR subnets that can be used with child OVN networks `ipv4.routes.external` setting
"ipv4.routes": validate.Optional(validate.IsListOf(validate.IsNetworkV4)),
// gendoc:generate(entity=network_physical, group=ipv4, key=ipv4.routes.anycast)
//
// ---
// type: bool
// condition: IPv4 address
// defaultdesc: 'false'
// shortdesc: Allow the overlapping routes to be used on multiple networks/NIC at the same time
"ipv4.routes.anycast": validate.Optional(validate.IsBool),
// gendoc:generate(entity=network_physical, group=ipv6, key=ipv6.routes)
//
// ---
// type: string
// condition: IPv6 address
// shortdesc: Comma-separated list of additional IPv6 CIDR subnets that can be used with child OVN networks `ipv6.routes.external` setting
"ipv6.routes": validate.Optional(validate.IsListOf(validate.IsNetworkV6)),
// gendoc:generate(entity=network_physical, group=ipv6, key=ipv6.routes.anycast)
//
// ---
// type: bool
// condition: IPv6 address
// defaultdesc: 'false'
// shortdesc: Allow the overlapping routes to be used on multiple networks/NIC at the same time
"ipv6.routes.anycast": validate.Optional(validate.IsBool),
// gendoc:generate(entity=network_physical, group=dns, key=dns.nameservers)
//
// ---
// type: string
// condition: standard mode
// shortdesc: List of DNS server IPs on `physical` network
"dns.nameservers": validate.Optional(validate.IsListOf(validate.IsNetworkAddress)),
// gendoc:generate(entity=network_physical, group=ovn, key=ovn.ingress_mode)
//
// ---
// type: string
// condition: standard mode
// defaultdesc: `l2proxy`
// shortdesc: Sets the method how OVN NIC external IPs will be advertised on uplink network: `l2proxy` (proxy ARP/NDP) or `routed`
"ovn.ingress_mode": validate.Optional(validate.IsOneOf("l2proxy", "routed")),
"volatile.last_state.created": validate.Optional(validate.IsBool),
}
// gendoc:generate(entity=network_physical, group=bgp, key=bgp.peers.NAME.address)
//
// ---
// type: string
// condition: BGP server
// defaultdesc: -
// shortdesc: Peer address (IPv4 or IPv6) for use by `ovn` downstream networks
// gendoc:generate(entity=network_physical, group=bgp, key=bgp.peers.NAME.asn)
//
// ---
// type: integer
// condition: BGP server
// defaultdesc: -
// shortdesc: Peer AS number for use by `ovn` downstream networks
// gendoc:generate(entity=network_physical, group=bgp, key=bgp.peers.NAME.password)
//
// ---
// type: string
// condition: BGP server
// defaultdesc: - (no password)
// shortdesc: Peer session password (optional) for use by `ovn` downstream networks
// gendoc:generate(entity=network_physical, group=bgp, key=bgp.peers.NAME.holdtime)
//
// ---
// type: integer
// condition: BGP server
// defaultdesc: `180`
// shortdesc: Peer session hold time (in seconds; optional)
// Add the BGP validation rules.
bgpRules, err := n.bgpValidationRules(config)
if err != nil {
return err
}
maps.Copy(rules, bgpRules)
// Validate the configuration.
err = n.validate(config, rules)
if err != nil {
return err
}
return nil
}
// checkParentUse checks if parent is already in use by another network or instance device.
func (n *physical) checkParentUse(ourConfig map[string]string) (bool, error) {
// Get all managed networks across all projects.
var err error
var projectNetworks map[string]map[int64]api.Network
err = n.state.DB.Cluster.Transaction(context.TODO(), func(ctx context.Context, tx *db.ClusterTx) error {
projectNetworks, err = tx.GetCreatedNetworks(ctx)
return err
})
if err != nil {
return false, fmt.Errorf("Failed to load all networks: %w", err)
}
for projectName, networks := range projectNetworks {
if projectName != api.ProjectDefaultName {
continue // Only default project networks can possibly reference a physical interface.
}
for _, network := range networks {
if network.Name == n.name {
continue // Ignore our own DB record.
}
// Check if another network is using our parent.
if network.Config["parent"] == ourConfig["parent"] {
// If either network doesn't specify a vlan, or both specify same vlan,
// then we can't use this parent.
if (network.Config["vlan"] == "" || ourConfig["vlan"] == "") || network.Config["vlan"] == ourConfig["vlan"] {
return true, nil
}
}
}
}
return false, nil
}
// Create checks whether the referenced parent interface is used by other networks or instance devices, as we
// need to have exclusive access to the interface.
func (n *physical) Create(clientType request.ClientType) error {
n.logger.Debug("Create", logger.Ctx{"clientType": clientType, "config": n.config})
// We only need to check in the database once, not on every clustered node.
if clientType == request.ClientTypeNormal {
inUse, err := n.checkParentUse(n.config)
if err != nil {
return err
}
if inUse {
return fmt.Errorf("Parent interface %q in use by another network", n.config["parent"])
}
}
return nil
}
// Delete deletes a network.
func (n *physical) Delete(clientType request.ClientType) error {
n.logger.Debug("Delete", logger.Ctx{"clientType": clientType})
err := n.Stop()
if err != nil {
return err
}
return n.common.delete(clientType)
}
// Rename renames a network.
func (n *physical) Rename(newName string) error {
n.logger.Debug("Rename", logger.Ctx{"newName": newName})
// Rename common steps.
err := n.common.rename(newName)
if err != nil {
return err
}
return nil
}
// Start sets up some global configuration.
func (n *physical) Start() error {
n.logger.Debug("Start")
reverter := revert.New()
defer reverter.Fail()
reverter.Add(func() { n.setUnavailable() })
err := n.setup(nil)
if err != nil {
return err
}
reverter.Success()
// Ensure network is marked as available now its started.
n.setAvailable()
return nil
}
func (n *physical) setup(oldConfig map[string]string) error {
reverter := revert.New()
defer reverter.Fail()
if !InterfaceExists(n.config["parent"]) {
return fmt.Errorf("Parent interface %q not found", n.config["parent"])
}
hostName := GetHostDevice(n.config["parent"], n.config["vlan"])
created, err := VLANInterfaceCreate(n.config["parent"], hostName, n.config["vlan"], util.IsTrue(n.config["gvrp"]))
if err != nil {
return err
}
if created {
reverter.Add(func() { _ = InterfaceRemove(hostName) })
}
// Set the MTU.
if n.config["mtu"] != "" {
mtu, err := strconv.ParseUint(n.config["mtu"], 10, 32)
if err != nil {
return fmt.Errorf("Invalid MTU %q: %w", n.config["mtu"], err)
}
phyLink := &ip.Link{Name: hostName}
err = phyLink.SetMTU(uint32(mtu))
if err != nil {
return fmt.Errorf("Failed setting MTU %q on %q: %w", n.config["mtu"], phyLink.Name, err)
}
}
// Record if we created this device or not (if we have not already recorded that we created it previously),
// so it can be removed on stop. This way we won't overwrite the setting on daemon restart.
if util.IsFalseOrEmpty(n.config["volatile.last_state.created"]) {
n.config["volatile.last_state.created"] = fmt.Sprintf("%t", created)
err = n.state.DB.Cluster.Transaction(context.TODO(), func(ctx context.Context, tx *db.ClusterTx) error {
return tx.UpdateNetwork(ctx, n.project, n.name, n.description, n.config)
})
if err != nil {
return fmt.Errorf("Failed saving volatile config: %w", err)
}
}
// Setup BGP.
err = n.bgpSetup(oldConfig)
if err != nil {
return err
}
reverter.Success()
return nil
}
// Stop stops is a no-op.
func (n *physical) Stop() error {
n.logger.Debug("Stop")
// Clear BGP.
err := n.bgpClear(n.config)
if err != nil {
return err
}
hostName := GetHostDevice(n.config["parent"], n.config["vlan"])
// Only try and remove created VLAN interfaces.
if n.config["vlan"] != "" && util.IsTrue(n.config["volatile.last_state.created"]) && InterfaceExists(hostName) {
err := InterfaceRemove(hostName)
if err != nil {
return err
}
}
// Reset MTU back to 1500 if overridden in config.
if n.config["mtu"] != "" && InterfaceExists(hostName) {
var resetMTU uint32 = 1500
link := &ip.Link{Name: hostName}
err := link.SetMTU(1500)
if err != nil {
return fmt.Errorf("Failed setting MTU %d on %q: %w", resetMTU, link.Name, err)
}
}
// Remove last state config.
delete(n.config, "volatile.last_state.created")
err = n.state.DB.Cluster.Transaction(context.TODO(), func(ctx context.Context, tx *db.ClusterTx) error {
return tx.UpdateNetwork(ctx, n.project, n.name, n.description, n.config)
})
if err != nil {
return fmt.Errorf("Failed removing volatile config: %w", err)
}
return nil
}
// Update updates the network. Accepts notification boolean indicating if this update request is coming from a
// cluster notification, in which case do not update the database, just apply local changes needed.
func (n *physical) Update(newNetwork api.NetworkPut, targetNode string, clientType request.ClientType) error {
n.logger.Debug("Update", logger.Ctx{"clientType": clientType, "newNetwork": newNetwork})
dbUpdateNeeded, changedKeys, oldNetwork, err := n.common.configChanged(newNetwork)
if err != nil {
return err
}
if !dbUpdateNeeded {
return nil // Nothing changed.
}
// If the network as a whole has not had any previous creation attempts, or the node itself is still
// pending, then don't apply the new settings to the node, just to the database record (ready for the
// actual global create request to be initiated).
if n.Status() == api.NetworkStatusPending || n.LocalStatus() == api.NetworkStatusPending {
return n.common.update(newNetwork, targetNode, clientType)
}
reverter := revert.New()
defer reverter.Fail()
hostNameChanged := slices.Contains(changedKeys, "vlan") || slices.Contains(changedKeys, "parent")
// We only need to check in the database once, not on every clustered node.
if clientType == request.ClientTypeNormal {
if hostNameChanged {
isUsed, err := n.IsUsed(true)
if isUsed || err != nil {
return errors.New("Cannot update network parent interface when in use")
}
inUse, err := n.checkParentUse(newNetwork.Config)
if err != nil {
return err
}
if inUse {
return fmt.Errorf("Parent interface %q in use by another network", newNetwork.Config["parent"])
}
}
}
if hostNameChanged {
err = n.Stop()
if err != nil {
return err
}
// Remove the volatile last state from submitted new config if present.
delete(newNetwork.Config, "volatile.last_state.created")
}
// Define a function which reverts everything.
reverter.Add(func() {
// Reset changes to all nodes and database.
_ = n.common.update(oldNetwork, targetNode, clientType)
})
// Apply changes to all nodes and database.
err = n.common.update(newNetwork, targetNode, clientType)
if err != nil {
return err
}
if !hostNameChanged {
err = n.setup(oldNetwork.Config)
if err != nil {
return err
}
} else {
err = n.setup(nil)
if err != nil {
return err
}
}
// Update OVS bridge entries (for dependent OVN networks).
if hostNameChanged {
vswitch, err := n.state.OVS()
if err == nil {
ovsBridge := fmt.Sprintf("incusovn%d", n.id)
err := vswitch.DeleteBridgePort(context.TODO(), ovsBridge, oldNetwork.Config["parent"])
if err != nil && !errors.Is(err, ovs.ErrNotFound) {
return err
}
err = vswitch.CreateBridgePort(context.TODO(), ovsBridge, newNetwork.Config["parent"], true)
if err != nil && !errors.Is(err, ovs.ErrNotFound) {
return err
}
}
}
reverter.Success()
// Notify dependent networks (those using this network as their uplink) of the changes.
// Do this after the network has been successfully updated so that a failure to notify a dependent network
// doesn't prevent the network itself from being updated.
if clientType == request.ClientTypeNormal && len(changedKeys) > 0 {
n.common.notifyDependentNetworks(changedKeys)
}
return nil
}
// DHCPv4Subnet returns the DHCPv4 subnet (if DHCP is enabled on network).
func (n *physical) DHCPv4Subnet() *net.IPNet {
_, subnet, err := net.ParseCIDR(n.config["ipv4.gateway"])
if err != nil {
return nil
}
return subnet
}
// DHCPv6Subnet returns the DHCPv6 subnet (if DHCP or SLAAC is enabled on network).
func (n *physical) DHCPv6Subnet() *net.IPNet {
_, subnet, err := net.ParseCIDR(n.config["ipv6.gateway"])
if err != nil {
return nil
}
return subnet
}
|