Install Concourse with BOSH
Concourse for VMware Tanzu is available for installation as a BOSH release. If you haven't read the Prerequisites and Background Information page, please do so before continuing.
This guide describes a process for installing VMware Concourse as a BOSH release for CI/CD usage. If you're interested in setting up Platform Automation, navigate to the Installing VMware Concourse for Platform Automation instead.
Set Up Certificates, Log In, and Alias Your BOSH Environment
If you already have your CA certificate and have already logged in to and aliased your BOSH environment, you can skip this section.
Get a CA certificate for your BOSH Director.
If you created your BOSH Director manually, retrieve the credentials that were created during setup.
If you are working with an Ops Manager-deployed BOSH Director, log in to Ops Manager and access the following endpoint in your Ops Manager domain:
OPS-MANAGER-DOMAINis the Ops Manager domain.
This will create a file in your downloads folder called
Copy and rename the
root_ca_certificatefile into the working directory. For example, on OSX:
mv ~/Downloads/root_ca_certificate ./ca-cert.crt
This certificate file can be used whenever a CLI command asks for a
--ca-certflag and value.
Ensure you are logged in to your BOSH environment with the appropriate BOSH Director credentials. For example, if you saved your CA certificate as
ca-cert.crt, run the following command:
bosh -e BOSH-ENVIRONMENT-IP login --ca-cert=ca-cert.crt
BOSH-ENVIRONMENT-IPis your BOSH environment IP address.
Finding director credentials
If you set up a BOSH Director directly, the director credentials were returned as a file after the setup process finished.
If you have an Ops Manager-deployed BOSH Director, you can find the director credentials in the Ops Manager credentials tab or at the following endpoint in your Ops Manager domain:
OPS-MANAGER-DOMAINis your Ops Manager domain.
Give your environment an alias by running the following command:
bosh -e BOSH-ENVIRONMENT-IP alias-env ALIAS --ca-cert=ca-cert.crt
BOSH-ENVIRONMENT-IPis your BOSH environment IP address
ALIASis the alias you're creating BOSH environment
Using an alias for your BOSH environment substantially reduces the keystrokes needed for commands in future.
You can use this alias whenever you target this environment by using the
-eflag in a BOSH command.
concourse-bosh-deployment directory on your local machine
concourse-bosh-deployment repository has a sample BOSH manifest,
versions.yml file, and a selection of deployment-modifying
operations files. Using these sample files makes it much faster and easier to get started.
Clone the concourse-bosh-deployment repo by running the following snippet on the command line:
git clone https://github.com/concourse/concourse-bosh-deployment.git
Move to the
All the paths used in this tutorial are relative to this directory.
Checkout the release that corresponds to the version of Concourse you want to install. For example, if you're installing the latest release, Concourse v6.7.3:
git checkout v6.7.3
For a list of all Concourse releases, see concourse-bosh-deployment in GitHub.
Checking out a release rather than a branch means that git produces the following output:
1 2 3 4 5 6 7 8 9 10 11 12
Note: checking out 'RELEASE'. You are in 'detached HEAD' state. You can look around, make experimental changes and commit them, and you can discard any commits you make in this state without impacting any branches by performing another checkout. If you want to create a new branch to retain commits you create, you may do so (now or later) by using -b with the checkout command again. Example: git checkout -b <new-branch-name> HEAD is now at HASH... COMMIT-MESSAGE
Download & Upload Concourse Release
If you haven't already, download the appropriate Concourse release from VMware Tanzu Network. For example, if you were to use the Concourse v6.7.3 release, you should end up with a file called
concourse-bosh-release-6.7.3.tgzin your Downloads directory.
bosh upload-releasecommand to upload the Concourse tarball that you downloaded from VMware Tanzu Network.
For example, with the latest release, Concourse v6.7.3:
bosh -e BOSH-ENVIRONMENT upload-release ~/Downloads/concourse-bosh-release-6.7.3.tgz
BOSH and Concourse variables
Installing Concourse requires setting certain configuration variables that depend on infrastructure. In this section we'll use the
bosh cloud-config command to look up our available options, and create a file to store the aforementioned configuration variables. We'll include this file in our final deployment.
Run the following command to fetch the cloud configuration details of your IaaS and put them in a
cloud-config.ymlfile to reference later:
1 2 3
bosh \ -e BOSH-ENVIRONMENT-ALIAS \ cloud-config > cloud-config.yml
The following steps describe setting variables that are necessary for deployment in a yaml file. If you'd prefer to set them on the command line when you run
bosh deploy, you could pass them in at that time with the
--var KEY=VALUEflag and syntax. Click here to learn more about
Create a file called
variables.ymlfile to store your Concourse- and BOSH-related environment variables. You can do this using vim or your favorite editor:
Fill in the following variables:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
--- deployment_name: DEPLOYMENT-NAME azs: - AVAILABILITY-ZONES network_name: NETWORK-NAME web_vm_type: VM-TYPE worker_vm_type: VM-TYPE db_persistent_disk_type: PERSISTENT-DISK-TYPE db_vm_type: VM-TYPE postgres_password: POSTGRES-PASSWORD external_url: EXTERNAL-URL web_ip: WEB-IP local_user: username: USERNAME password: PASSWORD external_host: EXTERNAL-HOST encryption_key: DB-ENCRYPTION-KEY
DEPLOYMENT-NAMEis the name of your choice for your Concourse deployment
AVAILABILITY-ZONESis an array of
namethat corresponds to
nameof one of the networks in
nameof one of the VM types in your
nameof one of the disk types in
POSTGRES-PASSWORDis the password of your choice for the PostgreSQL db used by Concourse
EXTERNAL-URLis a url associated with the
WEB-IPis a non-reserved IP address for your deployment (eg,
126.96.36.199). Only required if
local_user.usernameyour choice of username, used to log in to Concourse. Only required if
local_user.passwordis your choice of password, used to log in to Concourse.. Only required if
EXTERNAL-HOSTis the domain to be used on the TLS certificate. Only required if
keyused to encrypt the Concourse database. Only required if
Reserved IP Ranges
In some cases, you might need to modify the reserved IP ranges of your network on Ops Manager before choosing a
web_ipfor Concourse. For example, the reserved IP range is: 10.0.5.1-10.0.5.10, and you wish to set
web_ipas 10.0.5.8, the new reserved IP range to set on Ops Manager would be:
Concourse uses an external URL to facilitate communication between workers and ATCs.
When deploying for the first time, you might not know the final external URL - for example, you may later want to add a load balancer, or change your configuration as you go.
For now, choose any available URL to get started. You can always change this value later if you run into trouble or change your mind. To do so at any time, update the value in your variable files and redeploy.
Save and close the
Set Up a Deployment
To configure Concourse for VMware Tanzu, do the following:
- Prepare the Concourse deployment manifest.
You can write your own manifest or modify a template with your unique configuration. The
concourse-bosh-deployment repository that we cloned earlier has an example manifest template in the concourse.yml file located at
For more information about Cluster Concourse deployment, see the
README.md files at concourse-bosh-deployment in GitHub.
- Prepare a
cloud-config.ymlfile and upload it to your BOSH Director with
Deploy Concourse with
To deploy your new Concourse, use the following information:
- Your edited concourse manifest (eg,
- The versions file that comes with the
- Your environment variables (eg,
Any required operations files for your environment or Concourse setup.
The snippet below has a basic set of operations files, but you can add whatever options your unique deployment might require.
--vars-storeflag and a filename where BOSH can store your cluster credentials (eg,
BOSH creates this file for you if it does not already exist. If this is the case, you still need to specify a filename for BOSH to use. In the case that you already have an existing
cluster-creds.ymlfile, specify it here so that BOSH does not re-create it.
Keep in mind that if you specify a filename that does not exist, and BOSH re-creates this file for you, it also re-creates things such as passwords or secrets that go inside the file.
When you are ready, move to your terminal and run the following
bosh deploy commands:
1 2 3 4 5 6 7 8 9 10 11 12 13 14
Make sure all your file paths are correct. For more information, see Deploying in the BOSH documentation.
Different Concourse deployments require different environment variables and operations files. If you get an error, check the error message for clues about additional variables that need to be set. Check out the open-source Concourse documentation for additional information.
Upon successfully running your deploy script, a success message is displayed, and Concourse has been installed.
Use the external URL that you specified in your
variables.yml file to target your concourse with
fly and view the Concourse web UI with command
fly -t NEW-TARGET-NAME login -c http://WEB-IP:8080 -u USERNAME -p PASSWORD.