This project creates full-stack platform-specific packages for
chef-server
!
All files in the repository are licensed under the Apache 2.0 license. If any file is missing the License header it should assume the following is attached;
Copyright 2014 Chef Software Inc
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.
You must have a sane Ruby 1.9+ environment with Bundler installed. Ensure all the required gems are installed:
$ bundle install --binstubs
You'll need to create an omnibus.rb file based on the omnibus.rb.example.rb. Please grab credentials from teampass.
You create a platform-specific package using the build project
command:
$ bin/omnibus build chef-server
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.
You can clean up all temporary files generated during the build process with
the clean
command:
$ bin/omnibus clean chef-server
Adding the --purge
purge option removes ALL files generated during the
build including the project install directory (/opt/opscode
) and
the package cache directory (/var/cache/omnibus/pkg
):
$ bin/omnibus clean chef-server --purge
Full help for the Omnibus command line interface can be accessed with the
help
command:
$ bin/omnibus help
Top level make targets:
$ make dev
converges the dev platform (ubuntu 1004)
$ make dev-login
logs into the dev platform (ubuntu 1004)
$ make dev-build
will execute an omnibus build in the dev platform (ubuntu 1004)
$ make dev-destroy
will destroy the current dev platform (ubuntu 1004)
$ make dev-suspend
will suspend the current dev platform (ubuntu 1004)
$ make dev-resume
will resume the current dev platform (ubuntu 1004)
$ make update
will update omnibus and omnibus-software
$ make extract_dev_cache
will copy the git cache to the current directory
$ make deploy_dev_cache
will copy a local git cache into the current build environment
There is some additional tooling in the makefile to cleanup stale builds for long running environments. This will prevent builds from eating disk space.
The usual practice would be something like
$ make update dev dev-build
That would update omnibus, omnibus-software, converge a build environment and then build the package.
Every Omnibus project ships will a project-specific
Berksfile that will allow you to build your omnibus projects on all of the projects listed
in the .kitchen.yml
. You can add/remove additional platforms as needed by
changing the list found in the .kitchen.yml
platforms
YAML stanza.
This build environment is designed to get you up-and-running quickly. However, there is nothing that restricts you to building on other platforms. Simply use the omnibus cookbook 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.
Once you have tweaked your .kitchen.yml
(or .kitchen.local.yml
) to your
liking, you can bring up an individual build environment using the kitchen
command.
NOTE: Test Kitchen shoud be installed external to the local Ruby bundle. Please either use ChefDK or install the latest test-kitchen from Rubygems.
$ kitchen converge ubuntu-1204
Test Kitchen uses a regex syntax to match on plaforms, so for example ubuntu 10.04
will be specificed as ubuntu-1004, or even just ubuntu-10, if 10.04 is the
only 10 series specified in the .kitchen.yml
.
If you skipped down to this section without reading the rest of the README, note that you'll need to copy omnibus.rb.example to omnibus.rb in the opscode-omnibus directory (either before running kichen or from the opscode-omnibus directory once logged into the VM, which is the same directory mounted into it).
Then login to the instance and build the project as described in the Usage section:
$ kitchen login ubuntu-1204
[vagrant@ubuntu...] $ cd opscode-omnibus
[vagrant@ubuntu...] $ bundle install --binstubs
[vagrant@ubuntu...] $ ...
[vagrant@ubuntu...] $ bin/omnibus build chef-server
or if you prefer not to use binstubs and to use bundle exec instead:
$ kitchen login ubuntu-1204
[vagrant@ubuntu...] $ cd opscode-omnibus
[vagrant@ubuntu...] $ bundle install
[vagrant@ubuntu...] $ ...
[vagrant@ubuntu...] $ bundle exec omnibus build chef-server
For a complete list of all commands and platforms, run kitchen list
or
kitchen help
.