Added the redirection link to the documentation
This commit is contained in:
Marcin Grzejszczak
62
index.html
62
index.html
@@ -1,60 +1,12 @@
|
||||
---
|
||||
# The name of your project
|
||||
title: Spring Cloud Cloud Foundry
|
||||
|
||||
badges:
|
||||
|
||||
# Customize your project's badges. Delete any entries that do not apply.
|
||||
custom:
|
||||
- name: Source (GitHub)
|
||||
url: https://github.com/spring-cloud/spring-cloud-cloudfoundry
|
||||
icon: github
|
||||
|
||||
- name: StackOverflow
|
||||
url: https://stackoverflow.com/questions/tagged/spring-cloud
|
||||
icon: stackoverflow
|
||||
|
||||
---
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en-US">
|
||||
|
||||
<!-- Specify the parent of this project (or delete if none) to influence the rendering of the breadcrumb -->
|
||||
{% capture parent_link %}
|
||||
[Spring Cloud]({{ site.projects_site_url }}/spring-cloud)
|
||||
{% endcapture %}
|
||||
<meta charset="UTF-8">
|
||||
<meta http-equiv="refresh" content="1; url=https://cloud.spring.io/spring-cloud-cloudfoundry/reference/html/">
|
||||
|
||||
<script>
|
||||
window.location.href = "https://cloud.spring.io/spring-cloud-cloudfoundry/reference/html/"
|
||||
</script>
|
||||
|
||||
{% capture billboard_description %}
|
||||
<title>Page Redirection</title>
|
||||
|
||||
Spring Cloud for Cloudfoundry makes it easy to run [Spring Cloud](https://github.com/spring-cloud) apps in [Cloud Foundry](https://github.com/cloudfoundry) (the Platform as a Service). Cloud Foundry has the notion of a "service", which is middlware that you "bind" to an app, essentially providing it with an environment variable containing credentials (e.g. the location and username to use for the service).
|
||||
|
||||
{% endcapture %}
|
||||
|
||||
{% capture main_content %}
|
||||
|
||||
## Features
|
||||
|
||||
The `spring-cloud-cloudfoundry-web` project provides basic support for some enhanced features of webapps in Cloud Foundry: binding automatically to single-sign-on services and optionally enabling sticky routing for discovery.
|
||||
|
||||
The `spring-cloud-cloudfoundry-discovery` project provides an implementation of Spring Cloud Commons `DiscoveryClient` so you can `@EnableDiscoveryClient` and provide your credentials as `spring.cloud.cloudfoundry.discovery.[email,password]` and then you can use the `DiscoveryClient` directly or via a `LoadBalancerClient` (also `*.url` if you are not connecting to [Pivotal Web Services](https://run.pivotal.io)).
|
||||
|
||||
> NOTE: if you are looking for a way to bind to services then this is the wrong library. Check out the [Spring Cloud Connectors](https://github.com/spring-cloud/spring-cloud-connectors) instead.
|
||||
|
||||
<span id="quick-start"></span>
|
||||
|
||||
## Quick Start
|
||||
|
||||
{% include download_widget.md %}
|
||||
|
||||
{% endcapture %}
|
||||
|
||||
{% capture related_resources %}
|
||||
|
||||
### Sample Projects
|
||||
|
||||
* [Cloud Foundry Sample](https://github.com/spring-cloud/spring-cloud-cloudfoundry/tree/master/spring-cloud-cloudfoundry-sample)
|
||||
|
||||
{% endcapture %}
|
||||
|
||||
{% include project_page.html %}
|
||||
</html>
|
||||
If you are not redirected automatically, follow the <a href='https://cloud.spring.io/spring-cloud-cloudfoundry/reference/html/'>link to latest snapshot documentation</a>
|
||||
|
||||
@@ -1,219 +1,12 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!DOCTYPE HTML>
|
||||
|
||||
<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.7.1">
|
||||
<title>Spring Cloud for Cloud Foundry</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">
|
||||
<meta http-equiv="refresh" content="1; url=https://cloud.spring.io/spring-cloud-cloudfoundry/reference/html/">
|
||||
|
||||
<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>
|
||||
window.location.href = "https://cloud.spring.io/spring-cloud-cloudfoundry/reference/html/"
|
||||
</script>
|
||||
|
||||
</head>
|
||||
<body class="book toc2 toc-left">
|
||||
<div id="header">
|
||||
<h1>Spring Cloud for Cloud Foundry</h1>
|
||||
<div id="toc" class="toc2">
|
||||
<div id="toctitle">Table of Contents</div>
|
||||
<ul class="sectlevel1">
|
||||
<li><a href="#_discovery">Discovery</a></li>
|
||||
<li><a href="#_single_sign_on">Single Sign On</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div id="content">
|
||||
<div id="preamble">
|
||||
<div class="sectionbody">
|
||||
<div class="paragraph">
|
||||
<p>Spring Cloud for Cloudfoundry makes it easy to run
|
||||
<a href="https://github.com/spring-cloud">Spring Cloud</a> apps in
|
||||
<a href="https://github.com/cloudfoundry">Cloud Foundry</a> (the Platform as a
|
||||
Service). Cloud Foundry has the notion of a "service", which is
|
||||
middlware that you "bind" to an app, essentially providing it with an
|
||||
environment variable containing credentials (e.g. the location and
|
||||
username to use for the service).</p>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
<p>The <code>spring-cloud-cloudfoundry-commons</code> module configures the
|
||||
Reactor-based Cloud Foundry Java client, v 3.0, and can be used standalone.</p>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
<p>The <code>spring-cloud-cloudfoundry-web</code> project provides basic support for
|
||||
some enhanced features of webapps in Cloud Foundry: binding
|
||||
automatically to single-sign-on services and optionally enabling
|
||||
sticky routing for discovery.</p>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
<p>The <code>spring-cloud-cloudfoundry-discovery</code> project provides an
|
||||
implementation of Spring Cloud Commons <code>DiscoveryClient</code> so you can
|
||||
<code>@EnableDiscoveryClient</code> and provide your credentials as
|
||||
<code>spring.cloud.cloudfoundry.discovery.[username,password]</code> (also <code>*.url</code> if you are not connecting to <a href="https://run.pivotal.io">Pivotal Web Services</a>) and then you
|
||||
can use the <code>DiscoveryClient</code> directly or via a <code>LoadBalancerClient</code>.</p>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
<p>The first time you use it the discovery client might be slow owing to
|
||||
the fact that it has to get an access token from Cloud Foundry.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sect1">
|
||||
<h2 id="_discovery"><a class="link" href="#_discovery">Discovery</a></h2>
|
||||
<div class="sectionbody">
|
||||
<div class="paragraph">
|
||||
<p>Here’s a Spring Cloud app with Cloud Foundry discovery:</p>
|
||||
</div>
|
||||
<div class="listingblock">
|
||||
<div class="title">app.groovy</div>
|
||||
<div class="content">
|
||||
<pre class="highlightjs highlight"><code class="language-java hljs" data-lang="java">@Grab('org.springframework.cloud:spring-cloud-cloudfoundry')
|
||||
@RestController
|
||||
@EnableDiscoveryClient
|
||||
class Application {
|
||||
<title>Page Redirection</title>
|
||||
|
||||
@Autowired
|
||||
DiscoveryClient client
|
||||
|
||||
@RequestMapping('/')
|
||||
String home() {
|
||||
'Hello from ' + client.getLocalServiceInstance()
|
||||
}
|
||||
|
||||
}</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
<p>If you run it without any service bindings:</p>
|
||||
</div>
|
||||
<div class="listingblock">
|
||||
<div class="content">
|
||||
<pre>$ spring jar app.jar app.groovy
|
||||
$ cf push -p app.jar</pre>
|
||||
</div>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
<p>It will show its app name in the home page.</p>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
<p>The <code>DiscoveryClient</code> can lists all the apps in a space, according to
|
||||
the credentials it is authenticated with, where the space defaults to
|
||||
the one the client is running in (if any). If neither org nor space
|
||||
are configured, they default per the user’s profile in Cloud Foundry.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sect1">
|
||||
<h2 id="_single_sign_on"><a class="link" href="#_single_sign_on">Single Sign On</a></h2>
|
||||
<div class="sectionbody">
|
||||
<div class="admonitionblock note">
|
||||
<table>
|
||||
<tr>
|
||||
<td class="icon">
|
||||
<i class="fa icon-note" title="Note"></i>
|
||||
</td>
|
||||
<td class="content">
|
||||
All of the OAuth2 SSO and resource server features moved to Spring Boot
|
||||
in version 1.3. You can find documentation in the
|
||||
<a href="https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/">Spring Boot user guide</a>.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
<p>This project provides automatic binding from CloudFoundry service
|
||||
credentials to the Spring Boot features. If you have a CloudFoundry
|
||||
service called "sso", for instance, with credentials containing
|
||||
"client_id", "client_secret" and "auth_domain", it will bind
|
||||
automatically to the Spring OAuth2 client that you enable with
|
||||
<code>@EnableOAuth2Sso</code> (from Spring Boot). The name of the service can be
|
||||
parameterized using <code>spring.oauth2.sso.serviceId</code>.</p>
|
||||
</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>
|
||||
If you are not redirected automatically, follow the <a href='https://cloud.spring.io/spring-cloud-cloudfoundry/reference/html/'>link to latest snapshot documentation</a>
|
||||
|
||||
Reference in New Issue
Block a user