Merge branch 'feature/mac-m1' into 'master'

get hashiqube to work on Mac M1 chips, adding docker provider, update documentation

See merge request all-staff/hashiqube!83

Author: Riaan Nolan

Dockerfile

@@ -0,0 +1,51 @@
+# https://betterprogramming.pub/managing-virtual-machines-under-vagrant-on-a-mac-m1-aebc650bc12c
+# https://github.com/rofrano/vagrant-docker-provider
+
+FROM ubuntu:focal
+
+ENV DEBIAN_FRONTEND noninteractive
+
+# Install packages needed for SSH and interactive OS
+RUN apt-get update && \
+    yes | unminimize && \
+    apt-get -y install \
+        openssh-server \
+        passwd \
+        sudo \
+        man-db \
+        curl \
+        wget \
+        vim-tiny && \
+    apt-get -qq clean && \
+    rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
+
+# Enable systemd (from Matthew Warman's mcwarman/vagrant-provider)
+RUN (cd /lib/systemd/system/sysinit.target.wants/; for i in *; do [ $i == systemd-tmpfiles-setup.service ] || rm -f $i; done); \
+    rm -f /lib/systemd/system/multi-user.target.wants/*; \
+    rm -f /etc/systemd/system/*.wants/*; \
+    rm -f /lib/systemd/system/local-fs.target.wants/*; \
+    rm -f /lib/systemd/system/sockets.target.wants/*udev*; \
+    rm -f /lib/systemd/system/sockets.target.wants/*initctl*; \
+    rm -f /lib/systemd/system/basic.target.wants/*; \
+    rm -f /lib/systemd/system/anaconda.target.wants/*;
+
+# Enable ssh for vagrant
+RUN systemctl enable ssh.service; 
+EXPOSE 22
+
+# Create the vagrant user
+RUN useradd -m -G sudo -s /bin/bash vagrant && \
+    echo "vagrant:vagrant" | chpasswd && \
+    echo 'vagrant ALL=(ALL) NOPASSWD: ALL' > /etc/sudoers.d/vagrant && \
+    chmod 440 /etc/sudoers.d/vagrant
+
+# Establish ssh keys for vagrant
+RUN mkdir -p /home/vagrant/.ssh; \
+    chmod 700 /home/vagrant/.ssh
+ADD https://raw.githubusercontent.com/hashicorp/vagrant/master/keys/vagrant.pub /home/vagrant/.ssh/authorized_keys
+RUN chmod 600 /home/vagrant/.ssh/authorized_keys; \
+    chown -R vagrant:vagrant /home/vagrant/.ssh
+
+# Run the init daemon
+VOLUME [ "/sys/fs/cgroup" ]
+CMD ["/usr/sbin/init"]

README.md

@@ -23,7 +23,85 @@ Thanks to the flexibility of the HashiCorp products there is no need wonder how
 * Please download __Virtualbox__ from https://www.virtualbox.org/wiki/Downloads and __Vagrant__ from https://www.vagrantup.com/downloads.html and install
 * Using `git` - clone this repo `git clone $repo .` [__What is Git?__](git/#git)
 * Inside the local repo folder, do `vagrant up --provision` - This will setup, Vault, Nomad, Consul, Terraform, Localstack and Docker as well as giving you access the docsify website at http://localhost:3333
-* Open in your browser http://localhost:3333 for Documentation
+
+:bulb: If you see this error message
+
+```
+The IP address configured for the host-only network is not within the
+allowed ranges. Please update the address used to be within the allowed
+ranges and run the command again.
+
+Address: 10.9.99.10
+Ranges: 192.168.56.0/21
+
+Valid ranges can be modified in the /etc/vbox/networks.conf file. For
+more information including valid format see:
+
+https://www.virtualbox.org/manual/ch06.html#network_hostonly
+```
+
+Please create the following file: __/etc/vbox/networks.conf__ with the following contents
+
+```
+* 10.0.0.0/8 192.168.0.0/16
+* 2001::/64
+``` 
+
+and re-run `vagrant up --provision`
+
+## Dependencies
+To get started we are now going to install some core dependencies to get the Lab started, you need to install
+below dependencies before you can do anything
+
+__Mac Users only, Windows Users can skip this step__
+Let's first check if we have an __M1 Mac__, if that is the case the __virtualbox__ provider will not work.
+
+Click on the Apple Icon top left
+![About this Mac](images/mac_apple_icon.png?raw=true "About this Mac")
+
+and click on __About this Mac__
+
+If you see an __Intel__ chip, you can proceed with the `virtualbox` provider.
+![About this Mac Intel](images/mac_intel.png?raw=true "About this Mac Intel")
+
+If you see an __Apple M1__ chip, please ensure you specify the environment variable and the provider to be docker.
+```
+vagrant plugin uninstall vagrant-hostsupdater # the hostsupdator plugin does not work with the docker provider
+```
+
+![About this Mac M1](images/mac_m1.png?raw=true "About this Mac M1")
+
+#### Docker Desktop
+Docker Desktop is an easy-to-install application for your Mac or Windows environment that enables you to build and share containerized applications and microservices. It's a graphical user interface for the docker service.
+
+* Please download __Docker Desktop__ from https://www.docker.com/products/docker-desktop and install it on your laptop, to verify please bring up the Docker Desktop application. 
+
+I already have HashiQube running, you won't see any containers but you will be able to open the application 
+
+![Docker Desktop](images/docker_desktop_installed.png?raw=true "Docker Desktop")
+
+Now that docker has been installed we need to ensure that your docker environment and settings are configured
+
+- Ensure you have the latest version installed
+- Ensure that your Operating System is updated see: https://www.docker.com/blog/speed-boost-achievement-unlocked-on-docker-desktop-4-6-for-mac/
+
+##### Docker Desktop Resources
+
+![Docker Desktop Resources](images/docker_installed_resources.png?raw=true "Docker Desktop Resources")
+
+* Please ensure that you give your docker daemon at least __10G of RAM__ and sufficient disk space
+
+##### Docker Desktop Experimental Features
+
+![Docker Desktop Experimental Features](images/docker_installed_experimental_features.png?raw=true "Docker Desktop Experimental Features")
+
+https://www.docker.com/blog/speed-boost-achievement-unlocked-on-docker-desktop-4-6-for-mac/
+
+The latest version of Docker on Mac has some signaficant performance improvements, you should consider updating. 
+
+Improvements have been made to the way that files are synced between the macOS host and Docker VM. During testing with our amazing macOS community of users, we have observed that these changes have reduced the time taken to complete filesystem operations by up to 98%.
+
+For developers, these incredible gains in speed mean less time waiting for filesystem operations to complete (or building project-specific workarounds to improve performance) and more time focusing on innovation!
 
 ## Consul DNS
 __Local DNS via Consul__ <br />
@@ -42,6 +120,32 @@ Now you can use DNS like nomad.service.consul:9999 vault.service.consul:9999 via
 * Vagrant
 * `vagrant up --provision`
 
+
+If you see this error message
+
+```
+The IP address configured for the host-only network is not within the
+allowed ranges. Please update the address used to be within the allowed
+ranges and run the command again.
+
+Address: 10.9.99.10
+Ranges: 192.168.56.0/21
+
+Valid ranges can be modified in the /etc/vbox/networks.conf file. 
+For more information including valid format see
+
+https://www.virtualbox.org/manual/ch06.html#network_hostonly
+```
+
+Please create the following file: __/etc/vbox/networks.conf__ with the following contents
+
+```
+* 10.0.0.0/8 192.168.0.0/16
+* 2001::/64
+``` 
+
+and re-run `vagrant up --provision`
+
 ## Additional Information
 * [__Multi Cloud__](multi-cloud/#terraform-hashicorp-hashiqube) - Hashiqube on AWS, GCP and Azure (Clustered) https://registry.terraform.io/modules/star3am/hashiqube/hashicorp/latest
 * [__Vagrant__](hashicorp/#vagrant) - Development Environments Made Easy
@@ -112,6 +216,31 @@ For Documentation please open http://localhost:3333 in your browser
 ==> user.local.dev: Setting hostname...
 ```
 
+### Errors you might encounter
+__Error__ response from daemon: cannot stop container: 6c0c8135620ff47efe12df417a0df0e57d7a81a7f7ca06d011323fbb52e573db: tried to kill container, but did not receive an exit event <br />
+__Command__ `vagrant destroy` <br />
+__Solution__ run `vagrant destroy` again <br />
+```
+    hashiqube0.service.consul: Are you sure you want to destroy the 'hashiqube0.service.consul' VM? [y/N] y
+==> hashiqube0.service.consul: Stopping container...
+A Docker command executed by Vagrant didn't complete successfully!
+The command run along with the output from the command is shown
+below.
+
+Command: ["docker", "stop", "-t", "1", "6c0c8135620ff47efe12df417a0df0e57d7a81a7f7ca06d011323fbb52e573db", {:notify=>[:stdout, :stderr]}]
+
+Stderr: Error response from daemon: cannot stop container: 6c0c8135620ff47efe12df417a0df0e57d7a81a7f7ca06d011323fbb52e573db: tried to kill container, but did not receive an exit event
+```
+
+__Error__ The IP address configured for the host-only network is not within the allowed ranges. Please 
+update the address used to be within the allowed ranges and run the command again. <br />
+__Command__ `vagrant up --provision` <br /> 
+__Solution__ Ensure the following contents are present in `/etc/vbox/networks.conf` <br>
+```
+* 10.0.0.0/8 192.168.0.0/16
+* 2001::/64
+```
+
 ## To investigate
 ### CI/CD
     Gatling: (load testing) https://gatling.io/open-source

Vagrantfile

@@ -7,8 +7,8 @@ fqdn = ENV["fqdn"] || "service.consul"
 
 # https://www.virtualbox.org/manual/ch08.html
 vbox_config = [
-  { '--memory' => '4096' },
-  { '--cpus' => '2' },
+  { '--memory' => '10240' },
+  { '--cpus' => '4' },
   { '--cpuexecutioncap' => '100' },
   { '--biosapic' => 'x2apic' },
   { '--ioapic' => 'on' },
@@ -28,7 +28,7 @@ machines = [
     :disksize => '10GB',
     :vbox_config => vbox_config,
     :synced_folders => [
-      { :vm_path => '/data', :ext_rel_path => '../../', :vm_owner => 'ubuntu' },
+      { :vm_path => '/osdata', :ext_rel_path => '../../', :vm_owner => 'ubuntu' },
       { :vm_path => '/var/jenkins_home', :ext_rel_path => './jenkins/jenkins_home', :vm_owner => 'ubuntu' },
     ],
   },
@@ -67,21 +67,24 @@ Vagrant::configure("2") do |config|
     COMMAND_SEPARATOR = ";"
   end
 
-  # auto install plugins, will prompt for admin password on 1st vagrant up
-  required_plugins = %w( vagrant-disksize vagrant-hostsupdater )
-  required_plugins.each do |plugin|
-    exec "vagrant plugin install #{plugin}#{COMMAND_SEPARATOR}vagrant #{ARGV.join(" ")}" unless Vagrant.has_plugin? plugin || ARGV[0] == 'plugin'
-  end
+  # deprecated
+  # if @chipset != "Apple"; then
+  #   # auto install plugins, will prompt for admin password on 1st vagrant up
+  #   required_plugins = %w( vagrant-disksize vagrant-hostsupdater )
+  #   required_plugins.each do |plugin|
+  #     exec "vagrant plugin install #{plugin}#{COMMAND_SEPARATOR}vagrant #{ARGV.join(" ")}" unless Vagrant.has_plugin? plugin || ARGV[0] == 'plugin'
+  #   end
+  # end
 
   machines.each_with_index do |machine, index|
 
     config.vm.box = "ubuntu/focal64"
     config.vm.define machine[:name] do |config|
 
-      config.disksize.size = machine[:disksize]
+      # config.disksize.size = machine[:disksize] # deprecated
       config.ssh.forward_agent = true
       config.ssh.insert_key = true
-      config.vm.network "private_network", ip: machine[:ip]
+      config.vm.network "private_network", ip: "#{machine[:ip]}"
       config.vm.network "forwarded_port", guest: 22, host: machine[:ssh_port], id: 'ssh', auto_correct: true
 
       if machines.size == 1 # only expose these ports if 1 machine, else conflicts
@@ -110,7 +113,6 @@ Vagrant::configure("2") do |config|
       end
 
       config.vm.hostname = "#{machine[:name]}"
-      config.hostsupdater.aliases = ["#{machine[:name]}"]
 
       unless machine[:vbox_config].nil?
         config.vm.provider :virtualbox do |vb|
@@ -121,6 +123,30 @@ Vagrant::configure("2") do |config|
           end
         end
       end
+      
+      # if you are not on Apple M chip and want to use docker provider do:
+      # vagrant up --provision-with basetools --provider docker
+      # https://developers.redhat.com/blog/2016/09/13/running-systemd-in-a-non-privileged-container
+      # https://github.com/containers/podman/issues/3295
+      # --tmpfs /tmp : Create a temporary filesystem in /tmp
+      # --tmpfs /run : Create another temporary filesystem in /run
+      # --tmpfs /run/lock : Apparently having a tmpfs in /run isn’t enough – you ALSO need one in /run/lock
+      # -v /sys/fs/cgroup:/sys/fs/cgroup:ro : Mount the CGroup kernel configuration values into the container
+      # https://github.com/docker/for-mac/issues/6073
+      # Docker Desktop now uses cgroupv2. If you need to run systemd in a container then:
+      # * Ensure your version of systemd supports cgroupv2. It must be at least systemd 247. Consider upgrading any centos:7 images to centos:8.
+      # * Containers running systemd need the following options: --privileged --cgroupns=host -v /sys/fs/cgroup:/sys/fs/cgroup:rw.
+      # https://betterprogramming.pub/managing-virtual-machines-under-vagrant-on-a-mac-m1-aebc650bc12c
+      config.vm.provider "docker" do |docker, override|
+        override.vm.box        = nil
+        docker.build_dir       = "."
+        docker.remains_running = true
+        docker.has_ssh         = true
+        docker.privileged      = true
+        docker.volumes         = ['/sys/fs/cgroup:/sys/fs/cgroup:rw']
+        docker.create_args     = ['--cgroupns=host', '--tmpfs=/tmp:exec', '--tmpfs=/var/lib/docker:mode=0777,dev,size=15g,suid,exec', '--tmpfs=/run', '--tmpfs=/run/lock'] # '--memory=10g', '--memory-swap=14g', '--oom-kill-disable'
+        docker.env             = { "PROVIDER": "docker", "NAME": "hashiqube" }
+      end
 
       # mount the shared folder inside the VM
       unless machine[:synced_folders].nil?
@@ -161,6 +187,10 @@ Vagrant::configure("2") do |config|
       # vagrant up --provision-with docker to only run this on vagrant up
       config.vm.provision "docker", preserve_order: true, type: "shell", path: "docker/docker.sh"
 
+      # docsify
+      # vagrant up --provision-with docsify to only run this on vagrant up
+      config.vm.provision "docsify", type: "shell", preserve_order: true, privileged: false, path: "docsify/docsify.sh"
+
       # install terraform
       # vagrant up --provision-with terraform to only run this on vagrant up
       config.vm.provision "terraform", preserve_order: true, type: "shell", privileged: true, path: "hashicorp/terraform.sh"
@@ -247,10 +277,6 @@ Vagrant::configure("2") do |config|
 
 
 
-      # docsify
-      # vagrant up --provision-with docsify to only run this on vagrant up
-      config.vm.provision "docsify", type: "shell", preserve_order: true, privileged: false, path: "docsify/docsify.sh"
-
 
 
 

database/mysql.sh

@@ -7,12 +7,13 @@ yes | sudo docker system prune -a
 yes | sudo docker system prune --volumes
 sudo DEBIAN_FRONTEND=noninteractive apt-get --assume-yes install mysql-client
 sudo docker run \
+  --memory 512M \
   --name mysql \
   -e MYSQL_ROOT_PASSWORD=password -e MYSQL_DATABASE=mysqldb \
   -p 3306:3306 \
   -d mysql:latest \
   --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci
-sleep 15;
+sleep 60;
 echo -e '\e[38;5;198m'"++++ Show databases"
 mysql -h 127.0.0.1 -u root -ppassword -e "show databases;"
 echo -e '\e[38;5;198m'"++++ Create Vault MySQL user"

docker/docker.sh

@@ -1,16 +1,27 @@
 #/bin/bash
 # https://docs.docker.com/install/linux/docker-ce/ubuntu/
+sudo DEBIAN_FRONTEND=noninteractive apt-get update
 sudo DEBIAN_FRONTEND=noninteractive apt-get install --assume-yes apt-transport-https ca-certificates curl gnupg-agent software-properties-common
 sudo -i
 curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
-sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
+#PROCESSOR_ARCHITECTURE=$(lscpu | grep "Architecture" | awk '{print $NF}') >> /etc/environment
+#echo -e '\e[38;5;198m'"CPU is $PROCESSOR_ARCHITECTURE"
+arch=$(lscpu | grep "Architecture" | awk '{print $NF}')
+if [[ $arch == x86_64* ]]; then
+    ARCH="amd64"
+elif  [[ $arch == aarch64 ]]; then
+    ARCH="arm64"
+fi
+echo -e '\e[38;5;198m'"CPU is $ARCH"
+sudo add-apt-repository "deb [arch=$ARCH] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
 sudo apt-get update
 sudo DEBIAN_FRONTEND=noninteractive apt-get install --assume-yes docker-ce docker-ce-cli containerd.io
 sudo usermod -aG docker vagrant
 sudo mkdir -p /etc/docker
 sudo echo '{
-  "metrics-addr" : "0.0.0.0:9323",
-  "experimental" : true
+  "metrics-addr": "0.0.0.0:9323",
+  "experimental": true,
+  "storage-driver": "overlay2"
 }
 ' >/etc/docker/daemon.json
 sudo service docker restart
@@ -22,14 +33,16 @@ docker rm apache2
 yes | sudo docker system prune -a
 yes | sudo docker system prune --volumes
 echo "Creating Private Docker Registry"
-docker run -d -p 5000:5000 --restart=always --name registry registry:2
+docker run -d -p 5001:5001 --restart=always --name registry --memory 16M registry:2
 echo -e '\e[38;5;198m'"++++ docker build -t apache2 ."
 docker build -t apache2 .
 echo -e '\e[38;5;198m'"++++ docker images --filter reference=apache2"
 docker images --filter reference=apache2
 echo -e '\e[38;5;198m'"++++ docker run -t -d -i -p 8889:80 --name apache2 --rm apache2"
-docker run -t -d -i -p 8889:80 --name apache2 --rm apache2
+docker run -t -d -i -p 8889:80 --name apache2 --memory 16M --rm apache2
 docker ps
-echo -e '\e[38;5;198m''++++ open http://localhost:8889 in your browser'
-echo -e '\e[38;5;198m''++++ you can also run below to get apache2 version from the docker container'
+echo -e '\e[38;5;198m'"++++ Docker stats"
+docker stats --no-stream -a
+echo -e '\e[38;5;198m'"++++ open http://localhost:8889 in your browser"
+echo -e '\e[38;5;198m'"++++ you can also run below to get apache2 version from the docker container"
 echo -e '\e[38;5;198m'"++++ vagrant ssh -c \"docker ps; docker exec -it apache2 /bin/bash -c 'apache2 -t -v; ps aux'\""

docsify/docsify.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash -
+curl -sL https://deb.nodesource.com/setup_14.x | sudo -E bash -
 sudo DEBIAN_FRONTEND=noninteractive apt-get install --assume-yes nodejs
 sudo npm i docsify-cli -g --loglevel=error
 cd /vagrant