From 11c5c9cc03e8a58692ef4554c6b92dadd8ab9a74 Mon Sep 17 00:00:00 2001 From: buildmaster Date: Tue, 17 Sep 2019 13:19:40 +0000 Subject: [PATCH] Sync docs from master to gh-pages --- reference/html/README.html | 78 +++--- reference/html/appendix.html | 263 +++++++++++++++++++++ reference/html/index.html | 104 ++++---- reference/html/sagan-index.html | 8 +- reference/html/spring-cloud-zookeeper.html | 104 ++++---- 5 files changed, 410 insertions(+), 147 deletions(-) create mode 100644 reference/html/appendix.html diff --git a/reference/html/README.html b/reference/html/README.html index bc6f4c7e..67a70480 100644 --- a/reference/html/README.html +++ b/reference/html/README.html @@ -95,23 +95,23 @@ $(addBlockSwitches);
Table of Contents
@@ -137,7 +137,7 @@ with Spring Cloud Netflix provides Intelligent Routing (Zuul), Client Side Load
-

Zookeeper overview

+

1. Zookeeper overview

ZooKeeper is a centralized service for maintaining configuration information, naming, @@ -149,7 +149,7 @@ at Netflix.

-

Spring Cloud Zookeeper Features

+

2. Spring Cloud Zookeeper Features

Spring Cloud Zookeeper includes the following features:

@@ -167,7 +167,7 @@ at Netflix.

-

Running the Sample

+

3. Running the Sample

    @@ -191,23 +191,23 @@ Doing so brings in the required Spring Cloud Maven repositories and Build.

    Run java -jar spring-cloud-zookeeper-sample/target/spring-cloud-zookeeper-sample-1.2.0.BUILD-SNAPSHOT.jar.

  1. -

    Visit http://localhost:8080 to verify that {"serviceId":"testZookeeperApp","host":"<yourhost>","port":8080} works.

    +

    Visit localhost:8080 to verify that {"serviceId":"testZookeeperApp","host":"<yourhost>","port":8080} works.

  2. Run java -jar spring-cloud-zookeeper-sample/target/spring-cloud-zookeeper-sample-1.2.0.BUILD-SNAPSHOT.jar --server.port=8081

  3. -

    Visit http://localhost:8080 again to verify that {"serviceId":"testZookeeperApp","host":"<yourhost>","port":8081} eventually shows up in the results in a round-robin fashion. (It may take a minute or so.)

    +

    Visit localhost:8080 again to verify that {"serviceId":"testZookeeperApp","host":"<yourhost>","port":8081} eventually shows up in the results in a round-robin fashion. (It may take a minute or so.)

-

Building

+

4. Building

-

Basic Compile and Test

+

4.1. Basic Compile and Test

To build the source you will need to install JDK 1.7.

@@ -285,7 +285,7 @@ If all else fails, build with the command from .travis.yml (usually
-

Documentation

+

4.2. Documentation

The spring-cloud-build module has a "docs" profile, and if you switch that on it will try to build asciidoc sources from @@ -298,7 +298,7 @@ a modified file in the correct place. Just commit it and push the change.

-

Working with the code

+

4.3. Working with the code

If you don’t have an IDE preference we would recommend that you use Spring Tools Suite or @@ -307,7 +307,7 @@ a modified file in the correct place. Just commit it and push the change.

should also work without issue as long as they use Maven 3.3.3 or better.

-

Importing into eclipse with m2eclipse

+

4.3.1. Importing into eclipse with m2eclipse

We recommend the m2eclipse eclipse plugin when working with eclipse. If you don’t already have m2eclipse installed it is available from the "eclipse @@ -334,7 +334,7 @@ pom into your settings.xml.

-

Importing into eclipse without m2eclipse

+

4.3.2. Importing into eclipse without m2eclipse

If you prefer not to use m2eclipse you can generate eclipse project metadata using the following command:

@@ -353,7 +353,7 @@ from the file menu.

-

Contributing

+

5. Contributing

Spring Cloud is released under the non-restrictive Apache 2.0 license, @@ -363,7 +363,7 @@ to contribute even something trivial please do not hesitate, but follow the guidelines below.

-

Sign the Contributor License Agreement

+

5.1. Sign the Contributor License Agreement

Before we accept a non-trivial patch or pull request we will need you to sign the Contributor License Agreement. @@ -374,7 +374,7 @@ given the ability to merge pull requests.

-

Code of Conduct

+

5.2. Code of Conduct

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report @@ -382,7 +382,7 @@ unacceptable behavior to spri

-

Code Conventions and Housekeeping

+

5.3. Code Conventions and Housekeeping

None of these is essential for a pull request, but they will all help. They can also be added after the original pull request but before a merge.

@@ -430,7 +430,7 @@ message (where XXXX is the issue number).

-

Checkstyle

+

5.4. Checkstyle

Spring Cloud Build comes with a set of checkstyle rules. You can find them in the spring-cloud-build-tools module. The most notable files under the module are:

@@ -463,7 +463,7 @@ message (where XXXX is the issue number).

-

Checkstyle configuration

+

5.4.1. Checkstyle configuration

Checkstyle rules are disabled by default. To add checkstyle to your project just define the following properties and plugins.

@@ -533,11 +533,11 @@ message (where XXXX is the issue number).

<?xml version="1.0"?>
 <!DOCTYPE suppressions PUBLIC
-		"-//Puppy Crawl//DTD Suppressions 1.1//EN"
-		"https://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
+        "-//Puppy Crawl//DTD Suppressions 1.1//EN"
+        "https://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
 <suppressions>
-	<suppress files=".*ConfigServerApplication\.java" checks="HideUtilityClassConstructor"/>
-	<suppress files=".*ConfigClientWatch\.java" checks="LineLengthCheck"/>
+    <suppress files=".*ConfigServerApplication\.java" checks="HideUtilityClassConstructor"/>
+    <suppress files=".*ConfigClientWatch\.java" checks="LineLengthCheck"/>
 </suppressions>
@@ -553,9 +553,9 @@ $ touch .springformat
-

IDE setup

+

5.5. IDE setup

-

Intellij IDEA

+

5.5.1. Intellij IDEA

In order to setup Intellij you should import our coding conventions, inspection profiles and set up the checkstyle plugin. The following files can be found in the Spring Cloud Build project.

@@ -627,15 +627,15 @@ The following files can be found in the -

Go to File → Settings → Other settings → Checkstyle. There click on the + icon in the Configuration file section. There, you’ll have to define where the checkstyle rules should be picked from. In the image above, we’ve picked the rules from the cloned Spring Cloud Build repository. However, you can point to the Spring Cloud Build’s GitHub repository (e.g. for the checkstyle.xml : https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/main/resources/checkstyle.xml). We need to provide the following variables:

+

Go to File → Settings → Other settings → Checkstyle. There click on the + icon in the Configuration file section. There, you’ll have to define where the checkstyle rules should be picked from. In the image above, we’ve picked the rules from the cloned Spring Cloud Build repository. However, you can point to the Spring Cloud Build’s GitHub repository (e.g. for the checkstyle.xml : raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/main/resources/checkstyle.xml). We need to provide the following variables:

-

Install Zookeeper

+

1. Install Zookeeper

See the installation @@ -213,7 +213,7 @@ compile('org.apache.zookeeper:zookeeper:3.4.12') {

-

Service Discovery with Zookeeper

+

2. Service Discovery with Zookeeper

Service Discovery is one of the key tenets of a microservice based architecture. Trying to @@ -224,7 +224,7 @@ Extension. Spring Cloud Zookeeper uses this extension for service registrati discovery.

-

Activating

+

2.1. Activating

Including a dependency on org.springframework.cloud:spring-cloud-starter-zookeeper-discovery enables @@ -258,7 +258,7 @@ the way you include the dependency as described -

Registering with Zookeeper

+

2.2. Registering with Zookeeper

When a client registers with Zookeeper, it provides metadata (such as host and port, ID, and name) about itself.

@@ -338,7 +338,7 @@ query Zookeeper to locate other services).

-

Using the DiscoveryClient

+

2.3. Using the DiscoveryClient

Spring Cloud has support for Feign @@ -370,7 +370,7 @@ public String serviceUrl() {

-

Using Spring Cloud Zookeeper with Spring Cloud Netflix Components

+

3. Using Spring Cloud Zookeeper with Spring Cloud Netflix Components

Spring Cloud Netflix supplies useful tools that work regardless of which DiscoveryClient @@ -378,7 +378,7 @@ implementation you use. Feign, Turbine, Ribbon, and Zuul all work with Spring Cl Zookeeper.

-

Ribbon with Zookeeper

+

3.1. Ribbon with Zookeeper

Spring Cloud Zookeeper provides an implementation of Ribbon’s ServerList. When you use the spring-cloud-starter-zookeeper-discovery, Ribbon is autoconfigured to use the @@ -388,7 +388,7 @@ the spring-cloud-starter-zookeeper-discovery, Ribbon is autoconfig

-

Spring Cloud Zookeeper and Service Registry

+

4. Spring Cloud Zookeeper and Service Registry

Spring Cloud Zookeeper implements the ServiceRegistry interface, letting developers @@ -416,7 +416,7 @@ public void registerThings() {

-

Instance Status

+

4.1. Instance Status

Netflix Eureka supports having instances that are OUT_OF_SERVICE registered with the server. These instances are not returned as active service instances. This is useful for @@ -441,7 +441,7 @@ instance status actuator endpoint, as shown in the following example:

-The preceding example uses the http command from https://httpie.org. +The preceding example uses the http command from httpie.org. @@ -450,7 +450,7 @@ The preceding example uses the http command from -

Zookeeper Dependencies

+

5. Zookeeper Dependencies

The following topics cover how to work with Spring Cloud Zookeeper dependencies:

@@ -472,7 +472,7 @@ The preceding example uses the http command from -

Using the Zookeeper Dependencies

+

5.1. Using the Zookeeper Dependencies

Spring Cloud Zookeeper gives you a possibility to provide dependencies of your application as properties. As dependencies, you can understand other applications that are registered @@ -489,7 +489,7 @@ the state of your dependencies.

-

Activating Zookeeper Dependencies

+

5.2. Activating Zookeeper Dependencies

Including a dependency on org.springframework.cloud:spring-cloud-starter-zookeeper-discovery enables @@ -499,7 +499,7 @@ the dependencies in your properties, you can turn off the dependencies. To do so

-

Setting up Zookeeper Dependencies

+

5.3. Setting up Zookeeper Dependencies

Consider the following example of dependency representation:

@@ -534,7 +534,7 @@ spring.cloud.zookeeper: name is spring.cloud.zookeeper.dependencies.

-

Aliases

+

5.3.1. Aliases

Below the root property you have to represent each dependency as an alias. This is due to the constraints of Ribbon, which requires that the application ID be placed in the URL. @@ -557,7 +557,7 @@ public interface NewsletterService {

-

Path

+

5.3.2. Path

The path is represented by the path YAML property and is the path under which the dependency is registered under Zookeeper. As described in the @@ -567,7 +567,7 @@ That is why Spring Cloud Zookeeper maps the alias to the proper path.

-

Load Balancer Type

+

5.3.3. Load Balancer Type

The load balancer type is represented by loadBalancerType YAML property.

@@ -591,7 +591,7 @@ applied. You can choose one of the following load balancing strategies:

-

Content-Type Template and Version

+

5.3.4. Content-Type Template and Version

The Content-Type template and version are represented by the contentTypeTemplate and version YAML properties.

@@ -627,7 +627,7 @@ want to roam around your code to bump up the API version. That is why you can pr
-

Default Headers

+

5.3.5. Default Headers

Default headers are represented by the headers map in YAML.

@@ -652,7 +652,7 @@ appropriate list of values in your HTTP request.

-

Required Dependencies

+

5.3.6. Required Dependencies

Required dependencies are represented by required property in YAML.

@@ -671,7 +671,7 @@ start if the required dependency is not registered in Zookeeper.

-

Stubs

+

5.3.7. Stubs

You can provide a colon-separated path to the JAR containing stubs of the dependency, as shown in the following example:

@@ -705,7 +705,7 @@ example:

-

Configuring Spring Cloud Zookeeper Dependencies

+

5.4. Configuring Spring Cloud Zookeeper Dependencies

You can set the following properties to enable or disable parts of Zookeeper Dependencies functionalities:

@@ -748,7 +748,7 @@ dependency configuration. Without this setting, those two parameters do not work
-

Spring Cloud Zookeeper Dependency Watcher

+

6. Spring Cloud Zookeeper Dependency Watcher

The Dependency Watcher mechanism lets you register listeners to your dependencies. The @@ -756,14 +756,14 @@ functionality is, in fact, an implementation of the Observator patt dependency changes, its state (to either UP or DOWN), some custom logic can be applied.

-

Activating

+

6.1. Activating

Spring Cloud Zookeeper Dependencies functionality needs to be enabled for you to use the Dependency Watcher mechanism.

-

Registering a Listener

+

6.2. Registering a Listener

To register a listener, you must implement an interface called org.springframework.cloud.zookeeper.discovery.watcher.DependencyWatcherListener and @@ -781,7 +781,7 @@ information about whether your dependency has changed to CONNECTED

-

Using the Presence Checker

+

6.3. Using the Presence Checker

Bound with the Dependency Watcher is the functionality called Presence Checker. It lets you provide custom behavior when your application boots, to react according to the state @@ -816,7 +816,7 @@ overridden.

-

Distributed Configuration with Zookeeper

+

7. Distributed Configuration with Zookeeper

Zookeeper provides a @@ -859,7 +859,7 @@ request to /refresh causes the configuration to be reloaded. Watchi namespace (which Zookeeper supports) is not currently implemented.

-

Activating

+

7.1. Activating

Including a dependency on org.springframework.cloud:spring-cloud-starter-zookeeper-config enables @@ -880,7 +880,7 @@ the way you include the dependency as described -

Customizing

+

7.2. Customizing

Zookeeper Config may be customized by setting the following properties:

@@ -916,7 +916,7 @@ property sources with profiles.

-

Access Control Lists (ACLs)

+

7.3. Access Control Lists (ACLs)

You can add authentication information for Zookeeper ACLs by calling the addAuthInfo method of a CuratorFramework bean. One way to accomplish this is to provide your own diff --git a/reference/html/sagan-index.html b/reference/html/sagan-index.html index b7861d7e..f7955c02 100644 --- a/reference/html/sagan-index.html +++ b/reference/html/sagan-index.html @@ -95,8 +95,8 @@ $(addBlockSwitches);

@@ -109,7 +109,7 @@ $(addBlockSwitches);
-

Features

+

1. Features

    @@ -130,7 +130,7 @@ $(addBlockSwitches);
-

Quick Start

+

2. Quick Start

As long as Spring Cloud Zookeeper, Apache Curator and the Zookeeper Java Client are on the diff --git a/reference/html/spring-cloud-zookeeper.html b/reference/html/spring-cloud-zookeeper.html index 5fbc931c..c46f73f9 100644 --- a/reference/html/spring-cloud-zookeeper.html +++ b/reference/html/spring-cloud-zookeeper.html @@ -96,44 +96,44 @@ $(addBlockSwitches);

Table of Contents
@@ -154,7 +154,7 @@ with Spring Cloud Netflix provides Intelligent Routing (Zuul), Client Side Load
-

Install Zookeeper

+

1. Install Zookeeper

See the installation @@ -213,7 +213,7 @@ compile('org.apache.zookeeper:zookeeper:3.4.12') {

-

Service Discovery with Zookeeper

+

2. Service Discovery with Zookeeper

Service Discovery is one of the key tenets of a microservice based architecture. Trying to @@ -224,7 +224,7 @@ Extension. Spring Cloud Zookeeper uses this extension for service registrati discovery.

-

Activating

+

2.1. Activating

Including a dependency on org.springframework.cloud:spring-cloud-starter-zookeeper-discovery enables @@ -258,7 +258,7 @@ the way you include the dependency as described -

Registering with Zookeeper

+

2.2. Registering with Zookeeper

When a client registers with Zookeeper, it provides metadata (such as host and port, ID, and name) about itself.

@@ -338,7 +338,7 @@ query Zookeeper to locate other services).

-

Using the DiscoveryClient

+

2.3. Using the DiscoveryClient

Spring Cloud has support for Feign @@ -370,7 +370,7 @@ public String serviceUrl() {

-

Using Spring Cloud Zookeeper with Spring Cloud Netflix Components

+

3. Using Spring Cloud Zookeeper with Spring Cloud Netflix Components

Spring Cloud Netflix supplies useful tools that work regardless of which DiscoveryClient @@ -378,7 +378,7 @@ implementation you use. Feign, Turbine, Ribbon, and Zuul all work with Spring Cl Zookeeper.

-

Ribbon with Zookeeper

+

3.1. Ribbon with Zookeeper

Spring Cloud Zookeeper provides an implementation of Ribbon’s ServerList. When you use the spring-cloud-starter-zookeeper-discovery, Ribbon is autoconfigured to use the @@ -388,7 +388,7 @@ the spring-cloud-starter-zookeeper-discovery, Ribbon is autoconfig

-

Spring Cloud Zookeeper and Service Registry

+

4. Spring Cloud Zookeeper and Service Registry

Spring Cloud Zookeeper implements the ServiceRegistry interface, letting developers @@ -416,7 +416,7 @@ public void registerThings() {

-

Instance Status

+

4.1. Instance Status

Netflix Eureka supports having instances that are OUT_OF_SERVICE registered with the server. These instances are not returned as active service instances. This is useful for @@ -441,7 +441,7 @@ instance status actuator endpoint, as shown in the following example:

-The preceding example uses the http command from https://httpie.org. +The preceding example uses the http command from httpie.org. @@ -450,7 +450,7 @@ The preceding example uses the http command from -

Zookeeper Dependencies

+

5. Zookeeper Dependencies

The following topics cover how to work with Spring Cloud Zookeeper dependencies:

@@ -472,7 +472,7 @@ The preceding example uses the http command from -

Using the Zookeeper Dependencies

+

5.1. Using the Zookeeper Dependencies

Spring Cloud Zookeeper gives you a possibility to provide dependencies of your application as properties. As dependencies, you can understand other applications that are registered @@ -489,7 +489,7 @@ the state of your dependencies.

-

Activating Zookeeper Dependencies

+

5.2. Activating Zookeeper Dependencies

Including a dependency on org.springframework.cloud:spring-cloud-starter-zookeeper-discovery enables @@ -499,7 +499,7 @@ the dependencies in your properties, you can turn off the dependencies. To do so

-

Setting up Zookeeper Dependencies

+

5.3. Setting up Zookeeper Dependencies

Consider the following example of dependency representation:

@@ -534,7 +534,7 @@ spring.cloud.zookeeper: name is spring.cloud.zookeeper.dependencies.

-

Aliases

+

5.3.1. Aliases

Below the root property you have to represent each dependency as an alias. This is due to the constraints of Ribbon, which requires that the application ID be placed in the URL. @@ -557,7 +557,7 @@ public interface NewsletterService {

-

Path

+

5.3.2. Path

The path is represented by the path YAML property and is the path under which the dependency is registered under Zookeeper. As described in the @@ -567,7 +567,7 @@ That is why Spring Cloud Zookeeper maps the alias to the proper path.

-

Load Balancer Type

+

5.3.3. Load Balancer Type

The load balancer type is represented by loadBalancerType YAML property.

@@ -591,7 +591,7 @@ applied. You can choose one of the following load balancing strategies:

-

Content-Type Template and Version

+

5.3.4. Content-Type Template and Version

The Content-Type template and version are represented by the contentTypeTemplate and version YAML properties.

@@ -627,7 +627,7 @@ want to roam around your code to bump up the API version. That is why you can pr
-

Default Headers

+

5.3.5. Default Headers

Default headers are represented by the headers map in YAML.

@@ -652,7 +652,7 @@ appropriate list of values in your HTTP request.

-

Required Dependencies

+

5.3.6. Required Dependencies

Required dependencies are represented by required property in YAML.

@@ -671,7 +671,7 @@ start if the required dependency is not registered in Zookeeper.

-

Stubs

+

5.3.7. Stubs

You can provide a colon-separated path to the JAR containing stubs of the dependency, as shown in the following example:

@@ -705,7 +705,7 @@ example:

-

Configuring Spring Cloud Zookeeper Dependencies

+

5.4. Configuring Spring Cloud Zookeeper Dependencies

You can set the following properties to enable or disable parts of Zookeeper Dependencies functionalities:

@@ -748,7 +748,7 @@ dependency configuration. Without this setting, those two parameters do not work
-

Spring Cloud Zookeeper Dependency Watcher

+

6. Spring Cloud Zookeeper Dependency Watcher

The Dependency Watcher mechanism lets you register listeners to your dependencies. The @@ -756,14 +756,14 @@ functionality is, in fact, an implementation of the Observator patt dependency changes, its state (to either UP or DOWN), some custom logic can be applied.

-

Activating

+

6.1. Activating

Spring Cloud Zookeeper Dependencies functionality needs to be enabled for you to use the Dependency Watcher mechanism.

-

Registering a Listener

+

6.2. Registering a Listener

To register a listener, you must implement an interface called org.springframework.cloud.zookeeper.discovery.watcher.DependencyWatcherListener and @@ -781,7 +781,7 @@ information about whether your dependency has changed to CONNECTED

-

Using the Presence Checker

+

6.3. Using the Presence Checker

Bound with the Dependency Watcher is the functionality called Presence Checker. It lets you provide custom behavior when your application boots, to react according to the state @@ -816,7 +816,7 @@ overridden.

-

Distributed Configuration with Zookeeper

+

7. Distributed Configuration with Zookeeper

Zookeeper provides a @@ -859,7 +859,7 @@ request to /refresh causes the configuration to be reloaded. Watchi namespace (which Zookeeper supports) is not currently implemented.

-

Activating

+

7.1. Activating

Including a dependency on org.springframework.cloud:spring-cloud-starter-zookeeper-config enables @@ -880,7 +880,7 @@ the way you include the dependency as described -

Customizing

+

7.2. Customizing

Zookeeper Config may be customized by setting the following properties:

@@ -916,7 +916,7 @@ property sources with profiles.

-

Access Control Lists (ACLs)

+

7.3. Access Control Lists (ACLs)

You can add authentication information for Zookeeper ACLs by calling the addAuthInfo method of a CuratorFramework bean. One way to accomplish this is to provide your own