Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
salaboy authored Jul 12, 2023
1 parent 8d6d362 commit e885442
Showing 1 changed file with 9 additions and 10 deletions.
19 changes: 9 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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=<DAPR_APP_ID> --set ambient.remoteURL=<REMOTE_URL>
```

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=<DAPR_APP_ID> --set ambient.channelAddress=<REMOTE_URL>
helm install my-ambient . --set ambient.appId=<DAPR_APP_ID> --set ambient.remoteURL=<REMOTE_URL>
```
Where `<DAPR_APP_ID>` is the Dapr App Id that you can use in your components (for example for scopes)
```

and `<REMOTE_URL>` is a reachable URL where `dapr-ambient` will forward notifications received by the Dapr sidecar.
Where `<DAPR_APP_ID>` is the Dapr App Id that you can use in your components (for example, for scopes) and `<REMOTE_URL>` 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.
Expand Down

0 comments on commit e885442

Please sign in to comment.