| Filip Pytloun | 9534729 | 2015-10-06 16:28:31 +0200 | [diff] [blame] | 1 | ===== | 
|  | 2 | Aptly | 
|  | 3 | ===== | 
|  | 4 |  | 
|  | 5 | Install and configure Aptly server and client. | 
|  | 6 |  | 
|  | 7 | Available states | 
|  | 8 | ================ | 
|  | 9 |  | 
|  | 10 | .. contents:: | 
|  | 11 | :local: | 
|  | 12 |  | 
|  | 13 | ``aptly.server`` | 
|  | 14 | ---------------- | 
|  | 15 |  | 
|  | 16 | Setup aptly server | 
|  | 17 |  | 
|  | 18 | ``aptly.publisher`` | 
|  | 19 | ------------------- | 
|  | 20 |  | 
|  | 21 | Setup aptly publisher | 
|  | 22 |  | 
|  | 23 | Available metadata | 
|  | 24 | ================== | 
|  | 25 |  | 
|  | 26 | .. contents:: | 
|  | 27 | :local: | 
|  | 28 |  | 
|  | 29 | ``metadata.aptly.server.single`` | 
|  | 30 | -------------------------------- | 
|  | 31 |  | 
|  | 32 | Setup basic server | 
|  | 33 |  | 
|  | 34 |  | 
|  | 35 | ``metadata.aptly.client.publisher`` | 
|  | 36 | ----------------------------------- | 
|  | 37 |  | 
|  | 38 | Setup aptly publisher client | 
|  | 39 |  | 
|  | 40 | Configuration parameters | 
|  | 41 | ======================== | 
|  | 42 |  | 
|  | 43 |  | 
|  | 44 | Example reclass | 
|  | 45 | =============== | 
|  | 46 |  | 
|  | 47 | Basic 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 Pytloun | 611af94 | 2017-11-21 15:36:45 +0100 | [diff] [blame] | 69 | Define 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 Broulik | 5496f6a | 2018-02-01 17:16:15 +0100 | [diff] [blame] | 83 |  | 
| Filip Pytloun | 9534729 | 2015-10-06 16:28:31 +0200 | [diff] [blame] | 84 | Example 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 Michalec | d78b481 | 2016-12-27 16:11:06 +0100 | [diff] [blame] | 98 | sources: false | 
| Filip Pytloun | 9534729 | 2015-10-06 16:28:31 +0200 | [diff] [blame] | 99 | publisher: | 
|  | 100 | component: mycomponent | 
|  | 101 | distributions: | 
|  | 102 | - nightly/trusty | 
|  | 103 |  | 
| Jiri Broulik | 5496f6a | 2018-02-01 17:16:15 +0100 | [diff] [blame] | 104 | Basic 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 Binet | c4df8a4 | 2018-02-12 16:21:16 +0100 | [diff] [blame] | 118 | filter_with_deps: true | 
| Jiri Broulik | 5496f6a | 2018-02-01 17:16:15 +0100 | [diff] [blame] | 119 | publisher: | 
|  | 120 | component: example | 
|  | 121 | distributions: | 
|  | 122 | - xenial/repo/nightly | 
|  | 123 | - "s3:aptcdn:xenial/repo/nightly" | 
|  | 124 |  | 
|  | 125 |  | 
| Stehlik Lukas | 48e868a | 2018-01-11 14:33:16 +0100 | [diff] [blame] | 126 | Proxy 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 Pytloun | 9534729 | 2015-10-06 16:28:31 +0200 | [diff] [blame] | 140 | Read more | 
|  | 141 | ========= | 
|  | 142 |  | 
|  | 143 | * http://www.aptly.info/doc/configuration/ | 
| Filip Pytloun | c33d90f | 2017-02-02 12:52:25 +0100 | [diff] [blame] | 144 |  | 
|  | 145 | Documentation and Bugs | 
|  | 146 | ====================== | 
|  | 147 |  | 
|  | 148 | To learn how to install and update salt-formulas, consult the documentation | 
|  | 149 | available online at: | 
|  | 150 |  | 
|  | 151 | http://salt-formulas.readthedocs.io/ | 
|  | 152 |  | 
|  | 153 | In the unfortunate event that bugs are discovered, they should be reported to | 
|  | 154 | the appropriate issue tracker. Use Github issue tracker for specific salt | 
|  | 155 | formula: | 
|  | 156 |  | 
|  | 157 | https://github.com/salt-formulas/salt-formula-aptly/issues | 
|  | 158 |  | 
|  | 159 | For feature requests, bug reports or blueprints affecting entire ecosystem, | 
|  | 160 | use Launchpad salt-formulas project: | 
|  | 161 |  | 
|  | 162 | https://launchpad.net/salt-formulas | 
|  | 163 |  | 
|  | 164 | You can also join salt-formulas-users team and subscribe to mailing list: | 
|  | 165 |  | 
|  | 166 | https://launchpad.net/~salt-formulas-users | 
|  | 167 |  | 
|  | 168 | Developers wishing to work on the salt-formulas projects should always base | 
|  | 169 | their work on master branch and submit pull request against specific formula. | 
|  | 170 |  | 
|  | 171 | https://github.com/salt-formulas/salt-formula-aptly | 
|  | 172 |  | 
|  | 173 | Any questions or feedback is always welcome so feel free to join our IRC | 
|  | 174 | channel: | 
|  | 175 |  | 
|  | 176 | #salt-formulas @ irc.freenode.net |