summaryrefslogtreecommitdiffstats
path: root/os-plugins/plugins/xen/OpenSLX/OSPlugin/xen.pm
blob: 123319838d6dde192229cc72a71dbfe0b32aed55 (plain) (blame)
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
# Copyright (c) 2010 - RZ Uni Freiburg
# Copyright (c) 2010 - OpenSLX GmbH
#
# This program is free software distributed under the GPL version 2.
# See http://openslx.org/COPYING
#
# If you have any feedback please consult http://openslx.org/feedback and
# send your suggestions, praise, or complaints to feedback@openslx.org
#
# General information about OpenSLX can be found at http://openslx.org/
# -----------------------------------------------------------------------------
# xen.pm
#    - implementation of the 'xen' plugin
# -----------------------------------------------------------------------------
package OpenSLX::OSPlugin::xen;

use strict;
use warnings;

use base qw(OpenSLX::OSPlugin::Base);

use File::Path;

use OpenSLX::Basics;
use OpenSLX::Utils;

sub new
{
    my $class = shift;

    my $self = {
        name => 'xen',
    };

    return bless $self, $class;
}

sub getInfo
{
    my $self = shift;

    return {
        description => unshiftHereDoc(<<'        End-of-Here'),
            Configures Xen diskless boot, no installation yet.
        End-of-Here
        precedence => 10,
    };
}

sub getAttrInfo
{
    my $self = shift;

    return {
        'xen::active' => {
            applies_to_systems => 1,
            applies_to_clients => 1,
            description => unshiftHereDoc(<<'            End-of-Here'),
                should the 'xen'-plugin be executed during boot?
            End-of-Here
            content_regex => qr{^(0|1)$},
            content_descr => '1 means active - 0 means inactive',
            # set active to 0, later set specially created Xen system to 1
            default => '0',
        },
        # attribute 'imagesrc' defines where we can find xen images
        'xen::imagesrc' => {
            applies_to_systems => 1,
            applies_to_clients => 1,
            description => unshiftHereDoc(<<'            End-of-Here'),
                Where do we store our xen images? NFS? Filesystem?
            End-of-Here
            content_regex => qr{^(/|nfs://)},
            content_descr => 'local path or URI or "-" (unset)',
            default => undef,
        },
         # attribute 'tftpdir' defines TFTP dir for network boots /w NAT
        'xen::tftpdir' => {
            applies_to_systems => 1,
            applies_to_clients => 1,
            description => unshiftHereDoc(<<'            End-of-Here'),
                Do you want to define a stage 4 TFTP dir for netwoork boots?
                Needed to boot Xen via NFS, we only need the initramfs
                Hint: Mount your TFTP ro via NFS to a local dir
            End-of-Here
            content_regex => qr{^(/)},
            content_descr => 'local path or "-" (unset)',
            default => undef,
        },
    };
}

sub installationPhase
{
    my $self = shift;
    my $info = shift;

    $self->{pluginRepositoryPath} = $info->{'plugin-repo-path'};
    $self->{openslxBasePath}      = $info->{'openslx-base-path'};

    # Copy run-virt.include and template files to the appropriate place for
    # inclusion in stage4
    my $pluginName = $self->{'name'};
    my $pluginBasePath = 
      "$self->{openslxBasePath}/lib/plugins/$pluginName/files";

    foreach my $file ( qw( run-virt.include machine.include hvm.include ) ) {
        copyFile("$pluginBasePath/$file", "$self->{pluginRepositoryPath}/");
        chmod 0644, "$self->{pluginRepositoryPath}/$file";
    }

    return;
}

sub removalPhase
{
    my $self = shift;
    my $info = shift;

    return;
}

sub suggestAdditionalKernelModules
{
    my $self                = shift;
    my $makeInitRamFSEngine = shift;

    my @suggestedModules;

    # Xen needs bridge module, for guests xennet and maybe xenblk
    # earlier versions needed netloop
    push @suggestedModules, qw( bridge xennet xenblk );

    return @suggestedModules;
}

#sub _xenLabel
#{
#    # set label for each Xen system
#    foreach my $info (@$systemInfos) {
#        if ($info->{xen::active} eq 1) {
#            my $label = $info->{label} || '';
#            if (!length($label) || $label eq $info->{name}) {
#                if ($info->{name} =~ m{^(.+)::(.+)$}) {
#                    my $system = $1;
#                    my $exportType = $2;
#                    $label = $system . "-xen" . ' ' x (36-length($system))
#                      . $exportType;
#                } else {
#                    $label = $info->{name};
#                }
#            }
#        }
#        $info->{pxeLabel} = $label;
#    }
#    return $info; #??? 
#}

#sub _xenBootEntry
#{
#    # Xen entries look different
#    # Example:
#    # KERNEL mboot.c32 vendor-os/xen.gz dom0_mem=128000 ---
#    # vendor-os/vmlinuz-xen debug=3 --- vendor-os/initramfs-1
#    # TODO: versionsort oder per attr?
#    if ($info->{xen::active} eq 1) {
#        my $xenKernel = slxsystem(ls /boot/xen* | sort | tail -n 1);
#        $append .= " file=$bootURI"     if length($bootURI);
#        $append .= " file=$tftpPrefix"  if length($tftpPrefix);
#        $append .= " $clientAppend";
#        $append .= " --- $pxePrefix$vendorOSName/$info->{'initramfs-name'}";
#        $slxLabels .= "LABEL openslx-$info->{'external-id'}-xen\n";
#        # $slxLabels .= $pxeDefault;
#        $slxLabels .= "\tMENU LABEL ^$info->{pxeLabel}\n";
#        $slxLabels .= "\tKERNEL mboot.c32\n";
#        $slxLabels .= "\tAPPEND $pxePrefix$vendorOSName/$xenKernel";
#        # $slxLabels .= " dom0_mem=128000";
#        $slxLabels .= " --- $pxePrefix$vendorOSName/$kernelName";
#        $slxLabels .= " --- $append\n";
#        $slxLabels .= "\tIPAPPEND 3\n";
#    }
#    return $slxLabels;
#}

1;