Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

missing documentation wrt to deploy to CF with custom brokerpak #520

Open
poblin-orange opened this issue Aug 22, 2019 · 2 comments
Open

missing documentation wrt to deploy to CF with custom brokerpak #520

poblin-orange opened this issue Aug 22, 2019 · 2 comments

Comments

@poblin-orange
Copy link

@poblin-orange poblin-orange commented Aug 22, 2019

I successfully managed to deploy gc-service-broker to Cloudfoundry OSS.
Also, i did package a custom brokerpak for testing.
However, i dont see any instructions/documentation to let the gc-service-broker cf app load my custom brokerpak ?

@dominikmueller
Copy link
Contributor

@dominikmueller dominikmueller commented Aug 26, 2019

I can't help with documentation about deploying it on OSS Cloudfoundry, but you might be able to get some hints about which environment variables you need to set in your manifest by looking at the tile.yml (at least that's how I interpret it):

- name: gsb_brokerpak_sources

The name of the form defines the necessary environment variable. So the upper reference would result in a variable named "GSB_BROKERPAK_SOURCES".

gcp-service-broker/tile.yml

Lines 510 to 546 in b4c1f17

properties:
- name: uri
type: string
label: Brokerpak URI
description: "The URI to load. Supported protocols are http, https, gs, and git.\n\t\t\t\tCloud
Storage (gs) URIs follow the gs://<bucket>/<path> convention and will be read
using the service broker service account.\n\n\t\t\t\tYou can validate the checksum
of any file on download by appending a checksum query parameter to the URI in
the format type:value.\n\t\t\t\tValid checksum types are md5, sha1, sha256 and
sha512. e.g. gs://foo/bar.brokerpak?checksum=md5:3063a2c62e82ef8614eee6745a7b6b59"
configurable: true
- name: service_prefix
type: string
label: Service Prefix
description: A prefix to prepend to every service name. This will be exact, so
you may want to include a trailing dash.
configurable: true
optional: true
- name: excluded_services
type: text
label: Excluded Services
description: A list of UUIDs of services to exclude, one per line.
configurable: true
optional: true
- name: config
type: text
default: '{}'
label: Brokerpak Configuration
description: A JSON map of configuration key/value pairs for the brokerpak. If
a variable isn't found here, it's looked up in the global config.
configurable: true
- name: notes
type: text
label: Notes
description: A place for your notes, not used by the broker.
configurable: true
optional: true

The properties section for that form defines what kind of JSON key-value pairs you need to provide through that environment variable.

An example would be:

GSB_BROKERPAK_SOURCES: {"uri": "gs://foo/bar.brokerpak?checksum=md5:3063a2c62e82ef8614eee6745a7b6b59", "service_prefix": "experimental-", "config": "{}", "notes": "An example for configuring brokerpaks"}

There are plenty of other forms that might help to configure the GCP service broker to your needs.

Nevertheless, I also think that there is some documentation missing. But since the brokerpak feature still is in development there hopefully is more to come :)

@poblin-orange
Copy link
Author

@poblin-orange poblin-orange commented Aug 27, 2019

@dominikmueller thks! Il try this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.