cb-scheduler¶

SYNOPSIS¶

cb-scheduler -h | --help
cb-scheduler
    [--update-interval=<time_sec>]
    [--poll-timeout=<time_msec>]
    [--build-limit=<number>]
    [(--repo-server=<name> --ssh-user=<user> --ssh-pkey=<ssh_pkey_file>)]

DESCRIPTION¶

cb-scheduler - listens on incoming package/image build requests from the message broker on a regular schedule. Only if the max package/image to build limit is not exceeded, request messages from the broker are accepted. In case the request matches the runner capabilities e.g architecture it gets acknowledged and removed from the broker queue.

Building a package:¶

A package can be build for different distribution targets and architectures. Each distribution target/arch needs to be configured as a profile in the build_root.kiwi metadata and added as effective build target in the cloud_builder.yml configuration file:

.cb
  ├── build_root.kiwi
  └── cloud_builder.yml

An example package config to build the xclock package for the Tumbleweed distribution for x86_64 and aarch64 would look like the following:

schema_version: 0.1
name: xclock

distributions:
  -
    dist: TW
    arch: x86_64
    runner_group: suse

  -
    dist: TW
    arch: aarch64
    runner_group: suse

The above instructs the scheduler to create two buildroot environments, one for Tumbleweed(x86_64) and one for Tumbleweed(aarch64) and build the xclock package in each of these buildroots. To process this properly the scheduler creates a script which calls cb-prepare followed by cb-run with the corresponding parameters for each element of the distributions list. Each dist.arch build process is triggered by one build request. In the above example two requests to build all targets in the distributions list would be required.

The dist and arch settings of a distribution are combined into profile names given to cb-prepare as parameter and used in KIWI to create the buildroot environment. From the above example this would lead to two profiles named:

TW.x86_64
TW.aarch64

The .kiwi metadata file has to provide instructions such that the creation of a correct buildroot for these profiles is possible.

Build an OS image:¶

An image can be build for different profiles, build arguments and architectures. In contrast to a package build the image build only requires the cloud_builder.yml configuration file:

.cb
 └── cloud_builder.yml

An example image config to build myimage for myprofile and for the x86_64 achitecture would look like the following:

schema_version: 0.1
name: myimage

images:
  -
    arch: x86_64
    runner_group: suse
    selection:
      name: standard
      profiles:
        - myprofile
      build_arguments:
        - "--clear-cache"

The above instructs the scheduler to build one image for the myprofile profile and the x86_64 achitecture on a runner in the suse group. The package cache on this runner will be cleared prior building the image. The image output files will get pacakged into an rpm package. To do this properly the scheduler creates a script which calls cb-image.

The project directory is treated as the image description directory and passed as such to the KIWI image builder via cb-image. KIWI searches for a *.kiwi or config.xml file to accept the directory as an image description. If the cloud builder configuration file cloud_builder.yml names a profile, that profile must be defined in the KIWI config file.

OPTIONS¶

--update-interval=<time_sec>: Optional update interval to reconnect to the message broker. Default is 10sec
--poll-timeout=<time_msec>: Optional message broker poll timeout to return if no requests are available. Default: 5000msec
--build-limit=<number>: Max number of build processes this scheduler handles at the same time. Default: 10
--repo-server=<name>: Name or IP of collector repo server
--ssh-pkey=<ssh_pkey_file>: Path to ssh private key file to access repo server
--ssh-user=<user>: User name to access repo server