README
¶
bosh-bootloader
Also known as bbl (pronounced: "bubble"), bosh-bootloader is a command line utility for standing up BOSH
on an IaaS. bbl currently supports AWS, GCP, Microsoft Azure, Openstack and vSphere.
Docs
Prerequisites
Install Dependencies
The following should be installed on your local machine
- bosh-cli
- bosh create-env dependencies
- terraform >= 0.11.0
- ruby (necessary for bosh create-env)
Installation from orange
On *nix system
You can install this via the command-line with either curl or wget.
via curl
$ bash -c "$(curl -fsSL https://raw.github.com/orange-cloudfoundry/bosh-bootloader/master/bin/install.sh)"
via wget
$ bash -c "$(wget https://raw.github.com/orange-cloudfoundry/bosh-bootloader/master/bin/install.sh -O -)"
On windows
You can install it by downloading the .exe corresponding to your cpu from releases page: https://github.com/orange-cloudfoundry/bosh-bootloader/releases .
Alternatively, if you have terminal interpreting shell you can also use command line script above, it will download file in your current working dir.
From go command line
Simply run in terminal:
$ go get github.com/orange-cloudfoundry/bosh-bootloader
Install bosh-bootloader using a package manager
Mac OS X
$ brew tap cloudfoundry/tap
$ brew install bosh-cli
$ brew install bbl
Usage
IaaS-Specific Getting Started Guides
- Getting Started: Azure
- Getting Started: GCP
- Getting Started: AWS
- Getting Started: vSphere
- Getting Started: OpenStack
Managing state
The bbl state directory contains all of the files that were used to create your bosh director. This should be checked in to version control, so that you have all the information necessary to later destroy or update this environment at a later date.
| filename | contents |
|---|---|
bbl-state.json |
Environment name, and bbl version metadata |
bosh-deployment |
The latest bosh-deployment that has been tested with your version of bbl |
create-director.sh |
The BOSH cli command bbl will use to create your director when you run bbl up. See docs/advanced-configuration for help with modifying this. |
create-jumpbox.sh |
The BOSH cli command bbl will use to create your jumpbox. |
delete-director.sh |
The BOSH cli command bbl will use to delete your director. |
delete-jumpbox.sh |
The BOSH cli command bbl will use to delete your jumpbox. |
jumpbox-deployment |
The latest jumpbox-deployment that has been tested with your version of bbl. |
terraform |
The terraform templates bbl used to pave your IaaS. See docs/advanced-configuration for information on modifying this. |
vars |
This is where bbl will store environment specific variables. Consider storing this outside of version control. |
Tearing down an environment
Once you are done kicking the tires on CF and BOSH, clean up your environment to save IaaS costs:
-
You must first delete any deployments on BOSH. e.g.
bosh -d cf delete-deployment -
bbl downwith your IaaS user/account information.
Automating the automation tool
In order to use bbl in your concourse pipelines, the current supported way
for cf-deployment is to use the
cf-deployment-concourse-tasks.
There is a work-in-progress concourse resource for bbl: bbl-state-resource.
Directories