1. Installation

1.1. Prerequisites

Before you install make sure that you have at minimum python 3.7.2 installed. We recommend that you use a python virtualenv such as venv or pyenv to isolate the python installed packages as not to interfere with the system installation.

1.1.1. Installation via pip development

The installation via pip is not yet supported for cloudmesh cm. Thus we recommend that you use the source installation instead.

In future cloudmesh version 4 will be installed with

$ pip install cloudmesh-cms
$ pip install cloudmesh-cloud
$ pip install cloudmesh-storage

Additional packages will include

$ pip install cloudmesh-flow
$ pip install cloudmesh-emr
$ pip install cloudmesh-batch
$ pip install cloudmesh-openapi

For the time being we recommend you conduct the source install.

1.1.2. Source installation for development

The best way to install cloudmesh from source is to use our installer:

More documentation about it can be found at

You install it with

$ pip install cloudmesh-installer

It is best to create an emty directory and decide which bundles to install

$ mkdir cm
$ cd cm
$ cloudmesh-installer bundels

Decide which bundels you like to install (let us assume you use storage) and simply say

$ cloudmesh-installer git clone storage
$ cloudmesh-installer install storage -e

It will take a while to install On newer machines 1 minte, on older significant longer.

YOu can than test if

$ cms help

works. Make susre to stay up to date while issuing the pull command on your bundle

$ cloudmesh-installer git pull bundle
$ cloudmesh-installer install storage -e

1.2. Installation of mongod

First, you will need to install a cloudmesh4.yaml file, if you have not done this before. The easieast way to do so is with the command

$ cms help

Now you will need to edit the file

~/.cloudmesh/cloudmesh4.yaml

and change the password of the mongo entry to something you like, e.g. change the TBD to a real strong password

MONGO_PASSWORD: TBD

In case you do not have mongod installed, you can do so for macOS and Ubuntu 18.xx by setting the following variable:

MONGO_AUTOINSTALL: True

Now you can run the admin mongo install command. It will not only install mongo, but also add the path to your .bash_* file. In case of windows platform, you will have to set the PATH variable manually. To install it simply say.

$ cms admin mongo install

To create a password protection you than run the command

bash $ cms admin mongo create In case of Windows platform, after executing above command, open a new cms session and execute below commands.

$ cms admin mongo start

Once the mongo db is created it can be started and stoped with

$ cms admin mongo start
$ cms admin mongo stop

For cloudmesh to work properly, please start mongo.

1.3. Anaconda and Conda

We also have the base packages available as conda packages on conda hub in the chanel laszewski. This includes

  • cloudmesh-common
  • cloudmesh-cmd5
  • cloudmesh-sys

Note that the packages will always be a little bit behind the packages on pypi and especially the source distribution. If you are interested in helping out with the conda packages, let us know.