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.
|
||||
---|---|---|---|---|---|
cmd_release: | CMD release to be triggered.
|
||||
repository_url: | Repository path with the verification content.
|
||||
repository_file: | |||||
URL pointing to a valid repository file (.list, .repo).
|
|||||
igtf_repo: | Repository for the IGTF release.
|
||||
yaim_path: | Path pointing to YAIM configuration files.
|
||||
log_path: | Path to store logs produced during the execution.
|
||||
qcenv_*: | Pass environment variables needed by the QC specific checks.
|
||||
qc_step: | Run a given set of Quality Criteria steps.
|
||||
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).
|
||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
doc: | Docstring that will appear when typing fab -l.
|
||||||||||||||||
need_cert: | Whether installation type requires a signed cert.
|
||||||||||||||||
has_infomodel: | Whether the product publishes information about itself.
|
||||||||||||||||
cfgtool: | Configuration tool object.
|
||||||||||||||||
qc_mon_capable: |
|
||||||||||||||||
qc_specific_id: |
|
||||||||||||||||
qc_step: | Specific step from the Quality Criteria to run.
|
||||||||||||||||
exceptions: | Documented exceptions for a given UMD product.
|