author | Edward Pilatowicz <edward.pilatowicz@oracle.com> |
Mon, 16 Sep 2013 21:26:31 -0700 | |
changeset 2945 | 24196b483cc6 |
parent 1923 | 8d42b7caa49d |
permissions | -rw-r--r-- |
1923
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
1 |
.. CDDL HEADER START |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
2 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
3 |
.. The contents of this file are subject to the terms of the |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
4 |
Common Development and Distribution License (the "License"). |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
5 |
You may not use this file except in compliance with the License. |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
6 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
7 |
.. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
8 |
or http://www.opensolaris.org/os/licensing. |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
9 |
See the License for the specific language governing permissions |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
10 |
and limitations under the License. |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
11 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
12 |
.. When distributing Covered Code, include this CDDL HEADER in each |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
13 |
file and include the License file at usr/src/OPENSOLARIS.LICENSE. |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
14 |
If applicable, add the following below this CDDL HEADER, with the |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
15 |
fields enclosed by brackets "[]" replaced with your own identifying |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
16 |
information: Portions Copyright [yyyy] [name of copyright owner] |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
17 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
18 |
.. CDDL HEADER END |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
19 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
20 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
21 |
.. Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved. |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
22 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
23 |
.. _Repository file system layout: |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
24 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
25 |
Repository file system layout |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
26 |
============================= |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
27 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
28 |
File system Layout |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
29 |
------------------ |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
30 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
31 |
The types of information that the depot server stores and/or retrieves can |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
32 |
be categorized as follows: |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
33 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
34 |
- depot data |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
35 |
This includes: configuration data, presentation content (such as |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
36 |
web page templates), publishing data (e.g. in-flight transactions), |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
37 |
and temporary data (e.g. the feed cache). |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
38 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
39 |
- repository data |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
40 |
This includes: catalog information, package content (files), package |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
41 |
metadata (manifests), and search data. |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
42 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
43 |
Layout |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
44 |
~~~~~~ |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
45 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
46 |
The depot server uses the following 'root' directory structures for the |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
47 |
storage and retrieval of depot and repository data: |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
48 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
49 |
- repo_dir (depot and repository data) |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
50 |
cfg_cache (depot data) |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
51 |
A file containing the cached configuration information for the |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
52 |
depot server. |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
53 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
54 |
catalog/ (repository data) |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
55 |
This directory contains the repository catalog and its related |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
56 |
metadata. |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
57 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
58 |
file/ (repository data) |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
59 |
This directory contains the file content of packages in the |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
60 |
repository. |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
61 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
62 |
Files are stored using a two-level path fragment, derived from the |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
63 |
SHA1-hash of a file's content, assumed to have at least 8 distinct |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
64 |
characters. |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
65 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
66 |
Example: |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
67 |
00/ |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
68 |
0023bb/ |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
69 |
000023bb53fdc7bcf35e62b7b0b353a56d36a504 |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
70 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
71 |
index/ (repository data) |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
72 |
This directory contains the search indices for the repository. |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
73 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
74 |
pkg/ (repository data) |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
75 |
This directory contains the metadata (manifests) for the |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
76 |
repository's packages. |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
77 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
78 |
The manifests for each package are stored in a directory with the |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
79 |
same name as the package stem using a URL-encoded filename. |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
80 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
81 |
Example: |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
82 |
entire/ |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
83 |
0.5.11%2C5.11-0.86%3A20080422T234219Z |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
84 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
85 |
trans/ (depot data) |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
86 |
This directory contains in-flight transactions for packages that |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
87 |
are waiting for the publication process to complete so that they |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
88 |
can be added to the repository's catalog. |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
89 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
90 |
Each transaction is stored in a directory named after the pending |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
91 |
transaction id and contains the manifest waiting for publication |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
92 |
to finish stored with the filename of 'manifest'. |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
93 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
94 |
Example: |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
95 |
1229379580_pkg%3A%2Fsystem%2Flibc%400.1%2C5.11-98%3A20081215T221940Z/ |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
96 |
manifest |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
97 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
98 |
updatelog/ (repository data) |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
99 |
This directory contains metadata detailing changes to the repository |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
100 |
by publishing operations. |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
101 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
102 |
- content_root (depot data) |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
103 |
|
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
104 |
web/ |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
105 |
This directory contains all of the web presentation content for the |
8d42b7caa49d
16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff
changeset
|
106 |
depot. |