blob: 3990213faa582706359121bf76d18fc6ef20a869 [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 Egorenko964ba9a2018-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'"
Denis Egorenko964ba9a2018-10-31 17:22:05 +040050
Denis Egorenkoe5b036d2019-09-20 14:15:54 +040051Parameter `force` is optional and can be used to force update repo even it is
52already was updated before. It ignores file ${target_dir}/.lockmirror which
53used to detect repo status.
54
55Parameter `cache_dir` is optional and can be used to avoid extra disk space
Denis Egorenko964ba9a2018-10-31 17:22:05 +040056usage for repos, which can have same packages, by using hardlinks to files.
Denis Egorenkoe5b036d2019-09-20 14:15:54 +040057File ${cache_dir}/.ready detects cache readiness status and contains
58directories which are using current cache. By removing this file you will flush
59cache and lead to update all repos during next state run.
Denis Egorenko964ba9a2018-10-31 17:22:05 +040060