Next Previous Contents

5. Configuration Files

kadeploy tools suite is configured through two configuration files : deploy.conf and deploy_cmd.conf in the /etc/kadeploy/ folder.

5.1 deploy.conf

This file presents all the variables the user must defined in order to be able to use the deployment system. It is divided into several sections. A very short description is available for each variable and sometimes example values are given in commentary.

The user can find an example in the tools/cookbook folder.

nodes properties

first_check_timeout

value is the time in seconds to wait for the nodes to reboot and load the deployment kernel. A first attempt try to reboot them with a software reboot, after this timeout, all the non booted nodes are hard rebooted, and after a second timeout, the still non booted ones are excluded from deployment. If null, kadeploy waits for all the target nodes

last_check_timeout

value is the time in seconds to wait for the nodes to reboot and load the deployed system. If null it waits for all the nodes that booted the deployment kernel

nmap

enable_nmap

value is 0 or 1, setting it to 1 enables ping checks before rsh or ssh checks, to fasten checks on the arrival of the nodes

nmap_cmd

value is the absolute path of the nmap command

sentinelle

sentinelle is a parallel launcher that is used by kadeploy to perform all the parallel tasks required during the deployment process. Two environments are defined : the first is the deploy environment, which should be configured to let the parallel launcher work when the target nodes are running the deployment kernel, and the prod environment, which is used to issue parallel commands when the nodes are rebooted under the deployed system.

deploy_sentinelle_cmd

value is the absolute path of the sentinelle command used when the nodes are running the deployment kernel, this should be /usr/local/bin/DKsentinelle, and that is where you should copy the DKsentinelle binary

deploy_sentinelle_default_args

value is the default arguments given to the deploy_sentinelle_cmd to be able to connect to the nodes and timeout

deploy_sentinelle_pipelined_args

value is the deploy_sentinelle_cmd arguments given during pipelined operations, it is possible to adapt it to ensure that the pipeline topology will meet the throughput constraints and the reliability needs

deploy_sentinelle_endings

value is the command to issue to get a node's IP when it is running the deployment kernel

deploy_sentinelle_timeout

value is the number of seconds to wait for a parallel command to succeed

prod_sentinelle_cmd

value is the absolute path of the sentinelle command used when the nodes are running the deployed system, this path is common to the server issuing the deployment, and the target nodes

prod_sentinelle_default_args

value is the default arguments given to the prod_sentinelle_cmd to be able to connect to the nodes and timeout

prod_sentinelle_pipelined_args

value is the prod_sentinelle_cmd arguments given during pipelined operations, it is possible to adapt it to ensure that the pipeline topology will meet the throughput constraints and the reliability needs

prod_sentinelle_endings

value is the command to issue to get a node's IP when it is running the deployed system

prod_sentinelle_timeout

value is the number of seconds to wait for a parallel command to succeed

database

deploy_db_host

value is the hostname where the mysql server that owns the deployment system database is running

deploy_db_name

value is the name of the deploy database

deploy_db_login

value is the login to access to the deploy database

deploy_db_psswd

value is the password to access to the deploy database

rights_db_host

value is the hostname where the mysql server that owns the deployment rights database is running

rights_db_name

value is the name of the rights database

rights_db_login

value is the login to access to the rights database

rights_db_psswd

value is the password to access to the rights database

preinstall and postinstall

pre_install_archive

value is the absolute path to the preinstall archive containing the pre_install_script

pre_install_script

value is the name of the script in the preinstall archive that is supposed to be launched during the preinstall step

post_install_script

value is the name of the script in the postinstall archive, defined in the database for each environment, that is supposed to be executed during the postinstall step

PXE/TFTP

This part deals with the configuration of the PXE/TFTP structure, to allow kadeploy to control the way the nodes boot.

kernel_param

value is the default kernel parameters given to the deployed kernel on boot, if none is specified with the environment, these parameters often deals with console redirection during kernel booting process

tftp_repository_intel

value is the base directory in the TFTP structure for Intel NICs (for our example, value should be /tftpboot/X86PC/linux/)

pxe_rep_intel

value is the relative path from tftp_repository_intel to to the folder where kernel/initrd are associated to each node (for our example, value should be pxelinux.cfg/)

tftp_repository

value is the base directory in the TFTP structure for non Intel NICs (for our example, value should be /tftpboot/PXEClient/)

pxe_rep

value is the relative path from tftp_repository to to the folder where kernel/initrd are associated to each node (for our example, value should be pxelinux.cfg/)

tftp_relative_path

value is the directory where the grub files are generated (for our example, value should be images_grub/)

Some other custom variables are available here to ease the cluster management, by defining kernel/initrd shortcuts for kareboot. These custom variables begin with label_ their values are kernel/initrd pairs that can be assigned to a booting node.
label_deploy_tg3 = duke-vmlinuz:duke-initrd  ETH_DRV=tg3 console=tty0 console=ttyS0,38400n8 ramdisk_size=20000
means that the booting node will load duke-vmlinuz and duke-initrd from the
/tftpboot/PXEClient/images_grub
directory passing the following parameters to the kernel
ETH_DRV=tg3 console=tty0 console=ttyS0,38400n8 ramdisk_size=20000

5.2 deploy_cmd.conf

This file contains the appropriate reboot and remote console opening commands. The kareboot and kaconsole tools get the commands to execute according to node given in parameter from it.

Also, the user can find an example in the tools/cookbook folder with a brief description of the syntax to use.

The syntax is host_name command_type command where possible command types are softboot, hardboot, deployboot or console.

softboot

the sofboot line is the software reboot command. Typically it looks something like ssh user@hostname /sbin/reboot

deployboot

the deployboot line is the command to execute to reboot the node under the deployment kernel e.g. using the setup_pxe.pl utility in the boot/ directory

hardboot

hardboot is the hardware reboot command depending on special hardware equipment

console

console is the command to open a remote console on a cluster node e.g. via serial port using the kermit software


Next Previous Contents