Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/automationbroker/apb
A CLI tool for listing and deploying Service Bundles
https://github.com/automationbroker/apb
Last synced: about 1 month ago
JSON representation
A CLI tool for listing and deploying Service Bundles
- Host: GitHub
- URL: https://github.com/automationbroker/apb
- Owner: automationbroker
- License: apache-2.0
- Created: 2018-05-15T13:11:31.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-03-25T19:41:48.000Z (over 4 years ago)
- Last Synced: 2024-08-01T22:53:27.214Z (4 months ago)
- Language: Go
- Homepage: http://automationbroker.io
- Size: 41.7 MB
- Stars: 62
- Watchers: 7
- Forks: 13
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-repositories - automationbroker/apb - A CLI tool for listing and deploying Service Bundles (Go)
README
# apb
## Getting Started
### Create a namespace
Once logged into your OCP cluster, you must first create a project:
```
$ oc new-project test-project
```
### Add a registry
First add the default registry (ansibleplaybookbundle on Dockerhub):
```
$ apb registry add docker
```
Or to add a custom registry:
```
$ apb registry add docker --org ansibleplaybookbundle --type dockerhub
```
Then you can list your registries:
```
$ apb registry list
Found registries already in config:
NAME TYPE ORG URL
------ -+- --------- -+- --------------------- -+- ---------
docker | dockerhub | ansibleplaybookbundle | docker.io
```
### List available APBs
Once a registry is configured, run `apb bundle list`:
```
$ apb bundle list
Found specs already in registry: [docker]
BUNDLE IMAGE REGISTRY
--------------------- -+- ------------------------------------------------------------------- -+- --------
blankvm-apb | docker.io/ansibleplaybookbundle/virtualmachines-apb:latest | docker
prometheus-apb | docker.io/ansibleplaybookbundle/prometheus-apb:latest | docker
dynamic-apb | docker.io/ansibleplaybookbundle/dynamic-apb:latest | docker
eclipse-che-apb | docker.io/ansibleplaybookbundle/eclipse-che-apb:latest | docker
etherpad-apb | docker.io/ansibleplaybookbundle/etherpad-apb:latest | docker
pyzip-demo-db-apb | docker.io/ansibleplaybookbundle/pyzip-demo-db-apb:latest | docker
```
This command loads and caches APB specs (metadata) from newly added registries. Cached specs can be updated with `apb bundle list --refresh`
### Provision an APB
Provision any of the listed APBs like so:
```
$ apb bundle provision -n myproject --follow
```
To provision an APB with the `admin` ClusterRole used in the APB sandbox, run:
```
$ apb bundle provision -n myproject --sandbox-role admin --follow
```
_Note:_ the `--follow` flag waits for the APB to start running and shows logs on-screen.
## Tips
### Enabling tab completion for apb
`apb` supports command tab completion for `bash` and `zsh`:
```
$ source <(apb completion bash) # load bash completion into session
$ source <(apb completion zsh) # load zsh completion into session
```
## Troubleshooting
### Using apb with openshift.io
In the starter tier of openshift.io, the secret quota is 20 (at the time of this writing). Since each `apb bundle provision` action creates a serviceaccount with an API token residing in a secret, it's possible to hit this limit after a few provisions. Cleaning up `bundle-*****-[..]` serviceaccounts will help resolve this. You can check if you're hitting this limit with `oc get quota object-counts -o yaml`