| 315 |
dpurdie |
1 |
#-------------------------------------------------------------------------------
|
|
|
2 |
# Documentation
|
|
|
3 |
#
|
|
|
4 |
|
|
|
5 |
=pod
|
|
|
6 |
|
|
|
7 |
=head1 NAME
|
|
|
8 |
|
|
|
9 |
Package Storage Archives used by JATS
|
|
|
10 |
|
|
|
11 |
=head1 SYNOPSIS
|
|
|
12 |
|
|
|
13 |
Package archives are repositories for Packages that have been built by JATS.
|
|
|
14 |
There are six types of package archive, as shown below together with the
|
|
|
15 |
search order.
|
|
|
16 |
|
|
|
17 |
=over
|
|
|
18 |
|
|
|
19 |
=item 1 GBE_SANDBOX (User current sandbox)
|
|
|
20 |
|
|
|
21 |
=item 2 GBE_DPKG_LOCAL (User local store)
|
|
|
22 |
|
|
|
23 |
=item 3 GBE_DPKG_CACHE (Machine local cache)
|
|
|
24 |
|
|
|
25 |
=item 4 GBE_DPKG (Site repository)
|
|
|
26 |
|
|
|
27 |
=item 5 GBE_DPLY (Site repository)
|
|
|
28 |
|
|
|
29 |
=item 6 GBE_DPKG_STORE (Global repository)
|
|
|
30 |
|
|
|
31 |
=back
|
|
|
32 |
|
|
|
33 |
These are detailed in the following sections.
|
|
|
34 |
|
|
|
35 |
=head2 dpkg_archive
|
|
|
36 |
|
|
|
37 |
B<dpkg_archive> is the common package repository. This is on a shared network drive
|
|
|
38 |
and as such affects the build speed. JATS supports three mechanisms to supplement
|
|
|
39 |
dpkg_archive, as described below.
|
|
|
40 |
|
|
|
41 |
This archive is mandatory. Its location if specified by the EnvVar B<GBE_DPKG>.
|
|
|
42 |
|
|
|
43 |
=head2 deploy archive
|
|
|
44 |
|
|
|
45 |
B<deploy_archive> is the common package repository for deployable packages and
|
|
|
46 |
is similar to dpkg_archive.
|
|
|
47 |
|
|
|
48 |
This archive is optional. Its location if specified by the EnvVar B<GBE_DPLY>.
|
|
|
49 |
|
|
|
50 |
=head2 sandbox archive
|
|
|
51 |
|
|
|
52 |
B<sandbox_archive> is the common package repository for packages that are
|
|
|
53 |
being built within a jats 'Sandbox'. It is used to store the packages
|
|
|
54 |
generated by all builds within a sandbox.
|
|
|
55 |
|
|
|
56 |
This archive location will be determined automatically by JATS. It is only
|
|
|
57 |
used with the scope of a sandbox.
|
|
|
58 |
|
|
|
59 |
=head2 local dpkg_archive
|
|
|
60 |
|
|
|
61 |
JATS supports a package archive that is local to a project or suite of build
|
|
|
62 |
sandboxes. This is the archive used by the B<install> command.
|
|
|
63 |
|
|
|
64 |
The user does not have to do anything to access this archive. The archive is
|
|
|
65 |
located by the JATS wrapper script by scanning up the directory tree for a
|
|
|
66 |
directory called "local_dpkg_archive". If it is found then it is used as the
|
|
|
67 |
preferred source for locating archives. This allows a component to be tested
|
|
|
68 |
with a "local" or "fixed" version of another package, before an official
|
|
|
69 |
release is made.
|
|
|
70 |
|
|
|
71 |
A local archive may be shared by members of a team by setting the environment
|
|
|
72 |
variable B<GBE_DPKG_LOCAL> to the location of a shared drive.
|
|
|
73 |
|
|
|
74 |
This type of archive is being depricated for normal development in favour of
|
|
|
75 |
the Sandbox Archive.
|
|
|
76 |
|
|
|
77 |
=head2 dpkg_archive cache
|
|
|
78 |
|
|
|
79 |
JATS supports a package caching mechanism to reduce network utilization. If
|
|
|
80 |
the user specified B<GBE_DPKG_CACHE> exists then that archive is treated as a
|
|
|
81 |
cache archive. The various JATS tools work together to maintain the cache.
|
|
|
82 |
|
|
|
83 |
This cache must be setup by the user.
|
|
|
84 |
|
|
|
85 |
=head2 dpkg_archive store
|
|
|
86 |
|
|
|
87 |
JATS supports a global, read-only, package distribution mechanism. If
|
|
|
88 |
the user specified B<GBE_DPKG_STORE> exists then that archive is treated as a
|
|
|
89 |
global store. The store archive will be searched after all other archives.
|
|
|
90 |
|
|
|
91 |
A global store may be used by members of a global team, in a situation in
|
|
|
92 |
which the store is rsync'ed from a central repository.
|
|
|
93 |
|