docs(springboot cloudconfig): Write examples and docs for springboot cloudconfig

Signed-off-by: lony2003 <zhangke200377@outlook.com>

Author: lony2003

daprdocs/content/en/java-sdk-docs/spring-boot/_index.md

@@ -323,6 +323,146 @@ daprWorkflowClient.raiseEvent(instanceId, "MyEvenet", event);
 
 Check the [Dapr Workflow documentation](https://docs.dapr.io/developing-applications/building-blocks/workflow/workflow-overview/) for more information about how to work with Dapr Workflows.
 
+## Using Dapr Cloud Config with Spring Boot
+
+To enable dapr cloud config, you should add following properties in your application's config (properties for example):
+
+```properties
+# default enable is true, don't need to specify
+dapr.cloudconfig.enabled = true
+spring.config.import[0] = <schema>
+spring.config.import[1] = <schema>
+spring.config.import[2] = <schema>
+#... keep going if you want to import more configs
+```
+
+There are other config of the dapr cloud config, listed below:
+
+```properties
+#enable dapr cloud config or not (default = true).
+dapr.cloudconfig.enabled=true
+#timeout for getting dapr config (include wait for dapr sidecar) (default = 2000).
+dapr.cloudconfig.timeout=2000
+#whether enable dapr client wait for sidecar, if no response, will throw IOException (default = false).
+dapr.cloudconfig.wait-sidecar-enabled=false
+#retries of dapr client wait for sidecar (default = 3).
+dapr.cloudconfig.wait-sidecar-retries=3
+```
+
+In Dapr Cloud Config component, we support two ways to imprt config: Secret Store API and Configuration API.
+
+Both of them have their schemas, listed below.
+
+### Cloud Config Import Schemas
+
+#### Secret Store Component
+
+##### url structure
+
+`dapr:secret:<store-name>[/<secret-name>][?<paramters>]`
+
+###### paramters
+
+|  parameter  | description | default | available |
+|--------------------|--------------------|--------------------|--------------------|
+| type | value type | `value` | `value`/`doc`|
+| doc-type | type of doc | `properties` | `yaml`/`properties`/`or any file extensions you want`|
+
+- when type = `value`, if `secret-name` is specified, will treat secret as the value of property, and `secret-name` as the key of property; if none `secret-name` is specified, will get bulk secret and treat every value of secret as the value of property, and every key of secret as the key of property.
+- when type = `doc`, if `secret-name` is specified, will treat secret as a bunch of property, and load it with property or yaml loader; if none `secret-name` is specified, will get bulk secret and and treat every value of secret as bunches of property, and load them with property or yaml loader.
+- secret store with multiValud = true must specify nestedSeparator = ".", and using type = `doc` is not recommanded
+
+##### demo
+
+###### multiValued = false:
+
+####### store content(file secret store as example)
+
+```json
+{
+	"dapr.spring.demo-config-secret.singlevalue": "testvalue",
+	"multivalue-properties": "dapr.spring.demo-config-secret.multivalue.v1=spring\ndapr.spring.demo-config-secret.multivalue.v2=dapr",
+	"multivalue-yaml": "dapr:\n  spring:\n    demo-config-secret:\n      multivalue:\n        v3: cloud"
+}
+```
+
+####### valid demo url
+
+- `dapr:secret:democonfig/multivalue-properties?type=doc&doc-type=properties`
+- `dapr:secret:democonfig/multivalue-yaml?type=doc&doc-type=yaml`
+- `dapr:secret:democonfig/dapr.spring.demo-config.singlevalue?type=value`
+- `dapr:secret:democonfig?type=value`
+- `dapr:secret:democonfig?type=doc`
+
+###### multiValued = true, nestedSeparator = ".":
+
+####### store content(file secret store as example)
+
+```json
+{
+	"value1": {
+		"dapr": {
+			"spring": {
+				"demo-config-secret": {
+					"multivalue": {
+						"v4": "config"
+					}
+				}
+			}
+		}
+	}
+}
+```
+
+will be read as
+
+```json
+{
+	"value1": {
+		"dapr.spring.demo-config-secret.multivalue.v4": "config"
+	}
+}
+```
+
+####### valid demo url
+- `dapr:secret:demo-config-multi/value1?type=value`
+- `dapr:secret:demo-config-multi?type=value`
+
+#### Configuration Component
+
+##### url structure
+
+`dapr:config:<store-name>[/<key>][?<paramters>]`
+
+###### paramters
+
+|  parameter  | description | default | available |
+|--------------------|--------------------|--------------------|--------------------|
+| type | value type | `value` | `doc`/`value` |
+| doc-type | type of doc | `properties` | `yaml`/`properties`/`or any file extensions you want`|
+| subscribe | subscribe this configuration | `false` | `true`/`false` |
+
+- when subscribe = `true`, will subscribe update for the configuration.
+- when type = `value`, if `key` is specified, will treat config value as the value of property, and `key` as the key of property; if none `key` is specified, will get all key and value in the `config-name` and treat every config value as the value of property, and every `key` as the key of property.
+- when type = `doc`, if `key` is specified, will treat config value as a bunch of property, and load it with property or yaml loader; if none `key` is specified, will get all key and value in the `config-name` and treat every config value as bunches of property, and load them with property or yaml loader.
+
+##### Demo
+
+###### store content(table as example)
+
+| key | value |
+|--------------------|--------------------|
+| dapr.spring.demo-config-config.singlevalue | testvalue |
+| multivalue-properties | `dapr.spring.demo-config-config.multivalue.v1=spring\ndapr.spring.demo-config-config.multivalue.v2=dapr` |
+| multivalue-yaml | `dapr:\n  spring:\n    demo-config-config:\n      multivalue:\n        v3: cloud` |
+
+###### valid demo url
+
+- `dapr:config:democonfigconf/dapr.spring.demo-config-config.singlevalue?type=value`
+- `dapr:config:democonfigconf/multivalue-properties?type=doc&doc-type=properties`
+- `dapr:config:democonfigconf/multivalue-yaml?type=doc&doc-type=yaml`
+- `dapr:config:democonfigconf?type=doc`
+- `dapr:config:democonfigconf?type=value`
 
 ## Next steps
 

sdk-tests/components/secret.json

@@ -1 +1 @@
-{"94022f35-25ab-4ffa-a4a0-9b45b602b50c":{"name":"Jon Doe"},"e1f219a2-2689-4689-a18d-372bdf989b05":{"year":"2020","title":"The Metrics IV"}}
+{"589f54ec-d0b7-40b5-92d9-6ab7ddef3c4f":{"name":"Jon Doe"},"969595f8-859c-4f7d-ae6a-864704f94a10":{"year":"2020","title":"The Metrics IV"}}

sdk-tests/pom.xml

@@ -73,6 +73,7 @@
       <groupId>redis.clients</groupId>
       <artifactId>jedis</artifactId>
       <version>5.2.0</version>
+      <scope>test</scope>
     </dependency>
     <dependency>
       <groupId>io.grpc</groupId>

spring-boot-examples/README.md

@@ -1,12 +1,15 @@
 # Dapr Spring Boot and Testcontainers integration Example
 
-This example consists of two applications:
+This example consists of three applications:
 - Producer App: 
   - Publish messages using a Spring Messaging approach 
   - Store and retrieve information using Spring Data CrudRepository 
   - Implements a Workflow with Dapr Workflows
 - Consumer App:
   - Subscribe to messages
+- Cloud Config Demo:
+  - Import and use configs
+  - Can not run in Kubernetes currently, as lack of redis pre-fill data supported
 
 ## Running these examples from source code
 

spring-boot-examples/cloud-config-demo/components/redisconfigstore.yaml

@@ -0,0 +1,12 @@
+apiVersion: dapr.io/v1alpha1
+kind: Component
+metadata:
+  name: democonfigconf
+spec:
+  type: configuration.redis
+  version: v1
+  metadata:
+  - name: redisHost
+    value: localhost:6379
+  - name: redisPassword
+    value: ""

spring-boot-examples/cloud-config-demo/components/secret-spring/multivalued.json

@@ -0,0 +1,13 @@
+{
+  "value1": {
+    "dapr": {
+      "spring": {
+        "demo-config-secret": {
+          "multivalue": {
+            "v4": "config"
+          }
+        }
+      }
+    }
+  }
+}

spring-boot-examples/cloud-config-demo/components/secret-spring/singlevalued.json

@@ -0,0 +1,5 @@
+{
+  "dapr.spring.demo-config-secret.singlevalue": "testvalue",
+  "multivalue-properties": "dapr.spring.demo-config-secret.multivalue.v1=spring\ndapr.spring.demo-config-secret.multivalue.v2=dapr",
+  "multivalue-yaml": "dapr:\n  spring:\n    demo-config-secret:\n      multivalue:\n        v3: cloud"
+}

spring-boot-examples/cloud-config-demo/components/secretstore-springboot-multivalued.yaml

@@ -0,0 +1,14 @@
+apiVersion: dapr.io/v1alpha1
+kind: Component
+metadata:
+  name: democonfigMultivalued
+spec:
+  type: secretstores.local.file
+  version: v1
+  metadata:
+    - name: secretsFile
+      value: "./components/secret-spring/multivalued.json"
+    - name: nestedSeparator
+      value: "."
+    - name: multiValued
+      value: "true"

spring-boot-examples/cloud-config-demo/components/secretstore-springboot-singlevalued.yaml

@@ -0,0 +1,12 @@
+apiVersion: dapr.io/v1alpha1
+kind: Component
+metadata:
+  name: democonfig
+spec:
+  type: secretstores.local.file
+  version: v1
+  metadata:
+    - name: secretsFile
+      value: "./components/secret-spring/singlevalued.json"
+    - name: multiValued
+      value: "false"

spring-boot-examples/cloud-config-demo/pom.xml

@@ -0,0 +1,90 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+
+  <parent>
+    <groupId>io.dapr</groupId>
+    <artifactId>spring-boot-examples</artifactId>
+    <version>0.15.0-SNAPSHOT</version>
+  </parent>
+
+  <artifactId>cloud-config-demo</artifactId>
+  <name>cloud-config-demo</name>
+  <description>Spring Boot, Testcontainers and Dapr Integration Examples :: Cloud Config Demo</description>
+
+
+  <dependencyManagement>
+    <dependencies>
+      <dependency>
+        <groupId>org.springframework.boot</groupId>
+        <artifactId>spring-boot-dependencies</artifactId>
+        <version>${springboot.version}</version>
+        <type>pom</type>
+        <scope>import</scope>
+      </dependency>
+    </dependencies>
+  </dependencyManagement>
+
+  <dependencies>
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-starter-actuator</artifactId>
+    </dependency>
+
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-starter-web</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>io.dapr.spring</groupId>
+      <artifactId>dapr-spring-boot-starter</artifactId>
+      <version>${dapr.sdk.alpha.version}</version>
+    </dependency>
+    <dependency>
+      <groupId>io.dapr.spring</groupId>
+      <artifactId>dapr-spring-boot-starter-test</artifactId>
+      <version>${dapr.sdk.alpha.version}</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.testcontainers</groupId>
+      <artifactId>junit-jupiter</artifactId>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>redis.clients</groupId>
+      <artifactId>jedis</artifactId>
+      <version>5.2.0</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>com.redis</groupId>
+      <artifactId>testcontainers-redis</artifactId>
+      <version>2.2.4</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>io.rest-assured</groupId>
+      <artifactId>rest-assured</artifactId>
+      <scope>test</scope>
+    </dependency>
+  </dependencies>
+
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.springframework.boot</groupId>
+        <artifactId>spring-boot-maven-plugin</artifactId>
+      </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-site-plugin</artifactId>
+        <version>3.12.1</version>
+        <configuration>
+          <skip>true</skip>
+        </configuration>
+      </plugin>
+    </plugins>
+  </build>
+</project>