diff --git a/README.md b/README.md index 414f0ab5..2419ed21 100644 --- a/README.md +++ b/README.md @@ -142,3 +142,17 @@ Pipeline responsible for managing the development [bosh-lite pool](https://githu - Create new bosh-lites if there is room in the pool - Delete released bosh-lites + + #### Using Pooled Environments + + There are a number of helpful scripts in + [capi-workspace](https://github.com/cloudfoundry/capi-workspace) for using the + bosh lite pool. For example: + - `lib/claim-bosh-lite`: Claim a bosh lite environment from the pool. + - `lib/unclaim-bosh-lite`: Mark a bosh lite environment for deletion to free up space in the pool. + - `lib/target-bosh`: Set bosh environment variables in your terminal for a given pool environment. + - `bin/which_bosh`: Check which environment your terminal is currently targeting. + - `bin/print_env_info`: List the currently-claimed environments in the pool. + - `bin/deploy`: Deploy your local cf-deployment and capi-release to your targeted environment. + - `bin/target_cf`: Log in as admin via the cf CLI to your targeted environment. + - And more!