Cleanup all documentation references to the spring-cloudcache-starter* modules.

Resolves gh-63.
This commit is contained in:
John Blum
2019-10-17 11:58:35 -07:00
parent 829493bbd2
commit f98b6299d2
3 changed files with 22 additions and 50 deletions

View File

@@ -79,13 +79,11 @@ The current set of _auto-configuration_ classes in Spring Boot for Apache Geode
[[geode-gemfire-switch]]
=== Switch from Apache Geode to Pivotal Cloud Cache (a.k.a. Pivotal GemFire)
First, understand that {pivotal-gemfire-website}[Pivotal GemFire] is being succeeded by
{pivotal-cloudcache-website}[Pivotal Cloud Cache] (PCC). Therefore, all references to Pivotal GemFire
(i.e. "`gemfire`") also implies for Pivotal Cloud Cache (i.e. "`cloudcache`") as well.
First, understand that {pivotal-gemfire-website}[Pivotal GemFire] is being succeeded by {pivotal-cloudcache-website}[Pivotal Cloud Cache] (PCC).
Therefore, all references to Pivotal GemFire implies for Pivotal Cloud Cache (PCC) as well.
When it comes to Spring's support, whether you are developing with Open Source Software (OSS)
{apache-geode-website}[Apache Geode] or developing for {pivotal-cloudcache-website}[Pivotal Cloud Cache],
Spring has you covered.
When it comes to Spring's support, whether you are developing with Open Source Software (OSS) {apache-geode-website}[Apache Geode]
or developing for {pivotal-cloudcache-website}[Pivotal Cloud Cache], Spring has you covered.
At a strategic-level, this means:
@@ -100,7 +98,7 @@ SBDG will never lock you in! It is, and always will be, your choice!
Technically, this means to go from Apache Geode to Pivotal Cloud Cache (PCC), you must change 2 things.
First, you must switch the dependency from `spring-geode-starter` to `spring-cloudcache-starter`:
First, you must switch the dependency from `spring-geode-starter` to `spring-gemfire-starter`:
.Maven POM with Spring Boot for Apache Geode
[source,xml]
@@ -124,29 +122,6 @@ dependencies {
To:
.Maven POM with Spring Boot for Pivotal Cloud Cache
[source,xml]
[subs="verbatim,attributes"]
----
<dependency>
<groupId>org.springframework.geode</groupId>
<artifactId>spring-cloudcache-starter</artifactId>
<version>{revnumber}</version>
</dependency>
----
.Gradle build file with Spring Boot for Pivotal CloudCache
[source,groovy]
[subs="verbatim,attributes"]
----
dependencies {
compile 'org.springframework.geode:spring-cloudcache-starter:{revnumber}'
}
----
Alternatively, if you are developing externally managed, standalone, commercial Pivotal GemFire based
Spring Boot applications, you would then switch to (instead of PCC):
.Maven POM with Spring Boot for Pivotal GemFire
[source,xml]
[subs="verbatim,attributes"]
@@ -218,7 +193,7 @@ When using the `spring-gemfire-starter`, you do not need to declare the Pivotal
the documentation. The `spring-gemfire-starter` does that for you! You only need to declare the repository
and configure your settings.
To go back, simple change `spring-cloudcache-starter` (or the `spring-gemfire-starter`) to `spring-geode-starter`.
To go back, simple change `spring-gemfire-starter` to `spring-geode-starter`.
Done!

View File

@@ -1502,13 +1502,13 @@ Maven POM file from:
To:
.Spring Boot for Pivotal Cloud Cache dependency
.Spring Boot for Pivotal GemFire (a.k.a. Pivotal Cloud Cache (PCC)) dependency
[source,xml]
[subs="verbatim,attributes"]
----
<dependency>
<groupId>org.springframework.geode</groupId>
<artifactId>spring-cloudcache-starter</artifactId>
<artifactId>spring-gemfire-starter</artifactId>
<version>{version}</version>
</dependency>
----
@@ -1517,17 +1517,17 @@ TIP: See the link:../appendix.html#geode-gemfire-switch[Appendix] for more detai
.Acquiring Pivotal Cloud Cache Bits
*****
In order to acquire the Pivotal Cloud Cache (PCC) bits used by your Spring Boot application, you must sign up
and register on https://network.pivotal.io/[PivNet].
In order to acquire the Pivotal Cloud Cache (PCC) / Pivotal GemFire bits used by your Spring Boot application, you must
sign up and register on https://network.pivotal.io/[Pivotal Network] (a.k.a. "_PivNet_").
This should include instructions on how to configure your application Maven POM file with the necessary `<repository>`
declaration for acquiring the _Pivotal Cloud Cache_ bits pulled in by the `org.springframework.geode:spring-cloudcache-starter`
SBDG application dependency along with the necessary settings in `~/.m2/settings.xml` to authenticate and access
the Pivotal Commercial Repository.
declaration for acquiring the _Pivotal Cloud Cache_ / Pivotal GemFire bits pulled in by the `
org.springframework.geode:spring-gemfire-starter` SBDG application dependency as well as the necessary settings in
`~/.m2/settings.xml` to authenticate and access the Pivotal Commercial Repository server.
This is absolutely necessary since Pivotal Cloud Cache (PCC) bits are not available in _Maven Central_.
This is absolutely necessary since Pivotal Cloud Cache (PCC) / Pivotal GemFire bits are not available in _Maven Central_.
You can also find more details on this process in the Pivotal GemFire
You can also find more details on acquiring the bits in the Pivotal GemFire
https://gemfire.docs.pivotal.io/{pivotal-gemfire-version}/gemfire/getting_started/installation/obtain_gemfire_maven.html[documentation].
*****
@@ -1557,7 +1557,7 @@ for your Spring Boot application using Apache Geode or PCC:
----
<dependency>
<groupId>org.springframework.geode</groupId>
<artifactId>spring-cloudcache-starter-actuator</artifactId>
<artifactId>spring-gemfire-starter-actuator</artifactId>
<version>{version}</version>
</dependency>
----
@@ -1580,13 +1580,13 @@ OUT at o.s.c.a.TypeMappedAnnotation.getValue(TypeMappedAnnotation.java:403)
On the other hand, if you try to exclude Micrometer from the Apache Geode or PCC dependency, for example:
.Excluding the Micrometer dependency from `spring-cloudcache-starter`
.Excluding the Micrometer dependency from `spring-gemfire-starter`
[source,txt]
[subs="verbatim,attributes"]
----
<dependency>
<groupId>org.springframework.geode</groupId>
<artifactId>spring-cloudcache-starter</artifactId>
<artifactId>spring-gemfire-starter</artifactId>
<version>{version}</version>
<exclusions>
<exclusion>
@@ -1609,7 +1609,7 @@ tries to bootstrap Apache Geode on startup:
Therefore, you must include Spring Boot Actuator on your Spring Boot application classpath when deploying
to Pivotal Platform and using Pivotal Cloud Cache (PCC). Again, the easiest way to do that is include the
`org.springframework.geode:spring-cloudcache-starter-actuator` dependency on your application classpath.
`org.springframework.geode:spring-gemfire-starter-actuator` dependency on your application classpath.
*****
Additionally, and specifically when deploying to _Pivotal Platform_, we will create a `manifest.yml` file

View File

@@ -55,13 +55,10 @@ Maven POM or Gradle build file:
</dependency>
----
TIP: You may replace Apache Geode with Pivotal GemFire simply by changing the artifact ID
TIP: You may replace Apache Geode with Pivotal Cloud Cache or Pivotal GemFire by changing the artifact ID
from `org.springframework.session:spring-session-data-geode` to `org.springframework.session:spring-session-data-gemfire`.
The version number is the same.
TIP: Alternatively, you may replace Apache Geode with either Pivotal GemFire or Pivotal Cloud Cache (PCC) simply by
changing the artifact ID from `spring-geode-starter-session` to `spring-gemfire-starter-session` for Pivotal GemFire
or `spring-cloudcache-starter-session` for Pivotal Cloud Cache (PCC).
Alternatively, you may replace Apache Geode with Pivotal Cloud Cache (PCC) or Pivotal GemFire by changing the artifact
ID from `spring-geode-starter-session` to `spring-gemfire-starter-session`. The version number is the same.
After declaring the required Spring Session dependency, then begin your Spring Boot application as you normally would: