Skip to content

Commit

Permalink
Update documentation for apb remove (#281)
Browse files Browse the repository at this point in the history
  • Loading branch information
dymurray authored and Ryan Hallisey committed May 3, 2018
1 parent 09e689e commit 0c64bb9
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 3 deletions.
16 changes: 14 additions & 2 deletions docs/apb_cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -553,6 +553,7 @@ apb remove [OPTIONS]
| --broker BROKER_URL | Route to the Ansible Service Broker|
| --secure | Use secure connection to Ansible Service Broker |
| --all | Remove all stored APBs |
| --local, -l | Remove APB from internal registry (apb push'ed APB) |
| --id ID | ID of APB to remove |
| --secure | Use secure connection to Ansible Service Broker |
| --username BASIC_AUTH_USERNAME, -u BASIC_AUTH_USERNAME | Specify the basic auth username to be used |
Expand All @@ -561,7 +562,18 @@ apb remove [OPTIONS]


##### Examples
Remove an APB using an ID
Remove an APB that was pushed to the internal registry using `apb push`
```bash
$ pwd
/home/user/my-test-apb
$ apb remove -l
```
Remove all APBs from internal registry (assumes all APBs are named `*-apb`)
```bash
$ apb remove -l --all
```

Remove an APB using an ID (This only removes the spec from the broker. It does *not* remove the image itself from the remote registry.)
```bash
apb remove --id ca91b61da8476984f18fc13883ae2fdb
oc delete clusterserviceclass ca91b61da8476984f18fc13883ae2fdb
Expand All @@ -575,7 +587,7 @@ ID NAME DESCRIPTION
ca91b61da8476984f18fc13883ae2fdb dh-etherpad-apb Note taking web application
```

Remove all APBs
Remove all APB specs from the broker
```bash
apb remove --all
```
Expand Down
2 changes: 1 addition & 1 deletion docs/developers.md
Original file line number Diff line number Diff line change
Expand Up @@ -437,7 +437,7 @@ If a developer meets any of these criteria, then we suggest the following workfl

This is usually done via `apb prepare`. If you do not have the `apb` tooling installed, you can run:
```
$ cat apb.yml | grep base64
$ cat apb.yml | base64
```
This will return the base64 encoded `apb.yml` which you can copy and paste into the `Dockerfile` under the `LABEL` `com.redhat.apb.spec` like:
```
Expand Down

0 comments on commit 0c64bb9

Please sign in to comment.