PVE/Network/SDN/Zones/Plugin.pm

   1 package PVE::Network::SDN::Zones::Plugin;
   2
   3 use strict;
   4 use warnings;
   5
   6 use PVE::Tools;
   7 use PVE::JSONSchema;
   8 use PVE::Cluster;
   9
  10 use Data::Dumper;
  11 use PVE::JSONSchema qw(get_standard_option);
  12 use base qw(PVE::SectionConfig);
  13
  14 PVE::Cluster::cfs_register_file('sdn/zones.cfg',
  15                                  sub { __PACKAGE__->parse_config(@_); });
  16
  17 PVE::Cluster::cfs_register_file('sdn/zones.cfg.new',
  18                                  sub { __PACKAGE__->parse_config(@_); },
  19                                  sub { __PACKAGE__->write_config(@_); });
  20
  21 PVE::JSONSchema::register_standard_option('pve-sdn-zone-id', {
  22     description => "The SDN zone object identifier.",
  23     type => 'string', format => 'pve-sdn-zone-id',
  24 });
  25
  26 PVE::JSONSchema::register_format('pve-sdn-zone-id', \&parse_sdn_zone_id);
  27 sub parse_sdn_zone_id {
  28     my ($id, $noerr) = @_;
  29
  30     if ($id !~ m/^[a-z][a-z0-9]*[a-z0-9]$/i) {
  31         return undef if $noerr;
  32         die "zone ID '$id' contains illegal characters\n";
  33     }
  34     die "zone ID '$id' can't be more length than 10 characters\n" if length($id) > 10;
  35     return $id;
  36 }
  37
  38 my $defaultData = {
  39
  40     propertyList => {
  41         type => {
  42             description => "Plugin type.",
  43             type => 'string', format => 'pve-configid',
  44             type => 'string',
  45         },
  46         nodes => get_standard_option('pve-node-list', { optional => 1 }),
  47         zone => get_standard_option('pve-sdn-zone-id',
  48             { completion => \&PVE::Network::SDN::Zones::complete_sdn_zone }),
  49     },
  50 };
  51
  52 sub private {
  53     return $defaultData;
  54 }
  55
  56 sub decode_value {
  57     my ($class, $type, $key, $value) = @_;
  58
  59     if ($key eq 'nodes') {
  60         my $res = {};
  61
  62         foreach my $node (PVE::Tools::split_list($value)) {
  63             if (PVE::JSONSchema::pve_verify_node_name($node)) {
  64                 $res->{$node} = 1;
  65             }
  66         }
  67
  68         return $res;
  69     }
  70
  71    return $value;
  72 }
  73
  74 sub encode_value {
  75     my ($class, $type, $key, $value) = @_;
  76
  77     if ($key eq 'nodes') {
  78         return join(',', keys(%$value));
  79     }
  80
  81     return $value;
  82 }
  83
  84 sub parse_section_header {
  85     my ($class, $line) = @_;
  86
  87     if ($line =~ m/^(\S+):\s*(\S+)\s*$/) {
  88         my ($type, $id) = (lc($1), $2);
  89         my $errmsg = undef; # set if you want to skip whole section
  90         eval { PVE::JSONSchema::pve_verify_configid($type); };
  91         $errmsg = $@ if $@;
  92         my $config = {}; # to return additional attributes
  93         return ($type, $id, $errmsg, $config);
  94     }
  95     return undef;
  96 }
  97
  98 sub generate_sdn_config {
  99     my ($class, $plugin_config, $node, $data, $ctime) = @_;
 100
 101     die "please implement inside plugin";
 102 }
 103
 104 sub generate_controller_config {
 105     my ($class, $plugin_config, $controller, $id, $uplinks, $config) = @_;
 106
 107     die "please implement inside plugin";
 108 }
 109
 110 sub generate_controller_vnet_config {
 111     my ($class, $plugin_config, $controller, $zoneid, $vnetid, $config) = @_;
 112
 113 }
 114
 115 sub write_controller_config {
 116     my ($class, $plugin_config, $config) = @_;
 117
 118     die "please implement inside plugin";
 119 }
 120
 121 sub controller_reload {
 122     my ($class) = @_;
 123
 124     die "please implement inside plugin";
 125 }
 126
 127 sub on_delete_hook {
 128     my ($class, $zoneid, $vnet_cfg) = @_;
 129
 130     # verify that no vnet are associated to this zone
 131     foreach my $id (keys %{$vnet_cfg->{ids}}) {
 132         my $vnet = $vnet_cfg->{ids}->{$id};
 133         die "zone $zoneid is used by vnet $id"
 134             if ($vnet->{type} eq 'vnet' && defined($vnet->{zone}) && $vnet->{zone} eq $zoneid);
 135     }
 136 }
 137
 138 sub on_update_hook {
 139     my ($class, $zoneid, $zone_cfg, $controller_cfg) = @_;
 140
 141     # do nothing by default
 142 }
 143
 144 #helpers
 145 sub parse_tag_number_or_range {
 146     my ($str, $max, $tag) = @_;
 147
 148     my @elements = split(/,/, $str);
 149     my $count = 0;
 150     my $allowed = undef;
 151
 152     die "extraneous commas in list\n" if $str ne join(',', @elements);
 153     foreach my $item (@elements) {
 154         if ($item =~ m/^([0-9]+)-([0-9]+)$/) {
 155             $count += 2;
 156             my ($port1, $port2) = ($1, $2);
 157             die "invalid port '$port1'\n" if $port1 > $max;
 158             die "invalid port '$port2'\n" if $port2 > $max;
 159             die "backwards range '$port1:$port2' not allowed, did you mean '$port2:$port1'?\n" if $port1 > $port2;
 160
 161             if ($tag && $tag >= $port1 && $tag <= $port2){
 162                 $allowed = 1;
 163                 last;
 164             }
 165
 166         } elsif ($item =~ m/^([0-9]+)$/) {
 167             $count += 1;
 168             my $port = $1;
 169             die "invalid port '$port'\n" if $port > $max;
 170
 171             if ($tag && $tag == $port){
 172                 $allowed = 1;
 173                 last;
 174             }
 175         }
 176     }
 177     die "tag $tag is not allowed" if $tag && !$allowed;
 178
 179     return (scalar(@elements) > 1);
 180 }
 181
 182 #to be move to Network.pm helper
 183 sub get_first_local_ipv4_from_interface {
 184     my ($interface) = @_;
 185
 186     my $cmd = ['/sbin/ip', 'address', 'show', 'dev', $interface];
 187
 188     my $IP = "";
 189
 190     my $code = sub {
 191         my $line = shift;
 192
 193         if ($line =~ m!^\s*inet\s+($PVE::Tools::IPRE)(?:/\d+|\s+peer\s+)!) {
 194             $IP = $1;
 195             return;
 196         }
 197     };
 198
 199     PVE::Tools::run_command($cmd, outfunc => $code);
 200
 201     return $IP;
 202 }
 203
 204 1;