diff --git a/spring-cloud-app-broker-docs/src/docs/asciidoc/data-storage.adoc b/spring-cloud-app-broker-docs/src/docs/asciidoc/data-storage.adoc new file mode 100644 index 0000000..17d8e57 --- /dev/null +++ b/spring-cloud-app-broker-docs/src/docs/asciidoc/data-storage.adoc @@ -0,0 +1,2 @@ +[[data-storage]] +== Data Storage diff --git a/spring-cloud-app-broker-docs/src/docs/asciidoc/example-service-broker.adoc b/spring-cloud-app-broker-docs/src/docs/asciidoc/example-service-broker.adoc new file mode 100644 index 0000000..8fe8b61 --- /dev/null +++ b/spring-cloud-app-broker-docs/src/docs/asciidoc/example-service-broker.adoc @@ -0,0 +1,2 @@ +[[example-service-broker]] +== Example Service Broker Application diff --git a/spring-cloud-app-broker-docs/src/docs/asciidoc/getting-started.adoc b/spring-cloud-app-broker-docs/src/docs/asciidoc/getting-started.adoc new file mode 100644 index 0000000..66fe9a5 --- /dev/null +++ b/spring-cloud-app-broker-docs/src/docs/asciidoc/getting-started.adoc @@ -0,0 +1,77 @@ +[[getting-started]] +== Getting Started + +Create a Spring Boot application and include the Spring Cloud App Broker dependency in the application's build file. + +=== Maven Dependencies + +Include the following in your application's `pom.xml` file: + +```xml + + + org.springframework.cloud + spring-cloud-starter-app-broker-cloudfoundry + 1.0.0.BUILD-SNAPSHOT + + +``` + +=== Gradle Dependencies + +Include the following in your application's `build.gradle` file: + +```groovy +dependencies { + compile 'org.springframework.cloud:spring-cloud-starter-app-broker-cloudfoundry:1.0.0.BUILD-SNAPSHOT' +} +``` + +=== Configuring the Service Broker + +The service broker is configured using Spring Boot externalized configuration, supplied using a YAML or Java Properties file (for example, you can provide configuration in the `application.yml` file). Because Spring Cloud App Broker builds on Spring Cloud Open Service Broker, you must provide Spring Cloud Open Service Broker configuration to use Spring Cloud App Broker. + +Include Spring Cloud Open Servce Broker configuration using properties under `spring.cloud.openservicebroker` as in the following example: + +```yml +spring: + cloud: + openservicebroker: + catalog: + services: + - name: example + id: ebca66fd-461d-415b-bba3-5e379d671c88 + description: A useful service + bindable: true + tags: + - example + plans: + - name: standard + id: e19e6bc3-37c1-4478-b70f-c7157ebbb28c + description: A standard plan + free: true +``` + +Include Spring Cloud App Broker configuration using properties under `spring.cloud.appbroker` as in the following example: + +```yml +spring: + cloud: + appbroker: + services: + - service-name: example + plan-name: standard + apps: + - name: example-service-app1 + path: classpath:app1.jar + - name: example-service-app2 + path: classpath:app2.jar + deployer: + cloudfoundry: + api-host: api.sys.example.com + api-port: 443 + username: admin + password: adminpass + default-org: test + default-space: development +``` diff --git a/spring-cloud-app-broker-docs/src/docs/asciidoc/index.adoc b/spring-cloud-app-broker-docs/src/docs/asciidoc/index.adoc index 6dd8881..5959f29 100644 --- a/spring-cloud-app-broker-docs/src/docs/asciidoc/index.adoc +++ b/spring-cloud-app-broker-docs/src/docs/asciidoc/index.adoc @@ -21,4 +21,12 @@ [[abstract]] -Spring Cloud Open Service Broker is a framework for building {springboot-href} applications that implement the {osbapi-href} and deploy applications to back service instances. +Spring Cloud App Broker is a framework for building {springboot-href} applications that implement the {osbapi-href} and deploy applications as brokered services. + +include::introduction.adoc[] +include::getting-started.adoc[] +include::service-instances.adoc[] +include::service-bindings.adoc[] +include::service-broker-security.adoc[] +include::data-storage.adoc[] +include::example-service-broker.adoc[] diff --git a/spring-cloud-app-broker-docs/src/docs/asciidoc/introduction.adoc b/spring-cloud-app-broker-docs/src/docs/asciidoc/introduction.adoc new file mode 100644 index 0000000..34f2009 --- /dev/null +++ b/spring-cloud-app-broker-docs/src/docs/asciidoc/introduction.adoc @@ -0,0 +1,6 @@ +[[introduction]] +== Introduction + +Spring Cloud App Broker builds on Spring Cloud Open Service Broker. It can be used to create a service broker which complies with the Open Service Broker API and deploys applications and backing services to a platform. + +A service broker using Spring Cloud App Broker is a Spring Boot application. The broker can deploy applications written in any language supported by the targeted platform. 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 new file mode 100644 index 0000000..3512285 --- /dev/null +++ b/spring-cloud-app-broker-docs/src/docs/asciidoc/service-bindings.adoc @@ -0,0 +1,6 @@ +[[service-bindings]] +== Service Bindings + +=== Service Binding Creation + +=== Service Binding Deletion diff --git a/spring-cloud-app-broker-docs/src/docs/asciidoc/service-broker-security.adoc b/spring-cloud-app-broker-docs/src/docs/asciidoc/service-broker-security.adoc new file mode 100644 index 0000000..bb291e0 --- /dev/null +++ b/spring-cloud-app-broker-docs/src/docs/asciidoc/service-broker-security.adoc @@ -0,0 +1,2 @@ +[[service-broker-security]] +== Service Broker Security 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 new file mode 100644 index 0000000..5d7267d --- /dev/null +++ b/spring-cloud-app-broker-docs/src/docs/asciidoc/service-instances.adoc @@ -0,0 +1,8 @@ +[[service-instances]] +== Service Instances + +=== Creating a Service Instance + +=== Updating a Service Instance + +=== Deleting a Service Instance