Kublr-in-a-Box (Obsolete)

This document is outdated.

Please see Kublr-in-a-Box for new installation guide.

Installation Guide

Kublr-in-a-Box is a simple and convenient demo version of Kublr, running in Vagrant, that allows you set-up Kubernetes clusters. You can also use Kublr-in-a-Box to install a non-production licensed version of the full Kublr Platform.

By using and downloading Kublr and Kublr-in-a-Box, you agree to the following Terms of Use and Privacy Policy

Prerequisites for Kublr-in-a-Box Installation

  1. Real (not virtualized) 64-bit hardware workstation or server, supporting virtualization, examples: Mac Book Pro laptop, Dell computer, etc…
  2. Memory: minimum 8Gb RAM, recommended: 16Gb RAM (you may need to close other applications)
  3. CPU: At least 2 cores
  4. Disk: At least 20Gb
  5. OS: Mac OS: High Sierra or Microsoft Windows 10
  6. 100Mb/s stable Internet connection
  7. Local administrator privileges

Step-by-Step Instructions

  1. Download the latest version of Kublr-in-a-Box from our website: https://kublr.com/demo/.
  2. Unpack the kublr-in-a-box.zip file (Safari unpacks zip files by default).
  3. Install the latest version (5.2 or higher) of VirtualBox: https://www.virtualbox.org/wiki/Downloads.
  4. Install the latest version (2.1 or higher) of Vagrant: https://www.vagrantup.com/downloads.html.
  5. Open terminal with the current directory pointing to the unpacked Vagrantfile from kublr-in-a-box.zip file and launch the following command: vagrant up.
  6. The virtual machine should start up and ask for an External IP:

    ==> default: Running provisioner: shell...
    Virtual machine needs know you external IP for the machine in order to do proper installation of baremetal clusters.
    External IP:
    
  7. Please provide the IP address of your local machine in your local network, so your on-premise nodes are able to connect to this IP address while deploying a cluster.

  8. Wait while the Kublr-in-a-Box virtual machine starts up. It should end with the following output:

    ...
    default: Kubectl config file is available in current directory.
    default:
    default: The following links are available:
    default: Kublr HTTPS:   https://localhost:9443/ admin / kublrbox
    default: Kublr HTTP:    http://localhost:9080/  admin / kublrbox
    default: Keycloak HTTPS:    https://localhost:9443/auth/admin/kublr-ui/console  admin / kublrbox
    default: Keycloak HTTP: http://localhost:9080/auth/admin/kublr-ui/console   admin / kublrbox
    default: K8s:   https://localhost:7443/api/v1/namespaces/kube-system/services/kubernetes-dashboard/proxy/#!/pod?namespace=kublr
    

Open your favorite browser and navigate to http://localhost:9080/ Use following credentials to access Kublr-in-a-Box UI:

  • Username: admin
  • Password: kublrbox

Now you are good to go with Kublr-in-a-Box.

Cleanup Instructions

If you no longer need Kublr-in-a-Box, you can clean up resources:

Open terminal with the current directory pointing to the downloaded Vagrantfile file and launch the following commands:

vagrant destroy -f || rm -rf Vagrantfile
==> default: Forcing shutdown of VM...
==> default: Destroying VM and associated drives...

To remove installed Kublr Vagrant boxes:

Print the list of all installed Kublr boxes:

vagrant box list | grep kublr
kublr-321          (virtualbox, 0)
kublr-322          (virtualbox, 0)

Run the removal command for each box you want to remove:

vagrant box remove kublr-321
Removing box 'kublr-321' (v0) with provider 'virtualbox'...
vagrant box remove kublr-322
Removing box 'kublr-322' (v0) with provider 'virtualbox'...

Troubleshooting

VirtualBox Installation Failure on Mac

If you receive a “The installation failed” error message while installing the VirtualBox, follow these instructions:

VirtualBox Installation Error

  1. Open System Preferences -> Security & Privacy -> General
  2. Click on Allow button
  3. Try re-installing VirtualBox

    Mac OS Security Settings

Virtual Machine crashes during startup

Symptoms

If your virtual machine crashes with the message like this:

Stderr: VBoxManage.exe: error: The virtual machine 'kublr' has terminated unexpectedly during startup with exit code 1 (0x1).  More details may be available in 'C:\Users\xxx\VirtualBox VMs\kublr\Logs\VBoxHardening.log'
VBoxManage.exe: error: Details: code E_FAIL (0x80004005), component MachineWrap, interface IMachine

Double check that you are using Virtualbox 5.2 or later. VirtualBox 5.1 is not supported. If problem still persists on VirtualBox 5.2, please contact a Kublr representative.

Errors Starting Virtual Machine Using “vagrant up”

Symptoms

If Vagrant is already installed, you may experience following errors:

Ignoring ffi-1.9.14 because its extensions are not built.  Try: gem pristine ffi --version 1.9.14
Ignoring nokogiri-1.6.7.1 because its extensions are not built.  Try: gem pristine nokogiri --version 1.6.7.1
Ignoring unf_ext-0.0.7.2 because its extensions are not built.  Try: gem pristine unf_ext --version 0.0.7.2
Ignoring ffi-1.9.14 because its extensions are not built.  Try: gem pristine ffi --version 1.9.14
Ignoring nokogiri-1.6.7.1 because its extensions are not built.  Try: gem pristine nokogiri --version 1.6.7.1
Ignoring unf_ext-0.0.7.2 because its extensions are not built.  Try: gem pristine unf_ext --version 0.0.7.2
Installing the 'vagrant-disksize' plugin. This can take a few minutes...
Bundler, the underlying system Vagrant uses to install plugins,
reported an error. The error is shown below. These errors are usually
caused by misconfigured plugin installations or transient network
issues. The error from Bundler is:

conflicting dependencies ffi (= 1.9.18) and ffi (= 1.9.14)
  Activated ffi-1.9.14
  which does not match conflicting dependency (= 1.9.18)

  Conflicting dependency chains:
    ffi (= 1.9.14), 1.9.14 activated

  versus:
    ffi (= 1.9.18)

  Gems matching ffi (= 1.9.18):
    ffi-1.9.18

How to Fix

  1. Uninstall the current Vagrant version
  2. Install the new version as recommended in README.txt of kublr-in-a-box.zip

Symptoms

On Windows with the latest version of Vagrant (2.1.2) you may see the error as:

C:/HashiCorp/Vagrant/embedded/gems/2.1.2/gems/vagrant-2.1.2/bin/vagrant:47:in `[]=': Invalid argument - ruby_setenv(VAGRANT_NO_PLUGINS)(E
         from C:/HashiCorp/Vagrant/embedded/gems/2.1.2/gems/vagrant-2.1.2/bin/vagrant:47:in `block in <main>'
         from C:/HashiCorp/Vagrant/embedded/gems/2.1.2/gems/vagrant-2.1.2/bin/vagrant:36:in `each_index'
         from C:/HashiCorp/Vagrant/embedded/gems/2.1.2/gems/vagrant-2.1.2/bin/vagrant:36:in `<main>'

How to Fix

Open Vagrantfile and find the line: required_plugins = (plagin-name) There are list of plugins that you need to install

To fix the issue, run the command not in directory with Vagrantfile (up to the level above):

vagrant plugin install plagin-name

My Browser Refreshes the Page Every 3-5 Seconds

Some non-standard browser extensions or plugins (not installed by default) aren’t compatible with the Kublr Control Plane. In this case, please use the browser in incognito mode (plugins are automatically disabled) or temporary disable the plugins.

“vagrant up” Command Hangs on Microsoft Windows 7

More details can be found at: https://github.com/hashicorp/vagrant/issues/8783.

Please upgrade Microsoft PowerShell to version 5.0. https://www.microsoft.com/en-us/download/details.aspx?id=50395

“vagrant up” fails on Windows 10 with CylancePROTECT

Please contact your IT department to resolve the issue.

Related Documentation

  1. Vagrant documentation - https://www.vagrantup.com/docs/
  2. VirtualBox documentation - https://www.virtualbox.org/wiki/Documentation

For questions or troubleshooting please contact contact us

We welcome your feedback. After all, Kublr was created to simplify your Kubernetes experience.


Questions? Suggestions? Need help? Contact us.