Environment Variables¶

There are several environment variables that may be set to override default timeouts:

DOCKER_MIN_API_VERSION - represents the Docker API version currently in use (default: 1.44)
DOCKER_TIMEOUT - represents the Docker daemon connection timeout (default: 600)
OSBS_TIMEOUT - represents the OSBS timeout (default: 7200)
ODCS_TIMEOUT - represents the ODCS compose timeout (default: 600)

Configuration file¶

CEKit can be configured using a configuration file. We use the ini file format.

CEKit will look for this file at the path ~/.cekit/config. Its location can be changed via command line --config option.

Example

Running CEKit with different config file:

$ cekit --config ~/alternative_path build

Below you can find description of available sections together with options described in detail.

Common section¶

The [common] section contains settings used across CEKit.

Example

[common]
work_dir = /tmp
ssl_verify = False
cache_url = http://cache.host.com/fetch?#algorithm#=#hash#
redhat = True

Working directory¶

Key

work_dir

Description

Location of CEKit working directory, which is used to store some persistent data like dist-git repositories and artifact cache.

Default

~/.cekit

Example

[common]
work_dir=/tmp

SSL verification¶

Key

ssl_verify

Description

Controls verification of SSL certificates, for example when downloading artifacts.

Default

True

Example

[common]
ssl_verify = False

Cache URL¶

Key

cache_url

Description

Specifies a different location that could be used to fetch artifacts. Usually this is a URL to some cache service.

You can use following substitutions:

#filename# – the file name from the url of the artifact
#algorithm# – has algorithm specified for the selected artifact
#hash# – value of the digest.

Default

Not set

Example

Consider you have an image definition with artifacts section like this:

artifacts:
    - url: "http://some.host.com/7.0.0/jboss-eap-7.0.0.zip"
      md5: cd02482daa0398bf5500e1628d28179a

If we set the cache_url parameter in following way:

[common]
cache_url = http://cache.host.com/fetch?#algorithm#=#hash#

The JBoss EAP artifact will be fetched from: http://cache.host.com/fetch?md5=cd02482daa0398bf5500e1628d28179a.

And if we do it like this:

[common]
cache_url = http://cache.host.com/cache/#filename#

The JBoss EAP artifact will be fetched from: http://cache.host.com/cache/jboss-eap-7.0.0.zip.

Red Hat environment¶

Key

redhat

Description

This option changes CEKit default options to comply with Red Hat internal infrastructure and policies.

Tip

OSBS URL Restriction¶

Key

fetch_artifact_domains

Description

This option is used during OSBS processing to constrain the files added to fetch-artifacts-url. It may be set to a comma separated list of URLs. If set, each potential URL based artifact to be added to fetch-artifacts-url must be within one of the URL domain/paths specified by this key. If not set then all URLs are added without restriction.

Default

not set

Example

[common]
fetch_artifact_domains = https://www.foo.bar/my-path,https://www.example.com

URL Artifact Authentication¶

Key

url_authentication

Description

This option makes it possible to provide a username/password on a per-domain basis when downloading URL based artifacts. Multiple domains each with their own username/password may be specified with a ; deliminator while the domain is separated from the username:password combination via a # deliminator.

Default

Not set

Example

[common]
url_authentication=example.com#username:password;www.foo.org#username:password

Note

Due to the separators being used (;, #, :) these characters cannot be used within a password.