Split provisioners into external git repos

[LoreleiAurora]

Tasks:

• YAML config file to control VVV (Fixes Ability to disable installation of default WP sites #313)
• Allow selecting which sites to make active (Fixes Allow selecting which sites to make active #474)
• Ability to provision sites individually (Fixes Add site without re-provisioning existing site #753)
• Split provisioning of WP sites (Fixes Split provisioning of WP sites #611 Auto-site setup all the things #210)

---

• Ability to include Customfile from any folder (Fixes Customfile from any folder, not just Vagrantfile path (or alternative) #851)
• Pass site name & root dir to vvv-init scripts
• Pass site name & root dir to nginx config (Fixes Folder structure for auto site setups is inflexible #771)
• Allow a site to be stored outside the VVV dir on the host machine

YAML config file to control VVV

The YAML config file will allow inclusion of external provisioning scripts from git repos and disabling of provisioning of specific sites (at a later date it can be used to configure other aspects of VVV).

To use a default option for any site parameter simply miss it out of the site block.

sites:
  # All options defaults that can be used in a site config
  wordpress-default:
    # The git url for this site
    # e.g. https://github.com/Varying-Vagrant-Vagrants/vvv-wordpress-default.git
    repo: ''
    # The directory on the vm where the site lives
    # e.g.  '/srv/www/wordpress-default'
    vm_dir: /srv/www/{SITE NAME}
    # The directory on the host where the site lives
    # e.g.  '/PATH TO VVV/www/wordpress-default'
    local_dir: vagrant_dir/www/{SITE NAME}
    # Weather to use the sites Customfile if one is found
    allow_customfile: false 
    # Weather to run this sites provisioner
    skip_provisioning: false

    # If you are only providing a repo url to your site config 
    multisite: https://github.com/Varying-Vagrant-Vagrants/vvv-multisite.git

    # Site not stored in git accepting the default options
    site_name:

Ability to provision sites individually

Sites can be provisioned individually using the following vagrant command
vagrant provision --provision-with site-{sitename}
e.g. vagrant provision --provision-with site-wordpress-default

New Variables

Bash Variable	Nginx Variable	Example
${VVV_PATH_TO_SITE}	{vvv_path_to_site}	/srv/www/wordpress-default
${VVV_SITE_NAME}	{vvv_site_name}	wordpress-default

Path to site uses the vm_dir as defined in the config as apposed to the path to the dir in which the nginx config or shell script was found. This resolves the issue listed in #771.

[mbijon]

This is excellent for granularity, resources, and general control-freak moments. All these changes get a +1 from me (I haven't tested yet, but several of these things are great ideas).

It's a huge batch of changes though. So I'll say something I always say when I like something and want to see it in prod... if there's any resistance please break it up and include whatever possible. Let's only delay pieces that are disputed or buggy, not everything g.

[jeremyfelt]

I haven't had time to dig in yet, but I want to leave a note of general support for this. I'll take a closer look over the next few days. Thank you @LoreleiAurora!

[cfoellmann]

how about changing the dashboard like so?

---
default:
  dashboard:
    repo: https://github.com/topdown/VVV-Dashboard.git
---
sites:
  wordpress-default:
    repo: https://github.com/Varying-Vagrant-Vagrants/vvv-wordpress-default.git
    vm_dir: '/srv/www/wordpress-default-provisioner'
[...]

[cfoellmann]

@LoreleiAurora the timer for the provisioning is shown before the start of the provisioning of the sites. Not at the very end of the process

[LoreleiAurora]

@cfoellmann i forgot the timer existed, as each site is called as a separate vagrant provisioner i'm not really sure how we could keep it. Unless anyone else has any ideas?

[cfoellmann]

maybe add the counter to all provisioners? I can add them together. 😸

[LoreleiAurora]

@cfoellmann if you want to try that you can.
If you have you have push on this repo you also have push on LoreleiAurora:split-provisioners

[cfoellmann]

@jeremyfelt can you add some repos for multisite?

• vvv-wpmu-subdirectory
• vvv-wpmu-subdirectory-trunk
• vvv-wpmu-subdomain
• vvv-wpmu-subdomain-trunk

[Mte90]

There is a docs about that file? like the name of the file? what is the path? Also this works with old installation of vvv?
sorry for the many questions XD

[LoreleiAurora]

@Mte90 The file is vvv-config.yml in the root dir.
For this to work with your existing installation your config would look something like this:

sites:
  wordpress-default:
    repo: https://github.com/Varying-Vagrant-Vagrants/vvv-wordpress-default.git
    vm_dir: '/srv/www/wordpress-default-provisioner'

  wordpress-develop:
    repo: https://github.com/Varying-Vagrant-Vagrants/vvv-wordpress-develop.git
    vm_dir: '/srv/www/wordpress-develop-provisioner'

  // The below lines are the directory names of your site configs followed by a colon.
  preexisting-site-1: 
  preexisting-site-2:
  preexisting-site-3: 

I still need to write docs/migration guide.

[Mte90]

So in the case that I have many installed with vv this is compatible?
In case it's better that vv get the support for this before to use in my case

[LoreleiAurora]

I have not tested compatibility with vv, but if its not i would love to help make it compatible.
Ping @bradp

[LoreleiAurora]

@jeremyfelt Rather than having a repo for each of utilities what do you think about adding another key to the yaml file and storing them in one repo. This would give a config like this:

sites: 
  <Redacted for simplicity>

utilities:
  phpmyadmin: true
  memcached-admin: true
  opcache-status: true
  webgrind: true

Then any other utils (including third party ones) can be added to this repo and work with just one line. Kind of like a VVV plugin directory.

For example i have mongodb & adminmongo installed in vvv, this config could live as part of the utils repo.

[cfoellmann]

Shouldn't we look into provisioning the utilities via composer? I wanted to do it in the past but time...

[LoreleiAurora]

@cfoellmann we can do that in the scripts, but we keep the scripts that trigger the installs in that repo allowing non composer tools to be added with 1 uniform method of configuration.

[topdown]

What about adding a Yaml linter to validate these YAML files?
https://github.com/adrienverge/yamllint

Would hopefully lower support issues/questions when this PR is rolled out.
Just a thought.

[LoreleiAurora]

@topdown can you please open that as a new issue as this is already in develop.