vFLOWER lagt til
[virt-orchestrator.git] / vFLOWER / README.md
1 vFLOWer Toolkit
2 ============================
3 *Created by ByteLife Solutions*
4
5
6 <h4>1. OVERVIEW</h4>
7
8 vFLOWer Toolkit enables exchanging VMware vCenter Orchestrator content (workflows, actions, etc) as a versionable 
9 source code in XML format. Along with its pre-requisite components vFLOWer allows vCO administrators and/or developers 
10 to perform the following actions:
11
12 * Retrieve vCO content source code in XML format from remote version control repositories and 
13 build a binary vCO package to be imported into vCO.
14 * Publish vCO content source code in XML format to remote version control repositories by 
15 unpacking/converting exported binary vCO packages. 
16
17 **NOTE**
18 Current version of this integration tool handles only vCO packages. For publishing, vCO packages 
19 must be created first including all needed content.
20
21
22 <h4>2. PRE-REQUISITES</h4>
23
24 To work properly vFLOWer Toolkit needs multiple additional publicly available software components:
25
26 * Apache Ant. Tested with version 1.9.3. http://ant.apache.org/bindownload.cgi. 
27 * Oracle Java SE Development Kit. Tested with JDK 1.7.0.45 for Windows.
28 http://www.oracle.com/technetwork/java/javase/downloads/index.html. 
29 * OpenSSL. Needed for vCO packages retrieval only. Tested with OpenSSL 1.0.1e for Windows. http://www.openssl.org.
30 * Git command-line client. Tested with Git 1.8.5.2 for Windows. http://git-scm.com/downloads.
31 * VMware vCenter Orchestrator client.
32 * VMware vCenter Orchestrator. Tested with versions 5.1 and 5.5.
33
34 **NOTES**
35 * This product includes software developed by the Ant-Contrib project
36 (http://sourceforge.net/projects/ant-contrib).
37 * When using Windows as a client platform, Git client must be set up with UNIX-style file formats.
38 vCO is expecting that. 
39 * On a client machine ANT_HOME and JAVA_HOME environment variables must be set. In addition, 
40 PATH environment variable must be updated to include ANT, Java, Git client and OpenSSL binary directories. 
41
42
43 <h4>3. PUBLISHING vCO CONTENT TO THE GitHub</h4>
44
45 Multiple manual steps must be performed in order to publish vCO content to GitHub repository. 
46 All steps can be performed from a client machine having all needed pre-requisite components installed. 
47
48 * User account created in GitHub (if not existing). 
49 * New repository created in GitHub for publishable content.  
50 * New GitHub repository cloned to the client machine (git clone). 
51 * A vCO package created using vCO client to include all needed content. 
52 * The package exported to the client machine into specified input/output directory (part of repository 
53 folder structure) using vCO client. 
54 * ByteLife’s ANT precommit script launched from the repository root directory to unpack/convert 
55 the vCO package into XML-based source code. 
56 * New content commited and pushed to the remote GitHub repository (git commit, git push). 
57
58
59 <h4>4. RETRIEVING vCO CONTENT FROM THE GitHub</h4>
60
61 Multiple manual steps must be performed in order to retrieve vCO content from public GitHub repository. 
62 All steps can be performed from a client machine having all needed pre-requisite components installed. 
63
64 * vCO content source code downloaded from a public GitHub repository. Content can be downloaded 
65 by cloning remote repository (git clone) to the client machine which includes all needed ANT scripts 
66 and folder structure.
67 * ByteLife’s ANT build script launched from the repository root directory to build a vCO package from 
68 downloaded XML-based source code.
69 * The package imported from specified input/output directory to the vCO using vCO client.
70
71
72 ==============================================
73 For more information review **vFLOWer_User_Guide.pdf**
74
75 For pre-requisites installation hints review **vFLOWer_Prereq_Install_Guide.pdf**
76
77 See also http://www.bytelife.com/vFLOWer
78