[libvirt-ci PATCH 05/12] config: Introduce a new global config.yaml configuration file

[Andrea Bolognani]

On Wed, 2020-05-06 at 14:05 +0200, Erik Skultety wrote:
> +++ b/guests/config.yaml
> @@ -0,0 +1,23 @@
> +---
> +# Configuration file for lcitool
> +
> +install:

The file looks better if you leave an empty line between the section
name and the options.

> +  # Installation flavor determining the target environment for the VM:
> +  #
> +  # test - VMs suitable for local testing, 'test' has passwordless sudo

VMs suitable for local testing (the 'test' user has sudo privileges)

> +  # jenkins - VMs pluggable to a jenkins environment

VMs ready to be plugged into a Jenkins environment

> +  # gitlab - VMs ready to be plugged to a GitLab environment

VMs ready to be plugged into a GitLab environment

> +  flavor: test
> +
> +  # Initial root password to be set by ansible on the appliance. This password

Root password for the VM. This password...

> +  # will only be necessary for serial console access in case something goes
> +  # horribly wrong, for all other use cases, SSH key authentication will be used
> +  # instead. (Mandatory)
> +  #root_password:
> +
> +gitlab:
> +  # GitLab runner agent registration options, applies only if flavor == 'gitlab'.
> +  url: https://gitlab.com

This comment really applies to the section, not to the specific
option, so it should look like

  # GitLab-related options (only apply to the 'gitlab' flavor)
  gitlab:

    # GitLab connection URL
    url: https://gitlab.com

    ...

-- 
Andrea Bolognani / Red Hat / Virtualization