Commit f1d5baf2 authored by Rafael Monnerat's avatar Rafael Monnerat

slapos.package: Fix README syntax.

parent 529ff18e
...@@ -6,16 +6,25 @@ SlapOS Package is a simple tool which aims on keep a packages updates on a Linux ...@@ -6,16 +6,25 @@ SlapOS Package is a simple tool which aims on keep a packages updates on a Linux
Basic Commands Basic Commands
=============== ===============
# slappkg-update: Perform the update, if requested. * slappkg-update: Perform the update, if requested.
# slappkg-discover: Prints the system signature, used to match with signature-list to decide which section to use. * slappkg-discover: Prints the system signature, used to match with signature-list to decide which section to use.
* slappkg-upload-key: Uploads the signature configuration.
* slappkg-conf: Creates initial update.cfg and cron entry.
# slappkg-upload-key: Uploads the signature configuration .
Basic Usage Basic Usage
============ ============
# slappkg-update --slapos-configuration update.cfg .. code:: bash
# Generates initial configuration
slappkg-conf --slapos-configuration=update.cfg
# Runs update
slappkg-update --slapos-configuration=update.cfg
Upgrade Signature File Upgrade Signature File
======================= =======================
...@@ -27,114 +36,123 @@ server was upgraded before the dates present there, the upgrade will be trigger ...@@ -27,114 +36,123 @@ server was upgraded before the dates present there, the upgrade will be trigger
for packages (This only affects core promise). for packages (This only affects core promise).
Example: Example:
::
[system] .. code:: text
reboot = 2011-10-10
upgrade = 2014-02-20 [system]
reboot = 2011-10-10
upgrade = 2014-02-20
Distribution sections can have any other name choses by the user and it should Distribution sections can have any other name choses by the user and it should
contains the follow entries (always use new line for multiple values): contains the follow entries (always use new line for multiple values):
* repository-list: define a list of repository entries, defined by (name = value). * repository-list: define a list of repository entries, defined by (name = value).
Special minor notations explaned futher. Special minor notations explaned futher.
* filter-package-list: list of package names that are going to be keep installed and
* filter-package-list: list of package names that are going to be keep installed and
updated. updated.
* filter-promise-list: list of promises that are enabled for this distribution. The user * filter-promise-list: list of promises that are enabled for this distribution. The user
can decide which promises are going to be checked on every run. If this can decide which promises are going to be checked on every run. If this
section is not present, all promises available are going to be checked. section is not present, all promises available are going to be checked.
* signature-list: defines which systems the promises are applicable on. The signature for * signature-list: defines which systems the promises are applicable on. The signature for
every system can be found by slappkg-discover command. If None signature every system can be found by slappkg-discover command. If None signature
matches, the system will not be upgraded. matches, the system will not be upgraded.
Example: Example:
::
[debian-default] .. code:: text
repository-list =
main = http://ftp.fr.debian.org/debian/ wheezy main [debian-default]
main-src = http://ftp.fr.debian.org/debian/ wheezy main repository-list =
update = http://ftp.fr.debian.org/debian/ wheezy-updates main main = http://ftp.fr.debian.org/debian/ wheezy main
update-src = http://ftp.fr.debian.org/debian/ wheezy-updates main main-src = http://ftp.fr.debian.org/debian/ wheezy main
slapos = http://download.opensuse.org/repositories/home:/VIFIBnexedi/Debian_7.0 ./ update = http://ftp.fr.debian.org/debian/ wheezy-updates main
re6stnet = http://git.erp5.org/dist/deb ./ update-src = http://ftp.fr.debian.org/debian/ wheezy-updates main
filter-package-list = slapos = http://download.opensuse.org/repositories/home:/VIFIBnexedi/Debian_7.0 ./
ntp re6stnet = http://git.erp5.org/dist/deb ./
slapos.node filter-package-list =
re6stnet ntp
filter-promise-list = slapos.node
core re6stnet
hostname filter-promise-list =
signature-list = core
debian+++jessie/sid+++ hostname
signature-list =
debian+++jessie/sid+++
Configuration Examples Configuration Examples
======================== ========================
* Example of update.cfg: * Example of update.cfg:
:: .. code:: text
[slapupdate]
# Change this key for customise your upgrade. [slapupdate]
upgrade_key = 'slapos-generic-upgrade-key' # Change this key for customise your upgrade.
upgrade_key = 'slapos-generic-upgrade-key'
[networkcache]
download-binary-cache-url = http://www.shacache.org/shacache [networkcache]
download-cache-url = https://www.shacache.org/shacache download-binary-cache-url = http://www.shacache.org/shacache
download-binary-dir-url = http://www.shacache.org/shadir download-cache-url = https://www.shacache.org/shacache
download-binary-dir-url = http://www.shacache.org/shadir
# It is important to use only trustfull keys.
signature-certificate-list = # It is important to use only trustfull keys.
-----BEGIN CERTIFICATE----- signature-certificate-list =
MIIB8DCCAVmgAwIBAgIJAPFf61p8y809MA0GCSqGSIb3DQEBBQUAMBAxDjAMBgNV -----BEGIN CERTIFICATE-----
BAMMBUNPTVAtMCAXDTE0MDIxNzE2NDgxN1oYDzIxMTQwMTI0MTY0ODE3WjAQMQ4w MIIB8DCCAVmgAwIBAgIJAPFf61p8y809MA0GCSqGSIb3DQEBBQUAMBAxDjAMBgNV
DAYDVQQDDAVDT01QLTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEAsiqCyuv1 BAMMBUNPTVAtMCAXDTE0MDIxNzE2NDgxN1oYDzIxMTQwMTI0MTY0ODE3WjAQMQ4w
HO9FmtwnMbEa1/u8Dn7T0k7hVKYXVQYof+59Ltbb3cA3nLjFSJDr/wQT6N89MccS DAYDVQQDDAVDT01QLTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEAsiqCyuv1
PneRzkWqZKL06Kmj+N+XJfRyVaTz1qQtNzjdbYkO6RgQq+fvq2CO0+PSnL6NttLU HO9FmtwnMbEa1/u8Dn7T0k7hVKYXVQYof+59Ltbb3cA3nLjFSJDr/wQT6N89MccS
/a9nQMcVm7wZ8kmY+AG5LbVo8lmxDD16Wq0CAwEAAaNQME4wHQYDVR0OBBYEFEVi PneRzkWqZKL06Kmj+N+XJfRyVaTz1qQtNzjdbYkO6RgQq+fvq2CO0+PSnL6NttLU
YyWHF3W7/O4NaTjn4lElLpp7MB8GA1UdIwQYMBaAFEViYyWHF3W7/O4NaTjn4lEl /a9nQMcVm7wZ8kmY+AG5LbVo8lmxDD16Wq0CAwEAAaNQME4wHQYDVR0OBBYEFEVi
Lpp7MAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQEFBQADgYEAgIPGoxhUa16AgjZx YyWHF3W7/O4NaTjn4lElLpp7MB8GA1UdIwQYMBaAFEViYyWHF3W7/O4NaTjn4lEl
Jr1kUrs8Fg3ig8eRFQlBSLYfANIUxcQ2ScFAkmsvwXY3Md7uaSvMJsEl2jcjdmdi Lpp7MAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQEFBQADgYEAgIPGoxhUa16AgjZx
eSreNkx85j9GtMLY/2cv0kF4yAQNRtibtDkbg6fRNkmUopDosJNVf79l1GKX8JFL Jr1kUrs8Fg3ig8eRFQlBSLYfANIUxcQ2ScFAkmsvwXY3Md7uaSvMJsEl2jcjdmdi
zZBOFdOaLYY/6dLRwiTUKHU6su8= eSreNkx85j9GtMLY/2cv0kF4yAQNRtibtDkbg6fRNkmUopDosJNVf79l1GKX8JFL
-----END CERTIFICATE----- zZBOFdOaLYY/6dLRwiTUKHU6su8=
-----END CERTIFICATE-----
* Example of upgrade signature:
* Example of upgrade signature:
::
[debian-default] .. code:: text
repository-list =
main = http://ftp.fr.debian.org/debian/ wheezy main [debian-default]
main-src = http://ftp.fr.debian.org/debian/ wheezy main repository-list =
update = http://ftp.fr.debian.org/debian/ wheezy-updates main main = http://ftp.fr.debian.org/debian/ wheezy main
update-src = http://ftp.fr.debian.org/debian/ wheezy-updates main main-src = http://ftp.fr.debian.org/debian/ wheezy main
slapos = http://download.opensuse.org/repositories/home:/VIFIBnexedi/Debian_7.0 ./ update = http://ftp.fr.debian.org/debian/ wheezy-updates main
re6stnet = http://git.erp5.org/dist/deb ./ update-src = http://ftp.fr.debian.org/debian/ wheezy-updates main
filter-package-list = slapos = http://download.opensuse.org/repositories/home:/VIFIBnexedi/Debian_7.0 ./
ntp re6stnet = http://git.erp5.org/dist/deb ./
slapos.node filter-package-list =
re6stnet ntp
filter-promise-list = slapos.node
core re6stnet
hostname filter-promise-list =
signature-list = core
debian+++jessie/sid+++ hostname
signature-list =
[opensuse-legacy] debian+++jessie/sid+++
repository-list =
suse = http://download.opensuse.org/distribution/12.1/repo/oss/ [opensuse-legacy]
slapos = http://download.opensuse.org/repositories/home:/VIFIBnexedi/openSUSE_12.1 repository-list =
re6st = http://git.erp5.org/dist/rpm suse = http://download.opensuse.org/distribution/12.1/repo/oss/
filter-package-list = slapos = http://download.opensuse.org/repositories/home:/VIFIBnexedi/openSUSE_12.1
ntp re6st = http://git.erp5.org/dist/rpm
slapos.node
re6stnet filter-package-list =
signature-list = ntp
opensuse+++12.1+++x86_64 slapos.node
re6stnet
[system]
reboot = 2011-10-10 signature-list =
upgrade = 2014-02-20 opensuse+++12.1+++x86_64
[system]
reboot = 2011-10-10
upgrade = 2014-02-20
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment