mirror of https://github.com/dapr/docs.git
Configuration API quickstart docs (#3009)
* new configuration api quickstart Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com> * add new file Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com> * updates per sarthak Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com> * add diagram Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com> * updates per Mark Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com> Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>
This commit is contained in:
Hannah Hunter
GitHub
parent
d8bbfa5378
commit
36743211b0
|
|
@ -6,17 +6,40 @@ weight: 1000
|
|||
description: "Overview of the configuration API building block"
|
||||
---
|
||||
|
||||
## Introduction
|
||||
Consuming application configuration is a common task when writing applications. Frequently, configuration stores are used to manage this configuration data. A configuration item is often dynamic in nature and tightly coupled to the needs of the application that consumes it.
|
||||
|
||||
Consuming application configuration is a common task when writing applications and frequently configuration stores are used to manage this configuration data. A configuration item is often dynamic in nature and is tightly coupled to the needs of the application that consumes it. For example, common uses for application configuration include names of secrets, different identifiers, partition or consumer IDs, names of databases to connect to etc. These configuration items are typically stored as key/value items in a state store or database. Application configuration can be changed by either developers or operators at runtime and the developer needs to be notified of these changes in order to take the required action and load the new configuration. Also configuration data is typically read only from the application API perspective, with updates to the configuration store made through operator tooling. Dapr's configuration API allows developers to consume configuration items that are returned as read only key/value pairs and subscribe to changes whenever a configuration item changes.
|
||||
For example, application configuration can include:
|
||||
- Names of secrets
|
||||
- Different identifiers
|
||||
- Partition or consumer IDs
|
||||
- Names of databases to connect to, etc
|
||||
|
||||
Usually, configuration items are stored as key/value items in a state store or database. Developers or operators can change application configuration at runtime in the configuration store. Once changes are made, a service is notified to load the new configuration.
|
||||
|
||||
Configuration data is read-only from the application API perspective, with updates to the configuration store made through operator tooling. With Dapr's configuration API, you can:
|
||||
- Consume configuration items that are returned as read-only key/value pairs
|
||||
- Subscribe to changes whenever a configuration item changes
|
||||
|
||||
<img src="/images/configuration-api-overview.png" width=900>
|
||||
|
||||
It is worth noting that this configuration API should not be confused with the [Dapr sidecar and control plane configuration]({{<ref "configuration-overview">}}) which is used to set policies and settings on instances of Dapr sidecars or the installed Dapr control plane.
|
||||
{{% alert title="Note" color="primary" %}}
|
||||
The Configuration API should not be confused with the [Dapr sidecar and control plane configuration]({{< ref "configuration-overview" >}}), which is used to set policies and settings on Dapr sidecar instances or the installed Dapr control plane.
|
||||
{{% /alert %}}
|
||||
|
||||
*This API is currently in `Alpha` state*
|
||||
## Try out configuration
|
||||
|
||||
### Quickstart
|
||||
|
||||
Want to put the Dapr configuration API to the test? Walk through the following quickstart to see the configuration API in action:
|
||||
|
||||
| Quickstart | Description |
|
||||
| ---------- | ----------- |
|
||||
| [Configuration quickstart]({{< ref configuration-quickstart.md >}}) | Get configuration items or subscribe to configuration changes using the configuration API. |
|
||||
|
||||
### Start using the configuration API directly in your app
|
||||
|
||||
Want to skip the quickstarts? Not a problem. You can try out the configuration building block directly in your application to read and manage configuration data. After [Dapr is installed]({{< ref "getting-started/_index.md" >}}), you can begin using the configuration API starting with [the configuration how-to guide]({{< ref howto-manage-configuration.md >}}).
|
||||
|
||||
## Features
|
||||
|
||||
## Next steps
|
||||
Follow these guides on:
|
||||
|
|
|
|||
|
|
@ -8,12 +8,13 @@ description: "Learn how to get application configuration and subscribe for chang
|
|||
|
||||
This example uses the Redis configuration store component to demonstrate how to retrieve a configuration item.
|
||||
|
||||
<img src="/images/building-block-configuration-example.png" width=1000 alt="Diagram showing get configuration of example service">
|
||||
|
||||
{{% alert title="Note" color="primary" %}}
|
||||
This API is currently in `Alpha` state and only available on gRPC. An HTTP1.1 supported version with this URL syntax `/v1.0/configuration` will be available before the API is certified into `Stable` state.
|
||||
If you haven't already, [try out the configuration quickstart]({{< ref configuration-quickstart.md >}}) for a quick walk-through on how to use the configuration API.
|
||||
|
||||
{{% /alert %}}
|
||||
|
||||
<img src="/images/building-block-configuration-example.png" width=1000 alt="Diagram showing get configuration of example service">
|
||||
|
||||
## Create a configuration item in store
|
||||
|
||||
|
|
@ -68,7 +69,7 @@ spec:
|
|||
## Retrieve Configuration Items
|
||||
### Get configuration items using Dapr SDKs
|
||||
|
||||
{{< tabs Dotnet Java Python>}}
|
||||
{{< tabs ".NET" Java Python>}}
|
||||
|
||||
{{% codetab %}}
|
||||
|
||||
|
|
@ -304,7 +305,7 @@ asyncio.run(executeConfiguration())
|
|||
```
|
||||
|
||||
```bash
|
||||
dapr run --app-id orderprocessing --components-path components/ -- python3 OrderProcessingService.py
|
||||
dapr run --app-id orderprocessing --resources-path components/ -- python3 OrderProcessingService.py
|
||||
```
|
||||
|
||||
{{% /codetab %}}
|
||||
|
|
|
|||
|
|
@ -27,4 +27,5 @@ Hit the ground running with our Dapr quickstarts, complete with code samples aim
|
|||
| [State Management]({{< ref statemanagement-quickstart.md >}}) | Store a service's data as key/value pairs in supported state stores. |
|
||||
| [Bindings]({{< ref bindings-quickstart.md >}}) | Work with external systems using input bindings to respond to events and output bindings to call operations. |
|
||||
| [Secrets Management]({{< ref secrets-quickstart.md >}}) | Securely fetch secrets. |
|
||||
| [Configuration]({{< ref configuration-quickstart.md >}}) | Get configuration items and subscribe for configuration updates. |
|
||||
| [Resiliency]({{< ref resiliency >}}) | Define and apply fault-tolerance policies to your Dapr API requests. |
|
||||
|
|
|
|||
|
|
@ -0,0 +1,639 @@
|
|||
---
|
||||
type: docs
|
||||
title: "Quickstart: Configuration"
|
||||
linkTitle: Configuration
|
||||
weight: 76
|
||||
description: Get started with Dapr's Configuration building block
|
||||
---
|
||||
|
||||
Let's take a look at Dapr's [Configuration building block]({{< ref configuration-api-overview.md >}}). A configuration item is often dynamic in nature and tightly coupled to the needs of the application that consumes it. Configuration items are key/value pairs containing configuration data, such as:
|
||||
- App ids
|
||||
- Partition keys
|
||||
- Database names, etc
|
||||
|
||||
In this quickstart, you'll run an `order-processor` microservice that utilizes the Configuration API. The service:
|
||||
1. Gets configuration items from the configuration store.
|
||||
1. Subscribes for configuration updates.
|
||||
|
||||
<img src="/images/configuration-quickstart/configuration-quickstart-flow.png" width=1000 alt="Diagram that demonstrates the flow of the configuration API quickstart with key/value pairs used.">
|
||||
|
||||
Select your preferred language-specific Dapr SDK before proceeding with the Quickstart.
|
||||
|
||||
{{< tabs "Python" "JavaScript" ".NET" "Java" "Go" >}}
|
||||
<!-- Python -->
|
||||
{{% codetab %}}
|
||||
|
||||
### Pre-requisites
|
||||
|
||||
For this example, you will need:
|
||||
|
||||
- [Dapr CLI and initialized environment](https://docs.dapr.io/getting-started).
|
||||
- [Python 3.7+ installed](https://www.python.org/downloads/).
|
||||
<!-- IGNORE_LINKS -->
|
||||
- [Docker Desktop](https://www.docker.com/products/docker-desktop)
|
||||
<!-- END_IGNORE -->
|
||||
|
||||
### Step 1: Set up the environment
|
||||
|
||||
Clone the [sample provided in the Quickstarts repo](https://github.com/dapr/quickstarts/tree/master/configuration).
|
||||
|
||||
```bash
|
||||
git clone https://github.com/dapr/quickstarts.git
|
||||
```
|
||||
|
||||
Once cloned, open a new terminal and run the following command to set values for configuration items `orderId1` and `orderId2`.
|
||||
|
||||
```bash
|
||||
docker exec dapr_redis redis-cli MSET orderId1 "101" orderId2 "102"
|
||||
```
|
||||
|
||||
### Step 2: Run the `order-processor` service
|
||||
|
||||
From the root of the Quickstarts clone directory, navigate to the `order-processor` directory.
|
||||
|
||||
```bash
|
||||
cd ./configuration/python/sdk/order-processor
|
||||
```
|
||||
|
||||
Install the dependencies:
|
||||
|
||||
```bash
|
||||
pip3 install -r requirements.txt
|
||||
```
|
||||
|
||||
Run the `order-processor` service alongside a Dapr sidecar.
|
||||
|
||||
```bash
|
||||
dapr run --app-id order-processor --resources-path ../../../components/ --app-port 6001 -- python3 app.py
|
||||
```
|
||||
|
||||
> **Note**: Since Python3.exe is not defined in Windows, you may need to use `python app.py` instead of `python3 app.py`.
|
||||
|
||||
The expected output:
|
||||
|
||||
```
|
||||
== APP == Configuration for orderId1 : value: "101"
|
||||
== APP ==
|
||||
== APP == Configuration for orderId2 : value: "102"
|
||||
== APP ==
|
||||
== APP == App unsubscribed from config changes
|
||||
```
|
||||
|
||||
### (Optional) Step 3: Update configuration item values
|
||||
|
||||
Once the app has unsubscribed, try updating the configuration item values. Change the `orderId1` and `orderId2` values using the following command:
|
||||
|
||||
```bash
|
||||
docker exec dapr_redis redis-cli MSET orderId1 "103" orderId2 "104"
|
||||
```
|
||||
|
||||
Run the `order-processor` service again:
|
||||
|
||||
```bash
|
||||
dapr run --app-id order-processor --resources-path ../../../components/ --app-port 6001 -- python3 app.py
|
||||
```
|
||||
|
||||
> **Note**: Since Python3.exe is not defined in Windows, you may need to use `python app.py` instead of `python3 app.py`.
|
||||
|
||||
The app will return the updated configuration values:
|
||||
|
||||
```
|
||||
== APP == Configuration for orderId1 : value: "103"
|
||||
== APP ==
|
||||
== APP == Configuration for orderId2 : value: "104"
|
||||
== APP ==
|
||||
```
|
||||
|
||||
### The `order-processor` service
|
||||
|
||||
The `order-processor` service includes code for:
|
||||
- Getting the configuration items from the config store
|
||||
- Subscribing to configuration updates (which you made in the CLI earlier)
|
||||
- Unsubscribing from configuration updates and exiting the app after 20 seconds of inactivity.
|
||||
|
||||
Get configuration items:
|
||||
|
||||
```python
|
||||
# Get config items from the config store
|
||||
for config_item in CONFIGURATION_ITEMS:
|
||||
config = client.get_configuration(store_name=DAPR_CONFIGURATION_STORE, keys=[config_item], config_metadata={})
|
||||
print(f"Configuration for {config_item} : {config.items[config_item]}", flush=True)
|
||||
```
|
||||
|
||||
Subscribe to configuration updates:
|
||||
|
||||
```python
|
||||
# Subscribe for configuration changes
|
||||
configuration = await client.subscribe_configuration(DAPR_CONFIGURATION_STORE, CONFIGURATION_ITEMS)
|
||||
```
|
||||
|
||||
Unsubscribe from configuration updates and exit the application:
|
||||
|
||||
```python
|
||||
# Unsubscribe from configuration updates
|
||||
unsubscribed = True
|
||||
for config_item in CONFIGURATION_ITEMS:
|
||||
unsub_item = client.unsubscribe_configuration(DAPR_CONFIGURATION_STORE, config_item)
|
||||
#...
|
||||
if unsubscribed == True:
|
||||
print("App unsubscribed from config changes", flush=True)
|
||||
```
|
||||
|
||||
|
||||
{{% /codetab %}}
|
||||
|
||||
|
||||
<!-- JavaScript -->
|
||||
{{% codetab %}}
|
||||
|
||||
### Pre-requisites
|
||||
|
||||
For this example, you will need:
|
||||
|
||||
- [Dapr CLI and initialized environment](https://docs.dapr.io/getting-started).
|
||||
- [Python 3.7+ installed](https://www.python.org/downloads/).
|
||||
<!-- IGNORE_LINKS -->
|
||||
- [Docker Desktop](https://www.docker.com/products/docker-desktop)
|
||||
<!-- END_IGNORE -->
|
||||
|
||||
### Step 1: Set up the environment
|
||||
|
||||
Clone the [sample provided in the Quickstarts repo](https://github.com/dapr/quickstarts/tree/master/configuration).
|
||||
|
||||
```bash
|
||||
git clone https://github.com/dapr/quickstarts.git
|
||||
```
|
||||
|
||||
Once cloned, open a new terminal and run the following command to set values for configuration items `orderId1` and `orderId2`.
|
||||
|
||||
```bash
|
||||
docker exec dapr_redis redis-cli MSET orderId1 "101" orderId2 "102"
|
||||
```
|
||||
|
||||
### Step 2: Run the `order-processor` service
|
||||
|
||||
From the root of the Quickstarts clone directory, navigate to the `order-processor` directory.
|
||||
|
||||
```bash
|
||||
cd ./configuration/javascript/sdk/order-processor
|
||||
```
|
||||
|
||||
Install the dependencies:
|
||||
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
Run the `order-processor` service alongside a Dapr sidecar.
|
||||
|
||||
```bash
|
||||
dapr run --app-id order-processor --resources-path ../../../components/ --app-protocol grpc --dapr-grpc-port 3500 -- node index.js
|
||||
```
|
||||
|
||||
The expected output:
|
||||
|
||||
```
|
||||
== APP == Configuration for orderId1: {"key":"orderId1","value":"101","version":"","metadata":{}}
|
||||
== APP == Configuration for orderId2: {"key":"orderId2","value":"102","version":"","metadata":{}}
|
||||
== APP == App unsubscribed to config changes
|
||||
```
|
||||
|
||||
### (Optional) Step 3: Update configuration item values
|
||||
|
||||
Once the app has unsubscribed, try updating the configuration item values. Change the `orderId1` and `orderId2` values using the following command:
|
||||
|
||||
```bash
|
||||
docker exec dapr_redis redis-cli MSET orderId1 "103" orderId2 "104"
|
||||
```
|
||||
|
||||
Run the `order-processor` service again:
|
||||
|
||||
```bash
|
||||
dapr run --app-id order-processor --resources-path ../../../components/ --app-protocol grpc --dapr-grpc-port 3500 -- node index.js
|
||||
```
|
||||
|
||||
The app will return the updated configuration values:
|
||||
|
||||
```
|
||||
== APP == Configuration for orderId1: {"key":"orderId1","value":"103","version":"","metadata":{}}
|
||||
== APP == Configuration for orderId2: {"key":"orderId2","value":"104","version":"","metadata":{}}
|
||||
```
|
||||
|
||||
### The `order-processor` service
|
||||
|
||||
The `order-processor` service includes code for:
|
||||
- Getting the configuration items from the config store
|
||||
- Subscribing to configuration updates (which you made in the CLI earlier)
|
||||
- Unsubscribing from configuration updates and exiting the app after 20 seconds of inactivity.
|
||||
|
||||
Get configuration items:
|
||||
|
||||
```javascript
|
||||
// Get config items from the config store
|
||||
//...
|
||||
const config = await client.configuration.get(DAPR_CONFIGURATION_STORE, CONFIGURATION_ITEMS);
|
||||
Object.keys(config.items).forEach((key) => {
|
||||
console.log("Configuration for " + key + ":", JSON.stringify(config.items[key]));
|
||||
});
|
||||
```
|
||||
|
||||
Subscribe to configuration updates:
|
||||
|
||||
```javascript
|
||||
// Subscribe to config updates
|
||||
try {
|
||||
const stream = await client.configuration.subscribeWithKeys(
|
||||
DAPR_CONFIGURATION_STORE,
|
||||
CONFIGURATION_ITEMS,
|
||||
(config) => {
|
||||
console.log("Configuration update", JSON.stringify(config.items));
|
||||
}
|
||||
);
|
||||
```
|
||||
|
||||
Unsubscribe from configuration updates and exit the application:
|
||||
|
||||
```javascript
|
||||
// Unsubscribe to config updates and exit app after 20 seconds
|
||||
setTimeout(() => {
|
||||
stream.stop();
|
||||
console.log("App unsubscribed to config changes");
|
||||
process.exit(0);
|
||||
},
|
||||
```
|
||||
|
||||
{{% /codetab %}}
|
||||
|
||||
<!-- .NET -->
|
||||
{{% codetab %}}
|
||||
|
||||
### Pre-requisites
|
||||
|
||||
For this example, you will need:
|
||||
|
||||
- [Dapr CLI and initialized environment](https://docs.dapr.io/getting-started).
|
||||
- [.NET SDK or .NET 6 SDK installed](https://dotnet.microsoft.com/download).
|
||||
<!-- IGNORE_LINKS -->
|
||||
- [Docker Desktop](https://www.docker.com/products/docker-desktop)
|
||||
<!-- END_IGNORE -->
|
||||
|
||||
### Step 1: Set up the environment
|
||||
|
||||
Clone the [sample provided in the Quickstarts repo](https://github.com/dapr/quickstarts/tree/master/configuration).
|
||||
|
||||
```bash
|
||||
git clone https://github.com/dapr/quickstarts.git
|
||||
```
|
||||
|
||||
Once cloned, open a new terminal and run the following command to set values for configuration items `orderId1` and `orderId2`.
|
||||
|
||||
```bash
|
||||
docker exec dapr_redis redis-cli MSET orderId1 "101" orderId2 "102"
|
||||
```
|
||||
|
||||
### Step 2: Run the `order-processor` service
|
||||
|
||||
From the root of the Quickstarts clone directory, navigate to the `order-processor` directory.
|
||||
|
||||
```bash
|
||||
cd ./configuration/csharp/sdk/order-processor
|
||||
```
|
||||
|
||||
Recall NuGet packages:
|
||||
|
||||
```bash
|
||||
dotnet restore
|
||||
dotnet build
|
||||
```
|
||||
|
||||
Run the `order-processor` service alongside a Dapr sidecar.
|
||||
|
||||
```bash
|
||||
dapr run --app-id order-processor-http --resources-path ../../../components/ --app-port 7001 -- dotnet run --project .
|
||||
```
|
||||
|
||||
The expected output:
|
||||
|
||||
```
|
||||
== APP == Configuration for orderId1: {"Value":"101","Version":"","Metadata":{}}
|
||||
== APP == Configuration for orderId2: {"Value":"102","Version":"","Metadata":{}}
|
||||
== APP == App unsubscribed from config changes
|
||||
```
|
||||
|
||||
### (Optional) Step 3: Update configuration item values
|
||||
|
||||
Once the app has unsubscribed, try updating the configuration item values. Change the `orderId1` and `orderId2` values using the following command:
|
||||
|
||||
```bash
|
||||
docker exec dapr_redis redis-cli MSET orderId1 "103" orderId2 "104"
|
||||
```
|
||||
|
||||
Run the `order-processor` service again:
|
||||
|
||||
```bash
|
||||
dapr run --app-id order-processor-http --resources-path ../../../components/ --app-port 7001 -- dotnet run --project .
|
||||
```
|
||||
|
||||
The app will return the updated configuration values:
|
||||
|
||||
```
|
||||
== APP == Configuration for orderId1: {"Value":"103","Version":"","Metadata":{}}
|
||||
== APP == Configuration for orderId2: {"Value":"104","Version":"","Metadata":{}}
|
||||
```
|
||||
|
||||
### The `order-processor` service
|
||||
|
||||
The `order-processor` service includes code for:
|
||||
- Getting the configuration items from the config store
|
||||
- Subscribing to configuration updates (which you made in the CLI earlier)
|
||||
- Unsubscribing from configuration updates and exiting the app after 20 seconds of inactivity.
|
||||
|
||||
Get configuration items:
|
||||
|
||||
```csharp
|
||||
// Get config from configuration store
|
||||
GetConfigurationResponse config = await client.GetConfiguration(DAPR_CONFIGURATION_STORE, CONFIGURATION_ITEMS);
|
||||
foreach (var item in config.Items)
|
||||
{
|
||||
var cfg = System.Text.Json.JsonSerializer.Serialize(item.Value);
|
||||
Console.WriteLine("Configuration for " + item.Key + ": " + cfg);
|
||||
}
|
||||
```
|
||||
|
||||
Subscribe to configuration updates:
|
||||
|
||||
```csharp
|
||||
// Subscribe to config updates
|
||||
SubscribeConfigurationResponse subscribe = await client.SubscribeConfiguration(DAPR_CONFIGURATION_STORE, CONFIGURATION_ITEMS);
|
||||
```
|
||||
|
||||
Unsubscribe from configuration updates and exit the application:
|
||||
|
||||
```csharp
|
||||
// Unsubscribe to config updates and exit the app
|
||||
try
|
||||
{
|
||||
client.UnsubscribeConfiguration(DAPR_CONFIGURATION_STORE, subscriptionId);
|
||||
Console.WriteLine("App unsubscribed from config changes");
|
||||
Environment.Exit(0);
|
||||
}
|
||||
```
|
||||
|
||||
{{% /codetab %}}
|
||||
|
||||
<!-- Java -->
|
||||
{{% codetab %}}
|
||||
|
||||
### Pre-requisites
|
||||
|
||||
For this example, you will need:
|
||||
|
||||
- [Dapr CLI and initialized environment](https://docs.dapr.io/getting-started).
|
||||
- Java JDK 11 (or greater):
|
||||
- [Oracle JDK](https://www.oracle.com/technetwork/java/javase/downloads/index.html#JDK11), or
|
||||
- OpenJDK
|
||||
- [Apache Maven](https://maven.apache.org/install.html), version 3.x.
|
||||
<!-- IGNORE_LINKS -->
|
||||
- [Docker Desktop](https://www.docker.com/products/docker-desktop)
|
||||
<!-- END_IGNORE -->
|
||||
|
||||
### Step 1: Set up the environment
|
||||
|
||||
Clone the [sample provided in the Quickstarts repo](https://github.com/dapr/quickstarts/tree/master/configuration).
|
||||
|
||||
```bash
|
||||
git clone https://github.com/dapr/quickstarts.git
|
||||
```
|
||||
|
||||
Once cloned, open a new terminal and run the following command to set values for configuration items `orderId1` and `orderId2`.
|
||||
|
||||
```bash
|
||||
docker exec dapr_redis redis-cli MSET orderId1 "101" orderId2 "102"
|
||||
```
|
||||
|
||||
### Step 2: Run the `order-processor` service
|
||||
|
||||
From the root of the Quickstarts clone directory, navigate to the `order-processor` directory.
|
||||
|
||||
```bash
|
||||
cd ./configuration/java/sdk/order-processor
|
||||
```
|
||||
|
||||
Install the dependencies:
|
||||
|
||||
```bash
|
||||
mvn clean install
|
||||
```
|
||||
|
||||
Run the `order-processor` service alongside a Dapr sidecar.
|
||||
|
||||
```bash
|
||||
dapr run --app-id order-processor --resources-path ../../../components -- java -jar target/OrderProcessingService-0.0.1-SNAPSHOT.jar
|
||||
```
|
||||
|
||||
The expected output:
|
||||
|
||||
```
|
||||
== APP == Configuration for orderId1: {'value':'101'}
|
||||
== APP == Configuration for orderId2: {'value':'102'}
|
||||
== APP == App unsubscribed to config changes
|
||||
```
|
||||
|
||||
### (Optional) Step 3: Update configuration item values
|
||||
|
||||
Once the app has unsubscribed, try updating the configuration item values. Change the `orderId1` and `orderId2` values using the following command:
|
||||
|
||||
```bash
|
||||
docker exec dapr_redis redis-cli MSET orderId1 "103" orderId2 "104"
|
||||
```
|
||||
|
||||
Run the `order-processor` service again:
|
||||
|
||||
```bash
|
||||
dapr run --app-id order-processor --resources-path ../../../components -- java -jar target/OrderProcessingService-0.0.1-SNAPSHOT.jar
|
||||
```
|
||||
|
||||
The app will return the updated configuration values:
|
||||
|
||||
```
|
||||
== APP == Configuration for orderId1: {'value':'103'}
|
||||
== APP == Configuration for orderId2: {'value':'104'}
|
||||
```
|
||||
|
||||
### The `order-processor` service
|
||||
|
||||
The `order-processor` service includes code for:
|
||||
- Getting the configuration items from the config store
|
||||
- Subscribing to configuration updates (which you made in the CLI earlier)
|
||||
- Unsubscribing from configuration updates and exiting the app after 20 seconds of inactivity.
|
||||
|
||||
Get configuration items:
|
||||
|
||||
```java
|
||||
// Get config items from the config store
|
||||
try (DaprPreviewClient client = (new DaprClientBuilder()).buildPreviewClient()) {
|
||||
for (String configurationItem : CONFIGURATION_ITEMS) {
|
||||
ConfigurationItem item = client.getConfiguration(DAPR_CONFIGURATON_STORE, configurationItem).block();
|
||||
System.out.println("Configuration for " + configurationItem + ": {'value':'" + item.getValue() + "'}");
|
||||
}
|
||||
```
|
||||
|
||||
Subscribe to configuration updates:
|
||||
|
||||
```java
|
||||
// Subscribe for config changes
|
||||
Flux<SubscribeConfigurationResponse> subscription = client.subscribeConfiguration(DAPR_CONFIGURATON_STORE,
|
||||
CONFIGURATION_ITEMS.toArray(String[]::new));
|
||||
```
|
||||
|
||||
Unsubscribe from configuration updates and exit the application:
|
||||
|
||||
```java
|
||||
// Unsubscribe from config changes
|
||||
UnsubscribeConfigurationResponse unsubscribe = client
|
||||
.unsubscribeConfiguration(subscriptionId, DAPR_CONFIGURATON_STORE).block();
|
||||
if (unsubscribe.getIsUnsubscribed()) {
|
||||
System.out.println("App unsubscribed to config changes");
|
||||
}
|
||||
```
|
||||
|
||||
{{% /codetab %}}
|
||||
|
||||
<!-- Go -->
|
||||
{{% codetab %}}
|
||||
|
||||
### Pre-requisites
|
||||
|
||||
For this example, you will need:
|
||||
|
||||
- [Dapr CLI and initialized environment](https://docs.dapr.io/getting-started).
|
||||
- [Latest version of Go](https://go.dev/dl/).
|
||||
<!-- IGNORE_LINKS -->
|
||||
- [Docker Desktop](https://www.docker.com/products/docker-desktop)
|
||||
<!-- END_IGNORE -->
|
||||
|
||||
### Step 1: Set up the environment
|
||||
|
||||
Clone the [sample provided in the Quickstarts repo](https://github.com/dapr/quickstarts/tree/master/configuration).
|
||||
|
||||
```bash
|
||||
git clone https://github.com/dapr/quickstarts.git
|
||||
```
|
||||
|
||||
Once cloned, open a new terminal and run the following command to set values for configuration items `orderId1` and `orderId2`.
|
||||
|
||||
```bash
|
||||
docker exec dapr_redis redis-cli MSET orderId1 "101" orderId2 "102"
|
||||
```
|
||||
|
||||
### Step 2: Run the `order-processor` service
|
||||
|
||||
From the root of the Quickstarts clone directory, navigate to the `order-processor` directory.
|
||||
|
||||
```bash
|
||||
cd ./configuration/go/sdk/order-processor
|
||||
```
|
||||
|
||||
Run the `order-processor` service alongside a Dapr sidecar.
|
||||
|
||||
```bash
|
||||
dapr run --app-id order-processor --app-port 6001 --resources-path ../../../components -- go run .
|
||||
```
|
||||
|
||||
The expected output:
|
||||
|
||||
```
|
||||
== APP == Configuration for orderId1: {"Value":"101","Version":"","Metadata":null}
|
||||
== APP == Configuration for orderId2: {"Value":"102","Version":"","Metadata":null}
|
||||
== APP == dapr configuration subscribe finished.
|
||||
== APP == App unsubscribed to config changes
|
||||
```
|
||||
|
||||
### (Optional) Step 3: Update configuration item values
|
||||
|
||||
Once the app has unsubscribed, try updating the configuration item values. Change the `orderId1` and `orderId2` values using the following command:
|
||||
|
||||
```bash
|
||||
docker exec dapr_redis redis-cli MSET orderId1 "103" orderId2 "104"
|
||||
```
|
||||
|
||||
Run the `order-processor` service again:
|
||||
|
||||
```bash
|
||||
dapr run --app-id order-processor --app-port 6001 --resources-path ../../../components -- go run .
|
||||
```
|
||||
|
||||
The app will return the updated configuration values:
|
||||
|
||||
```
|
||||
== APP == Configuration for orderId1: {"Value":"103","Version":"","Metadata":null}
|
||||
== APP == Configuration for orderId2: {"Value":"104","Version":"","Metadata":null}
|
||||
```
|
||||
|
||||
### The `order-processor` service
|
||||
|
||||
The `order-processor` service includes code for:
|
||||
- Getting the configuration items from the config store
|
||||
- Subscribing to configuration updates (which you made in the CLI earlier)
|
||||
- Unsubscribing from configuration updates and exiting the app after 20 seconds of inactivity.
|
||||
|
||||
Get configuration items:
|
||||
|
||||
```go
|
||||
// Get config items from config store
|
||||
for _, item := range CONFIGURATION_ITEMS {
|
||||
config, err := client.GetConfigurationItem(ctx, DAPR_CONFIGURATION_STORE, item)
|
||||
//...
|
||||
c, _ := json.Marshal(config)
|
||||
fmt.Println("Configuration for " + item + ": " + string(c))
|
||||
}
|
||||
```
|
||||
|
||||
Subscribe to configuration updates:
|
||||
|
||||
```go
|
||||
// Subscribe for config changes
|
||||
err = client.SubscribeConfigurationItems(ctx, DAPR_CONFIGURATION_STORE, CONFIGURATION_ITEMS, func(id string, config map[string]*dapr.ConfigurationItem) {
|
||||
// First invocation when app subscribes to config changes only returns subscription id
|
||||
if len(config) == 0 {
|
||||
fmt.Println("App subscribed to config changes with subscription id: " + id)
|
||||
subscriptionId = id
|
||||
return
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
Unsubscribe from configuration updates and exit the application:
|
||||
|
||||
```go
|
||||
// Unsubscribe to config updates and exit app after 20 seconds
|
||||
select {
|
||||
case <-ctx.Done():
|
||||
err = client.UnsubscribeConfigurationItems(context.Background(), DAPR_CONFIGURATION_STORE, subscriptionId)
|
||||
//...
|
||||
{
|
||||
fmt.Println("App unsubscribed to config changes")
|
||||
}
|
||||
```
|
||||
|
||||
{{% /codetab %}}
|
||||
|
||||
{{< /tabs >}}
|
||||
|
||||
## Tell us what you think!
|
||||
|
||||
We're continuously working to improve our Quickstart examples and value your feedback. Did you find this quickstart helpful? Do you have suggestions for improvement?
|
||||
|
||||
Join the discussion in our [discord channel](https://discord.com/channels/778680217417809931/953427615916638238).
|
||||
|
||||
## Next steps
|
||||
|
||||
- Use Dapr Configuration with HTTP instead of an SDK.
|
||||
- [Python](https://github.com/dapr/quickstarts/tree/master/configuration/python/http)
|
||||
- [JavaScript](https://github.com/dapr/quickstarts/tree/master/configuration/javascript/http)
|
||||
- [.NET](https://github.com/dapr/quickstarts/tree/master/configuration/csharp/http)
|
||||
- [Java](https://github.com/dapr/quickstarts/tree/master/configuration/java/http)
|
||||
- [Go](https://github.com/dapr/quickstarts/tree/master/configuration/go/http)
|
||||
- Learn more about [Configuration building block]({{< ref configuration-api-overview >}})
|
||||
|
||||
{{< button text="Explore Dapr tutorials >>" page="getting-started/tutorials/_index.md" >}}
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 30 KiB |
Loading…
Reference in New Issue