README.md 1.52 KB
Newer Older
Stephen Delano's avatar
Stephen Delano committed
1
## Installation
Stephen Delano's avatar
Stephen Delano committed
2
3
4

Nothing to install here (yet). Move along.

Stephen Delano's avatar
Stephen Delano committed
5
## DSL
Stephen Delano's avatar
Stephen Delano committed
6

Stephen Delano's avatar
Stephen Delano committed
7
### Software DSL
Stephen Delano's avatar
Stephen Delano committed
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

Each piece of sofware built by Omnibus is defined with a DSL in the `config/software` subdirectory of the project. The following is a quick desctiption of that DSL.

`name`: The name of the software.

`dependencies`: An ::Array of ::Strings referring to the `name`s of softwares that need to be present before building this piece.

`source`: A ::Hash describing where the source of the software is to be downloaded from. Hash keys are the following:

* URL Downloads
** `:url` The url of the source tarball.
** `:md5' The md5sum of the source tarball.
* Git Downloads
** `:git` The location of the git repository from which to fetch the source code.

`build`: The instructions for building the software.

`command`: A command to execute. This encompasses a single build step.

27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
### Project DSL

## License

See the LICENSE and NOTICE files for more information.

Copyright: Copyright (c) 2012 Opscode, Inc.
License: Apache License, Version 2.0

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

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