blob: b179bec693f60e91acf2d98da9df626bfe8a2617 [file] [log] [blame]
Filip Pytloun95347292015-10-06 16:28:31 +02001=====
2Aptly
3=====
4
5Install and configure Aptly server and client.
6
7Available states
8================
9
10.. contents::
11 :local:
12
13``aptly.server``
14----------------
15
16Setup aptly server
17
18``aptly.publisher``
19-------------------
20
21Setup aptly publisher
22
23Available metadata
24==================
25
26.. contents::
27 :local:
28
29``metadata.aptly.server.single``
30--------------------------------
31
32Setup basic server
33
34
35``metadata.aptly.client.publisher``
36-----------------------------------
37
38Setup aptly publisher client
39
40Configuration parameters
41========================
42
43
44Example reclass
45===============
46
47Basic Aptly server with no repos or mirrors.
48
49.. code-block:: yaml
50
51 classes:
52 - service.aptly.server.single
53 parameters:
54 aptly:
55 server:
56 enabled: true
57 secure: true
58 gpg_keypair_id: A76882D3
59 gpg_passphrase:
60 gpg_public_key: |
61 -----BEGIN PGP PUBLIC KEY BLOCK-----
62 Version: GnuPG v1
63 ...
64 gpg_private_key: |
65 -----BEGIN PGP PRIVATE KEY BLOCK-----
66 Version: GnuPG v1
67 ...
68
Filip Pytloun611af942017-11-21 15:36:45 +010069Define s3 endpoint:
70
71.. code-block:: yaml
72
73 parameters:
74 aptly:
75 server:
76 endpoint:
77 mys3endpoint:
78 engine: s3
79 awsAccessKeyID: xxxx
80 awsSecretAccessKey: xxxx
81 bucket: test
82
Jiri Broulik5496f6a2018-02-01 17:16:15 +010083
Filip Pytloun95347292015-10-06 16:28:31 +020084Example pillar
85==============
86
87.. code-block:: yaml
88
89 aptly:
90 server:
91 enabled: true
92 repo:
93 myrepo:
94 distribution: trusty
95 component: main
96 architectures: amd64
97 comment: "Custom components"
Petr Michalecd78b4812016-12-27 16:11:06 +010098 sources: false
Filip Pytloun95347292015-10-06 16:28:31 +020099 publisher:
100 component: mycomponent
101 distributions:
102 - nightly/trusty
103
Jiri Broulik5496f6a2018-02-01 17:16:15 +0100104Basic Aptly server mirrors
105
106.. code-block:: yaml
107
108 aptly:
109 server:
110 mirror:
111 mirror_name:
112 source: http://example.com/debian
113 distribution: xenial
114 components: main
115 architectures: amd64
116 gpgkeys: 460F3999
117 filter: "!(Name (% *-dbg))"
Bruno Binetc4df8a42018-02-12 16:21:16 +0100118 filter_with_deps: true
Jiri Broulik5496f6a2018-02-01 17:16:15 +0100119 publisher:
120 component: example
121 distributions:
122 - xenial/repo/nightly
123 - "s3:aptcdn:xenial/repo/nightly"
124
125
Stehlik Lukas48e868a2018-01-11 14:33:16 +0100126Proxy environment variables (optional) in cron job for mirroring script
127
128.. code-block:: yaml
129
130 aptly:
131 server:
132 enabled: true
133 ...
134 mirror_update:
135 enabled: true
136 http_proxy: "http://1.2.3.4:8000"
137 https_proxy: "http://1.2.3.4:8000"
138 ...
139
Filip Pytloun95347292015-10-06 16:28:31 +0200140Read more
141=========
142
143* http://www.aptly.info/doc/configuration/
Filip Pytlounc33d90f2017-02-02 12:52:25 +0100144
145Documentation and Bugs
146======================
147
148To learn how to install and update salt-formulas, consult the documentation
149available online at:
150
151 http://salt-formulas.readthedocs.io/
152
153In the unfortunate event that bugs are discovered, they should be reported to
154the appropriate issue tracker. Use Github issue tracker for specific salt
155formula:
156
157 https://github.com/salt-formulas/salt-formula-aptly/issues
158
159For feature requests, bug reports or blueprints affecting entire ecosystem,
160use Launchpad salt-formulas project:
161
162 https://launchpad.net/salt-formulas
163
164You can also join salt-formulas-users team and subscribe to mailing list:
165
166 https://launchpad.net/~salt-formulas-users
167
168Developers wishing to work on the salt-formulas projects should always base
169their work on master branch and submit pull request against specific formula.
170
171 https://github.com/salt-formulas/salt-formula-aptly
172
173Any questions or feedback is always welcome so feel free to join our IRC
174channel:
175
176 #salt-formulas @ irc.freenode.net