Setup for Cross-Cloud and On-premises Kubernetes (OpenShift, Rancher, etc.)

For this kind of deployment, Krossboard is provided either as a ready-to-deploy OVF/VMDK virtual machine appliance, or a setup package for Ubuntu Server 18.04 LTS.

Regardless of the selected deployment approach, the installation steps described hereafter shall be achieved in a couple of minutes.

Before you begin

The following key points shall be considered according to the selected deployment approach:

  • For the OVF/VMDK distribution, a virtual machine manager or a cloud platform supporting this format is required. This format is supported by VirtualBox, VMware Workstation/Player/vSphere, AWS, GCP, and most of modern clouds and virtual machine management systems.
  • For the setup package, a machine running Ubuntu Server 18.04 LTS (with sudo access) is required to perform the installation. The deployment script may have to install missing dependencies (e.g. Docker), hence the machine should have access to official/mirrored Ubuntu repositories.

Hardware requirements: Krossboard itself has a very low resources footprint, the hardware resources allocated to the instance do mainly depend on the number of Kubernetes clusters and namespaces it’ll manage. For example, assuming an environment with 10 clusters we can start with 2 vCPUs and 512 MB of memory and then refine them later according to the actual resource utilization observed on the machine.

Deploy Krossboard using the OVF image

Deploy an instance of Krossboard using the following steps, then jump to the configuration section to set up the integration with your Kubernetes clusters.

Deploy Krossboard using the setup package

Deploy an instance of Krossboard using the following steps, then move to the configuration section to set up the integration with your Kubernetes clusters.

  • Go to the release page and download the latest stable setup package.

  • Copy the archive to the target installation machine.

  • Uncompress the archive and review the NOTICE and the EULA files to learn Krossboard terms of use.

    tar zxf krossboard-<VERSION>.tgz
    cd krossboard-<VERSION>
    
  • Use this command to launch the installation.

    sudo ./install.sh
    
  • Once the installation completed, reboot the machine to start the services.

Configuring the Integration with Kubernetes clusters

  • Create (or copy via SSH) the KUBECONFIG file of your Kubernetes clusters on the Krossboard machine. In the next steps we consider that it’s located at /opt/krossboard/etc/kubeconfig.

  • Make sure that the KUBECONFIG file is owned by the krossboard user (a read access for the krossboard user is also sufficient).

    sudo chown krossboard:krossboard /opt/krossboard/etc/kubeconfig
    
  • Edit the Krossboard configuration file as follows.

    sudo vi /opt/krossboard/etc/krossboard.env
    
    # Uncomment this line and set the KUBECONFIG variable appropriately.
    KUBECONFIG=/opt/krossboard/etc/kubeconfig
    
  • The configuration shall be taken into account within the next 10 minutes. However, you can force the refresh using this command.

    sudo systemctl restart  krossboard-data-processor-collector
    

Install Kubernetes Metrics Server

Krossboard relies on Kubernetes Metrics Server to retrieve certain metrics from Kubernetes. If it’s not yet the case, the Kubernetes Metrics Server can be installed as follows on each cluster.

kubectl apply -f https://github.com/kubernetes-sigs/metrics-server/releases/latest/download/components.yaml

Get access to Krossboard UI

Open a browser tab and point it to the Krossboard URL (i.e. http:///, changing <machine-addr> with the address of the instance).

Note: It may take a few seconds before the instance finishes its initialization, during this time you may experience a loading error in the browser.

The default username and password to sign in are:

  • Username: krossboard
  • Password (default): Kr0sSB8qrdAdm

It’s highly recommended to change this default password as soon as possible.

sudo /opt/krossboard/bin/krossboard-change-passwd

Other Resources