Information
We are currently investigating an issue with the editor of some pages. Please save your work and avoid to create new pages until this banner is gone.
Acsenv allows you to deploy acs development environments with ease. It can set up:
Virtual Machines requires more computers resources. At a minimum, each VM should be at least 4GB (4096) of memory, to allow for ACS to run. So be careful that the amount of VM resources matches the ones available on you local host. Though VM are slower to spin up and consumes your resources, they are great to provide isolation and are able to truly build up the final environment your application will run. Along with it, VM are able to display your graphical applications, so anything related to GUI a VM is your tool.
On the other hand, lightweight development environments can be created through Docker. That setup comes handy when you need to edit files and perform compilation from command line. Docker containers are great to run your TAT tests. Your development cycle can be speed up through the use of containers.
Often, when it is time to develop code for ACS, you end up trying to mixed up these elements:
All these elements are not suitable to be stored inside the VM or Docker container, because of the space they use (Several GB) and that we want to recreate the environment several times during the development cycle. For that reason, that elements are kept inside the local host and they are shared with the environment through:
Both VM and containers are provisioned through Ansible playbooks.
Ansible Acsenv can be cloned from:
https://bitbucket.sco.alma.cl/scm/~pburgos/ansible_acsenv.git
Download Virtualbox from official site:
https://www.virtualbox.org/wiki/Downloads
Vagrant allows you to script the Virtual Machines, so that all tasks related to create and destroy VM can be done through files and command line. Along with that, several tedious steps like setting up a NFS Share are greatly simplify using Vagrant.
Download Vagrant from the official site:
https://www.vagrantup.com/downloads
And follow the install instructions for your Operating System.
pyenv is a tool that allows you to isolate python and their packages, so that you keep you deployment clean and reproduceable. It's likely your already use this tool, so my recomendation is to create an environment for python and activate it before running pip, the command that follows this paragraph.
The python version used was 3.5.7
Python required packages
Install python requirement with pip
pip install -r requirements.txt
Create .acsenv in your home folder
mkdir $HOME/.acsenv/
create yml file boxes_config.yml. An example can be downloaded boxes_config.yml
---
memory: 4096
cpus: 2
gui: false
boxes:
- name: acs01
ip_private: 10.10.10.10
ip_public: 192.168.1.155
- name: acs02
ip_private: 10.10.10.11
ip_public: 192.168.1.156
Warning: acs needs at least 4GB (4096MB) of memory.
As you know, push passwords in clear code to a repository is a bad practice, even for environments intended for development. Sensitive information is encrypted using Ansible Vault. To allow ansible to decrypt the information you just need to add a file to the home of ansible_env folder. Example:
cd <ansible_acsenv> echo "Password" >> .vault_pass
Ask your instructor for the real password to be use here.
The cycle for a dev environment with virtual machine: build→ provision→destroy
Let's follow an example. Let's say that:
vagrant --acs_repo=/home/pburgos/Development/Repositories/bitbucket/almasw --acs_binary=/home/pburgos/.acsenv/versions/COMMON-2020JUN/dist --acs_working=/home/pburgos/.acsenv/versions/COMMON-2020JUN/working up acs01
This command will retrieve Centos7 box, and configure the mount points as nfs shares. It will ask for the administrator password to setup the NFS.
If a public_ip was specified for the machine in boxes_config.yml, then the user will be prompted to select the network interface to bridge to:
vagrant --acs_repo=/Users/pburgos/Development/Repositories/bitbucket/almasw --acs_binary=/Users/pburgos/.acsenv/versions/COMMON-2020JUN/dist --acs_working=/Users/pburgos/.acsenv/versions/COMMON-2020JUN/working up acs01 Bringing machine 'acs01' up with 'virtualbox' provider... ==> acs01: Importing base box 'centos/7'... ==> acs01: Matching MAC address for NAT networking... ==> acs01: Setting the name of the VM: ansible_acsenv_acs01_1595780860590_42357 ==> acs01: Clearing any previously set network interfaces... ==> acs01: Available bridged network interfaces: 1) en3: Thunderbolt Ethernet 2) en0: Wi-Fi (AirPort) 3) en1: Thunderbolt 1 4) en2: Thunderbolt 2 5) bridge0 6) awdl0 ==> acs01: When choosing an interface, it is usually the one that is ==> acs01: being used to connect to the internet. ==> acs01: acs01: Which interface should the network bridge to? 1 ==> acs01: Preparing network interfaces based on configuration... acs01: Adapter 1: nat acs01: Adapter 2: hostonly acs01: Adapter 3: bridged ==> acs01: Forwarding ports... acs01: 22 (guest) => 2222 (host) (adapter 1) ==> acs01: Running 'pre-boot' VM customizations... ==> acs01: Booting VM... ==> acs01: Waiting for machine to boot. This may take a few minutes... acs01: SSH address: 127.0.0.1:2222 acs01: SSH username: vagrant acs01: SSH auth method: private key acs01: acs01: Vagrant insecure key detected. Vagrant will automatically replace acs01: this with a newly generated keypair for better security. acs01: acs01: Inserting generated public key within guest... acs01: Removing insecure key from the guest if it's present... acs01: Key inserted! Disconnecting and reconnecting using new SSH key... ==> acs01: Machine booted and ready! ==> acs01: Checking for guest additions in VM... acs01: No guest additions were detected on the base box for this VM! Guest acs01: additions are required for forwarded ports, shared folders, host only acs01: networking, and more. If SSH fails on this machine, please install acs01: the guest additions and repackage the box to continue. acs01: acs01: This is not an error message; everything may continue to work properly, acs01: in which case you may ignore this message. ==> acs01: Setting hostname... ==> acs01: Configuring and enabling network interfaces... ==> acs01: Rsyncing folder: /Users/pburgos/ansible_acsenv/ => /vagrant ==> acs01: Exporting NFS shared folders... ==> acs01: Preparing to edit /etc/exports. Administrator privileges will be required... The nfsd service does not appear to be running. Starting the nfsd service ==> acs01: Mounting NFS shared folders...
To provision our new created VM we will use ansible playbooks. It does not matter how many machines are active at a given time, ansible will provision the machines that are running at a given time. Be careful if you use Virtual Machines in your local hosts for other purposes. The following comand will try to provision all machines in runnig state.
ansible-playbook -i vagrant.py vagrant_provision.yml
You can destroy you VM to create a new one. These can happed when a different acs_binaries is needed.
Let's say I want to destroy acs01. First I verified the status of that machine
❯ vagrant status Current machine states: acs01 running (virtualbox) acs02 not created (virtualbox)
To destroy acs01 VM we issue:
❯ vagrant destroy acs01 acs01: Are you sure you want to destroy the 'acs01' VM? [y/N] y ==> acs01: Forcing shutdown of VM... ==> acs01: Destroying VM and associated drives... ==> acs01: Pruning invalid NFS exports. Administrator privileges will be required... Password:
Let's verified it was destroyed:
❯ vagrant status acs01 Current machine states: acs01 not created (virtualbox)
Great!
To be added soon.