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,7 +36,9 @@ server was upgraded before the dates present there, the upgrade will be trigger ...@@ -27,7 +36,9 @@ 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:
::
.. code:: text
[system] [system]
reboot = 2011-10-10 reboot = 2011-10-10
upgrade = 2014-02-20 upgrade = 2014-02-20
...@@ -35,56 +46,60 @@ Example: ...@@ -35,56 +46,60 @@ Example:
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 =
[debian-default]
repository-list =
main = http://ftp.fr.debian.org/debian/ wheezy main main = http://ftp.fr.debian.org/debian/ wheezy main
main-src = http://ftp.fr.debian.org/debian/ wheezy main main-src = http://ftp.fr.debian.org/debian/ wheezy main
update = http://ftp.fr.debian.org/debian/ wheezy-updates main update = http://ftp.fr.debian.org/debian/ wheezy-updates main
update-src = http://ftp.fr.debian.org/debian/ wheezy-updates main update-src = http://ftp.fr.debian.org/debian/ wheezy-updates main
slapos = http://download.opensuse.org/repositories/home:/VIFIBnexedi/Debian_7.0 ./ slapos = http://download.opensuse.org/repositories/home:/VIFIBnexedi/Debian_7.0 ./
re6stnet = http://git.erp5.org/dist/deb ./ re6stnet = http://git.erp5.org/dist/deb ./
filter-package-list = filter-package-list =
ntp ntp
slapos.node slapos.node
re6stnet re6stnet
filter-promise-list = filter-promise-list =
core core
hostname hostname
signature-list = signature-list =
debian+++jessie/sid+++ debian+++jessie/sid+++
Configuration Examples Configuration Examples
======================== ========================
* Example of update.cfg: * Example of update.cfg:
.. code:: text
:: [slapupdate]
[slapupdate] # Change this key for customise your upgrade.
# Change this key for customise your upgrade. upgrade_key = 'slapos-generic-upgrade-key'
upgrade_key = 'slapos-generic-upgrade-key'
[networkcache] [networkcache]
download-binary-cache-url = http://www.shacache.org/shacache download-binary-cache-url = http://www.shacache.org/shacache
download-cache-url = https://www.shacache.org/shacache download-cache-url = https://www.shacache.org/shacache
download-binary-dir-url = http://www.shacache.org/shadir download-binary-dir-url = http://www.shacache.org/shadir
# It is important to use only trustfull keys. # It is important to use only trustfull keys.
signature-certificate-list = signature-certificate-list =
-----BEGIN CERTIFICATE----- -----BEGIN CERTIFICATE-----
MIIB8DCCAVmgAwIBAgIJAPFf61p8y809MA0GCSqGSIb3DQEBBQUAMBAxDjAMBgNV MIIB8DCCAVmgAwIBAgIJAPFf61p8y809MA0GCSqGSIb3DQEBBQUAMBAxDjAMBgNV
BAMMBUNPTVAtMCAXDTE0MDIxNzE2NDgxN1oYDzIxMTQwMTI0MTY0ODE3WjAQMQ4w BAMMBUNPTVAtMCAXDTE0MDIxNzE2NDgxN1oYDzIxMTQwMTI0MTY0ODE3WjAQMQ4w
...@@ -100,41 +115,44 @@ signature-certificate-list = ...@@ -100,41 +115,44 @@ signature-certificate-list =
-----END CERTIFICATE----- -----END CERTIFICATE-----
* Example of upgrade signature: * Example of upgrade signature:
:: .. code:: text
[debian-default]
repository-list = [debian-default]
repository-list =
main = http://ftp.fr.debian.org/debian/ wheezy main main = http://ftp.fr.debian.org/debian/ wheezy main
main-src = http://ftp.fr.debian.org/debian/ wheezy main main-src = http://ftp.fr.debian.org/debian/ wheezy main
update = http://ftp.fr.debian.org/debian/ wheezy-updates main update = http://ftp.fr.debian.org/debian/ wheezy-updates main
update-src = http://ftp.fr.debian.org/debian/ wheezy-updates main update-src = http://ftp.fr.debian.org/debian/ wheezy-updates main
slapos = http://download.opensuse.org/repositories/home:/VIFIBnexedi/Debian_7.0 ./ slapos = http://download.opensuse.org/repositories/home:/VIFIBnexedi/Debian_7.0 ./
re6stnet = http://git.erp5.org/dist/deb ./ re6stnet = http://git.erp5.org/dist/deb ./
filter-package-list = filter-package-list =
ntp ntp
slapos.node slapos.node
re6stnet re6stnet
filter-promise-list = filter-promise-list =
core core
hostname hostname
signature-list = signature-list =
debian+++jessie/sid+++ debian+++jessie/sid+++
[opensuse-legacy] [opensuse-legacy]
repository-list = repository-list =
suse = http://download.opensuse.org/distribution/12.1/repo/oss/ suse = http://download.opensuse.org/distribution/12.1/repo/oss/
slapos = http://download.opensuse.org/repositories/home:/VIFIBnexedi/openSUSE_12.1 slapos = http://download.opensuse.org/repositories/home:/VIFIBnexedi/openSUSE_12.1
re6st = http://git.erp5.org/dist/rpm re6st = http://git.erp5.org/dist/rpm
filter-package-list =
filter-package-list =
ntp ntp
slapos.node slapos.node
re6stnet re6stnet
signature-list =
signature-list =
opensuse+++12.1+++x86_64 opensuse+++12.1+++x86_64
[system] [system]
reboot = 2011-10-10 reboot = 2011-10-10
upgrade = 2014-02-20 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