<commit_before># BOSH Release for broker-registrar

The `broker-registrar-boshrelease` is a BOSH release aimed at providing a generic errands
for registering CloudFoundry service brokers via `broker-registrar` and `broker-deregistrar`
errands. While it can be deployed as a standalone deployment, it gains most power from being
added to existing service deployments, to provide a consistent way of registering/deregistering
service brokers.

## Usage

The standard `templates/make_manifest` script can be used to create a generic
BOSH manifest. If you wish to colocate this release on another deployment,
simply include the content of `templates/jobs.yml` in your [spruce](https://github.com/geofffranks/spruce)
templates for your bosh manifest, and fill out the required parameters

Don't forget to upload the bosh release!

```
# Grab from bosh.io
bosh upload release https://bosh.io/d/github.com/cloudfoundry-community/broker-registrar-boshrelease

# Or alternatively, do it manually
bosh target BOSH_HOST
git clone https://github.com/cloudfoundry-community/broker-registrar-boshrelease.git
cd broker-registrar-boshrelease
bosh upload release releases/broker-registrar-1.yml
```

## Registering/Deregistering brokers

Once this release has been deployed, you can use `bosh run errand broker-registrar`
and `bosh run errand broker-deregistrar to register + deregister the service broker.

**CAUTION!!!** The `broker-deregistrar` job will issue a purge-service-offering command
to CloudFoundry, deleting all instances of services, app bindings, services, and broker data.
Only use it if you really mean it. If you need to update a service broker from a new URL or
with new data, use the `broker-registrar` job, as it is capable of safely updating brokers.

### Development

As a developer of this release, create new releases and upload them:

```
bosh create release --force && bosh -n upload release
```

To share final releases:

```
bosh create release --final
```<commit_msg>update readme towards new links deployment<commit_after># Registering Service Brokers with Cloud Foundry

The `broker-registrar-boshrelease` is a BOSH release aimed at providing a generic errands
for registering service brokers with Cloud Foundry via `broker-registrar` and `broker-deregistrar`
errands. While it can be deployed as a standalone deployment, it gains most power from being
added to existing service deployments, to provide a consistent way of registering/deregistering
service brokers.

## Usage

The basic usage is to run an errand to register/re-register a service broker:

```
bosh2 run-errand broker-registrar
```


Upload the release to your BOSH:

```
bosh2 upload-release https://bosh.io/d/github.com/cloudfoundry-community/broker-registrar-boshrelease
```

## Deregistering brokers

**CAUTION!!!** The `broker-deregistrar` job will issue a purge-service-offering command
to CloudFoundry, deleting all instances of services, app bindings, services, and broker data.
Only use it if you really mean it. If you need to update a service broker from a new URL or
with new data, use the `broker-registrar` job, as it is capable of safely updating brokers.
{'fraction_non_alphanumeric': 0.06979695431472081, 'fraction_numerical': 0.0009517766497461929, 'mean_word_length': 4.994296577946768, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4340930', 'n_tokens_mistral': 926, 'n_tokens_neox': 874, 'n_words': 395}