IMPORTANT NOTICE
This is the website of KADEPLOY VERSION 2. The LATEST version of KADEPLOY is VERSION 3, whose web site is HERE.
3. Using kadeploy v2
The deployment system is composed of several tools or commands whose aim is the execution of all the needed actions to carry out deployments and other administrative tasks.
Every tool has his own man page available at the end of this documentation. This could be useful to answer some pertinent questions the reader may wonder.
3.1 The first time...
The two first steps are to register the cluster "software and hardware composition" in its current state.
If any environment is already installed on some partitions of some nodes, it is necessary to register it. This operation is done by giving the appropriate information (image name, image location, kernel path etc.) to the karecordenv tool.
Then, kaaddnode is used to register the cluster "hardware" composition. It needs the description of hosts, disks and partitions in a text file. The tool reads it and registers the information (name and addresses of nodes, disk type and size, partition number and size etc.) in the database.
Once these operations completed, the system is ready for deployments.
3.2 Deployment
The system has been prepared for deployment. Now what ? To deploy, something to be deployed is needed !
The environment to be deployed can either already exist and be registered in the database or already exist but not be registered or neither exist nor be registered. The first case is the simplest since nothing has to be done prior to the deployment itself. In the other cases, kacreateenv ( kaarchive/ karecordenv) are used to create and register (create/register) an environment in the database (cf. the environment section for details about these steps).
The deployment itself i.e. of a given environment on target partitions of a set of cluster nodes is done using the kadeploy tool.
A complete deployment is composed of the following steps :
- reboot on the deployment kernel via pxe protocol
- pre-installation actions (bench, partitionning and/or file system building if needed etc.)
- environment copy
- post-installation script sending and execution
- reboot on the freshly installed environment
If the deployment fails on some nodes, these are rebooted on a default environment.
Please refer to the customization scripts section for further details about preinstall and postinstall scripts.
3.3 Other tools for remote management
Two remote management tools are available to diagnostic and if possible take control of cluster nodes that would be for instance in an unstable or undefined state further to a deployment failure.
The kaconsole tool enables to open a console on a remote node. It needs special hardware equipment and special command configuration as described in the second part of the configuartion files section.
The kareboot tool enables to do various reboot types on cluster nodes. The possibilities are numerous : the reboot on a given (already installed) environment or on a given partition or even on the deployment kernel for instance. It also enables to hard reboot nodes appropriately equiped.
3.4 What if the cluster hardware composition changes ?
kaaddnode and kadelnode enable to add and remove nodes from the deployment system if the cluster composition changes.
3.5 Command summary
Functionalities summary
kaaddnode - registers nodes in deployment system
kadelnode - unregisters nodes in deployment system
karecordenv - registers an environment image in deployment system
kaarchive - creates an environment image
kacreateenv - creates and registers an environment image in deployment system
kadeploy - deploys an environment image
kaconsole - opens a remote console
kareboot - reboots according to requested reboot type
Use summary
The first time...
karecordenv- to register environments already installed (if any)kaaddnode- to register the cluster hardware composition
Deployment
kacreateenv/karecordenv/kaarchive- to create and/or register an environment and make it available for deploymentkadeploy- to deploy a registered environment
Other tools
kaconsole- to open a console on a remote nodekareboot- to reboot a cluster node
Examples
# karecordenv -n debian -d "custom debian" -fb file://home/toto/images/custom_debian.tgz -ft file://home/toto/images/debian_postinstall.tgz -size 750 -k /boot/vmlinuz # kaaddnode cluster_description.txt # kacreateenv -e new_debian -fb file://home/toto/images/new_debian.tgz -ft file://home/toto/images/debian_postinstall.tgz --size 650 -k /boot/vmlinuz --root-directory / # kadeploy -e new_debian -m node1 -m node2 -p hda7 # kaconsole -m node2 # kareboot -s -e custom_debian -m node2
Next Previous Contents