From 34153b482d82d89f74d22a4f85f1ddd408d7718b Mon Sep 17 00:00:00 2001 From: Ben Klein Date: Tue, 26 Feb 2019 13:39:29 -0600 Subject: [PATCH] Updates to reference documentation --- .../src/docs/asciidoc/deployment-platforms.adoc | 4 ++++ .../src/docs/asciidoc/service-bindings.adoc | 4 ++-- .../src/docs/asciidoc/service-instances.adoc | 4 ++++ 3 files changed, 10 insertions(+), 2 deletions(-) diff --git a/spring-cloud-app-broker-docs/src/docs/asciidoc/deployment-platforms.adoc b/spring-cloud-app-broker-docs/src/docs/asciidoc/deployment-platforms.adoc index bba4e1e..2d05997 100644 --- a/spring-cloud-app-broker-docs/src/docs/asciidoc/deployment-platforms.adoc +++ b/spring-cloud-app-broker-docs/src/docs/asciidoc/deployment-platforms.adoc @@ -16,6 +16,10 @@ spring: *api-port: 443* *username: admin* *password: adminpass* + *client-id: EXAMPLE_ID* + *client-secret: EXAMPLE_SECRET* *default-org: test* *default-space: development* ``` + +NOTE: The two properties `username` and `password` and the two properties `client-id` and `client-secret` are mutually exclusive. The `client-id` and `client-secret` properties are for use with OAuth 2.0. diff --git a/spring-cloud-app-broker-docs/src/docs/asciidoc/service-bindings.adoc b/spring-cloud-app-broker-docs/src/docs/asciidoc/service-bindings.adoc index 8e9ba9b..2f7b5e5 100644 --- a/spring-cloud-app-broker-docs/src/docs/asciidoc/service-bindings.adoc +++ b/spring-cloud-app-broker-docs/src/docs/asciidoc/service-bindings.adoc @@ -7,8 +7,8 @@ By default, Spring Cloud App Broker does not include functionality for managing === Creating a Service Binding -The service broker application must implement the https://docs.spring.io/spring-cloud-app-broker/docs/1.0.0.BUILD-SNAPSHOT/api/org/springframework/cloud/appbroker/service/CreateServiceInstanceAppBindingWorkflow.html[`CreateServiceInstanceAppBindingWorkflow`] interface. +The service broker application can implement the https://docs.spring.io/spring-cloud-app-broker/docs/1.0.0.BUILD-SNAPSHOT/api/org/springframework/cloud/appbroker/service/CreateServiceInstanceAppBindingWorkflow.html[`CreateServiceInstanceAppBindingWorkflow`] interface. Alternatively, the service broker application can implement the `ServiceInstanceBindingService` interface provided by Spring Cloud Open Service Broker. See https://docs.spring.io/spring-cloud-open-service-broker/docs/current/reference/html5/#service-bindings[Service Bindings] in the https://docs.spring.io/spring-cloud-open-service-broker/docs/current/reference/html5/[Spring Cloud Open Service Broker documentation]. === Deleting a Service Binding -The service broker application must implement the https://docs.spring.io/spring-cloud-app-broker/docs/1.0.0.BUILD-SNAPSHOT/api/org/springframework/cloud/appbroker/service/DeleteServiceInstanceBindingWorkflow.html[`DeleteServiceInstanceBindingWorkflow`] interface. +The service broker application can implement the https://docs.spring.io/spring-cloud-app-broker/docs/1.0.0.BUILD-SNAPSHOT/api/org/springframework/cloud/appbroker/service/DeleteServiceInstanceBindingWorkflow.html[`DeleteServiceInstanceBindingWorkflow`] interface. Alternatively, the service broker application can implement the `ServiceInstanceBindingService` interface provided by Spring Cloud Open Service Broker. See https://docs.spring.io/spring-cloud-open-service-broker/docs/current/reference/html5/#service-bindings[Service Bindings] in the https://docs.spring.io/spring-cloud-open-service-broker/docs/current/reference/html5/[Spring Cloud Open Service Broker documentation]. diff --git a/spring-cloud-app-broker-docs/src/docs/asciidoc/service-instances.adoc b/spring-cloud-app-broker-docs/src/docs/asciidoc/service-instances.adoc index 1a8ce6b..97296b1 100644 --- a/spring-cloud-app-broker-docs/src/docs/asciidoc/service-instances.adoc +++ b/spring-cloud-app-broker-docs/src/docs/asciidoc/service-instances.adoc @@ -200,6 +200,10 @@ By default (if you do not provide a `target` specification), all backing applica If you use the `SpacePerServiceInstance` target, App Broker will deploy backing applications to a unique target location that is named using the service instance GUID provided by the platform at service instance create time. For Cloud Foundry, this target location will be the org named by `spring.cloud.appbroker.deployer.cloudfoundry.default-org` and a new space created using the service instance GUID as the space name. +====== The `ServiceInstanceGuidSuffix` Target + +If you use the `ServiceInstanceGuidSuffix` target, App Broker will deploy backing applications using a unique name and hostname that incorporates the service instance GUID provided by the platform at service instance create time. For Cloud Foundry, the target location will be the org named by `spring.cloud.appbroker.deployer.cloudfoundry.default-org`, the space named by `spring.cloud.appbroker.deployer.cloudfoundry.default-space`, and an application name as `[APP-NAME]-[SI-GUID]`, where `[APP-NAME]` is the `name` listed for the application under `spring.cloud.appbroker.services.apps` and `[SI-GUID]` is the service instance GUID. The application will also use a hostname incorporating the service instance GUID as a suffix, as `[APP-NAME]-[SI-GUID]`. + ===== Service Instance Parameters When a user provides parameters while creating or updating a service instance, App Broker can transform these parameters into details of the backing app deployment using parameters transformers. You can configure parameters transformers using properties under `parameters-transformers`, as in the following example: