Latest Updates
Project archived, latest updates can be found here: https://github.com/star3am/hashiqube
HashiQube Overview
HashiQube is a VM or Docker Container with a Docker daemon inside. It runs all HashiCorp products. Vault, Terraform, Nomad, Consul, Waypoint, Boundary, Vagrant, Packer and Sentinel. It also runs a host of other popular Open Source DevOps / DevSecOps applications showcasing how simple integration with HashiCorp products can result in tangible learnings and benefits for all its users Once the Qube is up an internet connection is no longer needed meaning sales pitches and demos for potential and existing customers is greatly aided.
Links
HashiCorp blog post: https://www.hashicorp.com/resources/hashiqube-a-development-lab-using-all-the-hashicorp-products
HashiQube website: https://hashiqube.com
HashiQube github: https://github.com/star3am/hashiqube
HashiQube youtube: https://www.youtube.com/watch?v=6jGDAGWaFiw
HashiQube medium: https://medium.com/search?q=hashiqube
HashiQube runs all HashiCorp's products and more
Purpose
HashiQube has been created to enable anyone who is interested in secure automation pipelines the ability to run a suite of ‘best in class’ tools their local machines at the cost of a small amount of system resources. The Qube gives all interested parties the empowerment to deploy these tools in a way covers multiple use cases effectively providing a ‘concept to completion’ test bed using open source HashiCorp products. The original use case was born the desire to demystify DevSecOps utilising Terraform, Vault, Consul, Sentinel and Nomad as well as some other well know open source CI/CD tools by providing a ‘hands-on’ environment that demonstrates the value of secret and credential management in standard software development pipeline.
Thanks to the flexibility of the HashiCorp products there is no need to wonder how to achieve the goals of bringing software to market in a more secure and timely fashion, just Vagrant up!
Operating Systems and Chipsets Supported
| Name | Docker | Virtualbox | Hyper-V |
|---|---|---|---|
| amd64 | ✓ | ✓ | ✘ |
| arm64 | ✓ | ✘ | ✘ |
| linux | ✓ | ✓ | ✘ |
| windows | ✓ | ✘ | ✘ |
| mac intel | ✓ | ✓ | ✘ |
| mac apple | ✓ | ✘ | ✘ |
Instructions
- Docker - Download Docker from https://www.docker.com/products/docker-desktop and install
- Vagrant - Download Vagrant from https://www.vagrantup.com/downloads.html and install
- Virtualbox (Optional) - Download Virtualbox from https://www.virtualbox.org/wiki/Downloads and install
- Using
git- clone this repogit clone $repo .What is Git? - Inside the local repo folder, do
vagrant up --provision- This will setup, Vault, Nomad, Consul, Terraform, Localstack and Docker - Documentation locally available at http://localhost:3333
Components
HashiQube is made up out of a number of components and some rely on each other.
For example you can run components seperately as demonstrated below.
vagrant up --provision-with basetools
vagrant up --provision-with docker
vagrant up --provision-with docsify
vagrant up --provision-with vault
vagrant up --provision-with nomad
vagrant up --provision-with minikubeOr one-shot as demonstrated below.
vagrant up --provision-with basetools,docker,minikube,postgresql,dbt,apache-airflowDocker 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.
- Download Docker Desktop from https://www.docker.com/products/docker-desktop and install it on your laptop, to verify bring up the Docker Desktop application.
If you have HashiQube running, you won't see any containers but you will be able to open the application.
Now that docker is installed we need to ensure that the 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
- Ensure that you give your docker daemon at least 8G of RAM and sufficient disk space
Consul DNS
Local DNS via Consul
Add on our local Macbook a file /etc/resolver/consul with below contents
nameserver 10.9.99.10
port 8600
Now you can use DNS like nomad.service.consul:9999 vault.service.consul:9999 via Fabio Load Balancer
Pre-requisites
- 10GB of disk space
- Admin rights / sudo (you will be asked to update ETC Host file)
- Docker (Default) and/or Virtualbox
- Vagrant
vagrant up --provision
Hashiqube Integrations
- Multi Cloud - Hashiqube on AWS, GCP and Azure (Clustered) https://registry.terraform.io/modules/star3am/hashiqube/hashicorp/latest
- Vagrant - Vagrant is an open-source software product for building and maintaining portable virtual software development environments; e.g., for VirtualBox, KVM, Hyper-V, Docker containers, VMware, and AWS. It tries to simplify the software configuration management of virtualization in order to increase development productivity
- Vault - Secure, store and tightly control access to tokens, passwords, certificates, encryption keys for protecting secrets and other sensitive data using a UI, CLI, or HTTP API.
- Consul - Consul uses service identities and traditional networking practices to help organizations securely connect applications running in any environment.
- Nomad - A simple and flexible scheduler and orchestrator to deploy and manage containers and non-containerized applications across on-prem and clouds at scale.
- Traefik - Traefik is a modern HTTP reverse proxy and load balancer that seamlessly integrates with Nomad
- Fabio - Fabio is an HTTP and TCP reverse proxy that configures itself with data from Consul
- Terraform - Use Infrastructure as Code to provision and manage any cloud, infrastructure, or service
- Packer - Create identical machine images for multiple platforms from a single source configuration.
- Sentinel - Sentinel is an embedded policy-as-code framework
- Waypoint - Waypoint is an open source solution that provides a modern workflow for build, deploy, and release across platforms
- Boundary - Simple and secure remote access to any system from anywhere based on user identity.
- Docker - Securely build, share and run any application, anywhere
- Localstack - A fully functional local AWS cloud stack
- Ansible - Ansible is a suite of software tools that enables infrastructure as code. It is open-source and the suite includes software provisioning, configuration management, and application deployment functionality.
- LDAP - Lightweight Directory Access Protocol
- Jenkins - Jenkins is an open source automation server. It helps automate the parts of software development related to building, testing, and deploying, facilitating continuous integration and continuous delivery.
- Oracle MySQL - MySQL is an open-source relational database management system (RDBMS)
- Microsoft MSSQL - Microsoft SQL Server is a relational database management system developed by Microsoft
- PostgreSQL - PostgreSQL, also known as Postgres, is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
- Minikube - Minikube implements a local Kubernetes cluster on macOS, Linux, and Windows.
- Newrelic Kubernetes Monitoring - Monitor Kubernetes Clusters and Workloads with Newrelic
- Docsify - A magical documentation site generator
- Ansible-Tower - Is a web-based solution that makes Ansible even more easy to use for IT teams of all kinds. It’s designed to be the hub for all of your automation tasks.
- Dbt - Dbt is a data transformation tool that enables data analysts and engineers to transform, test and document data in the cloud data warehouse
- Airflow - Apache Airflow is an open-source workflow management platform for data engineering pipelines
- Visual-Studio-Code - Visual Studio Code is a code editor redefined and optimized for building and debugging modern web and cloud applications
Once the stack is up you will have a large number of services running and available on localhost
For Documentation please open http://localhost:3333 in your browser
Other
- LDAP can be accessed on ldap://localhost:389
- Localstack web http://localhost:8080
- DBT web http://localhost:28080
- Apache Airflow http://localhost:18889
- Ansible provisioning Apache2 http://localhost:8888
- Ansible AWX Tower http://localhost:8043
- Jenkins http://localhost:8088
- Oracle MySQL localhost:3306
- Microsoft SQL localhost:1433
- Minikube http://localhost:10888
- Traefik http://localhost:8181
- Fabio http://localhost:9999
Vagrant Basic Usage
- vagrant up --provision OR vagrant up --provision-with bootstrap|nomad|consul|vault|docker|ldap
- vagrant global-status # to see which VMs are active
- vagrant global-status --prune # to remove stale VMs from Vagrant cache
- vagrant status # vagrant status
- vagrant reload
- vagrant up
- vagrant destroy
- vagrant provision
- vagrant plugin list
Docker Basic Usage
- docker image ls
- docker ps
- docker stop
Errors you might encounter
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
Error response from daemon: cannot stop container: 6c0c8135620ff47efe12df417a0df0e57d7a81a7f7ca06d011323fbb52e573db: tried to kill container, but did not receive an exit event
Command vagrant destroy
Solution run vagrant destroy again
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.
Command vagrant up --provision
Solution Ensure the following contents are present in /etc/vbox/networks.conf
* 10.0.0.0/8 192.168.0.0/16
* 2001::/64
To investigate
CI/CD
Gatling: (load testing) https://gatling.io/open-source
Spinnaker for multi-cloud / multi swim lane CD tool: https://www.spinnaker.io/concepts/
Build agent showing code clean and dirty.
Java
Python
JavaScript
Monitoring / Dash-boarding
Hygiea dashboard: https://github.com/Hygieia/Hygieia
Alerting will be handled by a local docker messaging server such as Gotify: https://github.com/gotify/server
Containerisation and API’s
Gloo: https://docs.solo.io/gloo/latest/introduction/
Support & Feedback
For suggestions, feedback and queries please branch or and submit a Pull Request or directly contact the architects of the HashiQube via email:
Lead Automation Architect [email protected] https://www.linkedin.com/in/riaannolan/
About
Hashiqube has been created to help Engineers, Developers and anyone who wants to practise, learn or demo Hashicorp products to get started quickly with a local lab.
About Hashiqube
Hashiqube runs all the Hashicorp products and a host of other popular Open Source software taht is heavily used in the industry.
Once you have done vagrant up --provision you will have access to Vault, Nomad, Consul, Boundary, Waypoint and this documnetation page on your local computer.
- Vault http://localhost:8200
vagrant up --provision-with basetools,vault - Nomad http://localhost:4646
vagrant up --provision-with basetools,docker,nomad - Consul http://localhost:8500
vagrant up --provision-with basetools,consul - Waypoint on Nomad https://localhost:9702
vagrant up --provision-with basetools,docker,waypoint - Waypoint on Minikube https://localhost:19702
vagrant up --provision-with basetools,docker,waypoint-kubernetes-minikube - Boundary http://localhost:19200
vagrant up --provision-with basetools,boundary - Docsify http://localhost:3333
vagrant up --provision-with basetools,docsify
In addition to the Core Hashicorp products, Hashiqube also runs a host of other popular Open Source integrations that are heavily used within the industry today.
About Me
My name is Riaan Nolan and I was born in South Africa. I started out as a Web Developer in 2000 and from there progressed into Systems Administration, with a strong focus on Automation, Infrastrtucture and Configuration as Code.
I have worked for Multi-National companies in Portugal, Germany, China, South Africa, United States and Australia.
You are welcome to connect with me on Linkedin https://www.linkedin.com/in/riaannolan/
Credly profile: https://www.credly.com/users/riaan-nolan.e657145c
Contributors and Special mentions
A Very special mention to HashiQube's contributors, Thank You All for your help, suggestions and contributions no matter how small <3
- Thomas Cockin
- Konstantin Vanyushov
- Tristan Morgan
- Ringo Chan
- Ehsan Mirzaei
- Greg Luxford
- Byron Tuckett
- Lane Birmingham
- Devang Dhameliya
- Rajesh Cholleti
Videos
Videos were made with asciinema https://asciinema.org/
- asciinema rec -i 1
- asciicast2gif -S 1 -s 2 tmpd1zpq13n-ascii.cast tmpd1zpq13n-ascii.gif
License
HashiQube is available as open-source under the terms of the MIT License.