README.md
1# bosh-bootloader
2Also known as `bbl` *(pronounced: "bubble")*, bosh-bootloader is a command line utility for standing up BOSH
3on an IaaS. `bbl` currently supports AWS, GCP, Microsoft Azure, Openstack and vSphere.
4
5* [CI](https://infra.ci.cf-app.com/teams/main/pipelines/bosh-bootloader/)
6* [Tracker](https://www.pivotaltracker.com/n/projects/1488988)
7
8## Docs
9
10- [Getting Started: GCP](docs/getting-started-gcp.md)
11- [Deploying Concourse](docs/concourse.md)
12- [Upgrade](docs/upgrade.md)
13- [Advanced Configuration](docs/advanced-configuration.md)
14
15## Prerequisites
16
17### Install Dependencies
18
19The following should be installed on your local machine
20- [bosh-cli](https://bosh.io/docs/cli-v2.html)
21- [bosh create-env dependencies](https://bosh.io/docs/cli-env-deps.html)
22- [terraform](https://www.terraform.io/downloads.html) >= 0.11.0
23- ruby (necessary for bosh create-env)
24
25### Install bosh-bootloader using a package manager
26
27**Mac OS X**
28
29```sh
30$ brew tap cloudfoundry/tap
31$ brew install bosh-cli
32$ brew install bbl
33```
34
35## Usage
36
37### IaaS-Specific Getting Started Guides
38- [Getting Started: Azure](docs/getting-started-azure.md)
39- [Getting Started: GCP](docs/getting-started-gcp.md)
40- [Getting Started: AWS](docs/getting-started-aws.md)
41- [Getting Started: vSphere](docs/getting-started-vsphere.md)
42- [Getting Started: OpenStack](docs/getting-started-openstack.md)
43
44### Managing state
45
46The bbl state directory contains all of the files that were used to create your bosh director. You will need the entire bbl state in order to update, delete, or run bosh commands against the environment, so you should keep it someone anyone on your team can access it. However, it is important to note that the bbl state directory contains very senstive IAAS credentials, so you should keep it somewhere you feel comfortable storing these credentials, such as an encrypted bucket.
47
48 filename | contents
49------------ | -------------
50``bbl-state.json`` | Environment name, and bbl version metadata
51``terraform/`` | The terraform templates bbl used to pave your IaaS. See [docs/advanced-configuration](docs/advanced-configuration.md#terraform) for information on modifying this.
52``vars/`` | This is where bbl will store environment specific variables. Consider storing this outside of version control.
53``jumpbox-deployment/`` | The latest [jumpbox-deployment](http://github.com/cloudfoundry/jumpbox-deployment) that has been tested with your version of bbl.
54``create-jumpbox.sh`` | The BOSH cli command bbl will use to create your jumpbox.
55``bosh-deployment/`` | The latest [bosh-deployment](http://github.com/cloudfoundry/bosh-deployment) that has been tested with your version of bbl
56``create-director.sh`` | The BOSH cli command bbl will use to create your director when you run `bbl up`. See [docs/advanced-configuration](docs/advanced-configuration.md#opsfile) for help with modifying this.
57``cloud-config/``| The cloud-config yaml that bbl will upload to the director to map IAAS resources to BOSH resources.
58``delete-director.sh`` | The BOSH cli command bbl will use to delete your director.
59``delete-jumpbox.sh`` | The BOSH cli command bbl will use to delete your jumpbox.
60
61
62### Tearing down an environment
63
64Once you are done kicking the tires on CF and BOSH, clean up your environment to save IaaS costs:
65
661. You must first delete any deployments on BOSH. e.g. `bosh -d cf delete-deployment`
67
681. `bbl down` with your IaaS user/account information.
69
70### Automating the automation tool
71
72In order to use `bbl` in your concourse pipelines, the current supported way
73for `cf-deployment` is to use the
74[cf-deployment-concourse-tasks](https://github.com/cloudfoundry/cf-deployment-concourse-tasks).
75
76There is a work-in-progress concourse resource for bbl:
77[bbl-state-resource](https://github.com/cloudfoundry/bbl-state-resource).
78