Argument passing

UMD product verification can be customized by providing arguments at different stages. The current available arguments and the way to pass them to the tool are explained below:

Runtime args

Runtime arguments are given through fab argument list. Currently supported runtime arguments are:

umd_release:

UMD release to be triggered.

  • Available options:
    3:UMD-3 release.
    4:UMD-4 release.
  • Default value: No default value, this parameter is required to be provided at runtime if cmd_release is not used.
cmd_release:

CMD release to be triggered.

  • Available options:
    0:CMD-0 release.
  • Default value: No default value, this parameter is required to be provided at runtime if umd_release is not used.
repository_url:

Repository path with the verification content.

  • In YUM-based systems the URL MUST point to where repodata directory is located.

  • Multiple values are allowed by prefixing with repository_url.

    fab repository_url=<URL1>,repository_url_2=<URL2>,repository_url_other=<URL3>,..

  • Arguments passed with equal names will overwrite the value.
repository_file:
 

URL pointing to a valid repository file (.list, .repo).

  • Multiple values are allowed by prefixing with repository_file.

    fab repository_file=<URL1>,repository_file_2=<URL2>,repository_file_other=<URL3>,..

  • Arguments passed with equal names will overwrite the value.
igtf_repo:

Repository for the IGTF release.

  • Value must contain a URL pointing to a valid repository file.
  • Required value located in the default configuration file (see Static args).
yaim_path:

Path pointing to YAIM configuration files.

  • Default value: etc/yaim/.
log_path:

Path to store logs produced during the execution.

  • Default value: /var/tmp/umd-verification.
qcenv_*:

Pass environment variables needed by the QC specific checks.

  • The name of the environment variable to be exported is the name given after the underscore ‘_’ symbol. Accordingly, the variable’s value is the fab argument’s value.

    fab qcenv_FOO=bar,..

    This example will set FOO=bar in the testing environment.
qc_step:

Run a given set of Quality Criteria steps.

  • Multiple values are allowed by prefixing with qc_step.

    fab qc_step_1=QC_SEC,qc_step_2=QC_INFO,..

  • Arguments passed with equal names will overwrite the value.
umdnsu_url:

URL (hostname:port) to interface with umdnsu service running in the SAM-Nagios instance.
hostcert:

Public key server certificate.
hostkey:

Private key server certificate.
dont_ask_cert_renewal:
 

Do not prompt for certificate renewal (when certificates already exist)
ca_version:

Special runtime argument for CA verifications. This value refers to the CA release version with ‘<major>.<minor>.<patch>’ format.
enable_testing_repo:
 

Enable UMD or CMD testing repository.
enable_untested_repo:
 

Enable UMD or CMD untested repository.
params_file:

YAML file with extra parameters to be passed to the configuration management tool (Ansible, Puppet)

Static args

An additional way to provide the runtime arguments seen above is through the configuration file etc/defaults.yaml.

This file must exist since it is here where the required arguments are set. This is why it lives within the application codebase.

The format is YAML so the naming of the runtime arguments seen above differ a little. Currently supported runtime arguments (and their YAML formatted equivalent) are:

base:log_path:log_path argument.
umd_release:<distro_version (e.g. redhat5)>:
 umd_release argument.
igtf_repo:<distname (e.g. redhat)>:
 igtf_repo.
yaim:path:yaim_path.
nagios:umdnsu_url:
 umdnsu_url.

Instantiation args

These arguments are used when defining a new deployment (umd.base.Deploy instance) in the product’s directory umd/products. Currently supported instantiation arguments are:

name:

UMD product (aka Fabric command name).

  • Type: str.
  • Default value: empty string.
doc:

Docstring that will appear when typing fab -l.

  • Type: str.
  • Default value: empty string.
need_cert:

Whether installation type requires a signed cert.

  • Type: boolean.
  • Default value: False.
  • Additional info: creates a dummy CA to issue public and private keys needed for the product to be deployed.
has_infomodel:

Whether the product publishes information about itself.

  • Type: boolean.
  • Default value: False.
  • Additional info: launches QC_INFO_1 checks, so it’s mandatory for the product publishing data (commonly through BDII).
cfgtool:

Configuration tool object.

  • Type: umd.base.configure.BaseConfig.

  • Default value: None.

  • Additional info: contains an instance of any class that inherits from BaseConfig. Currently available: - umd.base.configure.YaimConfig

    nodetype:YAIM nodetype to be configured.
    siteinfo:File containing YAIM configuration variables.
    • umd.base.configure.PuppetConfig
      manifest:Main “.pp” with the configuration to be applied.
      module_from_puppetforge:
       list of modules to be installed (from PuppetForge).
      module_from_repository:
       module (repotype, repourl) tuples.
      module_path:Extra Puppet module locations.
qc_mon_capable:
Whether extenal monitoring (aka SAM Nagios) can monitor the

product.

  • Type: boolean.
  • Default value: False.
qc_specific_id:
ID that match the list of QC-specific checks to be executed.

The check definition must be included in etc/qc_specific.yaml.

  • Type: str.
  • Default value: None.
qc_step:

Specific step from the Quality Criteria to run.

  • Type: str, list.
  • Default value: empty list.
exceptions:

Documented exceptions for a given UMD product.

  • Type: dict.
  • Default value: empty dict.