394 lines
17 KiB
HTML
394 lines
17 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="generator" content="Asciidoctor 1.5.8">
|
|
<title>Features</title>
|
|
<link rel="stylesheet" href="css/spring.css">
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
|
|
|
|
<style>
|
|
.hidden {
|
|
display: none;
|
|
}
|
|
|
|
.switch {
|
|
border-width: 1px 1px 0 1px;
|
|
border-style: solid;
|
|
border-color: #7a2518;
|
|
display: inline-block;
|
|
}
|
|
|
|
.switch--item {
|
|
padding: 10px;
|
|
background-color: #ffffff;
|
|
color: #7a2518;
|
|
display: inline-block;
|
|
cursor: pointer;
|
|
}
|
|
|
|
.switch--item:not(:first-child) {
|
|
border-width: 0 0 0 1px;
|
|
border-style: solid;
|
|
border-color: #7a2518;
|
|
}
|
|
|
|
.switch--item.selected {
|
|
background-color: #7a2519;
|
|
color: #ffffff;
|
|
}
|
|
</style>
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/zepto/1.2.0/zepto.min.js"></script>
|
|
<script type="text/javascript">
|
|
function addBlockSwitches() {
|
|
$('.primary').each(function() {
|
|
primary = $(this);
|
|
createSwitchItem(primary, createBlockSwitch(primary)).item.addClass("selected");
|
|
primary.children('.title').remove();
|
|
});
|
|
$('.secondary').each(function(idx, node) {
|
|
secondary = $(node);
|
|
primary = findPrimary(secondary);
|
|
switchItem = createSwitchItem(secondary, primary.children('.switch'));
|
|
switchItem.content.addClass('hidden');
|
|
findPrimary(secondary).append(switchItem.content);
|
|
secondary.remove();
|
|
});
|
|
}
|
|
|
|
function createBlockSwitch(primary) {
|
|
blockSwitch = $('<div class="switch"></div>');
|
|
primary.prepend(blockSwitch);
|
|
return blockSwitch;
|
|
}
|
|
|
|
function findPrimary(secondary) {
|
|
candidate = secondary.prev();
|
|
while (!candidate.is('.primary')) {
|
|
candidate = candidate.prev();
|
|
}
|
|
return candidate;
|
|
}
|
|
|
|
function createSwitchItem(block, blockSwitch) {
|
|
blockName = block.children('.title').text();
|
|
content = block.children('.content').first().append(block.next('.colist'));
|
|
item = $('<div class="switch--item">' + blockName + '</div>');
|
|
item.on('click', '', content, function(e) {
|
|
$(this).addClass('selected');
|
|
$(this).siblings().removeClass('selected');
|
|
e.data.siblings('.content').addClass('hidden');
|
|
e.data.removeClass('hidden');
|
|
});
|
|
blockSwitch.append(item);
|
|
return {'item': item, 'content': content};
|
|
}
|
|
|
|
$(addBlockSwitches);
|
|
</script>
|
|
|
|
</head>
|
|
<body class="book toc2 toc-left">
|
|
<div id="header">
|
|
<div id="toc" class="toc2">
|
|
<div id="toctitle">Table of Contents</div>
|
|
<ul class="sectlevel1">
|
|
<li><a href="#_features">Features</a></li>
|
|
<li><a href="#_getting_started">Getting Started</a>
|
|
<ul class="sectlevel2">
|
|
<li><a href="#_bill_of_materials">Bill of Materials</a></li>
|
|
<li><a href="#_starter_dependencies">Starter Dependencies</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#_code_samples">Code Samples</a></li>
|
|
<li><a href="#_initializr">Initializr</a></li>
|
|
<li><a href="#_contact_us">Contact Us</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div id="content">
|
|
<div id="preamble">
|
|
<div class="sectionbody">
|
|
<div class="paragraph">
|
|
<p>The Spring Cloud GCP project makes the Spring Framework a first-class citizen of Google Cloud Platform (GCP).</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="_features"><a class="link" href="#_features">Features</a></h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph">
|
|
<p>Spring Cloud GCP offers a wide collection of libraries that make it easier to use Google Cloud Platform from Spring Framework applications.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>Project features include:</p>
|
|
</div>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p>Spring Cloud GCP Pub/Sub Support (Spring Integration and Spring Cloud Stream Binder)</p>
|
|
</li>
|
|
<li>
|
|
<p>Spring Data Cloud Spanner</p>
|
|
</li>
|
|
<li>
|
|
<p>Spring Data Cloud Datastore</p>
|
|
</li>
|
|
<li>
|
|
<p>Spring Data Reactive Repositories for Cloud Firestore</p>
|
|
</li>
|
|
<li>
|
|
<p>Spring Data Cloud SQL</p>
|
|
</li>
|
|
<li>
|
|
<p>Google Cloud Stackdriver Logging & Tracing</p>
|
|
</li>
|
|
<li>
|
|
<p>Google Cloud Storage (Spring Resource and Spring Integration)</p>
|
|
</li>
|
|
<li>
|
|
<p>Google Cloud Vision API Template</p>
|
|
</li>
|
|
<li>
|
|
<p>Spring Security identity extraction from Google Cloud IAP headers.</p>
|
|
</li>
|
|
<li>
|
|
<p>Google Cloud BigQuery with Spring Integration</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="_getting_started"><a class="link" href="#_getting_started">Getting Started</a></h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph">
|
|
<p>All Spring Cloud GCP artifacts are made available through Maven Central.</p>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_bill_of_materials"><a class="link" href="#_bill_of_materials">Bill of Materials</a></h3>
|
|
<div class="paragraph">
|
|
<p>If you’re using Maven, you should first add the Spring Cloud GCP Bill of Materials (BOM) to your <code>pom.xml</code>.
|
|
This will help you manage the version numbers of <code>spring-cloud-gcp</code> dependencies in your project.</p>
|
|
</div>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><dependencyManagement>
|
|
<dependencies>
|
|
<dependency>
|
|
<groupId>org.springframework.cloud</groupId>
|
|
<artifactId>spring-cloud-gcp-dependencies</artifactId>
|
|
<version>1.2.2.RELEASE</version>
|
|
<type>pom</type>
|
|
<scope>import</scope>
|
|
</dependency>
|
|
</dependencies>
|
|
</dependencyManagement></code></pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_starter_dependencies"><a class="link" href="#_starter_dependencies">Starter Dependencies</a></h3>
|
|
<div class="paragraph">
|
|
<p>Spring Cloud GCP offers <a href="https://github.com/spring-cloud/spring-cloud-gcp/tree/master/spring-cloud-gcp-starters">starter dependencies</a> through Maven to easily depend on different modules of the library.
|
|
Each starter contains all the dependencies and transitive dependencies needed to begin using their corresponding Spring Cloud GCP module.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>A sample of these artifacts are provided below.</p>
|
|
</div>
|
|
<table class="tableblock frame-all grid-all stretch">
|
|
<colgroup>
|
|
<col style="width: 33.3333%;">
|
|
<col style="width: 33.3333%;">
|
|
<col style="width: 33.3334%;">
|
|
</colgroup>
|
|
<thead>
|
|
<tr>
|
|
<th class="tableblock halign-left valign-top">Spring Cloud GCP Starter</th>
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
|
<th class="tableblock halign-left valign-top">Maven Artifact Coordinates</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Cloud Spanner</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Provides integrations with Google Cloud Spanner</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>org.springframework.cloud:spring-cloud-gcp-starter-data-spanner</code></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Cloud Datastore</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Provides integrations with Google Cloud Datastore</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>org.springframework.cloud:spring-cloud-gcp-starter-data-datastore</code></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Cloud Firestore</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Provides Spring Data Reactive Repositories support for Cloud Firestore</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>org.springframework.cloud:spring-cloud-gcp-starter-data-firestore</code></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Cloud Pub/Sub</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Provides integrations with Google Cloud Pub/Sub</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>org.springframework.cloud:spring-cloud-gcp-starter-pubsub</code></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Logging</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Enables Stackdriver Logging</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>org.springframework.cloud:spring-cloud-gcp-starter-logging</code></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">SQL - MySQL</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Cloud SQL integrations with MySQL</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>org.springframework.cloud:spring-cloud-gcp-starter-sql-mysql</code></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">SQL - PostgreSQL</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Cloud SQL integrations with PostgreSQL</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>org.springframework.cloud:spring-cloud-gcp-starter-sql-postgresql</code></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Storage</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Provides integrations with Google Cloud Storage and Spring Resource</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>org.springframework.cloud:spring-cloud-gcp-starter-storage</code></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Trace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Enables instrumentation with Google Stackdriver Tracing</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>org.springframework.cloud:spring-cloud-gcp-starter-trace</code></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Vision</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Provides integrations with Google Cloud Vision</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>org.springframework.cloud:spring-cloud-gcp-starter-vision</code></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Security - IAP</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Extracts IAP identity information from applications deployed to Google Cloud</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>org.springframework.cloud:spring-cloud-gcp-starter-security-iap</code></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="_code_samples"><a class="link" href="#_code_samples">Code Samples</a></h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph">
|
|
<p>The best way to learn how to use Spring Cloud GCP is to consult the <a href="https://github.com/spring-cloud/spring-cloud-gcp/tree/master/spring-cloud-gcp-samples">sample applications on Github</a>.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>The table below highlights several samples of the most commonly used integrations in Spring Cloud GCP.</p>
|
|
</div>
|
|
<table class="tableblock frame-all grid-all stretch">
|
|
<colgroup>
|
|
<col style="width: 50%;">
|
|
<col style="width: 50%;">
|
|
</colgroup>
|
|
<thead>
|
|
<tr>
|
|
<th class="tableblock halign-left valign-top">GCP Integration</th>
|
|
<th class="tableblock halign-left valign-top">Sample Application</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Cloud Pub/Sub</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://github.com/spring-cloud/spring-cloud-gcp/tree/master/spring-cloud-gcp-samples/spring-cloud-gcp-pubsub-sample">spring-cloud-gcp-pubsub-sample</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Cloud Spanner</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://github.com/spring-cloud/spring-cloud-gcp/tree/master/spring-cloud-gcp-samples/spring-cloud-gcp-data-spanner-sample">spring-cloud-gcp-data-spanner-sample</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Cloud Datastore</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://github.com/spring-cloud/spring-cloud-gcp/tree/master/spring-cloud-gcp-samples/spring-cloud-gcp-data-datastore-sample">spring-cloud-gcp-data-datastore-sample</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Cloud Firestore</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://github.com/spring-cloud/spring-cloud-gcp/tree/master/spring-cloud-gcp-samples/spring-cloud-gcp-data-firestore-sample">spring-cloud-gcp-data-firestore-sample</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Cloud SQL (w/ MySQL)</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://github.com/spring-cloud/spring-cloud-gcp/tree/master/spring-cloud-gcp-samples/spring-cloud-gcp-sql-mysql-sample">spring-cloud-gcp-sql-mysql-sample</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Cloud Storage</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://github.com/spring-cloud/spring-cloud-gcp/tree/master/spring-cloud-gcp-samples/spring-cloud-gcp-storage-resource-sample">spring-cloud-gcp-storage-resource-sample</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Stackdriver Logging</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://github.com/spring-cloud/spring-cloud-gcp/tree/master/spring-cloud-gcp-samples/spring-cloud-gcp-logging-sample">spring-cloud-gcp-logging-sample</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Trace</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://github.com/spring-cloud/spring-cloud-gcp/tree/master/spring-cloud-gcp-samples/spring-cloud-gcp-trace-sample">spring-cloud-gcp-trace-sample</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Cloud Vision</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://github.com/spring-cloud/spring-cloud-gcp/tree/master/spring-cloud-gcp-samples/spring-cloud-gcp-vision-api-sample">spring-cloud-gcp-vision-api-sample</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Cloud Security - IAP</p></td>
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://github.com/spring-cloud/spring-cloud-gcp/tree/master/spring-cloud-gcp-samples/spring-cloud-gcp-security-iap-sample">spring-cloud-gcp-security-iap-sample</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="_initializr"><a class="link" href="#_initializr">Initializr</a></h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph">
|
|
<p><a href="https://start.spring.io/">Spring Initializr</a> is a tool which generates the scaffolding code for a new Spring Boot project.
|
|
It handles the work of generating the Maven or Gradle build file so you do not have to manually add the dependencies yourself.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>Spring Initializr offers three modules from Spring Cloud GCP that you can use to generate your project.</p>
|
|
</div>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><strong>GCP Support</strong>: The GCP Support module contains auto-configuration support for every Spring Cloud GCP integration.
|
|
Most of the autoconfiguration code is only enabled if the required dependency is added to your project.</p>
|
|
</li>
|
|
<li>
|
|
<p><strong>GCP Messaging</strong>: Google Cloud Pub/Sub integrations work out of the box.</p>
|
|
</li>
|
|
<li>
|
|
<p><strong>GCP Storage</strong>: Google Cloud Storage integrations work out of the box.</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="_contact_us"><a class="link" href="#_contact_us">Contact Us</a></h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph">
|
|
<p>Spring Cloud GCP is an actively maintained project and we encourage users to raise issues and ask questions about the project.</p>
|
|
</div>
|
|
<div class="paragraph">
|
|
<p>We actively monitor the following communication channels:</p>
|
|
</div>
|
|
<div class="ulist">
|
|
<ul>
|
|
<li>
|
|
<p><a href="https://github.com/spring-cloud/spring-cloud-gcp">Spring Cloud GCP Github Repository</a>: Post an issue in our Github repository to ask questions, make a bug report, file feature requests, etc.</p>
|
|
</li>
|
|
<li>
|
|
<p><a href="https://gitter.im/spring-cloud-gcp/Lobby">Spring Cloud GCP Gitter Lobby</a>: Ask questions and talk to the developers in our Gitter chatroom.</p>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript" src="js/tocbot/tocbot.min.js"></script>
|
|
<script type="text/javascript" src="js/toc.js"></script>
|
|
<link rel="stylesheet" href="js/highlight/styles/atom-one-dark-reasonable.min.css">
|
|
<script src="js/highlight/highlight.min.js"></script>
|
|
<script>hljs.initHighlighting()</script>
|
|
</body>
|
|
</html> |