path: root/src/PVE/API2/Network/SDN/Controllers.pm

package PVE::API2::Network::SDN::Controllers;

use strict;
use warnings;

use PVE::SafeSyslog;
use PVE::Tools qw(extract_param);
use PVE::Cluster qw(cfs_read_file cfs_write_file);
use PVE::Network::SDN;
use PVE::Network::SDN::Zones;
use PVE::Network::SDN::Controllers;
use PVE::Network::SDN::Controllers::Plugin;
use PVE::Network::SDN::Controllers::EvpnPlugin;
use PVE::Network::SDN::Controllers::BgpPlugin;
use PVE::Network::SDN::Controllers::FaucetPlugin;

use Storable qw(dclone);
use PVE::JSONSchema qw(get_standard_option);
use PVE::RPCEnvironment;

use PVE::RESTHandler;

use base qw(PVE::RESTHandler);

my $sdn_controllers_type_enum = PVE::Network::SDN::Controllers::Plugin->lookup_types();

my $api_sdn_controllers_config = sub {
    my ($cfg, $id) = @_;

    my $scfg = dclone(PVE::Network::SDN::Controllers::sdn_controllers_config($cfg, $id));
    $scfg->{controller} = $id;
    $scfg->{digest} = $cfg->{digest};

    return $scfg;
};

my $CONTROLLER_PROPERTIES = {
    asn => {
        type => 'integer',
        description => 'The local ASN of the controller. BGP & EVPN only.',
        optional => 1,
        minimum => 0,
        maximum => 4294967295,
    },
    node => {
        type => 'string',
        optional => 1,
        description => 'Node(s) where this controller is active.',
    },
    peers => {
        type => 'string',
        optional => 1,
        description => 'Comma-separated list of the peers IP addresses.',
    },
    'bgp-multipath-as-relax' => {
        type => 'boolean',
        optional => 1,
        description =>
            'Consider different AS paths of equal length for multipath computation. BGP only.',
    },
    ebgp => {
        type => 'boolean',
        optional => 1,
        description => "Enable eBGP (remote-as external). BGP only.",
    },
    'ebgp-multihop' => {
        type => 'integer',
        optional => 1,
        description =>
            "Set maximum amount of hops for eBGP peers. Needs ebgp set to 1. BGP only.",
    },
    loopback => {
        description =>
            "Name of the loopback/dummy interface that provides the Router-IP. BGP only.",
        optional => 1,
        type => 'string',
    },
    'isis-domain' => {
        description => "Name of the IS-IS domain. IS-IS only.",
        optional => 1,
        type => 'string',
    },
    'isis-ifaces' => {
        description =>
            "Comma-separated list of interfaces where IS-IS should be active. IS-IS only.",
        optional => 1,
        type => 'string',
        format => 'pve-iface-list',
    },
    'isis-net' => {
        description => "Network Entity title for this node in the IS-IS network. IS-IS only.",
        optional => 1,
        type => 'string',
        format => 'pve-sdn-isis-net',
    },
};

__PACKAGE__->register_method({
    name => 'index',
    path => '',
    method => 'GET',
    description => "SDN controllers index.",
    permissions => {
        description =>
            "Only list entries where you have 'SDN.Audit' or 'SDN.Allocate' permissions on '/sdn/controllers/<controller>'",
        user => 'all',
    },
    parameters => {
        additionalProperties => 0,
        properties => {
            type => {
                description => "Only list sdn controllers of specific type",
                type => 'string',
                enum => $sdn_controllers_type_enum,
                optional => 1,
            },
            running => {
                type => 'boolean',
                optional => 1,
                description => "Display running config.",
            },
            pending => {
                type => 'boolean',
                optional => 1,
                description => "Display pending config.",
            },
        },
    },
    returns => {
        type => 'array',
        items => {
            type => "object",
            properties => {
                digest => {
                    type => 'string',
                    description => 'Digest of the controller section.',
                    optional => 1,
                },
                state => get_standard_option('pve-sdn-config-state'),
                controller => {
                    type => 'string',
                    description => 'Name of the controller.',
                },
                type => {
                    type => 'string',
                    description => 'Type of the controller',
                    enum => PVE::Network::SDN::Controllers::Plugin->lookup_types(),
                },
                pending => {
                    type => 'object',
                    description =>
                        'Changes that have not yet been applied to the running configuration.',
                    optional => 1,
                    properties => $CONTROLLER_PROPERTIES,
                },
                %$CONTROLLER_PROPERTIES,
            },
        },
        links => [{ rel => 'child', href => "{controller}" }],
    },
    code => sub {
        my ($param) = @_;

        my $rpcenv = PVE::RPCEnvironment::get();
        my $authuser = $rpcenv->get_user();

        my $cfg = {};
        if ($param->{pending}) {
            my $running_cfg = PVE::Network::SDN::running_config();
            my $config = PVE::Network::SDN::Controllers::config();
            $cfg = PVE::Network::SDN::pending_config($running_cfg, $config, 'controllers');
        } elsif ($param->{running}) {
            my $running_cfg = PVE::Network::SDN::running_config();
            $cfg = $running_cfg->{controllers};
        } else {
            $cfg = PVE::Network::SDN::Controllers::config();
        }

        my @sids = PVE::Network::SDN::Controllers::sdn_controllers_ids($cfg);
        my $res = [];
        foreach my $id (@sids) {
            my $privs = ['SDN.Audit', 'SDN.Allocate'];
            next if !$rpcenv->check_any($authuser, "/sdn/controllers/$id", $privs, 1);

            my $scfg = &$api_sdn_controllers_config($cfg, $id);
            next if $param->{type} && $param->{type} ne $scfg->{type};

            my $plugin_config = $cfg->{ids}->{$id};
            my $plugin = PVE::Network::SDN::Controllers::Plugin->lookup($plugin_config->{type});
            push @$res, $scfg;
        }

        return $res;
    },
});

__PACKAGE__->register_method({
    name => 'read',
    path => '{controller}',
    method => 'GET',
    description => "Read sdn controller configuration.",
    permissions => {
        check => ['perm', '/sdn/controllers/{controller}', ['SDN.Allocate']],
    },

    parameters => {
        additionalProperties => 0,
        properties => {
            controller => get_standard_option('pve-sdn-controller-id'),
            running => {
                type => 'boolean',
                optional => 1,
                description => "Display running config.",
            },
            pending => {
                type => 'boolean',
                optional => 1,
                description => "Display pending config.",
            },
        },
    },
    returns => {
        properties => {
            digest => {
                type => 'string',
                description => 'Digest of the controller section.',
                optional => 1,
            },
            state => get_standard_option('pve-sdn-config-state'),
            controller => {
                type => 'string',
                description => 'Name of the controller.',
            },
            type => {
                type => 'string',
                description => 'Type of the controller',
                enum => PVE::Network::SDN::Controllers::Plugin->lookup_types(),
            },
            pending => {
                type => 'object',
                description =>
                    'Changes that have not yet been applied to the running configuration.',
                optional => 1,
                properties => $CONTROLLER_PROPERTIES,
            },
            %$CONTROLLER_PROPERTIES,
        },
    },
    code => sub {
        my ($param) = @_;

        my $cfg = {};
        if ($param->{pending}) {
            my $running_cfg = PVE::Network::SDN::running_config();
            my $config = PVE::Network::SDN::Controllers::config();
            $cfg = PVE::Network::SDN::pending_config($running_cfg, $config, 'controllers');
        } elsif ($param->{running}) {
            my $running_cfg = PVE::Network::SDN::running_config();
            $cfg = $running_cfg->{controllers};
        } else {
            $cfg = PVE::Network::SDN::Controllers::config();
        }

        return &$api_sdn_controllers_config($cfg, $param->{controller});
    },
});

__PACKAGE__->register_method({
    name => 'create',
    protected => 1,
    path => '',
    method => 'POST',
    description => "Create a new sdn controller object.",
    permissions => {
        check => ['perm', '/sdn/controllers', ['SDN.Allocate']],
    },
    parameters => PVE::Network::SDN::Controllers::Plugin->createSchema(
        undef,
        {
            'lock-token' => get_standard_option('pve-sdn-lock-token'),
        },
    ),
    returns => { type => 'null' },
    code => sub {
        my ($param) = @_;

        my $type = extract_param($param, 'type');
        my $id = extract_param($param, 'controller');
        my $lock_token = extract_param($param, 'lock-token');

        my $plugin = PVE::Network::SDN::Controllers::Plugin->lookup($type);
        my $opts = $plugin->check_config($id, $param, 1, 1);

        # create /etc/pve/sdn directory
        PVE::Cluster::check_cfs_quorum();
        mkdir("/etc/pve/sdn");

        PVE::Network::SDN::lock_sdn_config(
            sub {

                my $controller_cfg = PVE::Network::SDN::Controllers::config();

                my $scfg = undef;
                if (
                    $scfg = PVE::Network::SDN::Controllers::sdn_controllers_config(
                        $controller_cfg, $id, 1,
                    )
                ) {
                    die "sdn controller object ID '$id' already defined\n";
                }

                $controller_cfg->{ids}->{$id} = $opts;
                $plugin->on_update_hook($id, $controller_cfg);

                PVE::Network::SDN::Controllers::write_config($controller_cfg);

            },
            "create sdn controller object failed",
            $lock_token,
        );

        return undef;
    },
});

__PACKAGE__->register_method({
    name => 'update',
    protected => 1,
    path => '{controller}',
    method => 'PUT',
    description => "Update sdn controller object configuration.",
    permissions => {
        check => ['perm', '/sdn/controllers', ['SDN.Allocate']],
    },
    parameters => PVE::Network::SDN::Controllers::Plugin->updateSchema(
        undef,
        {
            'lock-token' => get_standard_option('pve-sdn-lock-token'),
        },
    ),
    returns => { type => 'null' },
    code => sub {
        my ($param) = @_;

        my $id = extract_param($param, 'controller');
        my $digest = extract_param($param, 'digest');
        my $delete = extract_param($param, 'delete');
        my $lock_token = extract_param($param, 'lock-token');

        PVE::Network::SDN::lock_sdn_config(
            sub {

                my $controller_cfg = PVE::Network::SDN::Controllers::config();

                PVE::SectionConfig::assert_if_modified($controller_cfg, $digest);

                my $scfg =
                    PVE::Network::SDN::Controllers::sdn_controllers_config($controller_cfg, $id);

                my $plugin = PVE::Network::SDN::Controllers::Plugin->lookup($scfg->{type});
                my $opts = $plugin->check_config($id, $param, 0, 1);

                if ($delete) {
                    $delete = [PVE::Tools::split_list($delete)];
                    my $options = $plugin->private()->{options}->{ $scfg->{type} };
                    PVE::SectionConfig::delete_from_config($scfg, $options, $opts, $delete);
                }

                for my $k (keys %{$opts}) {
                    $scfg->{$k} = $opts->{$k};
                }

                $plugin->on_update_hook($id, $controller_cfg);

                PVE::Network::SDN::Controllers::write_config($controller_cfg);

            },
            "update sdn controller object failed",
            $lock_token,
        );

        return undef;
    },
});

__PACKAGE__->register_method({
    name => 'delete',
    protected => 1,
    path => '{controller}',
    method => 'DELETE',
    description => "Delete sdn controller object configuration.",
    permissions => {
        check => ['perm', '/sdn/controllers', ['SDN.Allocate']],
    },
    parameters => {
        additionalProperties => 0,
        properties => {
            controller => get_standard_option(
                'pve-sdn-controller-id',
                {
                    completion => \&PVE::Network::SDN::Controllers::complete_sdn_controllers,
                },
            ),
            'lock-token' => get_standard_option('pve-sdn-lock-token'),
        },
    },
    returns => { type => 'null' },
    code => sub {
        my ($param) = @_;

        my $id = extract_param($param, 'controller');
        my $lock_token = extract_param($param, 'lock-token');

        PVE::Network::SDN::lock_sdn_config(
            sub {

                my $cfg = PVE::Network::SDN::Controllers::config();

                my $scfg = PVE::Network::SDN::Controllers::sdn_controllers_config($cfg, $id);

                my $plugin = PVE::Network::SDN::Controllers::Plugin->lookup($scfg->{type});

                my $zone_cfg = PVE::Network::SDN::Zones::config();

                $plugin->on_delete_hook($id, $zone_cfg);

                delete $cfg->{ids}->{$id};
                PVE::Network::SDN::Controllers::write_config($cfg);

            },
            "delete sdn controller object failed",
            $lock_token,
        );

        return undef;
    },
});

1;