Installing Cloudbreak on Your Own VM

This is an advanced deployment option. Select this option if you have custom VM requirements. Otherwise, you should use one of the pre-built images and follow these instructions:

System Requirements

To launch the Cloudbreak deployer and install the Cloudbreak application, your system must meet the following requirements:

You can install Cloudbreak on Mac OS X for evaluation purposes only. Mac OS X is not supported for a production deployment of Cloudbreak.


To launch the Cloudbreak deployer and install the Cloudbreak application, you must first meet the following prerequisites:


Ports 22 (SSH), 80 (HTTPS), and 443 (HTTPS) must be open.

Root Access

Every command must be executed as root. In order to get root privileges execute:

sudo -i

System Updates

Ensure that your system is up-to-date by executing:

yum -y update

Reboot it if necessary.


Install iptables-services:

yum -y install iptables-services net-tools

Without iptables-services installed the iptables save command will not be available.

Next, configure permissive iptables on your machine:

iptables --flush INPUT && \
iptables --flush FORWARD && \
service iptables save


Additionally, review the following prerequisites:

Install Cloudbreak on Your Own VM

Install Cloudbreak using the following steps.


  1. Install the Cloudbreak deployer and unzip the platform-specific single binary to your PATH. For example:

    yum -y install unzip tar
    curl -Ls$(uname)_x86_64.tgz | sudo tar -xz -C /bin cbd
    cbd --version

    Once the Cloudbreak deployer is installed, you can set up the Cloudbreak application.

  2. Create a Cloudbreak deployment directory and navigate to it:

    mkdir cloudbreak-deployment
    cd cloudbreak-deployment

  3. In the directory, create a file called Profile with the following content:


    For example:

    export UAA_DEFAULT_SECRET=MySecret123
    export UAA_DEFAULT_USER_PW=MySecurePassword123

    You will need to provide the email and password when logging in to the Cloudbreak web UI and when using the Cloudbreak CLI. The secret will be used by Cloudbreak for authentication.

  4. Generate configurations by executing:

    rm *.yml
    cbd generate

    The cbd start command includes the cbd generate command which applies the following steps:

    • Creates the docker-compose.yml file, which describes the configuration of all the Docker containers required for the Cloudbreak deployment.
    • Creates the uaa.yml file, which holds the configuration of the identity server used to authenticate users with Cloudbreak.
  5. Start the Cloudbreak application by using the following commands:

    cbd pull
    cbd start

    This will start the Docker containers and initialize the application. The first time you start the Coudbreak app, the process will take longer than usual due to the download of all the necessary docker images.

  6. Next, check Cloudbreak application logs:

    cbd logs cloudbreak

    You should see a message like this in the log: Started CloudbreakApplication in 36.823 seconds. Cloudbreak normally takes less than a minute to start.

Next Steps After Installing on Your Own VM

Log in to the Cloudbreak web UI and create a credential for Cloubdreak using the following platform-specific instructions: