ViewVC Help
View File | Revision Log | Show Annotations | Root Listing
root/cvsroot/COMP/XCMSI/modules/GridInstall_help.pm
Revision: 1.1
Committed: Tue Dec 7 10:35:56 2004 UTC (20 years, 4 months ago) by corvo
Content type: text/plain
Branch: MAIN
Log Message:
Help module for Grid Installation program in man format.

File Contents

# User Rev Content
1 corvo 1.1 #!/usr/bin/perl
2     package GridInstall_help;
3    
4     use Cwd;
5     use site_utils qw(&execSys);
6     our (@ISA, @EXPORT, @EXPORT_OK);
7     use Exporter;
8     @ISA = qw(Exporter);
9     @EXPORT_OK = qw(&help);
10    
11     sub help {
12    
13     my $option = shift or 'man';
14     $helpStr = "
15    
16     =pod
17    
18     =head1 NAME
19    
20     B<" . $::exec . " > - (version 0.0.1).
21    
22     =head1 SYNOPSIS
23    
24     B<$::exec> [I<options>]
25    
26     =head1 DESCRIPTION
27    
28     I<". $::exec ."> is a Perl program intended to simplify the process
29     of creation and submission of CMS software installation jobs.
30     The program is able to generate scripts for different CMS
31     software types (tar, DAR, RPM) and submit them to the a given site.
32    
33     This script is based on queries on LCG BDIIs, that is on LCG Information system. It asks a given site, or site set,
34     for the published software tags (e.g. VO-cms-ORCA_8_6_0) and, according to the answer, performs the
35     best action, either full \"from scratch\" installation, or a simple upgrade.
36    
37     Then it updates the site Information System with the latest installed software tag.
38    
39     Multiple software installations are supported. The core installation script is I<cmsi>.
40    
41     B<". $::exec . "> relies on a set of different perl fragments, which can be combined to perform the right installation
42     according to the chosen software flavour.
43    
44     Once perl scripts and jdl files have been assembled, jobs are submitted to the target Computing Elements. Once landed on Worker Nodes
45     the scripts check the environment, basically an anvironment variable called \$VO_CMS_SW_DIR where CMS software is supposed
46     to be installed. Then I<cmsi> starts installing rpms.
47    
48     Finally the Information System is updated with the publishing of the new software tags.
49    
50     =head1 OPTIONS
51    
52     =over 4
53    
54     =item B<-i, --install> I< software name >
55    
56     Declares the software you want to install. It's possible to declare multiple software
57     (e.g. --install \"ORCA_8_6_0 OSCAR_3_6_1\")
58    
59     =item B<-u, --uninstall> I< software name >
60    
61     Declares the software you want to uninstall.
62    
63     =item B<-t, --type> I< software type >
64    
65     Declares the kind of distribution you're going to install. Possible value are tar, dar and rpm.
66    
67     =item B<-s, --site > I<site>
68    
69     Declares where you would like to install the given software. It can be a full URL or a domain name, e.g.
70     gridit001.pd.infn.it or infn.it.
71    
72     =item B<-l, --label> I< software tag >
73    
74     Defines the software tag you're going to publish on a site Information System. Conventionally CMS adopted:
75     VO-cms-I< software name >
76    
77     =item B<-b, --bdii> I<bdii>
78    
79     Defines the BDII to retrieve sites' software tag. LCG has no hierarchical Information System, so one has to define
80     \'a priori\' the BDII containing the choosen site to install. CMS has a official BDII, that is lxn1187.cern.ch. There's also
81     a \'test zone\' BDII, lxn1189.cern.ch, containing sites which are not yet LCG certified.
82    
83     =item B<-o, --org> I< virtual organization>
84    
85     Your Virtual Organization. Default is \'cms\'. The script selects for installation only those sites belonging to the given VO.
86     The user must have a valid grid certificate to be recognized by the information system.
87    
88     =back
89    
90    
91     =head1 EXAMPLES
92    
93     $::exec --install ORCA_8_6_0 -t rpm --site pd.infn.it --label VO-cms-ORCA_8_6_0\n
94    
95     installs Orca, version 860 and rpm flavour, in Padova.
96    
97     $::exec --install ORCA_8_6_0 -t rpm --site fzk.de --label VO-cms-ORCA_8_6_0 --bdii lxn1189.cern.ch\n
98    
99     installs Orca, version 860 and rpm flavour, in FZK querying the \"test BDII\" at Cern.
100    
101     $::exec --install CMKIN_3_2_0 -t tar --site pd.infn.it --label VO-cms-CMKIN_3_2_0_dar\n
102    
103     installs CMKIN, version 320 and tar flavour, in Padova.
104    
105     $::exec --uninstall ORCA_8_2_0 -t rpm --site pd.infn.it --label VO-cms-ORCA_8_2_0\n
106    
107     uninstalls Orca from Padova and removes the software tag from the Information System.
108    
109     =head1 ENVIRONMENT
110    
111     If user wants to submit jobs in GRID, which is default, it is necessary
112     to create a proxy certificate
113    
114     grid-proxy-init
115    
116     =cut";
117    
118     my $pod = getcwd() . '/CmsSwGridInstall.pod';
119     open($fh, ">$pod");
120     print ($fh $helpStr);
121     close $fh;
122     my $man = getcwd() . '/CmsSwGridInstall.man';
123     my $pod2man = 'pod2man --center=" " --release=" " ' . $pod . ' > ' . $man;
124     &execSys($pod2man);
125     my $cmd = 'man '. $man;
126     system($cmd);
127     exit;
128     }