mirror of https://github.com/dapr/docs.git
Latest changes from v1.1
This commit is contained in:
Ori Zohar
commit
4bc273f7c1
|
|
@ -0,0 +1 @@
|
|||
node_modules/
|
||||
|
|
@ -127,6 +127,10 @@ As an example, for this specific section the complete reference to the page and
|
|||
{{</* ref "contributing-docs.md#referencing-sections-in-other-pages" */>}}
|
||||
```
|
||||
|
||||
## Shortcodes
|
||||
|
||||
The following are useful shortcodes for writing Dapr documentation
|
||||
|
||||
### Images
|
||||
The markdown spec used by Docsy and Hugo does not give an option to resize images using markdown notation. Instead, raw HTML is used.
|
||||
|
||||
|
|
@ -230,6 +234,46 @@ The shortcode would be:
|
|||
{{</* youtube dQw4w9WgXcQ */>}}
|
||||
```
|
||||
|
||||
### Buttons
|
||||
|
||||
To create a button in a webpage, use the `button` shortcode.
|
||||
|
||||
#### Link to an external page
|
||||
|
||||
```
|
||||
{{</* button text="My Button" link="https://example.com" */>}}
|
||||
```
|
||||
|
||||
{{< button text="My Button" link="https://example.com" >}}
|
||||
|
||||
#### Link to another docs page
|
||||
|
||||
You can also reference pages in your button as well:
|
||||
```
|
||||
{{</* button text="My Button" page="contributing" */>}}
|
||||
```
|
||||
|
||||
{{< button text="My Button" page="contributing" >}}
|
||||
|
||||
#### Button colors
|
||||
|
||||
You can customize the colors using the Bootstrap colors:
|
||||
```
|
||||
{{</* button text="My Button" link="https://example.com" color="primary" */>}}
|
||||
{{</* button text="My Button" link="https://example.com" color="secondary" */>}}
|
||||
{{</* button text="My Button" link="https://example.com" color="success" */>}}
|
||||
{{</* button text="My Button" link="https://example.com" color="danger" */>}}
|
||||
{{</* button text="My Button" link="https://example.com" color="warning" */>}}
|
||||
{{</* button text="My Button" link="https://example.com" color="info" */>}}
|
||||
```
|
||||
|
||||
{{< button text="My Button" link="https://example.com" color="primary" >}}
|
||||
{{< button text="My Button" link="https://example.com" color="secondary" >}}
|
||||
{{< button text="My Button" link="https://example.com" color="success" >}}
|
||||
{{< button text="My Button" link="https://example.com" color="danger" >}}
|
||||
{{< button text="My Button" link="https://example.com" color="warning" >}}
|
||||
{{< button text="My Button" link="https://example.com" color="info" >}}
|
||||
|
||||
### References
|
||||
- [Docsy authoring guide](https://www.docsy.dev/docs/adding-content/)
|
||||
|
||||
|
|
|
|||
|
|
@ -22,5 +22,4 @@ The following steps in this guide are:
|
|||
1. Configure a component
|
||||
1. Explore Dapr quickstarts
|
||||
|
||||
<a class="btn btn-primary" href="{{< ref install-dapr-cli.md >}}" role="button">First step: Install the Dapr CLI >></a>
|
||||
|
||||
{{< button text="First step: Install the Dapr CLI >>" page="install-dapr-cli" >}}
|
||||
|
|
|
|||
|
|
@ -101,4 +101,4 @@ Exit the redis-cli with:
|
|||
exit
|
||||
```
|
||||
|
||||
<a class="btn btn-primary" href="{{< ref get-started-component.md >}}" role="button">Next step: Define a component >></a>
|
||||
{{< button text="Next step: Define a component >>" page="get-started-component" >}}
|
||||
|
|
|
|||
|
|
@ -90,4 +90,4 @@ You should see output with the secret you stored in the JSON file.
|
|||
{"my-secret":"I'm Batman"}
|
||||
```
|
||||
|
||||
<a class="btn btn-primary" href="{{< ref quickstarts.md >}}" role="button">Next step: Explore Dapr quickstarts >></a>
|
||||
{{< button text="Next step: Explore Dapr quickstarts >>" page="quickstarts" >}}
|
||||
|
|
|
|||
|
|
@ -110,5 +110,4 @@ Flags:
|
|||
Use "dapr [command] --help" for more information about a command.
|
||||
```
|
||||
|
||||
<a class="btn btn-primary" href="{{< ref install-dapr-selfhost.md >}}" role="button">Next step: Initialize Dapr >></a>
|
||||
|
||||
{{< button text="Next step: Initialize Dapr >>" page="install-dapr-selfhost" >}}
|
||||
|
|
|
|||
|
|
@ -53,7 +53,7 @@ dapr --version
|
|||
Output should look like this:
|
||||
```
|
||||
CLI version: 1.1.0
|
||||
Runtime version: 1.1.0
|
||||
Runtime version: 1.1.1
|
||||
```
|
||||
|
||||
### Step 4: Verify containers are running
|
||||
|
|
@ -109,5 +109,4 @@ You will see the Dapr config, Dapr binaries directory, and the default component
|
|||
|
||||
{{< /tabs >}}
|
||||
|
||||
<a class="btn btn-primary" href="{{< ref get-started-api.md >}}" role="button">Next step: Use the Dapr API >></a>
|
||||
|
||||
{{< button text="Next step: Use the Dapr API >>" page="get-started-api" >}}
|
||||
|
|
|
|||
|
|
@ -142,6 +142,6 @@ Use the `AWS account ID` and `AWS account secret` and plug them into the `access
|
|||
- [Pub/Sub building block]({{< ref pubsub >}})
|
||||
- Read [this guide]({{< ref "howto-publish-subscribe.md#step-2-publish-a-topic" >}}) for instructions on configuring pub/sub components
|
||||
- [AWS SQS as subscriber to SNS](https://docs.aws.amazon.com/sns/latest/dg/sns-sqs-as-subscriber.html)
|
||||
- [AWS SNS API refernce](https://docs.aws.amazon.com/sns/latest/api/Welcome.html)
|
||||
- [AWS SQS API refernce](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/Welcome.html)
|
||||
- [AWS SNS API reference](https://docs.aws.amazon.com/sns/latest/api/Welcome.html)
|
||||
- [AWS SQS API reference](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/Welcome.html)
|
||||
- [Authenticating to AWS]({{< ref authenticating-aws.md >}})
|
||||
|
|
|
|||
|
|
@ -67,13 +67,13 @@ The above example uses secrets as plain strings. It is recommended to use a loca
|
|||
|
||||
3. Create the managed identity(Optional)
|
||||
|
||||
This step is required only if the AKS Cluster is provisoned without the flag "--enable-managed-identity". If the cluster is provisioned with manahed identity, than is suggested to use the autogenerated managed identity that is associated to the Resource Group MC_*.
|
||||
This step is required only if the AKS Cluster is provisoned without the flag "--enable-managed-identity". If the cluster is provisioned with managed identity, than it is suggested to use the autogenerated managed identity that is associated to the Resource Group MC_*.
|
||||
|
||||
```bash
|
||||
$identity = az identity create -g [your resource group] -n [you managed identity name] -o json | ConvertFrom-Json
|
||||
$identity = az identity create -g [your resource group] -n [your managed identity name] -o json | ConvertFrom-Json
|
||||
```
|
||||
|
||||
Below the command to retrieve the managed identity in the autogenerated scenario:
|
||||
Below is the command to retrieve the managed identity in the autogenerated scenario:
|
||||
|
||||
```bash
|
||||
az aks show -g <AKSResourceGroup> -n <AKSClusterName>
|
||||
|
|
@ -134,19 +134,19 @@ The above example uses secrets as plain strings. It is recommended to use a loca
|
|||
apiVersion: "aadpodidentity.k8s.io/v1"
|
||||
kind: AzureIdentity
|
||||
metadata:
|
||||
name: [you managed identity name]
|
||||
name: [your managed identity name]
|
||||
spec:
|
||||
type: 0
|
||||
resourceID: [you managed identity id]
|
||||
clientID: [you managed identity Client ID]
|
||||
resourceID: [your managed identity id]
|
||||
clientID: [your managed identity Client ID]
|
||||
---
|
||||
apiVersion: "aadpodidentity.k8s.io/v1"
|
||||
kind: AzureIdentityBinding
|
||||
metadata:
|
||||
name: [you managed identity name]-identity-binding
|
||||
name: [your managed identity name]-identity-binding
|
||||
spec:
|
||||
azureIdentity: [you managed identity name]
|
||||
selector: [you managed identity selector]
|
||||
azureIdentity: [your managed identity name]
|
||||
selector: [your managed identity selector]
|
||||
```
|
||||
|
||||
10. Deploy the azure-identity-config.yaml:
|
||||
|
|
|
|||
|
|
@ -88,7 +88,7 @@ The above example uses secrets as plain strings. It is recommended to use a loca
|
|||
}
|
||||
```
|
||||
|
||||
**Save the both the appId and tenant from the output which will be used in the next step**
|
||||
**Save both the appId and tenant from the output which will be used in the next step**
|
||||
|
||||
4. Get the Object Id for [your_service_principal_name]
|
||||
|
||||
|
|
|
|||
|
|
@ -122,7 +122,7 @@ The latest Dapr helm chart no longer supports Helm v2. Please migrate from Helm
|
|||
|
||||
```bash
|
||||
helm upgrade --install dapr dapr/dapr \
|
||||
--version=1.1.0 \
|
||||
--version=1.1.1 \
|
||||
--namespace dapr-system \
|
||||
--create-namespace \
|
||||
--wait
|
||||
|
|
@ -132,7 +132,7 @@ The latest Dapr helm chart no longer supports Helm v2. Please migrate from Helm
|
|||
|
||||
```bash
|
||||
helm upgrade --install dapr dapr/dapr \
|
||||
--version=1.1.0 \
|
||||
--version=1.1.1 \
|
||||
--namespace dapr-system \
|
||||
--create-namespace \
|
||||
--set global.ha.enabled=true \
|
||||
|
|
|
|||
|
|
@ -16,6 +16,8 @@ When running a basic [Kubernetes Job](https://kubernetes.io/docs/concepts/worklo
|
|||
|
||||
When a job is finish without calling `Shutdown` your job will be in a `NotReady` state with only the `daprd` container running endlessly.
|
||||
|
||||
Be sure and use the *POST* HTTP verb when calling the shutdown API.
|
||||
|
||||
```yaml
|
||||
apiVersion: batch/v1
|
||||
kind: Job
|
||||
|
|
@ -30,8 +32,8 @@ spec:
|
|||
spec:
|
||||
containers:
|
||||
- name: job
|
||||
image: busybox
|
||||
command: ["/bin/sh", "-c", "sleep 20 && wget localhost:3500/v1.0/shutdown"]
|
||||
image: alpine
|
||||
command: ["/bin/sh", "-c", "apk --no-cache add curl && sleep 20 && curl -X POST localhost:3500/v1.0/shutdown"]
|
||||
restartPolicy: Never
|
||||
```
|
||||
|
||||
|
|
@ -57,4 +59,4 @@ func main() {
|
|||
defer client.Shutdown()
|
||||
// Job
|
||||
}
|
||||
```
|
||||
```
|
||||
|
|
|
|||
|
|
@ -55,7 +55,7 @@ Example settings for the dapr sidecar in a production-ready setup:
|
|||
|
||||
*Note: Since Dapr is intended to do much of the I/O heavy lifting for your app, it's expected that the resources given to Dapr enable you to drastically reduce the resource allocations for the application*
|
||||
|
||||
The CPU and memory limits above account for the fact that Dapr is intended to a high number of I/O bound operations. It is strongly recommended that you use a tool monitoring tool to baseline the sidecar (and app) containers and tune these settings based on those baselines.
|
||||
The CPU and memory limits above account for the fact that Dapr is intended to a high number of I/O bound operations. It is strongly recommended that you use a monitoring tool to baseline the sidecar (and app) containers and tune these settings based on those baselines.
|
||||
|
||||
## Highly-available mode
|
||||
|
||||
|
|
|
|||
|
|
@ -11,15 +11,15 @@ description: "Follow these steps to upgrade Dapr on Kubernetes and ensure a smoo
|
|||
- [Dapr CLI]({{< ref install-dapr-cli.md >}})
|
||||
- [Helm 3](https://github.com/helm/helm/releases) (if using Helm)
|
||||
|
||||
## Upgrade existing cluster to 1.1.0
|
||||
## Upgrade existing cluster to 1.1.1
|
||||
There are two ways to upgrade the Dapr control plane on a Kubernetes cluster using either the Dapr CLI or Helm.
|
||||
|
||||
### Dapr CLI
|
||||
|
||||
The example below shows how to upgrade to version 1.1.0:
|
||||
The example below shows how to upgrade to version 1.1.1:
|
||||
|
||||
```bash
|
||||
dapr upgrade -k --runtime-version=1.0.1
|
||||
dapr upgrade -k --runtime-version=1.1.1
|
||||
```
|
||||
|
||||
You can provide all the available Helm chart configurations using the Dapr CLI.
|
||||
|
|
@ -43,7 +43,7 @@ To resolve this issue please run the follow command to upgrade the CustomResourc
|
|||
kubectl replace -f https://raw.githubusercontent.com/dapr/dapr/5a15b3e0f093d2d0938b12f144c7047474a290fe/charts/dapr/crds/configuration.yaml
|
||||
```
|
||||
|
||||
Then proceed with the `dapr upgrade --runtime-version 1.1.0 -k` command as above.
|
||||
Then proceed with the `dapr upgrade --runtime-version 1.1.1 -k` command as above.
|
||||
|
||||
### Helm
|
||||
|
||||
|
|
|
|||
|
|
@ -25,11 +25,11 @@ description: "Follow these steps to upgrade Dapr in self-hosted mode and ensure
|
|||
dapr init
|
||||
```
|
||||
|
||||
1. Ensure you are using the latest version of Dapr (v1.1.0) with:
|
||||
1. Ensure you are using the latest version of Dapr (v1.1.1) with:
|
||||
|
||||
```bash
|
||||
$ dapr --version
|
||||
|
||||
CLI version: 1.1.0
|
||||
Runtime version: 1.1.0
|
||||
Runtime version: 1.1.1
|
||||
```
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ description: "Set-up New Relic for distributed tracing"
|
|||
|
||||
## Configure Dapr tracing
|
||||
|
||||
Dapr natively captures metrics and traces that can be send directly to New Relic. The easiest way to export these is by configuring Dapr to send the traces to [New Relic's Trace API](https://docs.newrelic.com/docs/understand-dependencies/distributed-tracing/trace-api/report-zipkin-format-traces-trace-api#existing-zipkin) using the Zipkin trace format.
|
||||
Dapr natively captures metrics and traces that can be send directly to New Relic. The easiest way to export these is by configuring Dapr to send the traces to [New Relic's Trace API](https://docs.newrelic.com/docs/distributed-tracing/trace-api/report-zipkin-format-traces-trace-api/) using the Zipkin trace format.
|
||||
|
||||
In order for the integration to send data to New Relic [Telemetry Data Platform](https://newrelic.com/platform/telemetry-data-platform), you need a [New Relic Insights Insert API key](https://docs.newrelic.com/docs/apis/get-started/intro-apis/types-new-relic-api-keys#insights-insert-key).
|
||||
|
||||
|
|
@ -108,8 +108,7 @@ All the data that is collected from Dapr, Kubernetes or any services that run on
|
|||
* [New Relic Account Signup](https://newrelic.com/signup)
|
||||
* [Telemetry Data Platform](https://newrelic.com/platform/telemetry-data-platform)
|
||||
* [Distributed Tracing](https://docs.newrelic.com/docs/understand-dependencies/distributed-tracing/get-started/introduction-distributed-tracing)
|
||||
* [New Relic Trace API](https://docs.newrelic.com/docs/understand-dependencies/distributed-tracing/trace-api)
|
||||
* [New Relic Metric API](https://docs.newrelic.com/docs/telemetry-data-platform/get-data/apis/introduction-metric-api)
|
||||
* [New Relic Trace API](https://docs.newrelic.com/docs/distributed-tracing/trace-api/introduction-trace-api/)
|
||||
* [Types of New Relic API keys](https://docs.newrelic.com/docs/apis/get-started/intro-apis/types-new-relic-api-keys)
|
||||
* [New Relic OpenTelemetry User Experience](https://blog.newrelic.com/product-news/opentelemetry-user-experience/)
|
||||
* [Alerts and Applied Intelligence](https://docs.newrelic.com/docs/alerts-applied-intelligence)
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ The table below shows the versions of Dapr releases that have been tested togeth
|
|||
|--------------------|:--------:|:--------|---------|---------|---------|
|
||||
| Feb 17th 2021 | 1.0.0</br>| 1.0.0 | Java 1.0.0 </br>Go 1.0.0 </br>PHP 1.0.0 </br>Python 1.0.0 </br>.NET 1.0.0 | 0.6.0 | Supported |
|
||||
| Mar 4th 2021 | 1.0.1</br>| 1.0.1 | Java 1.0.2 </br>Go 1.0.0 </br>PHP 1.0.0 </br>Python 1.0.0 </br>.NET 1.0.0 | 0.6.0 | Supported |
|
||||
| Apr 1st 2021 | 1.1.0</br> | 1.1.0 | Java 1.0.2 </br>Go 1.1.0 </br>PHP 1.0.0 </br>Python 1.1.0 </br>.NET 1.1.0 | 0.6.0 | Supported (current) |
|
||||
| Apr 1st 2021 | 1.1.1</br> | 1.1.0 | Java 1.0.2 </br>Go 1.1.0 </br>PHP 1.0.0 </br>Python 1.1.0 </br>.NET 1.1.0 | 0.6.0 | Supported (current) |
|
||||
|
||||
## Upgrade paths
|
||||
After the 1.0 release of the runtime there may be situations where it is necessary to explicitly upgrade through an additional release to reach the desired target. For example an upgrade from v1.0 to v1.2 may need go pass through v1.1
|
||||
|
|
@ -45,7 +45,7 @@ The table below shows the tested upgrade paths for the Dapr runtime. For example
|
|||
| 0.11 | N/A | 1.0.1 | Use Dapr CLI to upgrade for both self hosted and Kubernetes
|
||||
| | 1.0.1| 1.1.0 |
|
||||
| 1.0-rc1 to 1.0-rc4 | N/A | 1.0.1 | See Dapr 1.0 release notes
|
||||
| 1.0.0 or 1.0.1 | N/A | 1.1.0 | See Dapr 1.1 release notes
|
||||
| 1.0.0 or 1.0.1 | N/A | 1.1.1 | See Dapr 1.1 release notes
|
||||
|
||||
## Feature and deprecations
|
||||
There is a process for announcing feature deprecations. Deprecations are applied two (2) releases after the release in which they were announced. For example Feature X is announced to be deprecated in the 1.0.0 release notes and will then be removed in 1.2.0.
|
||||
|
|
|
|||
|
|
@ -36,12 +36,12 @@ dapr upgrade -k
|
|||
|
||||
### Upgrade specified version of Dapr runtime in Kubernetes
|
||||
```bash
|
||||
dapr upgrade -k --runtime-version 1.1.0
|
||||
dapr upgrade -k --runtime-version 1.1.1
|
||||
```
|
||||
|
||||
### Upgrade specified version of Dapr runtime in Kubernetes with value set
|
||||
```bash
|
||||
dapr upgrade -k --runtime-version 1.1.0 --set global.logAsJson=true
|
||||
dapr upgrade -k --runtime-version 1.1.1 --set global.logAsJson=true
|
||||
```
|
||||
# Related links
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,8 @@
|
|||
{{ $color := .Get "color" | default "primary" }}
|
||||
{{ $page := .Get "page" }}
|
||||
{{ $link := .Get "link" | default "#" }}
|
||||
{{ $text := .Get "text" }}
|
||||
|
||||
{{- if $page -}}{{- $link = ref . $page -}}{{- end -}}
|
||||
|
||||
<a class="btn btn-{{ $color }}" href="{{ $link }}" role="button">{{ $text }}</a>
|
||||
Loading…
Reference in New Issue