Skip to content

Latest commit

 

History

History
118 lines (84 loc) · 4.68 KB

installation-cli.md

File metadata and controls

118 lines (84 loc) · 4.68 KB
layout title category publish abstract pageord windows_link linux32_link linux64_link venv_link simple_install_link
bt_wiki
Installing the Cloudify CLI
Installation
true
Installation instructions for Cloudify CLI under multiple platforms
200
installation-simple-provider.html

{%summary%}{{page.abstract}}{%endsummary%}

Cloudify CLI (AKA cfy) is being distributed in two different methods:

  1. As a binary package
  2. As a Python package (via PyPi)

{% tip title=Which distribution method should you choose? %} The binary package is currently bundled with only the OpenStack and simple providers. Providers are essintially modules that allow you to bootstrap a Cloudify manager on a specific cloud environment (e.g. OpenStack or CloudStack). If you wish to use other providers, you should install the CLI via PyPi and then install the provider of your choice (which is also a Python module) in the same Python environment.{% endtip %}

Installing the binary package

Windows

  1. Download the [Setup file]({{ page.windows_link }})
  2. Run the setup file by double clicking on it.
  3. Click 'Next'
  4. Choose the path you would like the CLI to be installed at and click 'Next'. Default path is C:\Program Files (x86)\cfy
  5. To use the CLI you need the folder to be in your PATH environment variable. If you leave the checkbox checked, the installer will modify the PATH environment variable for you. Click 'Next' again.
  6. Click 'Install' to proceed with file extraction.
  7. After a few seconds, installation should be finished, and you can click 'Finish'.
  8. Open a new Command Prompt and check if you can run cfy -h. You should get an output describing how to use cfy.

Ubuntu

  1. Download a deb package that matches your system: [32bit]({{ page.linux32_link }}) or [64bit]({{ page.linux64_link }})
  2. Open a Terminal at the directory where you downloaded the file and run sudo dpkg -i <pkg.deb> replacing <pkg.deb> with the name of file you downloaded.
  3. After a few seconds installation should finish.
  4. Try running cfy -h command in your Terminal. You should get an output describing how to use cfy.

OS X

Coming soon, please follow the Python package installation below (Installing from PyPi).

Installing from PyPi

Installation via PyPi is intended mostly for development purposes. We'll assume you have Python 2.7.x and PIP installed and configured on your system.

To install run the following command:

{% highlight bash %} pip install cloudify {% endhighlight %}

After you've installed the CLI module iteself, you should install the providers you want to work with. Here's how you install the OpenStack provider for example:

{% highlight bash %} pip install cloudify-openstack {% endhighlight %}

{%note title=Note%} It's recommended to create a [virtualenv]({{ page.venv_link }}) and install the CLI in it. To do so type the following commands (replace virtual-env-name with the name of your choice, e.g. cloudify:

{% highlight bash %} virtualenv virtual-env-name cd virtual-env-name source bin/activate {% endhighlight %}

{%endnote%}

Prerequisites for Compilation

Cloudify CLI has dependencies that require compilation on your machine:

Windows

For Windows it's suggested to use Unofficial Windows Binaries for Python and install the following packages:

  1. PyCrypto
  2. PyYaml

Linux

Under Ubuntu, you'll need to install the python-dev package.

OS X

You will need Apple's developers tools that are installed with Xcode.

{% note title=Note for Mac users %} One of the libraries that's installed with the OpenStack provider (pycrypto) may fail to compile on certain variations of OS X. This seems to be a known issue. To solve it, type the following command in your terminal windows and try the installation again:

{% highlight bash %} export CFLAGS=-Qunused-arguments export CPPFLAGS=-Qunused-arguments {% endhighlight %}

{% endnote %}

What's Next

  • Now that you know the requirements and have the CLI installed, you can bootstrap your own manager on an existing VM.
  • For Cloud specific installation see the bootstrap manuals for each cloud provider under the Installation section.