From f08554855985bde86f30c6e5d3c5f19eebabd4f3 Mon Sep 17 00:00:00 2001 From: Bruce Potter Date: Mon, 17 Mar 2014 06:52:35 -0400 Subject: [PATCH] adding xCAT-SoftLayer files to 2.8 branch --- xCAT-SoftLayer/LICENSE.html | 326 ++++++++++++++++++ xCAT-SoftLayer/bin/getslnodes | 120 +++++++ xCAT-SoftLayer/bin/modifygrub | 264 ++++++++++++++ xCAT-SoftLayer/bin/pushinitrd | 236 +++++++++++++ xCAT-SoftLayer/pods/man1/getslnodes.1.pod | 84 +++++ xCAT-SoftLayer/pods/man1/pushinitrd.1.pod | 66 ++++ xCAT-SoftLayer/postscripts/setdefaultroute | 6 + .../scripts/post.sles.softlayer.common | 20 ++ .../sles/compute.sles11.softlayer.tmpl | 105 ++++++ xCAT-SoftLayer/xCAT-SoftLayer.spec | 73 ++++ xCAT-SoftLayer/xpod2man | 214 ++++++++++++ 11 files changed, 1514 insertions(+) create mode 100644 xCAT-SoftLayer/LICENSE.html create mode 100755 xCAT-SoftLayer/bin/getslnodes create mode 100755 xCAT-SoftLayer/bin/modifygrub create mode 100755 xCAT-SoftLayer/bin/pushinitrd create mode 100644 xCAT-SoftLayer/pods/man1/getslnodes.1.pod create mode 100644 xCAT-SoftLayer/pods/man1/pushinitrd.1.pod create mode 100755 xCAT-SoftLayer/postscripts/setdefaultroute create mode 100644 xCAT-SoftLayer/share/xcat/install/scripts/post.sles.softlayer.common create mode 100644 xCAT-SoftLayer/share/xcat/install/sles/compute.sles11.softlayer.tmpl create mode 100644 xCAT-SoftLayer/xCAT-SoftLayer.spec create mode 100755 xCAT-SoftLayer/xpod2man diff --git a/xCAT-SoftLayer/LICENSE.html b/xCAT-SoftLayer/LICENSE.html new file mode 100644 index 000000000..83d0eebb0 --- /dev/null +++ b/xCAT-SoftLayer/LICENSE.html @@ -0,0 +1,326 @@ + + + + + + + +Eclipse Public License - Version 1.0 + + + + + + +
+ +

Eclipse Public License - v 1.0 +

+ +

THE ACCOMPANYING PROGRAM IS PROVIDED UNDER +THE TERMS OF THIS ECLIPSE PUBLIC LICENSE ("AGREEMENT"). ANY USE, +REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE +OF THIS AGREEMENT.

+ +

1. DEFINITIONS

+ +

"Contribution" means:

+ +

a) +in the case of the initial Contributor, the initial code and documentation +distributed under this Agreement, and
+b) in the case of each subsequent Contributor:

+ +

i) +changes to the Program, and

+ +

ii) +additions to the Program;

+ +

where +such changes and/or additions to the Program originate from and are distributed +by that particular Contributor. A Contribution 'originates' from a Contributor +if it was added to the Program by such Contributor itself or anyone acting on +such Contributor's behalf. Contributions do not include additions to the +Program which: (i) are separate modules of software distributed in conjunction +with the Program under their own license agreement, and (ii) are not derivative +works of the Program.

+ +

"Contributor" means any person or +entity that distributes the Program.

+ +

"Licensed Patents " mean patent +claims licensable by a Contributor which are necessarily infringed by the use +or sale of its Contribution alone or when combined with the Program.

+ +

"Program" means the Contributions +distributed in accordance with this Agreement.

+ +

"Recipient" means anyone who +receives the Program under this Agreement, including all Contributors.

+ +

2. GRANT OF RIGHTS

+ +

a) +Subject to the terms of this Agreement, each Contributor hereby grants Recipient +a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly +display, publicly perform, distribute and sublicense the Contribution of such +Contributor, if any, and such derivative works, in source code and object code +form.

+ +

b) +Subject to the terms of this Agreement, each Contributor hereby grants +Recipient a non-exclusive, worldwide, royalty-free +patent license under Licensed Patents to make, use, sell, offer to sell, import +and otherwise transfer the Contribution of such Contributor, if any, in source +code and object code form. This patent license shall apply to the combination +of the Contribution and the Program if, at the time the Contribution is added +by the Contributor, such addition of the Contribution causes such combination +to be covered by the Licensed Patents. The patent license shall not apply to +any other combinations which include the Contribution. No hardware per se is +licensed hereunder.

+ +

c) +Recipient understands that although each Contributor grants the licenses to its +Contributions set forth herein, no assurances are provided by any Contributor +that the Program does not infringe the patent or other intellectual property +rights of any other entity. Each Contributor disclaims any liability to Recipient +for claims brought by any other entity based on infringement of intellectual +property rights or otherwise. As a condition to exercising the rights and +licenses granted hereunder, each Recipient hereby assumes sole responsibility +to secure any other intellectual property rights needed, if any. For example, +if a third party patent license is required to allow Recipient to distribute +the Program, it is Recipient's responsibility to acquire that license before +distributing the Program.

+ +

d) +Each Contributor represents that to its knowledge it has sufficient copyright +rights in its Contribution, if any, to grant the copyright license set forth in +this Agreement.

+ +

3. REQUIREMENTS

+ +

A Contributor may choose to distribute the +Program in object code form under its own license agreement, provided that: +

+ +

a) +it complies with the terms and conditions of this Agreement; and

+ +

b) +its license agreement:

+ +

i) +effectively disclaims on behalf of all Contributors all warranties and +conditions, express and implied, including warranties or conditions of title +and non-infringement, and implied warranties or conditions of merchantability +and fitness for a particular purpose;

+ +

ii) +effectively excludes on behalf of all Contributors all liability for damages, +including direct, indirect, special, incidental and consequential damages, such +as lost profits;

+ +

iii) +states that any provisions which differ from this Agreement are offered by that +Contributor alone and not by any other party; and

+ +

iv) +states that source code for the Program is available from such Contributor, and +informs licensees how to obtain it in a reasonable manner on or through a +medium customarily used for software exchange.

+ +

When the Program is made available in source +code form:

+ +

a) +it must be made available under this Agreement; and

+ +

b) a +copy of this Agreement must be included with each copy of the Program.

+ +

Contributors may not remove or alter any +copyright notices contained within the Program.

+ +

Each Contributor must identify itself as the +originator of its Contribution, if any, in a manner that reasonably allows +subsequent Recipients to identify the originator of the Contribution.

+ +

4. COMMERCIAL DISTRIBUTION

+ +

Commercial distributors of software may +accept certain responsibilities with respect to end users, business partners +and the like. While this license is intended to facilitate the commercial use +of the Program, the Contributor who includes the Program in a commercial +product offering should do so in a manner which does not create potential +liability for other Contributors. Therefore, if a Contributor includes the +Program in a commercial product offering, such Contributor ("Commercial +Contributor") hereby agrees to defend and indemnify every other +Contributor ("Indemnified Contributor") against any losses, damages and +costs (collectively "Losses") arising from claims, lawsuits and other +legal actions brought by a third party against the Indemnified Contributor to +the extent caused by the acts or omissions of such Commercial Contributor in +connection with its distribution of the Program in a commercial product +offering. The obligations in this section do not apply to any claims or Losses +relating to any actual or alleged intellectual property infringement. In order +to qualify, an Indemnified Contributor must: a) promptly notify the Commercial +Contributor in writing of such claim, and b) allow the Commercial Contributor +to control, and cooperate with the Commercial Contributor in, the defense and +any related settlement negotiations. The Indemnified Contributor may participate +in any such claim at its own expense.

+ +

For example, a Contributor might include the +Program in a commercial product offering, Product X. That Contributor is then a +Commercial Contributor. If that Commercial Contributor then makes performance +claims, or offers warranties related to Product X, those performance claims and +warranties are such Commercial Contributor's responsibility alone. Under this +section, the Commercial Contributor would have to defend claims against the +other Contributors related to those performance claims and warranties, and if a +court requires any other Contributor to pay any damages as a result, the +Commercial Contributor must pay those damages.

+ +

5. NO WARRANTY

+ +

EXCEPT AS EXPRESSLY SET FORTH IN THIS +AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT +WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, +WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, +MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely +responsible for determining the appropriateness of using and distributing the +Program and assumes all risks associated with its exercise of rights under this +Agreement , including but not limited to the risks and costs of program errors, +compliance with applicable laws, damage to or loss of data, programs or +equipment, and unavailability or interruption of operations.

+ +

6. DISCLAIMER OF LIABILITY

+ +

EXCEPT AS EXPRESSLY SET FORTH IN THIS +AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR +ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +(INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY +OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF +THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF +THE POSSIBILITY OF SUCH DAMAGES.

+ +

7. GENERAL

+ +

If any provision of this Agreement is invalid +or unenforceable under applicable law, it shall not affect the validity or +enforceability of the remainder of the terms of this Agreement, and without +further action by the parties hereto, such provision shall be reformed to the +minimum extent necessary to make such provision valid and enforceable.

+ +

If Recipient institutes patent litigation +against any entity (including a cross-claim or counterclaim in a lawsuit) +alleging that the Program itself (excluding combinations of the Program with +other software or hardware) infringes such Recipient's patent(s), then such +Recipient's rights granted under Section 2(b) shall terminate as of the date +such litigation is filed.

+ +

All Recipient's rights under this Agreement +shall terminate if it fails to comply with any of the material terms or +conditions of this Agreement and does not cure such failure in a reasonable +period of time after becoming aware of such noncompliance. If all Recipient's +rights under this Agreement terminate, Recipient agrees to cease use and +distribution of the Program as soon as reasonably practicable. However, +Recipient's obligations under this Agreement and any licenses granted by +Recipient relating to the Program shall continue and survive.

+ +

Everyone is permitted to copy and distribute +copies of this Agreement, but in order to avoid inconsistency the Agreement is +copyrighted and may only be modified in the following manner. The Agreement +Steward reserves the right to publish new versions (including revisions) of +this Agreement from time to time. No one other than the Agreement Steward has +the right to modify this Agreement. The Eclipse Foundation is the initial +Agreement Steward. The Eclipse Foundation may assign the responsibility to +serve as the Agreement Steward to a suitable separate entity. Each new version +of the Agreement will be given a distinguishing version number. The Program +(including Contributions) may always be distributed subject to the version of +the Agreement under which it was received. In addition, after a new version of +the Agreement is published, Contributor may elect to distribute the Program +(including its Contributions) under the new version. Except as expressly stated +in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to +the intellectual property of any Contributor under this Agreement, whether +expressly, by implication, estoppel or otherwise. All rights in the Program not +expressly granted under this Agreement are reserved.

+ +

This Agreement is governed by the laws of the +State of New York and the intellectual property laws of the United States of +America. No party to this Agreement will bring a legal action under this +Agreement more than one year after the cause of action arose. Each party waives +its rights to a jury trial in any resulting litigation.

+ +

 

+ +
+ + + + diff --git a/xCAT-SoftLayer/bin/getslnodes b/xCAT-SoftLayer/bin/getslnodes new file mode 100755 index 000000000..ae02b6642 --- /dev/null +++ b/xCAT-SoftLayer/bin/getslnodes @@ -0,0 +1,120 @@ +#!/usr/bin/perl + +# Query the softlayer account for info about all of the bare metal servers and +# put the info in mkdef stanza format, so the node can be defined in the xcat db +# so that xcat can manage/deploy them. + +use strict; +use Getopt::Long; +use Data::Dumper; +#$Data::Dumper::Maxdepth=2; + +# Globals - these are set once and then only read. +my $HELP; +my $VERBOSE; +my %CONFIG; # attributes read from config file + +my $usage = sub { + my $exitcode = shift @_; + print "Usage: getslnodes [-?|-h|--help] [-v|--verbose] []\n\n"; + if (!$exitcode) { + print "getslnodes queries your SoftLayer account and gets attributes for each\n"; + print "server. The attributes can be piped to 'mkdef -z' to define the nodes\n"; + print "in the xCAT DB so that xCAT can manage them. getslnodes\n"; + print "requires a .slconfig file in your home directory that contains your\n"; + print "SoftLayer userid, API key, and location of API perl module, in attr=val format.\n"; + } + exit $exitcode; +}; + +# Process the cmd line args +Getopt::Long::Configure("bundling"); +#Getopt::Long::Configure("pass_through"); +Getopt::Long::Configure("no_pass_through"); +if (!GetOptions('h|?|help' => \$HELP, 'v|verbose' => \$VERBOSE)) { $usage->(1); } + +if ($HELP) { $usage->(0); } +if (scalar(@ARGV)>1) { $usage->(1); } +my $hnmatch = $ARGV[0]; # if they specified a hostname match, only show svrs that start with that + +readconf("$ENV{HOME}/.slconfig"); # get the userid and api key from the config file +#my $api_username = 'SL276540'; +#my $api_key = '799d5d9267a927a330ec016f00bfe17e6fc532d203cf68b3b0d997b2d27a3ce1'; + +my $slinstalled = eval { push @INC, $CONFIG{apidir}; require SoftLayer::API::SOAP; }; +if (!$slinstalled) { die "Error: the SoftLayer::API::SOAP perl module is not installed. Download it using 'git clone https://github.com/softlayer/softlayer-api-perl-client' and put the directory in ~/.slconfig ."; } + +my $client = SoftLayer::API::SOAP->new('SoftLayer_Account', undef, $CONFIG{userid}, $CONFIG{apikey}); + +my $mask = "mask[operatingSystem.passwords,remoteManagementAccounts,remoteManagementComponent,backendNetworkComponents]"; +$client->setObjectMask($mask); + +#print $client->fault; +#print $client->faultstring; +#print "\n"; + +my $hw = $client->getHardware(); +my $servers = $hw->result; +foreach my $server (@$servers) { + if ($server->{fullyQualifiedDomainName} =~ m/$hnmatch/) { + print "\n".$server->{hostname}.":\n"; + print "\tobjtype=node\n"; + print "\tgroups=slnode,ipmi,all\n"; + print "\tmgt=ipmi\n"; + print "\tbmc=".$server->{remoteManagementComponent}->{ipmiIpAddress}."\n"; + print "\tbmcusername=".$server->{remoteManagementAccounts}->[0]->{username}."\n"; + print "\tbmcpassword=".$server->{remoteManagementAccounts}->[0]->{password}."\n"; + print "\tmac=".$server->{backendNetworkComponents}->[0]->{macAddress}."\n"; + print "\tip=".$server->{privateIpAddress}."\n"; + print "\tnetboot=xnba\n"; + print "\tarch=x86_64\n"; + print "\tusercomment=hostname:".$server->{fullyQualifiedDomainName}.", user:".$server->{operatingSystem}->{passwords}->[0]->{username}.", pw:".$server->{operatingSystem}->{passwords}->[0]->{password}."\n"; + + #print Dumper($server->{remoteManagementAccounts}); + #print "#Softlayer_account_info_for ".$server->{fullyQualifiedDomainName} . " Username: "; + #print $server->{operatingSystem}->{passwords}->[0]->{username} . " Password: "; + #print $server->{operatingSystem}->{passwords}->[0]->{password}. "\n"; + #print "nodeadd ".$server->{hostname}." groups=saptest ipmi.password=".$server->{remoteManagementAccounts}->[0]->{password}." ipmi.bmc=".$server->{remoteManagementComponent}->{ipmiIpAddress}; + #print " mac.mac=".$server->{backendNetworkComponents}->[0]->{macAddress}; + #print " hosts.ip=".$server->{privateIpAddress} ."\n"; + } +} +exit(0); + + +# Pring msg only if -v was specified +sub verbose { if ($VERBOSE) { print shift, "\n"; } } + + +# Read the config file. Format is attr=val on each line. Should contain at leas the userid and apikey. +# This function fills in the global %CONFIG hash. +sub readconf { + my $conffile = shift @_; + open(FILE, $conffile) || die "Error: can not open config file $conffile: $!\n"; + while () { + my $line = $_; + chomp($line); + if ($line =~ /^#/ || $line =~/^\s*$/) { next; } # skip comment lines + my ($key, $value) = split(/\s*=\s*/, $line, 2); + if (!defined($value)) { die "Error: line '$line' does not have format attribute=value\n"; } + $CONFIG{$key} = $value; + } + close FILE; + verbose('%CONFIG hash: ' . Dumper(\%CONFIG)); + + # the config file needs to contain at least the userid and api key + if (!defined($CONFIG{userid}) || !defined($CONFIG{apikey}) || !defined($CONFIG{apidir})) { + die "Error: the config file must contain values for userid, apikey, and apidir.\n"; + } +} + +#$mask = "mask[operatingSystem.passwords]"; +#$client->setObjectMask($mask); +#my $vs = $client->getVirtualGuests(); +#my $servers = $vs->result; +#foreach my $server (@$servers) { +# if ($server->{fullyQualifiedDomainName} eq "xcat1-sap.saptest.ibm.com") { +# print $server->{primaryIpAddress}."\n"; +# print $server->{operatingSystem}->{passwords}->[0]->{password}."\n"; +# } +#} diff --git a/xCAT-SoftLayer/bin/modifygrub b/xCAT-SoftLayer/bin/modifygrub new file mode 100755 index 000000000..a6d28407f --- /dev/null +++ b/xCAT-SoftLayer/bin/modifygrub @@ -0,0 +1,264 @@ +#!/usr/bin/perl + +# Modify the grub config file on the node to boot the specified kernel and initrd. +# This script is meant to be run on the node via xdsh -e. +# Currently requires that dns on the mn be configured and working to resolve the short node names. + +use strict; +use Getopt::Long; +use Data::Dumper; +use Socket; + +# Globals - these are set once and then only read. +my $HELP; +my $VERBOSE; +my $WAITTIME; +my $XCATNETBOOTTITLE = 'xCAT network boot kernel and initrd'; + +my $usage = sub { + my $exitcode = shift @_; + print "Usage: modifygrub [-?|-h|--help] [-v|--verbose] [-w ] \n\n"; + if (!$exitcode) { + print "Modify the grub config file on the node to boot the specified kernel and initrd.\n"; + } + exit $exitcode; +}; + +if (-f '/etc/os-release') { die "This script doesn't support ubuntu yet.\n"; } + +# Process the cmd line args +Getopt::Long::Configure("bundling"); +#Getopt::Long::Configure("pass_through"); +Getopt::Long::Configure("no_pass_through"); +if (!GetOptions('h|?|help' => \$HELP, 'v|verbose' => \$VERBOSE, 'w|waittime=s' => \$WAITTIME)) { $usage->(1); } + +if ($HELP) { $usage->(0); } +if (scalar(@ARGV) != 4) { $usage->(1); } +if (!defined($WAITTIME)) { $WAITTIME = 60; } # seconds to wait after configuring the nic (to let the switch handle the state change) +my %args; +$args{kernelpath} = $ARGV[0]; +$args{initrdpath} = $ARGV[1]; +$args{kernelparms} = $ARGV[2]; +$args{mnip} = $ARGV[3]; + +addKernelParms(\%args); # replace and add some parms to args{kernelparms} +updateGrub(\%args); # update the grub config with an entry filled with the info in args + +exit(0); + + +# Add ip and net info to the kernel parms. Modifies the kernelparms value of the args hash passed in. +sub addKernelParms { + my $args = shift @_; + + # replace '!myipfn!' with the mn ip + my $mnip = $args->{mnip}; + $args->{kernelparms} =~ s/!myipfn!/$mnip/g; + + # replace with the nodename + my $nodename = $ENV{NODE}; # this env var is set by xdsh + $args->{kernelparms} =~ s//$nodename/g; + + # get node ip and add it to the kernel parms + my ($nic, $ip, $netmask, $gateway) = getNodeIpInfo($args); + if (!$ip) { die "Error: could not find the NIC that would connect to the xCAT mgmt node's IP (".$args->{mnip}.").\n"; } + $args->{kernelparms} .= " hostip=$ip netmask=$netmask gateway=$gateway dns=$mnip hostname=$nodename netdevice=$nic netwait=$WAITTIME textmode=1"; +} + + +# get this nodes nic, ip, netmask, and gateway. Returns them in a 4 element array. +sub getNodeIpInfo { + my $args = shift @_; + my ($ipprefix) = $args->{mnip}=~m/^(\d+\.\d+)\./; #todo: this is a hack, just using the 1st 2 octets of the mn ip addr + verbose("using IP prefix $ipprefix"); + + # parse ip addr show output, looking for ipprefix, to determine nic and ip + my @output = runcmd("ip addr show"); + my ($nic, $ipandmask); + foreach my $line (@output) { + my ($nictmp, $iptmp); + if (($nictmp) = $line=~m/^\d+:\s+(\S+): /) { $nic = $nictmp; } # new stanza, remember it + if (($iptmp) = $line=~m/^\s+inet\s+($ipprefix\S+) /) { $ipandmask = $iptmp; last; } # got ip, we are done + } + my ($ip, $netmask) = convertIpAndMask($ipandmask); + + # if the nic is a bonded nic (common on sl), then find the 1st real nic that is part of it + my $realnic = $nic; + if ($nic =~ /^bond/) { + my @nics = grep(m/\s+master\s+$nic\s+/, @output); + if (!scalar(@nics)) { die "Error: can't find the NICs that are part of $nic.\n"; } + ($realnic) = $nics[0]=~m/^\d+:\s+(\S+): /; + } + + # finally, find the gateway + my $gateway; + my @output = runcmd("ip route"); + # we are looking for a line like: 10.0.0.0/8 via 10.54.51.1 dev bond0 + my @networks = grep(m/ via .* $nic\s*$/, @output); + if (scalar(@networks)) { ($gateway) = $networks[0]=~m/ via\s+(\S+)/; } + else { + # use the mn ip as a fall back + $gateway = $args->{mnip}; + verbose("using xCAT mgmt node IP as the fall back gateway."); + } + + verbose("IP info: realnic=$realnic, ip=$ip, netmask=$netmask, gateway=$gateway"); + return ($realnic, $ip, $netmask, $gateway); +} + + +# Convert an ip/mask in slash notation (like 10.0.0.1/26) to separate ip and netmask like 10.0.0.1 and 255.255.255.192 +sub convertIpAndMask { + my $ipandmask = shift @_; + my ($ip, $masknum) = split('/', $ipandmask); + my $netbin = oct("0b" . '1' x $masknum . '0' x (32-$masknum)); # create a str like '1111100', then convert to binary + my @netarr=unpack('C4',pack('N',$netbin)); # separate into the 4 octets + my $netmask=join('.',@netarr); # put them together into the normal looking netmask + return ($ip, $netmask); +} + + +# not used - resolve the hostname to an ip addr +sub getipaddr { + my $hostname = shift @_; + my $packed_ip; + $packed_ip = inet_aton($hostname); + if (!$packed_ip) { return undef; } + return inet_ntoa($packed_ip); +} + + +# Update the grub config file with a new stanza for booting our kernel and initrd +sub updateGrub { + my $args = shift @_; + + # how we specify the path for the kernel and initrd is different on redhat and suse + my $fileprefix; + if (isRedhat()) { $fileprefix = '/'; } + elsif (isSuse()) { $fileprefix = '/boot/'; } + else { die "Error: currently only support red hat or suse distros.\n"; } + + # open the grub file and see if it is in there or if we have to add it + my $grubfile = findGrubPath(); + verbose("reading $grubfile"); + open(FILE, $grubfile) || die "Error: can not open config file $grubfile for reading: $!\n"; + my @lines = ; + close FILE; + + # this is the entry we want in the grub file + my @rootlines = grep(/^\s+root\s+/, @lines); # copy one of the existing root lines + if (!scalar(@rootlines)) { die "Error: can't find an existing line for 'root' in the grub config file\n"; } + my ($rootline) = $rootlines[0] =~ m/^\s*(.*?)\s*$/; + my @entry = ( + "title $XCATNETBOOTTITLE\n", + "\t$rootline\n", + "\tkernel " . $fileprefix . $args->{kernelpath} . ' ' . $args->{kernelparms} . "\n", + "\tinitrd " . $fileprefix . $args->{initrdpath} . "\n", + ); + + my $needtowritefile = 1; + if (grep(/^title\s+$XCATNETBOOTTITLE/, @lines)) { $needtowritefile = updateGrubEntry(\@lines, \@entry); } # there is already an entry in there + else { addGrubEntry (\@lines, \@entry); } + + # write the file with the new/updated xcat entry + if ($needtowritefile) { + verbose("updating $grubfile"); + open(FILE, '>', $grubfile) || die "Error: can not open config file $grubfile for writing: $!\n"; + print FILE @lines; + close FILE; + } + else { print "Info: $grubfile did not need modifying. It was already up to date.\n"; } +} + + +# add our entry as the 1st one in the grub file +sub addGrubEntry { + my ($lines, $entry) = @_; + # find the index of the 1st stanza (it starts with 'title') + my $i; + for ($i=0; $i[$i] =~ m/^title\s+/) { verbose('adding xcat entry before:'.$lines->[$i]); last; } # found it + } + + # splice the entry right before the i-th line (which may also be 1 past the end) + splice(@$lines, $i, 0, @$entry); +} + + +# check the xcat entry in the grub file and see if it needs to be updated. Return 1 if it does. +sub updateGrubEntry { + my ($lines, $entry) = @_; + #print Dumper($lines), Dumper($entry); + # find the index of the xcat stanza + my $i; + for ($i=0; $i[$i] =~ m/^title\s+$XCATNETBOOTTITLE/) { last; } # found it + } + + # compare the next few lines with the corresponding line in @$entries and replace if different + my $replaced = 0; + for (my $j=0; $j[$i+$j], "\n ", $entry->[$j], "\n"; + if ($lines->[$i+$j] ne $entry->[$j]) { # this line was different + $lines->[$i+$j] = $entry->[$j]; + $replaced = 1; + } + } + + return $replaced; +} + + +# depending on the distro, find the correct grub file and return its path +sub findGrubPath { + # for rhel/centos it is /boot/grub/grub.conf, for sles it is /boot/grub/menu.lst + my @paths = qw(/boot/grub/grub.conf /boot/grub/menu.lst); + foreach my $p (@paths) { + if (-f $p) { return $p; } + } + + die "Error: Can't find grub config file.\n"; + + #todo: support ubuntu: you add an executable file in /etc/grub.d named 06_xcatnetboot that prints out the + # entry to add. Then run grub-mkconfig. +} + + +# Pring msg only if -v was specified +sub verbose { if ($VERBOSE) { print shift, "\n"; } } + +# Check the distro we are running on +sub isSuse { return (-e '/etc/SuSE-release'); } +sub isRedhat { return (-e '/etc/redhat-release' || -e '/etc/centos-release' || -e '/etc/fedora-release'); } # add chk for fedora + + + +# Run a command. If called in the context of return an array, it will capture the output +# of the cmd and return it. Otherwise, it will display the output to stdout. +# If the cmd has a non-zero rc, this function will die with a msg. +sub runcmd +{ + my ($cmd) = @_; + my $rc; + + $cmd .= ' 2>&1' ; + verbose($cmd); + + my @output; + if (wantarray) { + @output = `$cmd`; + $rc = $?; + } + else { + system($cmd); + $rc = $?; + } + + if ($rc) { + $rc = $rc >> 8; + if ($rc > 0) { die "Error: rc $rc return from cmd: $cmd\n"; } + else { die "Error: system error returned from cmd: $cmd\n"; } + } + elsif (wantarray) { return @output; } +} + diff --git a/xCAT-SoftLayer/bin/pushinitrd b/xCAT-SoftLayer/bin/pushinitrd new file mode 100755 index 000000000..7e3cd5a7e --- /dev/null +++ b/xCAT-SoftLayer/bin/pushinitrd @@ -0,0 +1,236 @@ +#!/usr/bin/perl + +# Copy the initrd, kernel, params, and static IP info to nodes, so they can net install +# even across vlans (w/o setting up pxe/dhcp broadcast relay). This assumes a working +# OS is on the node. This script is primarily meant to be used in the softlayer environment. + +#todo: site attr for using static ip? + +use strict; +use Getopt::Long; +use Data::Dumper; + +# Globals - these are set once and then only read. +my $HELP; +my $VERBOSE; +my $WAITTIME; +my $NOAUTOINST; + +my $usage = sub { + my $exitcode = shift @_; + print "Usage: pushinitrd [-?|-h|--help] [-v|--verbose] [-w ] \n\n"; + if (!$exitcode) { + print "Copy the initrd, kernel, params, and static IP info to nodes, so they can net install\n"; + print "even across vlans (w/o setting up pxe/dhcp broadcast relay). This assumes a working\n"; + print "OS is on the node, that you've run nodeset for these nodes, and that all of the nodes\n"; + print "are using the same osimage.\n"; + } + exit $exitcode; +}; + +# Process the cmd line args +Getopt::Long::Configure("bundling"); +#Getopt::Long::Configure("pass_through"); +Getopt::Long::Configure("no_pass_through"); +if (!GetOptions('h|?|help' => \$HELP, 'v|verbose' => \$VERBOSE, 'w|waittime=s' => \$WAITTIME, 'a|noautoinst' => \$NOAUTOINST)) { $usage->(1); } + +if ($HELP) { $usage->(0); } +if (scalar(@ARGV) != 1) { $usage->(1); } +if (!defined($WAITTIME)) { $WAITTIME = 75; } # seconds to wait after configuring the nic (to let the switch handle the state change) +my $noderange = $ARGV[0]; + +my %bootparms = getBootParms($noderange); + +copyFilesToNodes($noderange, \%bootparms); + +updateGrubOnNodes($noderange, \%bootparms); + +if (!$NOAUTOINST) { modifyAutoinstFiles($noderange, \%bootparms); } + +exit(0); + + +# Query the db for the kernel, initrd, and kcmdline attributes of the 1st node in the noderange +sub getBootParms { + my $nr = shift @_; + my %bootparms; + my @output = runcmd("nodels $nr bootparams.kernel bootparams.initrd bootparams.kcmdline"); + + # the attributes can be displayed in a different order than requested, so need to grep for them + my @gresults; + foreach my $a (qw(kernel initrd kcmdline)) { + my $attr = "bootparams.$a"; + @gresults = grep(/^\S+:\s+$attr:/, @output); + if (!scalar(@gresults)) { die "Error: attribute $attr not defined for the noderange. Did you run 'nodeset osimage=' ?\n"; } + # for now just pick the 1st one. They should all be the same, except for the node name in kcmdline + chomp($gresults[0]); + $gresults[0] =~ s/^\S+:\s+$attr:\s*//; + $bootparms{$a} = $gresults[0]; + if ($a eq 'kcmdline') { $bootparms{$a} =~ s|/install/autoinst/\S+|/install/autoinst/|; } + } + + # get the mgmt node cluster-facing ip addr + @output = runcmd('lsdef -t site -i master -c'); + chomp($output[0]); + my ($junk, $ip) = split(/=/, $output[0]); + $bootparms{mnip} = $ip; + + verbose(Dumper(\%bootparms)); + return %bootparms; +} + + +# Copy the kernel and initrd to the nodes +# Args: noderange, reference to the bootparms hash +sub copyFilesToNodes { + my $nr = shift @_; + my $bootparms = shift @_; + foreach my $a (qw(kernel initrd)) { + my $file = $bootparms->{$a}; + my $localfile = "/tftpboot/$file"; + # for the + my $remotefile = '/boot/' . remoteFilename($file); + print "Copying $localfile to $nr:$remotefile\n"; + runcmd("xdcp $nr -p $localfile $remotefile"); + } +} + + +# Form the remote file name, using the last 2 parts of the path, separated by "-" +sub remoteFilename { + my $f = shift @_; + $f =~ s|^.*/([^/]+)/([^/]+)$|$1-$2|; + return $f; +} + + +# Run the modifygrub script on the nodes to update the grub config file +# Args: noderange, reference to the bootparms hash +sub updateGrubOnNodes { + my $nr = shift @_; + my $bootparms = shift @_; + my $vtxt = ($VERBOSE ? '-v' : ''); + my @output = runcmd('which modifygrub'); + my $modifygrub = $output[0]; + chomp($modifygrub); + my $cmd = "xdsh $nr -e $modifygrub $vtxt -w $WAITTIME " . remoteFilename($bootparms->{kernel}) . ' ' . remoteFilename($bootparms->{initrd}) . ' '; + # we need to quote the kernel parms, both here when passing it to xdsh, and on the node + # when xdsh is passing it to modifygrub. The way to get single quotes inside single quotes + # is to quote each of the outer single quotes with double quotes. + $cmd .= q("'"') . $bootparms->{kcmdline} . q('"'"); + $cmd .= ' ' . $bootparms->{mnip}; + print "Running modifygrub on $nr to update the grub configuration.\n"; + runcmd($cmd); +} + + +# Hack the autoinst files to wait in a key spot to make them work even tho it takes +# the NICs almost a min before they can transmit after a state change. +#todo: this has only been tested with SLES nodes +sub modifyAutoinstFiles { + my $nr = shift @_; + my $bootparms = shift @_; + + # expand the noderange into a list of nodes + my @nodes = runcmd("nodels $nr"); + chomp(@nodes); + + # Edit each file to have chroot.sles insert a wait at the end of /etc/init.d/network + # this finds the end of boot.sh script (which is chroot.sles) + my $search = '\n\]\]>\s*\s*\s*'; + my $file = '/mnt/etc/init.d/network'; # at this point in the installation, the permanent file system is just mounted + #my $waitstring = 'echo Sleeping for 55s;sleep 55'; + # this is the string to insert in the nodes /etc/init.d/network script. It is a while loop pinging the mn, but some of the chars need to be escape for sed + my $waitstring = 'echo Waiting to reach xCAT mgmt node...;while \[ \$\(\(xcati+=1\)\) -le 60 \] \&\& ! ping -c2 -w3 ' . $bootparms->{mnip} .'; do echo i=\$xcati ; done; sleep 10'; + # this crazy sed string is from google. It gathers up the whole file into the hold buffer, and then the substitution is done on the whole file + my $sedstring = q|sed -n '1h;1!H;${;g;s/\(\t\treload_firewall\n\)\n/\1\t\t| . $waitstring . q(\n\n/g;p;}') . " $file > $file.new"; + # finally create the perl replace string that will be used to modify the autoinst file + my $replace = "$sedstring\nchmod 755 $file.new; mv -f $file.new $file"; + + # now actually update the file + print "Updating /install/autoinst files.\n"; + foreach my $n (@nodes) { + my $f = "/install/autoinst/$n"; + my $matches = sed($f, $search, $replace, mode=>'insertbefore'); + if (!$matches) { die "Error: could not find the right place in $f to insert the sed of the network wait.\n"; } + } +} + + +# this is like multi-line sed replace function +# Args: filename, search-string, replace-string +sub sed { + my ($file, $search, $replace, %options) = @_; + #my $opts = 's'; + #if ($options{global}) { $opts .= 'g'; } + + # open the file for reading + verbose("reading $file"); + open(FILE, $file) || die "Error: can not open file $file for reading: $!\n"; + my $lines; + while () { $lines .= $_; } + #verbose('file length is '.length($lines)); + close FILE; + + # we also need to look for this string 1st + my $replacecopy = $replace; # a search string can't have special chars in it + $replacecopy =~ s/(\W)/\\$1/g; # so escape all of the meta characters + #print "replacecopy=$replacecopy\n"; + # check to see if the replace string is already in the file + if ($lines =~ m/$replacecopy/s) { + print "$file did not need updating.\n"; + return 1; + } + + # search/replace and see if there were any matches + my $matches; + if ($options{mode} eq 'insertbefore') { $matches = $lines =~ s/($search)/\n$replace\n$1/s; } + elsif ($options{mode} eq 'insertafter') { $matches = $lines =~ s/($search)/$1\n$replace\n/s; } + elsif ($options{mode} eq 'replace') { $matches = $lines =~ s/$search/$replace/s; } + else { die "Internal error: don't suppor sed mode of $options{mode}.\n"; } + + + # write file if necessary + if ($matches) { + verbose("updating $file"); + open(FILE, '>', $file) || die "Error: can not open file $file for writing: $!\n"; + print FILE $lines; + close FILE; + } + return $matches; +} + + +# Pring msg only if -v was specified +sub verbose { if ($VERBOSE) { print shift, "\n"; } } + + + +# Run a command. If called in the context of return an array, it will capture the output +# of the cmd and return it. Otherwise, it will display the output to stdout. +# If the cmd has a non-zero rc, this function will die with a msg. +sub runcmd +{ + my ($cmd) = @_; + my $rc; + + $cmd .= ' 2>&1' ; + verbose($cmd); + + my @output; + if (wantarray) { + @output = `$cmd`; + $rc = $?; + } + else { + system($cmd); + $rc = $?; + } + + if ($rc) { + $rc = $rc >> 8; + if ($rc > 0) { die "Error: rc $rc return from cmd: $cmd\n"; } + else { die "Error: system error returned from cmd: $cmd\n"; } + } + elsif (wantarray) { return @output; } +} diff --git a/xCAT-SoftLayer/pods/man1/getslnodes.1.pod b/xCAT-SoftLayer/pods/man1/getslnodes.1.pod new file mode 100644 index 000000000..d9e3bbb1c --- /dev/null +++ b/xCAT-SoftLayer/pods/man1/getslnodes.1.pod @@ -0,0 +1,84 @@ +=head1 NAME + +B - queries your SoftLayer account and gets attributes for each server. + +=head1 SYNOPSIS + +B [B<-v>|B<--verbose>] [I] + +B [B<-?> | B<-h> | B<--help>] + +=head1 DESCRIPTION + +The B command queries your SoftLayer account and gets attributes for each +server. The attributes can be piped to 'mkdef -z' to define the nodes +in the xCAT DB so that xCAT can manage them. + +Before using this command, you must download and install the SoftLayer API perl module. +For example: + + cd /usr/local/lib + git clone https://github.com/softlayer/softlayer-api-perl-client.git + +You also need to follow these directions to get your SoftLayer API key: http://knowledgelayer.softlayer.com/procedure/retrieve-your-api-key + +B requires a .slconfig file in your home directory that contains your +SoftLayer userid, API key, and location of the SoftLayer API perl module, in attr=val format. +For example: + + # Config file used by the xcat cmd getslnodes + userid = joe_smith + apikey = 1234567890abcdef1234567890abcdef1234567890abcdef + apidir = /usr/local/lib/softlayer-api-perl-client + +=head1 OPTIONS + +=over 10 + +=item B<-?|-h|--help> + +Display usage message. + +=item B<-v|--version> + +Command Version. + +=back + +=head1 RETURN VALUE + +0 The command completed successfully. + +1 An error has occurred. + +=head1 EXAMPLES + +=over 3 + +=item 1. + +Display information about all of the nodes in your SoftLayer account: + + getslnodes + +=item 2. + +Display information about all of the nodes whose hostname starts with foo: + + getslnodes foo + +=item 3. + +Create xCAT node defintions in the xCAT DB for all of the nodes in your SoftLayer account: + + getslnodes | mkdef -z + +=back + +=head1 FILES + +/opt/xcat/bin/getslnodes + +=head1 SEE ALSO + +L diff --git a/xCAT-SoftLayer/pods/man1/pushinitrd.1.pod b/xCAT-SoftLayer/pods/man1/pushinitrd.1.pod new file mode 100644 index 000000000..45c6e0168 --- /dev/null +++ b/xCAT-SoftLayer/pods/man1/pushinitrd.1.pod @@ -0,0 +1,66 @@ +=head1 NAME + +B - queries your SoftLayer account and gets attributes for each server. + +=head1 SYNOPSIS + +B [B<-v>|B<--verbose>] [B<-w> I] [I] + +B [B<-?> | B<-h> | B<--help>] + +=head1 DESCRIPTION + +The B command copies the initrd, kernel, params, and static IP info to nodes, so they can be net installed +even across vlans (w/o setting up pxe/dhcp broadcast relay). This assumes a working +OS is on the nodes. Before running this command, you must run nodeset for these nodes. +All of the nodes given to one invocation of B must be using the same osimage. + +Before using this command, if will be most convenient if you exchange the ssh keys using: + + xdsh -K + +=head1 OPTIONS + +=over 10 + +=item B<-w> I + +The number of seconds the initrd should wait before trying to communicate over the network. +The default is 75. This translates into the netwait kernel parameter and is usually needed +in a SoftLayer environment because it can take a while for a NIC to be active after changing state. + +=item B<-?|-h|--help> + +Display usage message. + +=item B<-v|--version> + +Command Version. + +=back + +=head1 RETURN VALUE + +0 The command completed successfully. + +1 An error has occurred. + +=head1 EXAMPLES + +=over 3 + +=item 1. + +Configure nodes for net installing in a SoftLayer environment: + + pushinitrd + +=back + +=head1 FILES + +/opt/xcat/bin/pushinitrd + +=head1 SEE ALSO + +L diff --git a/xCAT-SoftLayer/postscripts/setdefaultroute b/xCAT-SoftLayer/postscripts/setdefaultroute new file mode 100755 index 000000000..6932b0d79 --- /dev/null +++ b/xCAT-SoftLayer/postscripts/setdefaultroute @@ -0,0 +1,6 @@ +#!/bin/bash + +# set the default route of the node to the ip address and nic passed in + +set -x +ip route replace to default via $1 dev $2 diff --git a/xCAT-SoftLayer/share/xcat/install/scripts/post.sles.softlayer.common b/xCAT-SoftLayer/share/xcat/install/scripts/post.sles.softlayer.common new file mode 100644 index 000000000..ded409aac --- /dev/null +++ b/xCAT-SoftLayer/share/xcat/install/scripts/post.sles.softlayer.common @@ -0,0 +1,20 @@ +#!/bin/sh + +# This is modified from the standard xcat post.sles.common in that it does not set up +# the ifcfg-eth0 file to do dhcp and it does not restart the network. It just leaves +# ifcfg-eth0 the way autoyast configured it, assuming we set it statically. + +# save what autoyast set network config to, to help with debugging +cp /etc/sysconfig/network/ifcfg-eth0 /tmp/ifcfg-eth0.orig +cp /etc/hosts /tmp/hosts.orig +cp /etc/resolv.conf /tmp/resolv.conf.orig +cp /etc/HOSTNAME /tmp/HOSTNAME.orig + +#cd /etc/sysconfig/network +perl -pi -e 's/^FIREWALL="yes"/FIREWALL="no"/' /etc/sysconfig/network/config + +# autoyast already set hostname correctly + +HOSTNAME=$(hostname -s) +echo $HOSTNAME + diff --git a/xCAT-SoftLayer/share/xcat/install/sles/compute.sles11.softlayer.tmpl b/xCAT-SoftLayer/share/xcat/install/sles/compute.sles11.softlayer.tmpl new file mode 100644 index 000000000..96bf8ed28 --- /dev/null +++ b/xCAT-SoftLayer/share/xcat/install/sles/compute.sles11.softlayer.tmpl @@ -0,0 +1,105 @@ + + + + + + + true + true + + false + false + mbr + + + + GMT + #TABLE:site:key=timezone:value# + + + english-us + + en_US + + false + false + false + true + + + non + + + true + true + true + + + + + + + XCATPARTITIONHOOK + true + all + + + + + + #INCLUDE_DEFAULT_PTRNLIST_S# + + + #INCLUDE_DEFAULT_PKGLIST_S# + + + + + + + root + #CRYPT:passwd:key=system,username=root:password# + true + + + + + + true + + #TABLE:site:key=domain:value# + #TABLE:nodelist:$NODE:node# + + #XCATVAR:XCATMASTER# + + + #TABLE:site:key=domain:value# + + + + false + + + + #INCLUDE:#ENV:XCATROOT#/share/xcat/install/scripts/pre.sles# + #INCLUDE:#ENV:XCATROOT#/share/xcat/install/scripts/chroot.sles# + + + + + + diff --git a/xCAT-SoftLayer/xCAT-SoftLayer.spec b/xCAT-SoftLayer/xCAT-SoftLayer.spec new file mode 100644 index 000000000..5e2eb386c --- /dev/null +++ b/xCAT-SoftLayer/xCAT-SoftLayer.spec @@ -0,0 +1,73 @@ +Summary: Utilities to make xCAT work in a SoftLayer environment +Name: xCAT-SoftLayer +Version: %(cat Version) +Release: snap%(date +"%Y%m%d%H%M") +Epoch: 4 +License: EPL +Group: Applications/System +Source: xCAT-SoftLayer-%(cat Version).tar.gz +Packager: IBM Corp. +Vendor: IBM Corp. +Distribution: %{?_distribution:%{_distribution}}%{!?_distribution:%{_vendor}} +Prefix: /opt/xcat +BuildRoot: /var/tmp/%{name}-%{version}-%{release}-root + +BuildArch: noarch +Requires: xCAT-server +#Requires: xCAT-server >= %{epoch}:%(cat Version|cut -d. -f 1,2) + +Provides: xCAT-SoftLayer = %{epoch}:%{version} + +%description +xCAT-SoftLayer provides Utilities to make xCAT work in a SoftLayer environment. This package should be installed on your management server + +# %define VERBOSE %(if [ "$VERBOSE" = "1" -o "$VERBOSE" = "yes" ];then echo 1; else echo 0; fi) +# %define NOVERBOSE %(if [ "$VERBOSE" = "1" -o "$VERBOSE" = "yes" ];then echo 0; else echo 1; fi) +# %define NOVERBOSE %{?VERBOSE:1}%{!?VERBOSE:0} + +%prep +# %if %NOVERBOSE +# echo NOVERBOSE is on +# set +x +# %elseif +# set -x +# %endif + +%setup -q -n xCAT-SoftLayer +%build +# Convert pods to man pages and html pages +./xpod2man + +%install +rm -rf $RPM_BUILD_ROOT +mkdir -p $RPM_BUILD_ROOT/%{prefix}/bin +mkdir -p $RPM_BUILD_ROOT/%{prefix}/share/xcat/install +mkdir -p $RPM_BUILD_ROOT/install/postscripts +mkdir -p $RPM_BUILD_ROOT/%{prefix}/share/doc/packages/xCAT-SoftLayer +mkdir -p $RPM_BUILD_ROOT/%{prefix}/share/man/man1 +mkdir -p $RPM_BUILD_ROOT/%{prefix}/share/doc/man1 + +cp -a share/xcat/install/* $RPM_BUILD_ROOT/%{prefix}/share/xcat/install/ + +cp -d bin/* $RPM_BUILD_ROOT/%{prefix}/bin +chmod 755 $RPM_BUILD_ROOT/%{prefix}/bin/* + +cp -d postscripts/* $RPM_BUILD_ROOT/install/postscripts +chmod 755 $RPM_BUILD_ROOT/install/postscripts/* + +cp LICENSE.html $RPM_BUILD_ROOT/%{prefix}/share/doc/packages/xCAT-SoftLayer +chmod 644 $RPM_BUILD_ROOT/%{prefix}/share/doc/packages/xCAT-SoftLayer/* + +cp share/man/man1/* $RPM_BUILD_ROOT/%{prefix}/share/man/man1 +chmod 444 $RPM_BUILD_ROOT/%{prefix}/share/man/man1/* +cp share/doc/man1/* $RPM_BUILD_ROOT/%{prefix}/share/doc/man1 +chmod 644 $RPM_BUILD_ROOT/%{prefix}/share/doc/man1/* + +%clean +rm -rf $RPM_BUILD_ROOT + +%files +%defattr(-,root,root) +#%doc LICENSE.html +%{prefix} +/install/postscripts diff --git a/xCAT-SoftLayer/xpod2man b/xCAT-SoftLayer/xpod2man new file mode 100755 index 000000000..c885505bd --- /dev/null +++ b/xCAT-SoftLayer/xpod2man @@ -0,0 +1,214 @@ +#!/usr/bin/perl +# IBM(c) 2007 EPL license http://www.eclipse.org/legal/epl-v10.html + +# First builds the xCAT summary man page from Synopsis of each man page. +# Then converts all of the pod man pages into html (including links to each other) + +# We assume that this script is run in the xCAT-vlan-2.0 dir, so everything is +# done relative to that. + +use strict; +#use lib '.'; +use Pod::Man; +use Pod::Html; + +my $poddir = 'pods'; +my $mandir = 'share/man'; +my $htmldir = 'share/doc'; +my $cachedir = '/tmp'; + +my @pods = getPodList($poddir); +#foreach (@pods) { print "$_\n"; } exit; + +# Build the cmd overview page. +#writesummarypage("$poddir/man1/xcat.1.pod", @pods); + +# Build the man page for each pod. +#mkdir($mandir) or die "Error: could not create $mandir.\n"; +print "Converting PODs to man pages...\n"; +foreach my $podfile (@pods) { + my $manfile = $podfile; + $manfile =~ s/^$poddir/$mandir/; # change the beginning of the path + $manfile =~ s/\.pod$//; # change the ending + my $mdir = $manfile; + $mdir =~ s|/[^/]*$||; # get rid of the basename part + if (system("mkdir -p $mdir")) { die "Error: could not create $mdir.\n"; } + my ($section) = $podfile =~ /\.(\d+)\.pod$/; + convertpod2man($podfile, $manfile, $section); +} + +my @dummyPods = createDummyPods($poddir, \@pods); + +# Build the html page for each pod. +#mkdir($htmldir) or die "Error: could not create $htmldir.\n"; +print "Converting PODs to HTML pages...\n"; +# have to clear the cache, because old entries can cause a problem +unlink("$cachedir/pod2htmd.tmp", "$cachedir/pod2htmi.tmp"); +foreach my $podfile (@pods) { + my $htmlfile = $podfile; + $htmlfile =~ s/^$poddir/$htmldir/; # change the beginning of the path + $htmlfile =~ s/\.pod$/\.html/; # change the ending + my $hdir = $htmlfile; + $hdir =~ s|/[^/]*$||; # get rid of the basename part + if (system("mkdir -p $hdir")) { die "Error: could not create $hdir.\n"; } + #print "$podfile, $htmlfile, $poddir, $htmldir\n"; + convertpod2html($podfile, $htmlfile, $poddir, $htmldir); +} + +# Remove the dummy pods +unlink @dummyPods; +rmdir "$poddir/man7"; + +exit; + + +# To enable linking between the cmd man pages and the db man pages, need to: +# grep thru the cmd pods searching for references (L<>) to any section 5 man page +# if that pod does not exist, create an empty one that will satisfy pod2html +# keep track of all dummy pods created, so they can be removed later +sub createDummyPods { + my ($poddir, $pods) = @_; + my $cmd = "grep -r -E 'L<.+\\([57]\\)\\|.+\\.[57]>' " . $poddir; + #print "Running cmd: ", $cmd, "\n"; + my @lines = `$cmd`; + if ($?) { print "Error running: $cmd\n"; print join('', @lines); } + #my @lines; + #system($cmd); + my @dummyPods; + foreach my $l (@lines) { + #print "$l\n"; + my @matches = $l =~ /L<([^\(]+)\(([57])\)\|\1\.[57]>/g; # get all the matches in the line + # The above line should create the array with every other entry being the man page name + # and every other entry is the section # (5 or 7) + my $cmd; + while ($cmd=shift @matches) { + #foreach my $m (@matches) { + my $section = shift @matches; + my $filename = "$poddir/man$section/$cmd.$section.pod"; + #print "$filename\n"; + if (!(grep /^$filename$/, @$pods) && !(grep /^$filename$/, @dummyPods)) { push @dummyPods, $filename; } + } + } + + + # Create these empty files + print "Creating empty linked-to files: ", join(', ', @dummyPods), "\n"; + mkdir "$poddir/man7"; + foreach my $d (@dummyPods) { + if (!open(TMP, ">>$d")) { warn "Could not create dummy pod file $d ($!)\n"; } + else { close TMP; } + } + + return @dummyPods; +} + +# Recursively get the list of pod man page files. +sub getPodList { + my $poddir = shift; + my @files; + + # 1st get toplevel dir listing + opendir(DIR, $poddir) or die "Error: could not read $poddir.\n"; + my @topdir = grep !/^\./, readdir(DIR); # / + close(DIR); + + # Now go thru each subdir (these are man1, man3, etc.) + foreach my $mandir (@topdir) { + opendir(DIR, "$poddir/$mandir") or die "Error: could not read $poddir/$mandir.\n"; + my @dir = grep !/^\./, readdir(DIR); # / + close(DIR); + foreach my $file (@dir) { + push @files, "$poddir/$mandir/$file"; + } + } + return sort @files; +} + + +# Create the xcat man page that gives a summary description of each xcat cmd. +# Not used. +sub writesummarypage { + my $file = shift; # relative path file name of the man page + # the rest of @_ contains the pod files that describe each cmd + + open(FILE, ">$file") or die "Error: could not open $file for writing.\n"; + + print FILE <<'EOS1'; +=head1 NAME + +B - extreme Cluster Administration Tool. + +=head1 DESCRIPTION + +Extreme Cluster Administration Toolkit (xCAT). xCAT is a scalable distributed computing management +and provisioning tool that provides a unified interface for hardware control, discovery, and +OS diskful/diskfree deployment. + + +=head1 XCAT DATABASE + +All of the cluster configuration information is in the xCAT database. See L for +descriptions of every table in the database. + +=head1 XCAT COMMANDS + +What follows is a short description of each xCAT command. To get more information about a particular +command, see its man page. Note that the commands are listed in alphabetical order B, +i.e. all the commands in section 1, then the commands in section 3, etc. + +=over 12 +EOS1 + +# extract the summary for each cmd from its man page +foreach my $manpage (@_) { + my ($sectionnum) = $manpage =~ /\.(\d+)\.pod$/; + # Suck in the whole file, then we will parse it. + open(MANPAGE, "$manpage") or die "Error: could not open $manpage for reading.\n"; + my @contents = ; + my $wholemanpage = join('', @contents); + close(MANPAGE); + # This regex matches: optional space, =head1, space, title, space, cmd, space, description, newline + my ($cmd, $description) = $wholemanpage =~ /^\s*=head1\s+\S+\s+(\S+)\s+(.+?)\n/si; + if (!defined($cmd)) { print "Warning: $manpage is not in a recognized structure. It will be ignored.\n"; next; } + if (!defined($description)) { print "Warning: $manpage does not have a description for $cmd. It will be ignored.\n"; next; } + $cmd =~ s/^.<(.+)>$/$1/; # if the cmd name has pod formatting around it, strip it off + $description =~ s/^-\s*//; # if the description has a leading hypen, strip it off + print FILE "\n=item L<$cmd($sectionnum)|$cmd.$sectionnum>\n\n".$description."\n"; +} + +# Artificially add the xcattest cmd, because the xCAT-test rpm will add this +print FILE "\n=item L\n\nRun automated xCAT test cases.\n"; + + print FILE <<"EOS3"; + +=back +EOS3 + + close FILE; +} + + +# Create the html page for one pod. +sub convertpod2html { + my ($podfile, $htmlfile, $poddir, $htmldir) = @_; + + #TODO: use --css= and --title= to make the pages look better + pod2html($podfile, + "--outfile=$htmlfile", + "--podpath=man1", + "--podroot=$poddir", + "--htmldir=$htmldir", + "--recurse", + "--cachedir=$cachedir", + ); + +} + + +# Create the man page for one pod. +sub convertpod2man { + my ($podfile, $manfile, $section) = @_; + + my $parser = Pod::Man->new(section => $section); + $parser->parse_from_file($podfile, $manfile); +}