blob: 6ae3163d2ce8b489209ff96e0db7136fe074d412 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
spandx Omnibus project
======================
This project creates full-stack platform-specific packages for
`spandx`!
Installation
------------
You must have a sane Ruby 2.0.0+ environment with Bundler installed. Ensure all
the required gems are installed:
```shell
$ bundle install --binstubs
```
Usage
-----
### Build
You create a platform-specific package using the `build project` command:
```shell
$ bin/omnibus build spandx
```
The platform/architecture type of the package created will match the platform
where the `build project` command is invoked. For example, running this command
on a MacBook Pro will generate a Mac OS X package. After the build completes
packages will be available in the `pkg/` folder.
### Clean
You can clean up all temporary files generated during the build process with
the `clean` command:
```shell
$ bin/omnibus clean spandx
```
Adding the `--purge` purge option removes __ALL__ files generated during the
build including the project install directory (`/opt/spandx`) and
the package cache directory (`/var/cache/omnibus/pkg`):
```shell
$ bin/omnibus clean spandx --purge
```
### Publish
Omnibus has a built-in mechanism for releasing to a variety of "backends", such
as Amazon S3. You must set the proper credentials in your
[`omnibus.rb`](omnibus.rb) config file or specify them via the command line.
```shell
$ bin/omnibus publish path/to/*.deb --backend s3
```
### Help
Full help for the Omnibus command line interface can be accessed with the
`help` command:
```shell
$ bin/omnibus help
```
Version Manifest
----------------
Git-based software definitions may specify branches as their
default_version. In this case, the exact git revision to use will be
determined at build-time unless a project override (see below) or
external version manifest is used. To generate a version manifest use
the `omnibus manifest` command:
```
omnibus manifest PROJECT -l warn
```
This will output a JSON-formatted manifest containing the resolved
version of every software definition.
Kitchen-based Build Environment
-------------------------------
Every Omnibus project ships with a project-specific
[Berksfile](https://docs.chef.io/berkshelf.html) that will allow you to build
your omnibus projects on all of the platforms listed in the
[`.kitchen.yml`](.kitchen.yml). You can add/remove additional platforms as
needed by changing the list found in the [`.kitchen.yml`](.kitchen.yml)
`platforms` YAML stanza.
This build environment is designed to get you up-and-running quickly. However,
there is nothing that restricts you from building on other platforms. Simply use
the [omnibus cookbook](https://github.com/chef-cookbooks/omnibus) to setup your
desired platform and execute the build steps listed above.
The default build environment requires Test Kitchen and VirtualBox for local
development. Test Kitchen also exposes the ability to provision instances using
various cloud providers like AWS, DigitalOcean, or OpenStack. For more
information, please see the [Test Kitchen documentation](https://kitchen.ci/).
Once you have tweaked your [`.kitchen.yml`](.kitchen.yml) (or
[`.kitchen.local.yml`](.kitchen.local.yml)) to your liking, you can bring up an
individual build environment using the `kitchen` command.
```shell
$ bin/kitchen converge ubuntu-1804
```
Then login to the instance and build the project as described in the Usage
section:
```shell
$ bin/kitchen login ubuntu-1804
[vagrant@ubuntu...] $ . load-omnibus-toolchain.sh
[vagrant@ubuntu...] $ [ -e .bundle ] && sudo chown -R vagrant:vagrant .bundle
[vagrant@ubuntu...] $ cd spandx # or 'cd spandx/omnibus' if your omnibus project is embedded in your main project
[vagrant@ubuntu...] $ bundle install
[vagrant@ubuntu...] $ bin/omnibus build spandx
```
For a complete list of all commands and platforms, run `kitchen list` or
`kitchen help`.
|
