Gitiles
Code Review Sign In
gerrit.mcp.mirantis.com / salt-formulas / aptly / 9f7ed4060c890fcd5d3b95a123548af91e8a156a / . / README.rst
blob: d84ba04115264b54401d5b9de0b9bb2650c91b93 [file] [log] [blame]
Filip Pytloun95347292015-10-06 16:28:31 +0200[diff] [blame]1=====
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 +0100[diff] [blame]69Define 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
Filip Pytloun95347292015-10-06 16:28:31 +0200[diff] [blame]83Example pillar
84==============
85
86.. code-block:: yaml
87
88 aptly:
89 server:
90 enabled: true
91 repo:
92 myrepo:
93 distribution: trusty
94 component: main
95 architectures: amd64
96 comment: "Custom components"
Petr Michalecd78b4812016-12-27 16:11:06 +0100[diff] [blame]97 sources: false
Filip Pytloun95347292015-10-06 16:28:31 +0200[diff] [blame]98 publisher:
99 component: mycomponent
100 distributions:
101 - nightly/trusty
102
Stehlik Lukas48e868a2018-01-11 14:33:16 +0100[diff] [blame]103Proxy environment variables (optional) in cron job for mirroring script
104
105.. code-block:: yaml
106
107 aptly:
108 server:
109 enabled: true
110 ...
111 mirror_update:
112 enabled: true
113 http_proxy: "http://1.2.3.4:8000"
114 https_proxy: "http://1.2.3.4:8000"
115 ...
116
Filip Pytloun95347292015-10-06 16:28:31 +0200[diff] [blame]117Read more
118=========
119
120* http://www.aptly.info/doc/configuration/
Filip Pytlounc33d90f2017-02-02 12:52:25 +0100[diff] [blame]121
122Documentation and Bugs
123======================
124
125To learn how to install and update salt-formulas, consult the documentation
126available online at:
127
128 http://salt-formulas.readthedocs.io/
129
130In the unfortunate event that bugs are discovered, they should be reported to
131the appropriate issue tracker. Use Github issue tracker for specific salt
132formula:
133
134 https://github.com/salt-formulas/salt-formula-aptly/issues
135
136For feature requests, bug reports or blueprints affecting entire ecosystem,
137use Launchpad salt-formulas project:
138
139 https://launchpad.net/salt-formulas
140
141You can also join salt-formulas-users team and subscribe to mailing list:
142
143 https://launchpad.net/~salt-formulas-users
144
145Developers wishing to work on the salt-formulas projects should always base
146their work on master branch and submit pull request against specific formula.
147
148 https://github.com/salt-formulas/salt-formula-aptly
149
150Any questions or feedback is always welcome so feel free to join our IRC
151channel:
152
153 #salt-formulas @ irc.freenode.net