blob: dde29423797e8f9544b75db4542ef5702492d9e3 [file] [log] [blame]
OlgaGusarenko4b8f0ce2018-06-19 16:04:15 +03001=====
2Usage
3=====
azvyagintseve5c4e832018-01-25 20:02:46 +02004
OlgaGusarenko4b8f0ce2018-06-19 16:04:15 +03005This file provides the debmirror sample pillars configurations for different
6use cases.
azvyagintseve5c4e832018-01-25 20:02:46 +02007
azvyagintsevb67fd052018-07-24 09:08:28 +02008See debmirror/schemas/*.yaml for all possible options
OlgaGusarenko4b8f0ce2018-06-19 16:04:15 +03009A sample of one debmirror mirror configuration (Ubuntu):
azvyagintseve5c4e832018-01-25 20:02:46 +020010
11.. code-block:: yaml
azvyagintsevb80d6222018-02-19 15:53:40 +020012
azvyagintseve5c4e832018-01-25 20:02:46 +020013 parameters:
14 debmirror:
15 client:
16 enabled: true
17 mirrors:
18 target01:
azvyagintsevb67fd052018-07-24 09:08:28 +020019 enabled: true
20 fetch_retry: 3
azvyagintsev73720db2018-06-20 17:28:09 +030021 http_proxy : "url"
22 https_proxy: "url"
23 ftp_proxy: "url"
24 rsync_proxy: "url"
25 no_proxy: ['val1', 'val2']
azvyagintseve5c4e832018-01-25 20:02:46 +020026 force: False
27 lock_target: True
28 extra_flags: [ '--verbose', '--progress', '--nosource', '--no-check-gpg', '--rsync-extra=none' ]
29 method: "rsync" # string
30 arch: [ 'amd64' ]
31 mirror_host: "mirror.mirantis.com" # rsync
32 mirror_root: ':mirror/nightly/ubuntu/'
Denis Egorenko87307732018-10-31 17:22:05 +040033 cache_dir: "/var/www/mirror/.cache/ubuntu"
azvyagintseve5c4e832018-01-25 20:02:46 +020034 target_dir: "/var/www/mirror/ubuntu/"
35 log_file: "/var/www/mirror/target01_log.log"
36 dist: [ xenial ] #, xenial-security, xenial-updates ]
37 section: [ main ] #, multiverse, restricted, universe ]
38 exclude_deb_section: [ 'games', gnome, Xfce, sound, electronics, graphics, hamradio , doc, localization, kde, video ]
39 filter:
40 00: "--exclude=/"
41 01: "--exclude='/android*'"
42 02: "--exclude='/firefox*'"
43 03: "--exclude='/chromium-browser*'"
44 04: "--exclude='/ceph*'"
45 05: "--exclude='/*-wallpapers*'"
46 06: "--exclude='/language-pack-(?!en)'"
47 07: "--include='/main(.*)manpages'"
48 08: "--include='/main(.*)python-(.*)doc'"
49 09: "--include='/main(.*)python-(.*)network'"
50
Denis Egorenko87307732018-10-31 17:22:05 +040051Parameter cache_dir is optional and can be used to avoid extra disk space
52usage for repos, which can have same packages, by using hardlinks to files.
53
OlgaGusarenko4b8f0ce2018-06-19 16:04:15 +030054**Documentation and bugs**
55
56* http://salt-formulas.readthedocs.io/
57 Learn how to install and update salt-formulas
58
59* https://github.com/salt-formulas/salt-formula-debmirror/issues
60 In the unfortunate event that bugs are discovered, report the issue to the
61 appropriate issue tracker. Use the Github issue tracker for a specific salt
62 formula
63
64* https://launchpad.net/salt-formulas
65 For feature requests, bug reports, or blueprints affecting the entire
66 ecosystem, use the Launchpad salt-formulas project
azvyagintseve5c4e832018-01-25 20:02:46 +020067
68* https://github.com/salt-formulas/salt-formula-debmirror
OlgaGusarenko4b8f0ce2018-06-19 16:04:15 +030069 Develop the salt-formulas projects in the master branch and then submit pull
70 requests against a specific formula
azvyagintseve5c4e832018-01-25 20:02:46 +020071
OlgaGusarenko4b8f0ce2018-06-19 16:04:15 +030072* https://launchpad.net/~salt-formulas-users
73 Join the salt-formulas-users team and subscribe to mailing list if required
azvyagintseve5c4e832018-01-25 20:02:46 +020074
OlgaGusarenko4b8f0ce2018-06-19 16:04:15 +030075* #salt-formulas @ irc.freenode.net
76 Use this IRC channel in case of any questions or feedback which is always
77 welcome
Denis Egorenko87307732018-10-31 17:22:05 +040078