Skip to content

Commit 0c64bb9

Browse files
dymurrayRyan Hallisey
authored andcommitted
Update documentation for apb remove (#281)
1 parent 09e689e commit 0c64bb9

File tree

2 files changed

+15
-3
lines changed

2 files changed

+15
-3
lines changed

docs/apb_cli.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -553,6 +553,7 @@ apb remove [OPTIONS]
553553
| --broker BROKER_URL | Route to the Ansible Service Broker|
554554
| --secure | Use secure connection to Ansible Service Broker |
555555
| --all | Remove all stored APBs |
556+
| --local, -l | Remove APB from internal registry (apb push'ed APB) |
556557
| --id ID | ID of APB to remove |
557558
| --secure | Use secure connection to Ansible Service Broker |
558559
| --username BASIC_AUTH_USERNAME, -u BASIC_AUTH_USERNAME | Specify the basic auth username to be used |
@@ -561,7 +562,18 @@ apb remove [OPTIONS]
561562

562563

563564
##### Examples
564-
Remove an APB using an ID
565+
Remove an APB that was pushed to the internal registry using `apb push`
566+
```bash
567+
$ pwd
568+
/home/user/my-test-apb
569+
$ apb remove -l
570+
```
571+
Remove all APBs from internal registry (assumes all APBs are named `*-apb`)
572+
```bash
573+
$ apb remove -l --all
574+
```
575+
576+
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.)
565577
```bash
566578
apb remove --id ca91b61da8476984f18fc13883ae2fdb
567579
oc delete clusterserviceclass ca91b61da8476984f18fc13883ae2fdb
@@ -575,7 +587,7 @@ ID NAME DESCRIPTION
575587
ca91b61da8476984f18fc13883ae2fdb dh-etherpad-apb Note taking web application
576588
```
577589

578-
Remove all APBs
590+
Remove all APB specs from the broker
579591
```bash
580592
apb remove --all
581593
```

docs/developers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -437,7 +437,7 @@ If a developer meets any of these criteria, then we suggest the following workfl
437437

438438
This is usually done via `apb prepare`. If you do not have the `apb` tooling installed, you can run:
439439
```
440-
$ cat apb.yml | grep base64
440+
$ cat apb.yml | base64
441441
```
442442
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:
443443
```

0 commit comments

Comments
 (0)