Software Archive Specification
Contents
Short background
A 'Service' in gCube is a software system which delivers functionality. It is composed by a set of related 'Packages'.
In the gCube context, a 'Package' is a 'piece of software' that can be deployed into a gHN. Packages are single tarballs, compliant with the Package Model, that contains the files to be installed, along with rules describing software/packages dependencies, deployment instructions and so on.
Each service is described by a 'Profile' document, named Service Profile.
For each Service Profile a corresponding 'Software Archive' should be delivered.
Software Archive Structure
A Software Archive is a single TAR GZ file, which contains all the files declared on the Service Profile and has the following structure:
. |--<PackageName>(Main) | |--<GARArchive> | |--svnpath.txt | |--<additional files> | |--doc | \--api | |- index.html | \- others javadoc files | | |--<PackageName> | |--<LibraryFile> | |--svnpath.txt | |--<additional files> | \--doc | \--api | |-- index.html | \-- others javadoc files | |.... | | |--<PackageName> | |--<LibraryFile> | |--svnpath.txt | |--<additional files> | \--doc | \--api | |-- index.html | \-- others javadoc files | |-- README |-- MANTAINERS |-- CHANGELOG |-- INSTALL |-- LICENSE | \-profile.xml
where:
- at the root level, the archive contains the Service Profile of the service itself. All the file names included in the archive have to be reported with a relative path starting from their <PackageName> folder (not included) *as defined on the Service Profile*.
- for every Package declared inside the Service Profile, the archive contains a directory (called with the same name of the PackageName field of the profile) including the corresponding jar/gar file:
- for a WSRF service the name reported into the GARArchive field;
- for a library/stubs the name reported into the LibraryFile field.
and any other additional file declared in the service profile (e.g. installation or reboot scripts)
In Main packages the 'doc/api' folder with javadoc is mandatory, optional for the others packages.
The 'svnpath.txt' file is mandatory for each packages and contains the link to the source code or to the library download location in cases of external library not open source.
Creating Software Archives
Manually
An easy way to create a Service Archive is to do it manually.
- Create a folder structure as described in previous section according to the corresponding Service Profile.
- Create a TAR GZ file of the created folder structure.
Using ETICS
Create a new component in ETICS for each service profile you already defined in order to create the related Service Archive as artefact. Let see now how you should do this in ETICS.
- name the component as <ServiceName>-servicearchive
- declare a dynamic dependency against each ETICS component that produces a package to be included in the Service Archive. In this way, the packages forming the whole service are available and they are built immediately before they are packaged. Link this configuration with the corresponding parent configuration.
- use the CVS Commands to download additional files related to the whole service, but not included in the packages (like the Service Profile)
- use the Build Commands available in ETICS in the following way:
INIT:
The init command has to be used to create the ${prefix} directory and all the <PackageName> subdirs
INSTALL:
The install command has to be used to move the GAR/JAR files and other additional files from their ${moduleDir} directory to the appropriate <PackageName> directory previously created.
Copy the javadoc to the appropriate <PackageName> directory.
Furthermore echo command with vcsroot link have to be redirected to a file 'svnpath.txt' in the appropriate <PackageName> directory.
PACKAGING:
Leave this command blank. At the end of the build process the default ETICS package command will create a
tar.gz (the ServiceArchive!) of the ${prefix} folder
To better understand the final result of the process above, you can have a look to the *-servicearchive components already created in ETICS.
Example
To better understand the example below check the Service Profile specification.
Service Profile Example
The following Profile describes a service and its stubs as two packages
<?xml version="1.0" encoding="UTF-8"?> <Resource xsi:noNamespaceSchemaLocation="service.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ID></ID> <Type>Service</Type> <Profile> <Description>Description</Description> <Class>Class</Class> <Name>Name</Name> <Version>1.0.0</Version> <Configuration> <Static> <Configs> <Config> <File>aux.txt</File> <Description>aux</Description> <Label>aux</Label> </Config> <Config> <File>aux2.txt</File> <Description>aux2</Description> <Label>aux2</Label> </Config> </Configs> </Static> <Dynamic/> </Configuration> <Dependencies> <Dependency> <Class>DepClass</Class> <Name>DepName</Name> <Version>1.0.0</Version> </Dependency> </Dependencies> <Packages> <Main> <Description>Main Package Description</Description> <Name>Name-service</Name> <Version>1.1.0</Version> <MultiVersion value="true"/> <Mandatory level="GHN"/> <Shareable level="VO"/> <InstallScripts> <File>maininstall.sh</File> </InstallScripts> <UninstallScripts> <File>mainuninstall.sh</File> </UninstallScripts> <RebootScripts> <File>mainreboot.sh</File> </RebootScripts> <Dependencies> <Dependency> <Service> <Class>MainDepClass</Class> <Name>MainDepName</Name> <Version>1.0.0</Version> </Service> <Package>DepPackage</Package> <Version>1.0.0</Version> <Scope level="GHN"/> <Optional>true</Optional> </Dependency> </Dependencies> <SpecificData>text</SpecificData> <GARArchive>main.gar</GARArchive> <ServiceEquivalenceFunctions>...</ServiceEquivalenceFunctions> <PortType>...</PortType> </Main> <Software> <Description>Software Description</Description> <Name>Name-stubs</Name> <Version>1.0.0</Version> <MultiVersion value="true"/> <Mandatory level="GHN"/> <Shareable level="VO"/> <GHNRequirements>....</GHNRequirements> <InstallScripts> <File>softwareinstall.sh</File> </InstallScripts> <UninstallScripts> <File>softwareuninstall.sh</File> </UninstallScripts> <RebootScripts> <File>softwarereboot.sh</File> </RebootScripts> <Dependencies> <Dependency> <Service> <Class>SoftwareClass</Class> <Name>SoftwareName</Name> <Version>1.0.0</Version> </Service> <Package>SoftwarePackage</Package> <Version>1.0.0</Version> <Scope level="VO"/> <Optional>false</Optional> </Dependency> </Dependencies> <SpecificData>text</SpecificData> <Type>library</Type> <Files> <File>stubs.jar</File> </Files> </Software> <Software> <Description>Test Suite</Description> <Name>Name-test-suite</Name> <Version>1.0.0</Version> [...] <Type>library</Type> <Files> <File>testsuite.jar</File> </Files> </Software> </Packages> <SpecificData>text</SpecificData> </Profile> </Resource>
This service has to produce as ServiceArchive a tar.gz file with the following structure:
. |-- Name-service | |-- aux.txt | |-- aux2.txt | |-- main.gar | |-- maininstall.sh | |-- mainreboot.sh | |-- mainuninstall.sh | |-- svnpath.txt | |--doc | \--api | |--index.html | \--others javadoc files | |-- Name-stubs | |-- stubs.jar | |-- softwareinstall.sh | |-- softwarereboot.sh | |-- softwareuninstall.sh | \-- svnpath.txt | |-- Name-test-suite | |-- testsuite.jar | \-- svnpath.txt | \-- profile.xml
Software Archive Validation Process
The Software Archive validation process relies on the information contained in the following sections of the Service Profile to validate the actual constituents of the Software Archive.
Description Tag
The description supplied in the store(StoreMessage) method has priority with respect to the one supplied with the profile. If no description is supplied with the method invocation the one filled in the profile will be used. If no one of this choice are used to supply the description the validation fails.
Class & Name Tag
During validation the Class and Name must be the same to the one passed as argument to store(StoreMessage) API.
Version Tag
This tag is always replaced with the version supplied with the store(StoreMessage) method. This choice have been thought to simplify the life of the developer to avoid to change everytime profile.
Configuration Section
<Configuration> <Static> <Configs> <Config> <File>'''aux.txt'''</File> <Description>aux</Description> <Label>aux</Label> </Config> <Config> <File>'''aux2.txt'''</File> <Description>aux2</Description> <Label>aux2</Label> </Config> </Configs> </Static> <Dynamic/> </Configuration>
. |-- Name-service | |-- aux.txt | |-- aux2.txt | |-- main.gar | |-- maininstall.sh | |-- mainreboot.sh | |-- mainuninstall.sh | |-- svnpath.txt | |--doc | \--api | |--index.html | \--others javadoc files | |-- Name-stubs | |-- stubs.jar | |-- softwareinstall.sh | |-- softwarereboot.sh | |-- softwareuninstall.sh | \-- svnpath.txt | |-- Name-test-suite | |-- testsuite.jar | \-- svnpath.txt | \-- profile.xml
This section will be moved soon on Main section. For the time being you have just to remind that the files declared in this section must go inside the directory with the name of the Main Package on Software Archive.
InstallScripts/UninstallScripts/RebootScripts Tag
<Main> ... <Name>'''Name-service'''</Name> [...] <InstallScripts> <File>'''maininstall.sh'''</File> </InstallScripts> <UninstallScripts> <File>'''mainuninstall.sh'''</File> </UninstallScripts> <RebootScripts> <File>'''mainreboot.sh'''</File> </RebootScripts> [...] </Main>
<Software> [...] <Name>'''Name-stubs'''</Name> [...] <InstallScripts> <File>'''softwareinstall.sh'''</File> </InstallScripts> <UninstallScripts> <File>'''softwareuninstall.sh'''</File> </UninstallScripts> <RebootScripts> <File>'''softwarereboot.sh'''</File> </RebootScripts> [...] </Software>
. |-- Name-service | |-- aux.txt | |-- aux2.txt | |-- main.gar | |-- maininstall.sh | |-- mainreboot.sh | |-- mainuninstall.sh | |-- svnpath.txt | |--doc | \--api | |--index.html | \--others javadoc files | |-- Name-stubs | |-- stubs.jar | |-- softwareinstall.sh | |-- softwarereboot.sh | |-- softwareuninstall.sh | \-- svnpath.txt | |-- Name-test-suite | |-- testsuite.jar | \-- svnpath.txt | \-- profile.xml
Just remind the general rule for this section: The files must be go inside the directory with the name of the Package on Software Archive.
Specific Main Package Sections
GARArchive Tag
<Main> [...] <Name>'''Name-service'''</Name> [...] <GARArchive>'''main.gar'''</GARArchive> [...] <Main>
. |-- Name-service | |-- aux.txt | |-- aux2.txt | |-- main.gar | |-- maininstall.sh | |-- mainreboot.sh | |-- mainuninstall.sh | |-- svnpath.txt | |--doc | \--api | |--index.html | \--others javadoc files | |-- Name-stubs | |-- stubs.jar | |-- softwareinstall.sh | |-- softwarereboot.sh | |-- softwareuninstall.sh | \-- svnpath.txt | |-- Name-test-suite | |-- testsuite.jar | \-- svnpath.txt | \-- profile.xml
The gar archive must go under the Main Package folder (i.e. Name-service) on Software Archive
Specific Software Package Sections
Files Section
<Software> [...] <Name>'''Name-stubs'''</Name> [...] <Files> <File>'''stubs.jar'''</File> </Files> [...] </Software>
. |-- Name-service | |-- aux.txt | |-- aux2.txt | |-- main.gar | |-- maininstall.sh | |-- mainreboot.sh | |-- mainuninstall.sh | |-- svnpath.txt | |--doc | \--api | |--index.html | \--others javadoc files | |-- Name-stubs | |-- stubs.jar | |-- softwareinstall.sh | |-- softwarereboot.sh | |-- softwareuninstall.sh | \-- svnpath.txt | |-- Name-test-suite | |-- testsuite.jar | \-- svnpath.txt | \-- profile.xml
The files must go under the folder with the name of the Software Package (i.e. Name-stubs) on Software Archive
URI Tag
URI tag can be used instead of a Files tag whenever the actual content is stored remotely. This case is not showed in the example above.
<URI>http://dlib25.isti.cnr.it/maven/Service3.tar.gz<URI>
During the validation phase Software Repository tries to download the file. If it is not downloadable the validation fails. If you specify this tag you have to make sure this file will be available for a long period in the future. If not it would be better to include it directly on the Software Archive
Test Suite
Test suite is a mandatory piece of code used to test the Service at deployment time. Test suite have to be declared as a package in the Service Profile. This task should be accomplished adding a Package to the profile declaration. The name of this package should be <ServiceName>-test-suite
<Software> [...] <Name>'''Name-test-suite'''</Name> [...] <Files> <File>'''testsuite.jar'''</File> </Files> [...] </Software>
This service has to produce as ServiceArchive a tar.gz file with the following structure:
. |-- Name-service | |-- aux.txt | |-- aux2.txt | |-- main.gar | |-- maininstall.sh | |-- mainreboot.sh | |-- mainuninstall.sh | |-- svnpath.txt | |--doc | \--api | |--index.html | \--others javadoc files | |-- Name-stubs | |-- stubs.jar | |-- softwareinstall.sh | |-- softwarereboot.sh | |-- softwareuninstall.sh | \-- svnpath.txt | |-- Name-test-suite | |-- testsuite.jar | \-- svnpath.txt | \-- profile.xml
Example
The following Profile describes a service and its stubs as two packages
<?xml version="1.0" encoding="UTF-8"?> <Resource xmlns:p1="http://schemas.xmlsoap.org/wsdl/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ID/> <Type>Service</Type> <Profile> <Description>Deployer: perform local deployment/undeployment of GCUBE packages</Description> <Class>VREManagement</Class> <Name>Deployer</Name> <Version>1.0.0</Version> <Dependencies> <Dependency> <Class>VREManagement</Class> <Name>SoftwareRepository</Name> <Version>1.0.0</Version> </Dependency> <Dependency> <Class>VREManagement</Class> <Name>VREManager</Name> <Version>1.0.0</Version> </Dependency> </Dependencies> <Packages> <Main deployable="false"> <Name>Deployer-service</Name> <Version>1.0.2</Version> <Mandatory level="GHN"/> <Shareable level="VO"/> <GHNRequirements> <Requirement category="Site" requirement="string" value="java1.5" operator="ge"/> </GHNRequirements> <Dependencies> <Dependency> <Service> <Class>VREManagement</Class> <Name>Deployer</Name> <Version>1.0.0</Version> </Service> <Package>Deployer-stubs</Package> <Version>1.0.2</Version> <Scope level="GHN"/> <Optional>false</Optional> </Dependency> <Dependency> <Service> <Class>VREManagement</Class> <Name>SoftwareRepository</Name> <Version>1.0.0</Version> </Service> <Package>SoftwareRepository-stubs</Package> <Version>[1.0.3,1.1.0)</Version> <Scope level="GHN"/> <Optional>false</Optional> </Dependency> </Dependencies> <GARArchive>org.gcube.common.vremanagement.deployer.gar</GARArchive> <PortType> <Name>gcube/common/vremanagement/Deployer</Name> <Security/> <WSDL>...</WSDL> </PortType> </Main> <Software> <Name>Deployer-stubs</Name> <Version>1.0.2</Version> <MultiVersion value="true"/> <Mandatory level="GHN"/> <Shareable level="VO"/> <GHNRequirements> <Requirement category="Site" operator="ge" requirement="string" value="java1.5"/> </GHNRequirements> <Type>library</Type> <Files> <File>org.gcube.common.vremanagement.deployer.stubs.jar</File> </Files> </Software> <Software> <Name>Deployer-test-suite</Name> <Version>1.0.1</Version> <MultiVersion value="true"/> <Shareable level="VO"/> <GHNRequirements> <Requirement category="Site" operator="ge" requirement="string" value="java1.5"/> </GHNRequirements> <Type>application</Type> <Files> <File>lib/org.gcube.common.vremanagement.deployer.testsuite.jar</File> </Files> </Software> </Packages> </Profile> </Resource>
This service has to produce a SoftwareArchive (a tar.gz) file with the following structure:
. | |--Deployer-service | |--org.gcube.common.vremanagement.deployer.gar | |--svnpath.txt | \--doc | \--api | |--index.html | \--others javadoc files | |--Deployer-stubs | |--org.gcube.common.vremanagement.deployer.stubs.jar | \--svnpath.txt | |--Deployer-test-suite | \--org.gcube.common.vremanagement.deployer.testsuite.jar | \--profile.xml
The ETICS configuration (org.gcube.vre-management.deployer-servicearchive) is:
INIT:
mkdir -p ${prefix};
mkdir -p ${prefix}/Deployer-service;
mkdir -p ${prefix}/Deployer-stubs;
mkdir -p ${prefix}/Deployer-test-suite;
INSTALL:
cp ${org.gcube.vre-management.deployer.moduleDir}/etc/profile.xml ${prefix};
cp ${org.gcube.vre-management.deployer.moduleDir}/lib/*.gar ${prefix}/Deployer-service;
cp -r ${org.gcube.vre-management.deployer.moduleDir}/doc ${prefix}/Deployer-service;
echo ${org.gcube.vre-management.deployer.vcsroot}/${org.gcube.vre-management.deployer.tag} > ${prefix}/Deployer-service/svnpath.txt;
cp ${org.gcube.vre-management.deployer-stubs.moduleDir}/lib/org.gcube.common.vremanagement.deployer.stubs.jar ${prefix}/Deployer-stubs;
echo ${org.gcube.vre-management.deployer-stubs.vcsroot}/${org.gcube.vre-management.deployer-stubs.tag} > ${prefix}/Deployer-stubs/svnpath.txt;
cp ${org.gcube.vre-management.deployer-test-suite.moduleDir}/lib/org.gcube.common.vremanagement.deployer.testsuite.jar ${prefix}/Deployer-test-suite;
echo ${org.gcube.vre-management.deployer-test-suite.vcsroot}/${org.gcube.vre-management.deployer-test-suite.tag} > ${prefix}/Deployer-test-suite/svnpath.txt;
The servicearchive configuration is related to the service configuration that should be as following:
INIT:
mkdir -p ${prefix}
COMPILE:
ant -Detics.build=true garService
DOC:
ant -Detics.build=true doc
INSTALL:
cp -R ${moduleDir}/lib/*.gar ${prefix}; cp -R ${moduleDir}/doc ${prefix}
