From e885442eab15da70d0c84b1796c66783502d59db Mon Sep 17 00:00:00 2001 From: salaboy Date: Wed, 12 Jul 2023 14:38:56 +0100 Subject: [PATCH] Update README.md --- README.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index c1b5a34..e216a5b 100644 --- a/README.md +++ b/README.md @@ -2,36 +2,35 @@ Dapr Ambient allows you to create Dapr Applications using the `daprd` Sidecar as a Kubernetes `Daemonset` or `Deployment`. This enables other use cases where Sidecars are not the best option. -By running `daprd` as a Kubernetes `DaemonSet` (or as a `Deployment`) the `daprd` container will be running in each Kubernetes Node, reducing the network hops between the applications and Dapr. +By running `daprd` as a Kubernetes `DaemonSet` (or as a `Deployment`), the `daprd` container will be running in each Kubernetes Node, reducing the network hops between the applications and Dapr. -If you need multiple Dapr Applications you can deploy this chart multiple times using different `ambient.appId`s. +If you need multiple Dapr Applications, you can deploy this chart multiple times using different `ambient.appId`s. ## Getting Started -Before you install Dapr Ambient, please make sure you have Dapr installed in your cluster. +Before installing Dapr Ambient, please ensure you have Dapr installed in your cluster. -If you want to get started with Dapr Ambient you can easily create a new Dapr Ambient instance by install the oficial Helm Chart: +If you want to get started with Dapr Ambient, you can easily create a new Dapr Ambient instance by installing the official Helm Chart: ``` helm install my-ambient-dapr-ambient oci://registry-1.docker.io/daprio/dapr-ambient-chart --set ambient.appId= --set ambient.remoteURL= ``` -If you want to take a look at a step by step tutorial using some applications and interacting with Dapr Components check out the [step-by-step tutorial using Kubernetes KinD here](tutorial/README.md). +If you want to take a look at a step by step tutorial using some applications and interacting with Dapr Components, check out the [step-by-step tutorial using Kubernetes KinD here](tutorial/README.md). ## From Source To deploy this chart from source you can run from inside the `chart/dapr-ambient` directory: ``` -helm install my-ambient . --set ambient.appId= --set ambient.channelAddress= +helm install my-ambient . --set ambient.appId= --set ambient.remoteURL= -``` -Where `` is the Dapr App Id that you can use in your components (for example for scopes) +``` -and `` is a reachable URL where `dapr-ambient` will forward notifications received by the Dapr sidecar. +Where `` is the Dapr App Id that you can use in your components (for example, for scopes) and `` is a reachable URL where `dapr-ambient` will forward notifications received by the Dapr sidecar. -Future versions might include forwarding notifications to multiple remote URLs. +Future versions include forwarding notifications to multiple remote URLs. ## Customize Dapr Ambient Is possible to customize Dapr Ambient using custom Helm values.