Setting up an OpenvCloud cluster is done in following steps:

Meet the prerequisites

  • Currently supported G8 size:

    • 3 dedicated controller nodes

    • 8 dedicated CPU nodes

    • 4 dedicated storage nodes

  • Each node needs to be able to access each other node in the cluster

  • Certificates for SSL verification have to be included in YAML config in certificates section. Each certificate object should include fields key and crt containing a private key and a certificate correspondingly. The certificates for different cases should be referenced by name in ssl section

Create the configuration file

Installing an OpenvCloud cluster is done based on a single system-config.yaml configuration file.

This configuration files describes:

  • Switch configuration

  • Operating system installations

  • Kubernetes cluster running on the controllers, which hosts the OpenvCloud master and and all other controller components

  • CPU and storage nodes installation

  • ...

The system-config.yaml file needs to be stored and maintained on

An example of a system-config.yaml can be found here.

Important A common technique to create a system-config.yaml is to make a copy from another environment and start editing. Please make sure to alter the ssh.private-key setting, and not just leave the copy from the other environment.

Validate the configuration file

Having valid configuration is of course very important. Validating is done with the OpenvCloud environment manager, a.k.a. Meneja (Swahili for 'manager'), available on

In Meneja you can select the environment you are setting up and click the Validate configuration button. When your configuration is valid you'll see the following text appear next to the button: "The configuration is valid!"

Install the operation system on the controller nodes

On Meneja a USB stick can be downloaded that already has the custom configuration for a specific environment. As shown on the screenshot below, there is a link called "Download usb installer image" which results in a bootable ISO file, which can be used to boot from (via the IPMI or via burning it onto a USB stick):


After booting up the controller node with the boot image, the user gets a screen with the following options:

meneja boot menu

The rest is extremely simple. Just select the right option depending on the controller node that needs to be installed and the rest is completely automatic.

Once you see the following screen, the installation of the controller node has finished. Just unplug the installer image and reboot the machine.

boot menu

Repeat this procedure for all three controllers.

Automatic Installation

By running the following command you will have your cluster fully installed and deployed

bash / -p <PASSWORD> [- u <MANIFESTURL> | -v <VERSION>]
password is the password you enterned on meneja to download the image


bash / -s rooter123 -v 2.5.0

Deploy virtual machine images

To add images see

Manual Installation

Access the management container

The management container is used to perform various admin operations on the environment. It is based on the management image and has the kubectl tool installed that is needed to perform various Kubernetes related operations. The management container also contains the environment system configuration which is necessary to use the installer tool inside the pod. The installer tool uses the system config by default and it doesn't need to be specified by the user.

For more details about the ìnstaller script see Installer Script Details.

Accessing the management container can be done using 0-access.

From a web browser open the OpenvCloud portal and go to the 0-access page at https://{env name}


Choose management from the list. You will be directed to a page that will allow you to request access to the pod which will redirect you to a page with instructions about how to access the management container and the remaining time for this session.

Installing the operating system on the nodes

You need to be in management container to perform this operation.

To prepare the CPU and storage nodes with the necessary OS, first start a tmux session and then run the following command:

installer node action --name all install_os

If a node fails during the installation, use the following command to install the node again:

installer node action --name {node name} install_os

Setup the storage nodes

From the management container execute:

export ENV_NAME="be-g8-3"
# let's generate the config
python3 /opt/code/
cd /opt/code/github/openvstorage/dev_ops/Ansible/openvstorage/playbooks/
ansible-playbook -i inventories/$ENV_NAME/inventory preInstall.yml
# this last step is not very bullet proof and might need to be repeated
ansible-playbook -i inventories/$ENV_NAME/inventory full_setup.yml

Install JumpScale services on the OpenvCloud cluster nodes

You need to be in management container to perform this operation.

First start a tmux session. The following command will install the JumpScale services on all OpenvCloud cluster nodes (CPU and storage):

installer node jsaction --name all install

If a node fails during the installation, use the following command to install the node again:

installer node jsaction --name {node name} install

For more details about the ìnstaller tool see Installer Script Details.

When done, the environment should be ready to use.