VVV logo VVV

Index

containsElement

Does a bash array contain a value?

Arguments

Exit codes

network_detection

Test that we have network connectivity with a URL. Deprecated, use check_network_connection_to_host instead

Arguments

See also

check_network_connection_to_host

Test that we have network connectivity with a URL.

Arguments

Exit codes

network_check

Tests network connectivity with several hosts needed for provisioning

Function has no arguments.

See also

log_to_file

Redirects stdout to a log file in the provisioner log folder

Arguments

noroot

Run a command that cannot be ran as root

vvv_apt_keys_has

Tests if an apt-key has been added

Arguments

vvv_src_list_has

Tests if an apt-source has been added

Arguments

vvv_format_output

Takes an input string and attempts to apply terminal formatting for various colours

Example

MSG=$(vvv_format_output "<success>green!</success>, <error>red :(</error>, <url>example.com</url></>normal text")

Arguments

vvv_output

Output to the terminal, and log to a provisioner log at the same time, with applied formatting

Arguments

vvv_info

Prints an information message

Arguments

vvv_error

Prints out an error message

Arguments

vvv_warn

Prints our a warning message

Arguments

vvv_success

Prints out a success message

Arguments

get_config_value

Retrieves a config value from the main config YAML file Uses shyaml get-value internally

Arguments

get_config_values

Retrieves config values from the main config YAML file Uses shyaml get-values internally

Arguments

get_config_type

Retrieves the type of a config value from the main config YAML file Uses shyaml get-type internally

Arguments

get_config_keys

Retrieves config keys from the main config YAML file Uses shyaml keys internally

Arguments

vvv_add_hook

Add a bash function to execute on a hook

Example

vvv_add_hook init vvv_init_profile 0

Arguments

vvv_hook

Executes a hook. Functions added to this hook will be executed

Example

vvv_hook before_packages

Arguments

vvv_parallel_hook

Executes a hook. Functions added to this hook will be executed in parallel

Example

vvv_parallel_hook before_packages

Arguments

vvv_apt_update

Updates Apt keys then fetches Apt updates.

vvv_apt_packages_upgrade

Upgrades all Apt packages.

vvv_apt_cleanup

Performs Apt autoremoval and cleanup.

vvv_package_install

Installs a selection of packages via apt

Example

vvv_package_install wget curl etc

vvv_is_apt_pkg_installed

checks if an apt package is installed, returns 0 if installed, 1 if not

Arguments

vvv_cleanup_dpkg_locks

cleans up dpkg lock files to avoid provisioning issues based on a fix from https://github.com/Varying-Vagrant-Vagrants/VVV/issues/2150

vvv_apt_package_remove

removes a selection of packages via apt

Example

vvv_apt_package_remove wget curl etc

vvv_maybe_install_nginx_config

Installs an Nginx config file and reload Nginx. If Nginx fails to load after doing this it will print an error and attempt to undo the change.

Example

vvv_maybe_install_nginx_config /tmp/nginx-site-config.conf vvv-site-mysite.conf sites

Arguments

vvv_get_sites

Retrieves a list of sites.

Function has no arguments.

vvv_update_guest_hosts

Updates the guest environments hosts file.

Function has no arguments.