Skip to content

DTaaS Vagrant Box

This document provides instructions for creating a custom Operating System virtual disk for running the DTaaS platform. The virtual disk is managed by vagrant. The purpose is two-fold:

  • Provide cross-platform installation of the DTaaS platform. Any operating system supporting the use of vagrant software utility can support installation of the DTaaS platform.
  • Create a ready-to-use development environment for code contributors.

There are two scripts in this directory:

Script name Purpose Default
user.sh user installation ✅
developer.sh developer installation ❌

If you are installing the DTaaS for developers, the default installation caters to your needs. You can skip the next step and continue with the creation of vagrant box.

If additional software installation is desired for developers, the Vagrantfile needs to be modified. The existing Vagrantfile has two lines:

1
2
    config.vm.provision "shell", path: "user.sh"
    #config.vm.provision "shell", path: "developer.sh"

Uncomment the second line to have more software components installed. If you are not a developer, no changes are required to the Vagrantfile.

This vagrant box installed for users will have the following items:

  1. docker v24.0
  2. nodejs v20.10
  3. yarn v1.22
  4. npm v10.2
  5. containers - ml-workspace-minimal v0.13, traefik v2.10, gitlab-ce v16.4, influxdb v2.7, grafana v10.1, rabbitmq v3-management, eclipse-mosquitto (mqtt) v2, mongodb v7.0

This vagrant box installed for developers will have the following items additional items:

  • docker-compose v2.20
  • microk8s v1.27
  • jupyterlab
  • mkdocs
  • container - telegraf v1.28

At the end of installation, the software stack created in vagrant box can be visualised as shown in the following figure.

vagrant base box

The upcoming instructions will help with the creation of base vagrant box.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
#create a key pair
ssh-keygen -b 4096 -t rsa -f vagrant -q -N ""

vagrant up

# let the provisioning be complete
# replace the vagrant ssh key-pair with personal one
vagrant ssh

# install the oh-my-zsh
sh -c "$(curl -fsSL https://raw.github.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"
# install plugins: history, autosuggestions,
git clone https://github.com/zsh-users/zsh-autosuggestions ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/zsh-autosuggestions

# inside ~/.zshrc, modify the following line
plugins=(git zsh-autosuggestions history cp tmux)

# to replace the default vagrant ssh key-pair with
# the generated private key into authorized keys
cp /vagrant/vagrant.pub /home/vagrant/.ssh/authorized_keys

# exit vagrant guest machine and then
# copy own private key to vagrant private key location
cp vagrant .vagrant/machines/default/virtualbox/private_key

# check
vagrant ssh #should work

# exit vagrant guest machine and then
vagrant halt

vagrant package --base dtaas \
--info "info.json" --output dtaas.vagrant

# Add box to the vagrant cache in ~/.vagrant.d/boxes directory
vagrant box add --name dtaas ./dtaas.vagrant

# You can use this box in other vagrant boxes using
#config.vm.box = "dtaas"

References

Image sources: Ubuntu logo