install_with_vmware.md

Vmware setup (aka "Virtualbox c'est no way")

Prerequisites

• Providing

  • Vmware workstation
  • Vagrant
  • Vmware utility driver
  • Vagrant plugins:
    • vagrant-reload
    • vagrant-vmware-desktop
    • on some distribution also the vagrant plugins :
      • winrm
      • winrm-fs
      • winrm-elevated

• Provisioning with python

  • Python3 (>=3.8)
  • ansible-core==2.12.6
  • pywinrm

• Or provisioning With Docker

  • Docker

check dependencies

• If you run ansible locally

./goad.sh -t check -l GOAD -p vmware -m local

• If you run ansible with docker

./goad.sh -t check -l GOAD -p vmware -m docker

Install dependencies

If the check is not ok you will have to install the dependencies (no automatic install is provided as it depend of your package manager and distribution). Here some install command lines are given for ubuntu.

Install Vmware workstation

• Download and install vmware workstation and set your license key (or use the 30 days trial) workstation-pro-evaluation
• Note that workstation-player can't manage clone and snapshot and will not work with vagrant you need to use the pro version
• You will also need to install VMware Utility driver (https://developer.hashicorp.com/vagrant/downloads/vmware) (an install guide can be found here : https://developer.hashicorp.com/vagrant/docs/providers/vmware/vagrant-vmware-utility)

cd /tmp
wget https://releases.hashicorp.com/vagrant-vmware-utility/1.0.21/vagrant-vmware-utility_1.0.21_linux_amd64.zip
sudo mkdir -p /opt/vagrant-vmware-desktop/bin
sudo unzip -d /opt/vagrant-vmware-desktop/bin vagrant-vmware-utility_1.0.21_linux_amd64.zip
sudo /opt/vagrant-vmware-desktop/bin/vagrant-vmware-utility certificate generate
sudo /opt/vagrant-vmware-desktop/bin/vagrant-vmware-utility service install

• Note that you will need to install the vmware-desktop plugin after the vagrant installation :

vagrant plugin install vagrant-vmware-desktop

Install Vagrant

• vagrant from their official site vagrant. The version you can install through your favorite package manager (apt, yum, ...) is probably not the latest one.
• Install vagrant plugin vbguest if you want the guest addition: vagrant plugin install vagrant-vbguest (not mandatory)
• Vagrant installation is well describe in the official vagrant page (tests are ok on 2.3.4)
• Some github issues indicate vagrant got some issue on some version and work well with 2.2.19 (apt install vagrant=2.2.19)

wget -O- https://apt.releases.hashicorp.com/gpg | gpg --dearmor | sudo tee /usr/share/keyrings/hashicorp-archive-keyring.gpg
echo "deb [signed-by=/usr/share/keyrings/hashicorp-archive-keyring.gpg] https://apt.releases.hashicorp.com $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/hashicorp.list
sudo apt update && sudo apt install vagrant

• on some recent versions (ubuntu 23.04), you should consider run also:

gem install winrm winrm-fs winrm-elevated

Install docker

• If you want to run the ansible install from docker and don't install all the python dependencies just install docker

Or Install Ansible locally

• If you want to play ansible from your host or a linux vm you should launch the following commands :

• Create a python >= 3.8 virtualenv

sudo apt install git
git clone [email protected]:Orange-Cyberdefense/GOAD.git
cd GOAD/ansible
sudo apt install python3.8-venv
python3.8 -m virtualenv .venv
source .venv/bin/activate

• Install ansible and pywinrm in the .venv
  • ansible following the extensive guide on their website ansible.
  • Tested with ansible-core (2.12)
  • pywinrm be sure you got the pywinrm package installed

python3 -m pip install --upgrade pip
python3 -m pip install ansible-core==2.12.6
python3 -m pip install pywinrm

• Install all the ansible-galaxy requirements
  • ansible windows
  • ansible community.windows
  • ansible chocolatey (not needed anymore)
  • ansible community.general

ansible-galaxy install -r ansible/requirements.yml

Install

Launch installation automatically

• This will launch vagrant up and the ansible playbooks
• If you run ansible locally

./goad.sh -t install -l GOAD -p vmware -m local

• If you run ansible on docker

./goad.sh -t install -l GOAD -p vmware -m docker

Launch installation manually

Create the vms

• To create the VMs just run

cd ad/GOAD/providers/vmware
vagrant up

note: For some distributions, you may need to run additional commands to install WinRM gems this can be done via the following commands:

vagrant plugin install winrm
vagrant plugin install winrm-fs
vagrant plugin install winrm-elevated

• At the end of the vagrantup you should have the vms created and running

Launch provisioning with Docker

• launch the provision script (launch ansible with failover on errors)

sudo docker run -ti --rm --network host -h goadansible -v $(pwd):/goad -w /goad/ansible goadansible /bin/bash -c "ANSIBLE_COMMAND='ansible-playbook -i ../ad/GOAD/data/inventory -i ../ad/GOAD/providers/vmware/inventory' ../scripts/provisionning.sh"

• or launch ansible from docker directly

sudo docker run -ti --rm --network host -h goadansible -v $(pwd):/goad -w /goad/ansible goadansible ansible-playbook -i ../ad/GOAD/data/inventory -i ../ad/GOAD/providers/vmware/inventory main.yml

Launch provisioning with Ansible

• launch the provision script (launch ansible with failover on errors)

cd ansible
export ANSIBLE_COMMAND="ansible-playbook -i ../ad/GOAD/data/inventory -i ../ad/GOAD/providers/vmware/inventory"
../scripts/provisionning.sh

• or launch ansible directly

cd ansible/
ansible-playbook -i ../ad/GOAD/data/inventory -i ../ad/GOAD/providers/vmware/inventory main.yml

• Details on the provisioning process are here : provisioning.md