Skip to content

v1.0.0

Compare
Choose a tag to compare
@gberche-orange gberche-orange released this 19 Jan 09:08
· 180 commits to develop since this release
  • maintenance_info support
  • service instance upgrade support. Fixes #278.
  • initial service instance update support (plan/param). Contributes to #40

Service authors notes

This release introduces breaking change for service authors w.r.t. to the completion marker. Service authors in paas-templates need to include the following

  • in pre-deploy.sh call shared-operators/coab/coa-hooks/prepare-coab-completion-marker.bash: this packages coab-vars.yml file into coab-completion-marker-vars.yml with a single coab_completion_marker top-level key
  • in the bosh deployment, include shared-operators/coab/bosh-operators/99-add-coab-finger-print-operators.yml: this inserts coab_completion_marker key as an extra manifest entry which gets ignored by bosh, but preserved in the resulting manifest, and polled by coab
  • in post-deploy.sh call shared-operators/coab/coa-hooks/verify-coab-completion-marker.bash: this verifies that the coab_completion_marker key is present in resulting manifest

Service operator notes

To configure supported plan upgrades and possibly customize default rejection message, specify the following in coab broker deployment manifest:

# Message displayed when a plan upgrade request is rejected
# {0}: current/previous plan name
# {1}: request plan name
# {2}: List of supported plan upgrades from current/previous plane name
# plans.upgrade.rejected-message-template=plan upgrade from {0} to {1} are not supported, please prefer creating a new instance and export/import your data into it. List of supported plan upgrades from {0} is: {2}
# Matrix of supported plan upgrades.
# accepts from small to medium and large
# accepts from medium to large
# all others plan update requests are rejected
"plans.upgrade.supportedFromTo[small_plan_name][0]": medium_plan_name
"plans.upgrade.supportedFromTo[small_plan_name][1]": large_plan_name
"plans.upgrade.supportedFromTo[medium_plan_name][0]": large_plan_name
  • in coab broker catalog file (e.g. coab-depls/cf-apps-deployments/coa-noop-broker/template/broker-catalog-config-tpl.yml) declare the maintenance_info associated to the service plan as documented in the OSB API specifications catalog part
              - id: noop-ondemand-plan-2
                name: mysql-sample
                description: mysql sample schema
                [...]
                maintenance_info:
                  version: 50.0.0"
                  description: "Dashboard url with backend guid"