// Do not edit this file (e.g. go instead to src/main/asciidoc)
= Spring Framework on Google Cloud Platform
This project makes it easy for Spring users to run their applications on Google Cloud Platform.
You can check our project website https://cloud.spring.io/spring-cloud-gcp[here].
For a deep dive into the project, refer to the https://cloud.spring.io/spring-cloud-static/spring-cloud-gcp/1.1.0.RELEASE/single/spring-cloud-gcp.html[Spring Cloud GCP 1.1 Reference Document].
If you prefer to learn by doing, try https://codelabs.developers.google.com/spring[Spring on GCP codelabs].
Currently, this repository provides support for:
- link:spring-cloud-gcp-pubsub[Spring Cloud GCP Pub/Sub, including Spring Integration Channel Adapters]
- link:spring-cloud-gcp-pubsub-stream-binder[Spring Cloud GCP Pub/Sub Stream Binder]
- link:spring-cloud-gcp-storage[Spring Resource Abstraction for Google Cloud Storage, including Spring Integration Channel Adapters]
- link:spring-cloud-gcp-data-spanner[Spring Data Cloud Spanner]
- link:spring-cloud-gcp-data-datastore[Spring Data Cloud Datastore]
- link:spring-cloud-gcp-vision[Google Cloud Vision API Template]
- Spring Boot starters
** link:spring-cloud-gcp-starters/spring-cloud-gcp-starter[GCP Support]
** link:spring-cloud-gcp-starters/spring-cloud-gcp-starter-config[Google Cloud Config] (Beta)
** link:spring-cloud-gcp-starters/spring-cloud-gcp-starter-data-spanner[Google Cloud Spanner]
** link:spring-cloud-gcp-starters/spring-cloud-gcp-starter-data-datastore[Google Cloud Datastore]
** link:spring-cloud-gcp-starters/spring-cloud-gcp-starter-logging[Google Cloud Logging]
** link:spring-cloud-gcp-starters/spring-cloud-gcp-starter-pubsub[Google Cloud Pub/Sub]
** link:spring-cloud-gcp-starters/spring-cloud-gcp-starter-sql-mysql[Google Cloud SQL MySQL]
** link:spring-cloud-gcp-starters/spring-cloud-gcp-starter-sql-postgresql[Google Cloud SQL PostgreSQL]
** link:spring-cloud-gcp-starters/spring-cloud-gcp-starter-storage[Google Cloud Storage]
** link:spring-cloud-gcp-starters/spring-cloud-gcp-starter-trace[Stackdriver Trace with Spring Cloud Sleuth]
** link:spring-cloud-gcp-starters/spring-cloud-gcp-starter-security-iap[Google Cloud IAP Authentication]
** link:spring-cloud-gcp-starters/spring-cloud-gcp-starter-vision[Google Cloud Vision API]
If you have any other ideas, suggestions or bug reports, please use our https://github.com/spring-cloud/spring-cloud-gcp/issues[GitHub issue tracker] and let us know!
We would love to hear from you.
If you want to collaborate in the project, we would also love to get your Pull Requests.
Before you start working on one, please take a look at our link:CONTRIBUTING.adoc[collaboration manual].
== Spring Initializr
Spring Initializr contains Spring Cloud GCP auto-configuration support through the GCP Support entry.
GCP Messaging contains the Spring Cloud GCP messaging support with Google Cloud Pub/Sub working out of the box.
Similarly to GCP Messaging, GCP Storage contains the Google Cloud Storage support with no other dependencies needed.
== Spring Cloud GCP Bill of Materials (BOM)
If you're a Maven user, add our BOM to your pom.xml <dependencyManagement> section.
This will allow you to not specify versions for any of the Maven dependencies and instead delegate versioning to the BOM.
[source,xml]
== Spring Milestones Maven Repository
The latest non-GA Maven artifacts for the project are only available in the Spring Milestones repository.
You will want to make sure that the repository is added to your pom.xml file or globally in your https://maven.apache.org/settings.html[`settings.xml`] file.
[source,xml]
== Spring Boot Starters
Spring Boot greatly simplifies the Spring Cloud GCP experience.
Our starters handle the object instantiation and configuration logic so you don't have to.
Every starter depends on the GCP starter to provide critical bits of configuration, like the GCP project ID or OAuth2 credentials location.
You can configure these as properties in, for example, a properties file:
[source]
spring.cloud.gcp.project-id=[YOUR_GCP_PROJECT_ID]
spring.cloud.gcp.credentials.location=file:[LOCAL_PRIVATE_KEY_FILE]
spring.cloud.gcp.credentials.scopes=[SCOPE_1],[SCOPE_2],[SCOPE_3]
These properties are optional and, if not specified, Spring Boot will attempt to automatically find them for you.
For details on how Spring Boot finds these properties, refer to the https://cloud.spring.io/spring-cloud-gcp[documentation].
NOTE: If your app is running on Google App Engine or Google Compute Engine, in most cases, you should omit the spring.cloud.gcp.credentials.location property and, instead, let the Spring Cloud GCP Core Starter find the correct credentials for those environments.