Statistics
| Branch: | Tag: | Revision:

one / README.md @ a0f1701f

History | View | Annotate | Download (4.32 KB)

1

    
2
OpenNebula - The OpenSource Toolkit for Cloud Computing
3

    
4
## DESCRIPTION
5

    
6
OpenNebula is an open-source project aimed at building the industry standard
7
open source cloud computing tool to manage the complexity and heterogeneity of
8
distributed data center infrastructures.
9

    
10
Complete documentation can be found at
11

    
12
  http://opennebula.org/documentation:rel2.4
13

    
14
## INSTALLATION
15

    
16
### REQUISITES
17

    
18
This machine will act as the OpenNebula server and therefore needs to have
19
installed the following software:
20

    
21
* **ruby** >= 1.8.5
22
* **sqlite3** >= 3.5.2
23
* **xmlrpc-c** >= 1.06
24
* **openssl** >= 0.9
25
* **ssh**
26
* **sqlite3-ruby** gem
27

    
28
Additionally, to build OpenNebula from source you need:
29

    
30
* Development versions of the **sqlite3**, **xmlrpc-c** and **openssl**
31
  packages, if your distribution does not install them with the libraries.
32
* **scons** >= 0.97
33
* **g++** >= 4
34
* **flex** >= 2.5 (optional, only needed to rebuild the parsers)
35
* **bison** >= 2.3 (optional, only needed to rebuild the parsers)
36
* **libxml2-dev**
37

    
38

    
39
### OPTIONAL PACKAGES
40

    
41
These packages are not needed to run or build OpenNebula. They improve the
42
performance of the user-land libraries and tools of OpenNebula, nor the core
43
system. You will probably experiment a more responsive CLI.
44

    
45
First install rubygems and ruby development libraries
46

    
47
* **ruby-dev**
48
* **rubygems**
49
* **rake**
50
* **make**
51

    
52
Then install the following packages:
53

    
54
* **ruby xmlparser**, some distributions include a binary package for this
55
  (**libxml-parser-ruby1.8**). If it is not available in your distribution
56
  install expat libraries with its development files and install xmlparser
57
  using gem:
58
  
59
    $ sudo gem install xmlparser --no-ri --no-rdoc
60
    
61
  Note the extra parameters to gem install. Some versions of xmlparser have
62
  problems building the documentation and we can use it without documentation
63
  installed.
64
  
65
* **ruby nokogiri**, to install this gem you will need **libxml2** and
66
  **libxslt** libraries and their development versions. The we can install
67
  nokogiri library:
68
  
69
    $ sudo gem install nokogiri --no-ri --no-rdoc
70

    
71

    
72
### BUILDING
73

    
74
Compilation is done using **scons** command:
75

    
76
    $ scons [OPTION=VALUE]
77

    
78
The argument expression *[OPTIONAL]* is used to set non-default values for:
79

    
80
        OPTION      VALUE
81
        sqlite_db   path-to-sqlite-install
82
        sqlite      no if you don't want to build sqlite support
83
        mysql       yes if you want to build mysql support
84
        xmlrpc      path-to-xmlrpc-install
85
        parsers     yes if you want to rebuild flex/bison files
86
        
87

    
88
### INSTALLATION
89

    
90
* OpenNebula can be installed in two modes: system-wide, or in self-contained
91
  directory. In either case, you do not need to run OpenNebula as root. These
92
  options can be specified when running the install script:
93

    
94
    $ ./install.sh install_options
95
    
96
where **install_options** can be one or more of:
97
  
98
    OPTION  VALUE
99
    -u      user that will run OpenNebula, defaults to user executing
100
            install.sh
101
    -g      group of the user that will run OpenNebula, defaults to user
102
            executing install.sh
103
    -k      keep current configuration files, useful when upgrading
104
    -d      target installation directory. If defined, it will specified
105
            the path for the self-contained install. If not defined, the
106
            installation will be performed system wide
107
    -r      remove Opennebula, only useful if -d was not specified,
108
            otherwise rm -rf $ONE_LOCATION would do the job
109
    -h      prints installer help
110

    
111

    
112
## CONFIGURATION
113

    
114
Information on how to configure OpenNebula is located at http://opennebula.org/documentation:rel2.4
115

    
116

    
117
## CONTACT
118

    
119
OpenNebula web page: http://opennebula.org
120

    
121
Development and issue tracking: http://dev.opennebula.org
122

    
123
Support mailing list: http://opennebula.org/support:support
124

    
125

    
126
## LICENSE
127

    
128
Copyright 2002-2011, OpenNebula Project Leads (OpenNebula.org)
129

    
130
Licensed under the Apache License, Version 2.0 (the "License"); you may
131
not use this file except in compliance with the License. You may obtain
132
a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
133

    
134
Unless required by applicable law or agreed to in writing, software
135
distributed under the License is distributed on an "AS IS" BASIS,
136
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
137
See the License for the specific language governing permissions and
138
limitations under the License.
139

    
140