Maestro API

Your interaction with EPAM Orchestrator - Stage Setup in particular - results in a set of parameters to host applications and configure net access. These are called hosting and network plans respectively and stored as xml files. The API Reference Guide that you can find in the Documentation section contains sample xml network and hosting plans illustrating creation of basic resources, configuration of Cloud services, addition of instances and other operations performed by Orchestrator, reflected in xml.

EPAM Orchestrator Ruby Gem

Our developers created a tool that allows the users manipulate EPAM Orchestrator using the Ruby tools. The supported gem provides basic functionality to the EPAM Cloud.

This gem is a private one so it is not available in public rubygems repositories. Still, you can use bundler to work with git repository.

Below, you can see step-by steps instructions on the Cloud Ruby Gem installation:

  • Linux-way

1. Create Gemfile with next contents:

source 'https://rubygems.org' gem 'epam-or2', :git => 'https://git.epam.com/yauhen_artsiukhou/fog-or2.git', :tag => 'v0.3.1'

2. In same directory, execute bundle install

3. Test it preliminary, by running a Ruby code sample as:

require 'OR2'

This should return 0.

  • Windows-way

1. Create Gemfile with next contents:

source 'https://rubygems.org' gem 'epam-or2', :git => 'https://git.epam.com/yauhen_artsiukhou/fog-or2.git', :tag => 'v0.3.1'

2. In same directory, execute bundle install

3. Locate folder with gems, installed by Bundler (it may be located inside of Ruby gem's folder, for example: RUBY_PATH\gems\RUBY_VER\bundler\gems. Due to this, we have to include this dir in Ruby $LOAD_PATH variable, because it is not there by default.

4. To fix p.3 - we can either run Ruby with option -I

ruby -I RUBY_PATH\gems\RUBY_VER\bundler\gems\fog-or2\lib

OR

set RUBYLIB= RUBY_PATH\gems\RUBY_VER\bundler\gems\fog-or2\lib

5. Test it preliminary, by running Ruby code simple as:

require 'OR2'

This should return 0.

Documentation

Below is a list of documents related to this section. You can find the full list of our documents in the Documentation Storage.

Please select a required document:

EPAM Cloud Orchestrator - Maestro API Reference Guide

The Maestro API Reference Guide contains detailed information on EPAM Cloud Orchestrator Application Programming Interface, guidelines on its utilization, usage examples and errors description.