Skip to content

Commit

Permalink
Fix docs: reference bbl destroy instead of bbl down
Browse files Browse the repository at this point in the history
- `bbl destroy` is the replacement for `bbl down`, and
`destroy` is the preferred command, though `bbl down`
still exists as an undocumented (in `bbl -h`) command
for backward compatibility purpose.
- Hence, this commit replaces references to `bbl down`
with `bbl destroy` in docs.

(see discussion: cloudfoundry#542)
  • Loading branch information
peterhaochen47 authored and beyhan committed Nov 18, 2022
1 parent 5e4f954 commit 32e910e
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Once you are done kicking the tires on CF and BOSH, clean up your environment to

1. You must first delete any deployments on BOSH. e.g. `bosh -d cf delete-deployment`

1. `bbl down` with your IaaS user/account information.
1. `bbl destroy` with your IaaS user/account information.

### Automating the automation tool

Expand Down
12 changes: 6 additions & 6 deletions docs/cleaning-up.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

In addition to creating resources for deploying BOSH, bbl has two subcommands
for assisting you in cleaning up an environment after you are done with it:
`bbl down` and `bbl cleanup-leftovers`.
`bbl destroy` and `bbl cleanup-leftovers`.


## bbl down
## bbl destroy

If you have the state file for a working environment, then bbl will destroy
everything it has created.
Expand All @@ -14,16 +14,16 @@ As a safety precaution, bbl will not delete the
environment if there are running VMs deployed by the BOSH director.

```
bbl down
bbl destroy
```


## bbl cleanup-leftovers

Sometimes, `bbl down` isn't enough to do the job.
Sometimes, `bbl destroy` isn't enough to do the job.
Perhaps you are in one of these situations:

* `bbl down` failed during deletion and lost information.
* `bbl destroy` failed during deletion and lost information.
* The `bbl-state-dir` is on a computer that you no longer have access to.
* You created resources outside of bbl that you want to nuke.
* You are running bbl's acceptance tests and they failed, orphaning IaaS resources.
Expand All @@ -33,7 +33,7 @@ cli utility [leftovers](https://github.com/genevieve/leftovers) as a
subcommand in bbl.

You can think of `bbl cleanup-leftovers` as kind of like
`bbl down --force`, but without the need for a `bbl-state-dir`.
`bbl destroy --force`, but without the need for a `bbl-state-dir`.

**The filter is very important!**

Expand Down

0 comments on commit 32e910e

Please sign in to comment.