$Id: pulse2-package-server-configuration.xml 132 2009-05-12 16:27:50Z nrueff $
Copyright © 2009 Olivier Roussy - Mandriva
| Revision History | ||
|---|---|---|
| Revision 1.2.1 | 2009-05-12 | OR |
|
||
| Revision 1.2.0 | 2008-21-21 | OR |
|
||
Abstract
This document explains the content of the configuration file of the package server service from Pulse 2
Table of Contents
The « package server » service is the Pulse 2 daemon that implement all the package apis, it permit the creation, edition, suppression, share, mirroring... of packages.
The service configuration file is /etc/mmc/pulse2/package-server/package-server.ini
Like all Pulse 2 related configuration file, its file format is INI style. The file is made of sections, each one starting with a « [sectionname] » header. In each section options can be defined like this: « option = value ».
For example:
[section1] option1 = 1 option2 = 2 [section2] option1 = foo option2 = plop
For now four sections are available in this configuration file. The section describing the mirror, package_api_get or package_api_put can be duplicated if you need to have more than one api of this kind.
Table 1. package-server.ini available sections
| Section name | Description | Optional |
|---|---|---|
| main | Common package server configuration directives | no |
| daemon | Package server daemon related behaviors | yes |
| ssl | Package server ssl related dehaviors | yes |
| mirror_api | yes | |
| user_package_api | yes | |
| scheduler_api | yes | |
| mirror:XX | yes | |
| package_api_get:XX | yes | |
| package_api_put:XX | yes |
All the other sections (loggers, handlers, ...) are related to Python language logging framework. See http://docs.python.org/lib/logging-config-fileformat.html .
This section is used to configure the inventory server services.
Table 2. Available options for the "main" section
| Option name | Description | Optional | Default value |
|---|---|---|---|
| host | The hostname or ip address where the inventory. | yes | localhost |
| port | The port on which the inventory listen. | yes | 9999 |
| package_detect_activate | Is package autodetection activated | yes | 0 |
| package_detect_loop | Time between two loops of detection | yes | 60 |
| package_detect_smart_method | methods in none, last_time_modification, check_size; for more than 1 method, separate with "," | yes | none |
| package_detect_smart_time | yes | 60 | |
| package_mirror_loop | yes | 5 | |
| package_mirror_target | Package api can synhronise package data to others servers; package synchronisation targets | yes | |
| package_mirror_status_file | package synchronisation state file. used only if package_mirror_target is defined. File where pending sync are written so that they can be finished on package server restart. | yes | /var/data/mmc/status |
| package_mirror_command | package synchronisation command to use | yes | /usr/bin/rsync |
| package_mirror_command_options | package synchronisation command options | yes | -ar --delete |
| package_mirror_level0_command_options | package synchronisation command on only one level options | yes | -d --delete |
| package_mirror_command_options_ssh_options | options passed to SSH via "-o" if specified --rsh is automatically added to package_mirror_command_options | yes | "" |
| package_global_mirror_activate | loop for the sync of the whole package directory; can only be activated when package_mirror_target is given | yes | 1 |
| package_global_mirror_loop | yes | 3600 | |
| package_global_mirror_command_options | yes | -ar --delete | |
| real_package_deletion | real package deletion | yes | 0 |
| mm_assign_algo | machine/mirror assign algo | yes | default |
| up_assign_algo | user/packageput assign algo | yes | default |
package_mirror_command_options_ssh_options can be for exemple :
IdentityFile=/root/.ssh/id_dsa StrictHostKeyChecking=no Batchmode=yes PasswordAuthentication=no ServerAliveInterval=10 CheckHostIP=no ConnectTimeout=10
This section sets the package server service run-time options and privileges.
Table 3. Available options for the "daemon" section
| Option name | Description | Optional | Default value |
|---|---|---|---|
| pidfile | The package server service store its PID in the given file. | yes | /var/run/pulse2-package-server.pid |
| user | The inventory service runs as this specified user. | yes | root |
| group | The inventory service runs as this specified group. | yes | root |
| umask | The inventory service umask defines the right of the new files it creates (log files for example). | yes | 0077 |
This section defines some global options..
Table 4. Available options for the "ssl" section
| Option name | Description | Optional | Default value |
|---|---|---|---|
| username | yes | "" | |
| password | yes | "" | |
| enablessl | SSL mode support | yes | 1 |
| verifypeer | use SSL certificates | yes | 0 |
| cacert | path to the certificate file describing the certificate authority of the SSL server | yes | /etc/mmc/pulse2/package-server/keys/cacert.pem |
| localcert | path to the SSL server private certificate | yes | /etc/mmc/pulse2/package-server/keys/privkey.pem |
This section define options for the mirror_api api implementation (it assign mirrors and package_api to machines).
Table 5. Available options for the "mirror_api" section
| Option name | Description | Optional | Default value |
|---|---|---|---|
| mount_point | The api mount point | no | /rpc |
This section define options for the user_package_api api implementation (it assign package_api to users, it's used for the package edition permissions).
Table 6. Available options for the "user_package_api" section
| Option name | Description | Optional | Default value |
|---|---|---|---|
| mount_point | The api mount point | no | /upaa |
This section define options for the scheduler_api api implementation (it assign a scheduler to each machine).
Table 7. Available options for the "scheduler_api" section
| Option name | Description | Optional | Default value |
|---|---|---|---|
| mount_point | The api mount point | no | /scheduler_api |
| schedulers | The possible schedulers (can be a url or an id). | no |
This section define options for the mirror api implementation.
Table 8. Available options for the "mirror:XX" section
| Option name | Description | Optional | Default value |
|---|---|---|---|
| mount_point | The api mount point | no | |
| src | The root path of the package tree. | no |
This section define options for the package_api_get api implementation.
Table 9. Available options for the "package_api_get:XX" section
| Option name | Description | Optional | Default value |
|---|---|---|---|
| mount_point | The api mount point | no | |
| src | The root path of the package tree. | no |
This section define options for the package_api_put api implementation.
Table 10. Available options for the "package_api_put:XX" section
| Option name | Description | Optional | Default value |
|---|---|---|---|
| mount_point | The api mount point | no | /rpc |
| src | The root path of the package tree. | no | |
| tmp_input_dir | The directory where the data for package creation is put | yes |