From ece502a9c60feccfc4d33157ec7dde5d5da03829 Mon Sep 17 00:00:00 2001 From: jasonviviano <83607984+jasonviviano@users.noreply.github.com> Date: Mon, 28 Jun 2021 15:26:41 -0400 Subject: [PATCH 01/34] Reformatted VS Code documentation --- .../ides/visual-studio-code/_index.md | 7 + .../vscode-dapr-extension.md | 140 ++++++++++++++++++ .../vscode-manual-configuration.md} | 61 +------- .../vscode-remote-dev-containers.md | 31 ++++ 4 files changed, 182 insertions(+), 57 deletions(-) create mode 100644 daprdocs/content/en/developing-applications/ides/visual-studio-code/_index.md create mode 100644 daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md rename daprdocs/content/en/developing-applications/ides/{vscode.md => visual-studio-code/vscode-manual-configuration.md} (67%) create mode 100644 daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-remote-dev-containers.md diff --git a/daprdocs/content/en/developing-applications/ides/visual-studio-code/_index.md b/daprdocs/content/en/developing-applications/ides/visual-studio-code/_index.md new file mode 100644 index 000000000..de374e4bf --- /dev/null +++ b/daprdocs/content/en/developing-applications/ides/visual-studio-code/_index.md @@ -0,0 +1,7 @@ +--- +type: docs +title: "Visual Studio Code" +linkTitle: "Visual Studio Code" +weight: 1000 +description: "Information on how to develop and run Dapr applications in VS Code" +--- \ No newline at end of file diff --git a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md new file mode 100644 index 000000000..bcbf97bba --- /dev/null +++ b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md @@ -0,0 +1,140 @@ +--- +type: docs +title: "Dapr Visual Studio Code extension overview" +linkTitle: "Overview" +weight: 10000 +description: "Information on how to develop and run Dapr applications with the Dapr extension" +--- + + +Dapr offers a *preview* [Dapr Visual Studio Code extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-dapr) for local development and debugging of your Dapr applications. + +Open in VSCode + +## Features Overview + +### Scaffold Dapr Tasks + +* Helps scaffold VS Code task.json and launch.json configurations needed to debug your application within the Dapr environment. +* Requires an already existing launch.json files to be found in the VS Code workspace. +* Example NodeJS App: + + +Before scaffolding version of launch.json configurations: +```json +{ + "version": "0.2.0", + "configurations": [ + { + "type": "pwa-node", + "request": "launch", + "name": "Launch Program", + "skipFiles": [ + "/**" + ], + "program": "${workspaceFolder}/app.js" + } +} +``` +After scaffolding version of launch.json: +```json +{ + "version": "0.2.0", + "configurations": [ + { + "type": "pwa-node", + "request": "launch", + "name": "Launch Program", + "skipFiles": [ + "/**" + ], + "program": "${workspaceFolder}/app.js" + }, + { + "type": "pwa-node", + "request": "launch", + "name": "Launch Program with Dapr", + "skipFiles": [ + "/**" + ], + "program": "${workspaceFolder}/app.js", + "preLaunchTask": "daprd-debug", + "postDebugTask": "daprd-down" + } +} +``` +After scaffolding task.json: + +```json +{ + "version": "2.0.0", + "tasks": [ + { + "appId": "nodeapp", + "appPort": 3500, + "label": "daprd-debug", + "type": "daprd" + }, + { + "appId": "nodeapp", + "label": "daprd-down", + "type": "daprd-down" + } + ] +} +``` + +### Scaffold Dapr Components +* Generates the Dapr component assets needed for general Dapr applications. +* Provides a Component folder in your VS Code workspace that contains pubsub, statestore and a zipkin yaml file. +* Example pubsub file: + +```yaml +apiVersion: dapr.io/v1alpha1 +kind: Component +metadata: + name: pubsub +spec: + type: pubsub.redis + metadata: + - name: redisHost + value: localhost:6379 + - name: redisPassword + value: "" +``` + +### View Running Dapr Applications +* Adds a view container specifically for Dapr applications which when selected displays a tree view called "Applications" which shows locally-running Dapr applications. + +
Screenshot of the Dapr VSCode extension view running applications option + +### Invoke Dapr Application Methods +* Allows users to select a Dapr application found in the tree view "Applications" and invoke GET/POST methods by name. +* Allows users to specify an optional payload for POST methods +
Screenshot of the Dapr VSCode extension invoke option + +### Publish Events to Dapr Applications +* You can publish events to running applications you select in the "Applications" tree view. +* Allows you to specify both the topic and an optional payload. + +
Screenshot of the Dapr VSCode extension publish option + + +## Telemetry + +### Data Collection + +The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft's privacy statement. Microsoft's privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and privacy statement. Your use of the software operates as your consent to these practices. + +### Disabling Telemetry +If you don’t wish to send usage data to Microsoft, you can set the telemetry.enableTelemetry setting to false. + + +## Additional Resources + +### Debuggin Multiple Dapr Applications At The Same Time +Using the VS Code extension you can debug multiple Dapr applications at the same time with [Multi-target debugging](https://code.visualstudio.com/docs/editor/debugging#_multitarget-debugging) + +### Dapr Community Call Demonstration +Watch this [video](https://www.youtube.com/watch?v=OtbYCBt9C34&t=85) on how to use the Dapr VS Code extension: + \ No newline at end of file diff --git a/daprdocs/content/en/developing-applications/ides/vscode.md b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-manual-configuration.md similarity index 67% rename from daprdocs/content/en/developing-applications/ides/vscode.md rename to daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-manual-configuration.md index c165829d1..746c75f53 100644 --- a/daprdocs/content/en/developing-applications/ides/vscode.md +++ b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-manual-configuration.md @@ -1,64 +1,11 @@ --- type: docs -title: "Visual Studio Code integrations with Dapr" -linkTitle: "Visual Studio Code" -weight: 1000 -description: "Information on how to develop and run Dapr applications in VS Code" +title: "Visual Studio Code manual configuration" +linkTitle: "Visual Studio Code manual configuration" +weight: 30000 +description: "Information on how to setup Visual Studio Code debugging manually" --- -## Extension - -Dapr offers a *preview* [Dapr Visual Studio Code extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-dapr) for local development and debugging of your Dapr applications. - -Open in VSCode - -### Feature overview -- Scaffold Dapr task, launch, and component assets -
Screenshot of the Dapr VSCode extension scaffold option -- View running Dapr applications -
Screenshot of the Dapr VSCode extension view running applications option -- Invoke Dapr application methods -
Screenshot of the Dapr VSCode extension invoke option -- Publish events to Dapr applications -
Screenshot of the Dapr VSCode extension publish option - -#### Example -Watch this [video](https://www.youtube.com/watch?v=OtbYCBt9C34&t=85) on how to use the Dapr VS Code extension: - - -## Remote Dev Containers - -The Visual Studio Code Remote Containers extension lets you use a Docker container as a full-featured development environment enabling you to [develop inside a container](https://code.visualstudio.com/docs/remote/containers) without installing any additional frameworks or packages to your local filesystem. - -Dapr has pre-built Docker remote containers for each of the language SDKs. You can pick the one of your choice for a ready made environment. Note these pre-built containers automatically update to the latest Dapr release. - -### Setup a remote dev container - -#### Prerequisites -- [Docker Desktop](https://www.docker.com/products/docker-desktop) -- [Visual Studio Code](https://code.visualstudio.com/) -- [VSCode Remote Development extension pack](https://aka.ms/vscode-remote/download/extension) - -#### Create remote Dapr container -1. Open your application workspace in VS Code -2. In the command command palette (ctrl+shift+p) type and select `Remote-Containers: Add Development Container Configuration Files...` -
Screenshot of adding a remote container -3. Type `dapr` to filter the list to available Dapr remote containers and choose the language container that matches your application. Note you may need to select `Show All Definitions...` -
Screenshot of adding a Dapr container -4. Follow the prompts to rebuild your application in container. -
Screenshot of reopening an application in the dev container - -#### Example -Watch this [video](https://www.youtube.com/watch?v=D2dO4aGpHcg&t=120) on how to use the Dapr VS Code Remote Containers with your application. - - -## Troubleshooting - -### Debugging multiple Dapr applications at the same time -Using the VS Code extension you can debug multiple Dapr applications at the same time with [Multi-target debugging](https://code.visualstudio.com/docs/editor/debugging#_multitarget-debugging) - - -### Manually configuring Visual Studio Code for debugging with daprd If instead of using the Dapr VS Code extension you wish to configure a project to use Dapr in the [tasks.json](https://code.visualstudio.com/Docs/editor/tasks) and [launch.json](https://code.visualstudio.com/Docs/editor/debugging) files these are the manual steps. When developing Dapr applications, you typically use the dapr cli to start your daprized service similar to this: diff --git a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-remote-dev-containers.md b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-remote-dev-containers.md new file mode 100644 index 000000000..3ba86cdf9 --- /dev/null +++ b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-remote-dev-containers.md @@ -0,0 +1,31 @@ +--- +type: docs +title: "Visual Studio Code Remote Dev Containers" +linkTitle: "Visual Studio Code remote dev containers" +weight: 20000 +description: "Information on how to setup a remote dev environment" +--- + +The Visual Studio Code Remote Containers extension lets you use a Docker container as a full-featured development environment enabling you to [develop inside a container](https://code.visualstudio.com/docs/remote/containers) without installing any additional frameworks or packages to your local filesystem. + +Dapr has pre-built Docker remote containers for each of the language SDKs. You can pick the one of your choice for a ready made environment. Note these pre-built containers automatically update to the latest Dapr release. + +### Setup a remote dev container + +#### Prerequisites +- [Docker Desktop](https://www.docker.com/products/docker-desktop) +- [Visual Studio Code](https://code.visualstudio.com/) +- [VSCode Remote Development extension pack](https://aka.ms/vscode-remote/download/extension) + +#### Create remote Dapr container +1. Open your application workspace in VS Code +2. In the command command palette (ctrl+shift+p) type and select `Remote-Containers: Add Development Container Configuration Files...` +
Screenshot of adding a remote container +3. Type `dapr` to filter the list to available Dapr remote containers and choose the language container that matches your application. Note you may need to select `Show All Definitions...` +
Screenshot of adding a Dapr container +4. Follow the prompts to rebuild your application in container. +
Screenshot of reopening an application in the dev container + +#### Example +Watch this [video](https://www.youtube.com/watch?v=D2dO4aGpHcg&t=120) on how to use the Dapr VS Code Remote Containers with your application. + \ No newline at end of file From 61559e9ab9bf7edee29c897f2cde845a8c8d7835 Mon Sep 17 00:00:00 2001 From: jasonviviano <83607984+jasonviviano@users.noreply.github.com> Date: Tue, 29 Jun 2021 12:28:06 -0400 Subject: [PATCH 02/34] Added changes to the reformatting of the VS Code Changes are based on comments received. --- .../ides/visual-studio-code/_index.md | 4 ++-- .../ides/visual-studio-code/vscode-dapr-extension.md | 12 ++++++------ .../vscode-manual-configuration.md | 4 ++-- .../vscode-remote-dev-containers.md | 10 +++++----- 4 files changed, 15 insertions(+), 15 deletions(-) diff --git a/daprdocs/content/en/developing-applications/ides/visual-studio-code/_index.md b/daprdocs/content/en/developing-applications/ides/visual-studio-code/_index.md index de374e4bf..42aba5db5 100644 --- a/daprdocs/content/en/developing-applications/ides/visual-studio-code/_index.md +++ b/daprdocs/content/en/developing-applications/ides/visual-studio-code/_index.md @@ -1,7 +1,7 @@ --- type: docs -title: "Visual Studio Code" +title: "Visual Studio Code integration with Dapr" linkTitle: "Visual Studio Code" weight: 1000 -description: "Information on how to develop and run Dapr applications in VS Code" +description: "How to develop and run Dapr applications in Visual Studio Code" --- \ No newline at end of file diff --git a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md index bcbf97bba..be07df115 100644 --- a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md +++ b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md @@ -3,7 +3,7 @@ type: docs title: "Dapr Visual Studio Code extension overview" linkTitle: "Overview" weight: 10000 -description: "Information on how to develop and run Dapr applications with the Dapr extension" +description: "How to develop and run Dapr applications with the Dapr extension" --- @@ -11,13 +11,13 @@ Dapr offers a *preview* [Dapr Visual Studio Code extension](https://marketplace. Open in VSCode -## Features Overview +## Features -### Scaffold Dapr Tasks +### Scaffold Dapr tasks * Helps scaffold VS Code task.json and launch.json configurations needed to debug your application within the Dapr environment. * Requires an already existing launch.json files to be found in the VS Code workspace. -* Example NodeJS App: +* Example NodeJS app: Before scaffolding version of launch.json configurations: @@ -84,7 +84,7 @@ After scaffolding task.json: } ``` -### Scaffold Dapr Components +### Scaffold Dapr components * Generates the Dapr component assets needed for general Dapr applications. * Provides a Component folder in your VS Code workspace that contains pubsub, statestore and a zipkin yaml file. * Example pubsub file: @@ -108,7 +108,7 @@ spec:
Screenshot of the Dapr VSCode extension view running applications option -### Invoke Dapr Application Methods +### Invoke Dapr application methods * Allows users to select a Dapr application found in the tree view "Applications" and invoke GET/POST methods by name. * Allows users to specify an optional payload for POST methods
Screenshot of the Dapr VSCode extension invoke option diff --git a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-manual-configuration.md b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-manual-configuration.md index 746c75f53..7a27a4ef6 100644 --- a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-manual-configuration.md +++ b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-manual-configuration.md @@ -1,7 +1,7 @@ --- type: docs -title: "Visual Studio Code manual configuration" -linkTitle: "Visual Studio Code manual configuration" +title: "Visual Studio Code manual debugging configuration" +linkTitle: "Manual debugging configuration" weight: 30000 description: "Information on how to setup Visual Studio Code debugging manually" --- diff --git a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-remote-dev-containers.md b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-remote-dev-containers.md index 3ba86cdf9..d3409a88e 100644 --- a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-remote-dev-containers.md +++ b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-remote-dev-containers.md @@ -1,12 +1,12 @@ --- type: docs -title: "Visual Studio Code Remote Dev Containers" -linkTitle: "Visual Studio Code remote dev containers" +title: "Visual Studio Code remote dev containers" +linkTitle: "Remote dev containers" weight: 20000 -description: "Information on how to setup a remote dev environment" +description: "How to setup a remote dev container environment with Dapr" --- -The Visual Studio Code Remote Containers extension lets you use a Docker container as a full-featured development environment enabling you to [develop inside a container](https://code.visualstudio.com/docs/remote/containers) without installing any additional frameworks or packages to your local filesystem. +The Visual Studio Code [Remote Containers extension](https://code.visualstudio.com/docs/remote/containers) lets you use a Docker container as a full-featured development environment without installing any additional frameworks or packages to your local filesystem. Dapr has pre-built Docker remote containers for each of the language SDKs. You can pick the one of your choice for a ready made environment. Note these pre-built containers automatically update to the latest Dapr release. @@ -19,7 +19,7 @@ Dapr has pre-built Docker remote containers for each of the language SDKs. You c #### Create remote Dapr container 1. Open your application workspace in VS Code -2. In the command command palette (ctrl+shift+p) type and select `Remote-Containers: Add Development Container Configuration Files...` +2. In the command command palette (`CTRL+SHIFT+P`) type and select `Remote-Containers: Add Development Container Configuration Files...`
Screenshot of adding a remote container 3. Type `dapr` to filter the list to available Dapr remote containers and choose the language container that matches your application. Note you may need to select `Show All Definitions...`
Screenshot of adding a Dapr container From e964f66fd9822e00df8d616ddd0c4b091cfbc8fb Mon Sep 17 00:00:00 2001 From: jasonviviano <83607984+jasonviviano@users.noreply.github.com> Date: Tue, 29 Jun 2021 12:36:01 -0400 Subject: [PATCH 03/34] Revised grammer on manual configuration and remote dev containers Revised based on comments --- .../vscode-dapr-extension.md | 28 ++++++++----------- .../vscode-manual-configuration.md | 8 ++++-- 2 files changed, 17 insertions(+), 19 deletions(-) diff --git a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md index be07df115..49d1847ab 100644 --- a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md +++ b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md @@ -103,9 +103,8 @@ spec: value: "" ``` -### View Running Dapr Applications -* Adds a view container specifically for Dapr applications which when selected displays a tree view called "Applications" which shows locally-running Dapr applications. - +### View running Dapr applications +* The Applications view shows Dapr applications running locally on your machine.
Screenshot of the Dapr VSCode extension view running applications option ### Invoke Dapr application methods @@ -113,28 +112,25 @@ spec: * Allows users to specify an optional payload for POST methods
Screenshot of the Dapr VSCode extension invoke option -### Publish Events to Dapr Applications -* You can publish events to running applications you select in the "Applications" tree view. -* Allows you to specify both the topic and an optional payload. - +### Publish events to Dapr applications +* Within the Applications view, users can right-click and publish messages to a running Dapr application, specifying the topic and payload. +Users can also publish messages to all running applications.
Screenshot of the Dapr VSCode extension publish option ## Telemetry -### Data Collection +### Data collection -The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft's privacy statement. Microsoft's privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and privacy statement. Your use of the software operates as your consent to these practices. +The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described [in the repository](https://github.com/microsoft/vscode-dapr). There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft's privacy statement. Microsoft's privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and privacy statement. Your use of the software operates as your consent to these practices. ### Disabling Telemetry -If you don’t wish to send usage data to Microsoft, you can set the telemetry.enableTelemetry setting to false. +If you don’t wish to send usage data to Microsoft, you can set the `telemetry.enableTelemetry` setting to `false`. Learn more in the VSCode [FAQ](https://code.visualstudio.com/docs/supporting/faq#_how-to-disable-telemetry-reporting). +## Additional resources -## Additional Resources - -### Debuggin Multiple Dapr Applications At The Same Time -Using the VS Code extension you can debug multiple Dapr applications at the same time with [Multi-target debugging](https://code.visualstudio.com/docs/editor/debugging#_multitarget-debugging) - -### Dapr Community Call Demonstration +### Debugging multiple Dapr applications at the same time +Using the VS Code extension, you can debug multiple Dapr applications at the same time with [Multi-target debugging](https://code.visualstudio.com/docs/editor/debugging#_multitarget-debugging). +### Community call demo Watch this [video](https://www.youtube.com/watch?v=OtbYCBt9C34&t=85) on how to use the Dapr VS Code extension: \ No newline at end of file diff --git a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-manual-configuration.md b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-manual-configuration.md index 7a27a4ef6..30c15ab6c 100644 --- a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-manual-configuration.md +++ b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-manual-configuration.md @@ -3,12 +3,14 @@ type: docs title: "Visual Studio Code manual debugging configuration" linkTitle: "Manual debugging configuration" weight: 30000 -description: "Information on how to setup Visual Studio Code debugging manually" +description: "How to manually setup Visual Studio Code debugging" --- -If instead of using the Dapr VS Code extension you wish to configure a project to use Dapr in the [tasks.json](https://code.visualstudio.com/Docs/editor/tasks) and [launch.json](https://code.visualstudio.com/Docs/editor/debugging) files these are the manual steps. +The [Dapr VSCode extension]({{< ref vscode-dapr-extension.md >}}) automates the setup of [VSCode debugging](https://code.visualstudio.com/Docs/editor/debugging). -When developing Dapr applications, you typically use the dapr cli to start your daprized service similar to this: +If instead you wish to manually configure the `[tasks.json](https://code.visualstudio.com/Docs/editor/tasks)` and `[launch.json](https://code.visualstudio.com/Docs/editor/debugging)` files to use Dapr, these are the steps. + +When developing Dapr applications, you typically use the Dapr cli to start your daprized service similar to this: ```bash dapr run --app-id nodeapp --app-port 3000 --dapr-http-port 3500 app.js From 1808dde10bd24ede889a3028d306d235017a1e29 Mon Sep 17 00:00:00 2001 From: jasonviviano <83607984+jasonviviano@users.noreply.github.com> Date: Tue, 29 Jun 2021 12:37:47 -0400 Subject: [PATCH 04/34] Removed unnecessary wording --- .../ides/visual-studio-code/vscode-manual-configuration.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-manual-configuration.md b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-manual-configuration.md index 30c15ab6c..437155dd5 100644 --- a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-manual-configuration.md +++ b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-manual-configuration.md @@ -26,8 +26,6 @@ One approach to attaching the debugger to your service is to first run daprd wit Using the [tasks.json](https://code.visualstudio.com/Docs/editor/tasks) and [launch.json](https://code.visualstudio.com/Docs/editor/debugging) files in Visual Studio Code, you can simplify the process and request that VS Code kick off the daprd process prior to launching the debugger. -Let's get started! - #### Modifying launch.json configurations to include a preLaunchTask In your [launch.json](https://code.visualstudio.com/Docs/editor/debugging) file add a [preLaunchTask](https://code.visualstudio.com/Docs/editor/debugging#_launchjson-attributes) for each configuration that you want daprd launched. The [preLaunchTask](https://code.visualstudio.com/Docs/editor/debugging#_launchjson-attributes) will reference tasks that you define in your tasks.json file. Here is an example for both Node and .NET Core. Notice the [preLaunchTasks](https://code.visualstudio.com/Docs/editor/debugging#_launchjson-attributes) referenced: daprd-web and daprd-leaderboard. From dafe094ffaa87c1506c358d293a25fe9d280d11b Mon Sep 17 00:00:00 2001 From: jasonviviano <83607984+jasonviviano@users.noreply.github.com> Date: Wed, 30 Jun 2021 14:29:22 -0400 Subject: [PATCH 05/34] Revision on JSON Snippets Shown Cut down the JSON shown to users in the VS Code Dapr section and renamed link title --- .../vscode-dapr-extension.md | 46 ++----------------- 1 file changed, 3 insertions(+), 43 deletions(-) diff --git a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md index 49d1847ab..728602edc 100644 --- a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md +++ b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md @@ -1,7 +1,7 @@ --- type: docs title: "Dapr Visual Studio Code extension overview" -linkTitle: "Overview" +linkTitle: "Dapr extension" weight: 10000 description: "How to develop and run Dapr applications with the Dapr extension" --- @@ -19,37 +19,8 @@ Dapr offers a *preview* [Dapr Visual Studio Code extension](https://marketplace. * Requires an already existing launch.json files to be found in the VS Code workspace. * Example NodeJS app: - -Before scaffolding version of launch.json configurations: +After scaffolding the launch.json should contain similar snippets: ```json -{ - "version": "0.2.0", - "configurations": [ - { - "type": "pwa-node", - "request": "launch", - "name": "Launch Program", - "skipFiles": [ - "/**" - ], - "program": "${workspaceFolder}/app.js" - } -} -``` -After scaffolding version of launch.json: -```json -{ - "version": "0.2.0", - "configurations": [ - { - "type": "pwa-node", - "request": "launch", - "name": "Launch Program", - "skipFiles": [ - "/**" - ], - "program": "${workspaceFolder}/app.js" - }, { "type": "pwa-node", "request": "launch", @@ -61,27 +32,16 @@ After scaffolding version of launch.json: "preLaunchTask": "daprd-debug", "postDebugTask": "daprd-down" } -} ``` -After scaffolding task.json: +After scaffolding the task.json should contain similar snippets: ```json -{ - "version": "2.0.0", - "tasks": [ { "appId": "nodeapp", "appPort": 3500, "label": "daprd-debug", "type": "daprd" - }, - { - "appId": "nodeapp", - "label": "daprd-down", - "type": "daprd-down" } - ] -} ``` ### Scaffold Dapr components From bb25bc522781d5421fdb7b4ff4c3d5a794a7e94a Mon Sep 17 00:00:00 2001 From: Aaron Crawfis Date: Fri, 2 Jul 2021 12:41:42 -0700 Subject: [PATCH 06/34] Add docs on Bridge to Kubernetes --- .../debugging/bridge-to-kubernetes.md | 26 +++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 daprdocs/content/en/developing-applications/debugging/bridge-to-kubernetes.md diff --git a/daprdocs/content/en/developing-applications/debugging/bridge-to-kubernetes.md b/daprdocs/content/en/developing-applications/debugging/bridge-to-kubernetes.md new file mode 100644 index 000000000..d4b953e37 --- /dev/null +++ b/daprdocs/content/en/developing-applications/debugging/bridge-to-kubernetes.md @@ -0,0 +1,26 @@ +--- +type: docs +title: "Bridge to Kubernetes support for Dapr services" +linkTitle: "Bridge to Kubernets" +weight: 300 +description: "Debug Dapr apps locally which still connected to your Kubernetes cluster" +--- + +Bridge to Kubernetes allows you to run and debug code on your development computer, while still connected to your Kubernetes cluster with the rest of your application or services. This type of debugging is often called *local tunnel debugging*. + +{{< button text="Learn more about Bridge to Kubernetes" link="https://code.visualstudio.com/docs/containers/bridge-to-kubernetes" >}} + +## Debug Dapr apps + +Bridge to Kubernetes supports debugging Dapr apps on your machine, while still having them interact with the services and applications running on your Kubernetes cluster. This example showcases Bridge to Kubernetes enabling a developer to debug the [distributed calculator quickstart](https://github.com/dapr/quickstarts/tree/master/distributed-calculator): + + + +{{% alert title="Isolation mode" color="warning" %}} +[Isolation mode](https://code.visualstudio.com/docs/containers/bridge-to-kubernetes#_running-in-isolation-mode) is currently not supported with Dapr apps. Make sure to launch Bridge to Kubernetes mode without isolation. +{{% /alert %}} + +## Further reading + +- [Bridge to Kubernetes documentation](https://code.visualstudio.com/docs/containers/bridge-to-kubernetes) +- [VSCode integration]({{< ref vscode >}}) From 0d71c00cf3a04b298e184ec3a7343c7a222322fa Mon Sep 17 00:00:00 2001 From: kshitijcode Date: Fri, 9 Jul 2021 13:41:28 +0530 Subject: [PATCH 07/34] Add information to create a database named 'daprStore' in case no databaseName is specified as Dapr Mongo Component defaults to `daprStore` Add information to create a database named 'daprStore' in case no databaseName is specified as Dapr Mongo Component defaults to `daprStore` --- .../supported-state-stores/setup-mongodb.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-mongodb.md b/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-mongodb.md index 5def2d0e1..f3b336449 100644 --- a/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-mongodb.md +++ b/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-mongodb.md @@ -77,6 +77,11 @@ docker run --name some-mongo -d mongo ``` You can then interact with the server using `localhost:27017`. + +{{% alert title="Note" %}} +Please create a database named `daprStore` in case the `databaseName` is not specified in the component definition. +{{% /alert %}} + {{% /codetab %}} {{% codetab %}} From 5ed7836c17b4a978944f8f9fff8201752f0ca558 Mon Sep 17 00:00:00 2001 From: kshitijcode Date: Sat, 10 Jul 2021 10:06:42 +0530 Subject: [PATCH 08/34] Update daprdocs/content/en/reference/components-reference/supported-state-stores/setup-mongodb.md Co-authored-by: Aaron Crawfis --- .../supported-state-stores/setup-mongodb.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-mongodb.md b/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-mongodb.md index f3b336449..255b604f3 100644 --- a/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-mongodb.md +++ b/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-mongodb.md @@ -78,9 +78,7 @@ docker run --name some-mongo -d mongo You can then interact with the server using `localhost:27017`. -{{% alert title="Note" %}} -Please create a database named `daprStore` in case the `databaseName` is not specified in the component definition. -{{% /alert %}} +If you do not specify a `databaseName` value in your component definition, make sure to create a database named `daprStore`. {{% /codetab %}} From a44cc7898a6f566203e6a24ff4e1dc1a07c18214 Mon Sep 17 00:00:00 2001 From: jasonviviano <83607984+jasonviviano@users.noreply.github.com> Date: Mon, 12 Jul 2021 11:24:13 -0400 Subject: [PATCH 09/34] Update daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md Co-authored-by: Aaron Crawfis --- .../vscode-dapr-extension.md | 36 +++++-------------- 1 file changed, 8 insertions(+), 28 deletions(-) diff --git a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md index 728602edc..fac04e1bb 100644 --- a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md +++ b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md @@ -13,36 +13,16 @@ Dapr offers a *preview* [Dapr Visual Studio Code extension](https://marketplace. ## Features -### Scaffold Dapr tasks +### Scaffold Dapr debugging tasks -* Helps scaffold VS Code task.json and launch.json configurations needed to debug your application within the Dapr environment. -* Requires an already existing launch.json files to be found in the VS Code workspace. -* Example NodeJS app: +The Dapr extension helps you debug your applications with Dapr using Visual Studio Code's [built-in debugging capability](https://code.visualstudio.com/Docs/editor/debugging). -After scaffolding the launch.json should contain similar snippets: -```json - { - "type": "pwa-node", - "request": "launch", - "name": "Launch Program with Dapr", - "skipFiles": [ - "/**" - ], - "program": "${workspaceFolder}/app.js", - "preLaunchTask": "daprd-debug", - "postDebugTask": "daprd-down" - } -``` -After scaffolding the task.json should contain similar snippets: +Using the `Dapr: Scaffold Dapr Tasks` [Command Palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) operation, you can update your existing `task.json` and `launch.json` files to launch and configure the Dapr sidecar when you begin debugging. -```json - { - "appId": "nodeapp", - "appPort": 3500, - "label": "daprd-debug", - "type": "daprd" - } -``` +1. Make sure you have a launch configuration set for your app. ([Learn more](https://code.visualstudio.com/Docs/editor/debugging)) +1. Open the Command Palette with `Ctrl+Shift+P` +1. Select `Dapr: Scaffold Dapr Tasks` +1. Run your app and the Dapr sidecar with `F5` or via the Run view. ### Scaffold Dapr components * Generates the Dapr component assets needed for general Dapr applications. @@ -93,4 +73,4 @@ If you don’t wish to send usage data to Microsoft, you can set the `telemetry. Using the VS Code extension, you can debug multiple Dapr applications at the same time with [Multi-target debugging](https://code.visualstudio.com/docs/editor/debugging#_multitarget-debugging). ### Community call demo Watch this [video](https://www.youtube.com/watch?v=OtbYCBt9C34&t=85) on how to use the Dapr VS Code extension: - \ No newline at end of file + From 1ac25cb93c3df88378978b1e77938d2b370028c7 Mon Sep 17 00:00:00 2001 From: jasonviviano <83607984+jasonviviano@users.noreply.github.com> Date: Mon, 12 Jul 2021 11:24:20 -0400 Subject: [PATCH 10/34] Update daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md Co-authored-by: Aaron Crawfis --- .../vscode-dapr-extension.md | 26 +++++++------------ 1 file changed, 9 insertions(+), 17 deletions(-) diff --git a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md index fac04e1bb..6652faf11 100644 --- a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md +++ b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md @@ -24,24 +24,16 @@ Using the `Dapr: Scaffold Dapr Tasks` [Command Palette](https://code.visualstudi 1. Select `Dapr: Scaffold Dapr Tasks` 1. Run your app and the Dapr sidecar with `F5` or via the Run view. -### Scaffold Dapr components -* Generates the Dapr component assets needed for general Dapr applications. -* Provides a Component folder in your VS Code workspace that contains pubsub, statestore and a zipkin yaml file. -* Example pubsub file: +### Scaffold Dapr components -```yaml -apiVersion: dapr.io/v1alpha1 -kind: Component -metadata: - name: pubsub -spec: - type: pubsub.redis - metadata: - - name: redisHost - value: localhost:6379 - - name: redisPassword - value: "" -``` +When adding Dapr to your application, you may want to have a dedicated components directory, separate from the default components initialized as part of `dapr init`. + +To create a dedicated components folder with the default `statestore`, `pubsub`, and `zipkin` components, use the `Dapr: Scaffold Dapr Components` [Command Palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) operation. + +1. Open your application directory in Visual Studio Code +1. Open the Command Palette with `Ctrl+Shift+P` +1. Select `Dapr: Scaffold Dapr Components` +1. Run your application with `dapr run --components-path ./components -- ...` ### View running Dapr applications * The Applications view shows Dapr applications running locally on your machine. From 9f9f8708690f0c441afbdb652ab6cabdb6037425 Mon Sep 17 00:00:00 2001 From: jasonviviano <83607984+jasonviviano@users.noreply.github.com> Date: Mon, 12 Jul 2021 11:24:24 -0400 Subject: [PATCH 11/34] Update daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md Co-authored-by: Aaron Crawfis --- .../ides/visual-studio-code/vscode-dapr-extension.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md index 6652faf11..453525f86 100644 --- a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md +++ b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md @@ -36,7 +36,9 @@ To create a dedicated components folder with the default `statestore`, `pubsub`, 1. Run your application with `dapr run --components-path ./components -- ...` ### View running Dapr applications -* The Applications view shows Dapr applications running locally on your machine. + +The Applications view shows Dapr applications running locally on your machine. +
Screenshot of the Dapr VSCode extension view running applications option ### Invoke Dapr application methods From 311abba65f2b0d7244637eaeea417ecec771080e Mon Sep 17 00:00:00 2001 From: jasonviviano <83607984+jasonviviano@users.noreply.github.com> Date: Mon, 12 Jul 2021 11:24:29 -0400 Subject: [PATCH 12/34] Update daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md Co-authored-by: Aaron Crawfis --- .../ides/visual-studio-code/vscode-dapr-extension.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md index 453525f86..9871b6744 100644 --- a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md +++ b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md @@ -47,10 +47,12 @@ The Applications view shows Dapr applications running locally on your machine.
Screenshot of the Dapr VSCode extension invoke option ### Publish events to Dapr applications -* Within the Applications view, users can right-click and publish messages to a running Dapr application, specifying the topic and payload. -Users can also publish messages to all running applications. -
Screenshot of the Dapr VSCode extension publish option +Within the Applications view, users can right-click and publish messages to a running Dapr application, specifying the topic and payload. + +Users can also publish messages to all running applications. + +
Screenshot of the Dapr VSCode extension publish option ## Telemetry From 46fd2593507ed3d31040a90043d0fccd8942242f Mon Sep 17 00:00:00 2001 From: jasonviviano <83607984+jasonviviano@users.noreply.github.com> Date: Mon, 12 Jul 2021 11:24:37 -0400 Subject: [PATCH 13/34] Update daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md Co-authored-by: Aaron Crawfis --- .../ides/visual-studio-code/vscode-dapr-extension.md | 1 + 1 file changed, 1 insertion(+) diff --git a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md index 9871b6744..c54d428ca 100644 --- a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md +++ b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md @@ -61,6 +61,7 @@ Users can also publish messages to all running applications. The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described [in the repository](https://github.com/microsoft/vscode-dapr). There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft's privacy statement. Microsoft's privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and privacy statement. Your use of the software operates as your consent to these practices. ### Disabling Telemetry + If you don’t wish to send usage data to Microsoft, you can set the `telemetry.enableTelemetry` setting to `false`. Learn more in the VSCode [FAQ](https://code.visualstudio.com/docs/supporting/faq#_how-to-disable-telemetry-reporting). ## Additional resources From 8b1a0f5ba76e59afda94eb2abcda7c6a6de64cf8 Mon Sep 17 00:00:00 2001 From: jasonviviano <83607984+jasonviviano@users.noreply.github.com> Date: Mon, 12 Jul 2021 11:24:43 -0400 Subject: [PATCH 14/34] Update daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md Co-authored-by: Aaron Crawfis --- .../ides/visual-studio-code/vscode-dapr-extension.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md index c54d428ca..85c5e4c7f 100644 --- a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md +++ b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md @@ -68,6 +68,8 @@ If you don’t wish to send usage data to Microsoft, you can set the `telemetry. ### Debugging multiple Dapr applications at the same time Using the VS Code extension, you can debug multiple Dapr applications at the same time with [Multi-target debugging](https://code.visualstudio.com/docs/editor/debugging#_multitarget-debugging). + ### Community call demo + Watch this [video](https://www.youtube.com/watch?v=OtbYCBt9C34&t=85) on how to use the Dapr VS Code extension: From 951de9956db1c8be57cbdb7bf9e9e5469c2307d4 Mon Sep 17 00:00:00 2001 From: jasonviviano <83607984+jasonviviano@users.noreply.github.com> Date: Mon, 12 Jul 2021 11:24:47 -0400 Subject: [PATCH 15/34] Update daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-manual-configuration.md Co-authored-by: Aaron Crawfis --- .../ides/visual-studio-code/vscode-manual-configuration.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-manual-configuration.md b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-manual-configuration.md index 437155dd5..b1a03835a 100644 --- a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-manual-configuration.md +++ b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-manual-configuration.md @@ -1,7 +1,7 @@ --- type: docs title: "Visual Studio Code manual debugging configuration" -linkTitle: "Manual debugging configuration" +linkTitle: "Manual debugging" weight: 30000 description: "How to manually setup Visual Studio Code debugging" --- @@ -171,4 +171,4 @@ Once you have made the required changes, you should be able to switch to the [de {{% alert title="Note" color="primary" %}} Since you didn't launch the service(s) using the **dapr** ***run*** cli command, but instead by running **daprd**, the **dapr** ***list*** command will not show a list of apps that are currently running. -{{% /alert %}} \ No newline at end of file +{{% /alert %}} From 4de9dbaed71ae4762d49b88e69d391fa8d5575cb Mon Sep 17 00:00:00 2001 From: jasonviviano <83607984+jasonviviano@users.noreply.github.com> Date: Mon, 12 Jul 2021 11:24:57 -0400 Subject: [PATCH 16/34] Update daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md Co-authored-by: Aaron Crawfis --- .../ides/visual-studio-code/vscode-dapr-extension.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md index 85c5e4c7f..dd890ba48 100644 --- a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md +++ b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md @@ -41,9 +41,10 @@ The Applications view shows Dapr applications running locally on your machine.
Screenshot of the Dapr VSCode extension view running applications option -### Invoke Dapr application methods -* Allows users to select a Dapr application found in the tree view "Applications" and invoke GET/POST methods by name. -* Allows users to specify an optional payload for POST methods +### Invoke Dapr applications + +Within the Applications view, users can right-click and invoke Dapr apps via GET or POST methods, optionally specifying a payload. +
Screenshot of the Dapr VSCode extension invoke option ### Publish events to Dapr applications From c0aa9808c3e0ba5e68f2752d740304a87d2f33ee Mon Sep 17 00:00:00 2001 From: jasonviviano <83607984+jasonviviano@users.noreply.github.com> Date: Mon, 12 Jul 2021 11:25:08 -0400 Subject: [PATCH 17/34] Update daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md Co-authored-by: Aaron Crawfis --- .../ides/visual-studio-code/vscode-dapr-extension.md | 1 + 1 file changed, 1 insertion(+) diff --git a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md index dd890ba48..855d2c4a3 100644 --- a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md +++ b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md @@ -68,6 +68,7 @@ If you don’t wish to send usage data to Microsoft, you can set the `telemetry. ## Additional resources ### Debugging multiple Dapr applications at the same time + Using the VS Code extension, you can debug multiple Dapr applications at the same time with [Multi-target debugging](https://code.visualstudio.com/docs/editor/debugging#_multitarget-debugging). ### Community call demo From a9a95068b0e7106601a97a74c62fbccd93433b9d Mon Sep 17 00:00:00 2001 From: Nick Greenfield Date: Mon, 12 Jul 2021 16:50:53 -0700 Subject: [PATCH 18/34] Fix linkTitle and use aka.ms links --- .../debugging/bridge-to-kubernetes.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/daprdocs/content/en/developing-applications/debugging/bridge-to-kubernetes.md b/daprdocs/content/en/developing-applications/debugging/bridge-to-kubernetes.md index d4b953e37..b7c336628 100644 --- a/daprdocs/content/en/developing-applications/debugging/bridge-to-kubernetes.md +++ b/daprdocs/content/en/developing-applications/debugging/bridge-to-kubernetes.md @@ -1,14 +1,14 @@ --- type: docs title: "Bridge to Kubernetes support for Dapr services" -linkTitle: "Bridge to Kubernets" +linkTitle: "Bridge to Kubernetes" weight: 300 description: "Debug Dapr apps locally which still connected to your Kubernetes cluster" --- Bridge to Kubernetes allows you to run and debug code on your development computer, while still connected to your Kubernetes cluster with the rest of your application or services. This type of debugging is often called *local tunnel debugging*. -{{< button text="Learn more about Bridge to Kubernetes" link="https://code.visualstudio.com/docs/containers/bridge-to-kubernetes" >}} +{{< button text="Learn more about Bridge to Kubernetes" link="https://aka.ms/bridge-vscode-dapr" >}} ## Debug Dapr apps @@ -17,10 +17,10 @@ Bridge to Kubernetes supports debugging Dapr apps on your machine, while still h {{% alert title="Isolation mode" color="warning" %}} -[Isolation mode](https://code.visualstudio.com/docs/containers/bridge-to-kubernetes#_running-in-isolation-mode) is currently not supported with Dapr apps. Make sure to launch Bridge to Kubernetes mode without isolation. +[Isolation mode](https://aka.ms/bridge-isolation-vscode-dapr) is currently not supported with Dapr apps. Make sure to launch Bridge to Kubernetes mode without isolation. {{% /alert %}} ## Further reading - [Bridge to Kubernetes documentation](https://code.visualstudio.com/docs/containers/bridge-to-kubernetes) -- [VSCode integration]({{< ref vscode >}}) +- [VSCode integration]({{< ref vscode >}}) \ No newline at end of file From fa1186129f65039245c4ebf995c49bbeefad1a60 Mon Sep 17 00:00:00 2001 From: jasonviviano <83607984+jasonviviano@users.noreply.github.com> Date: Wed, 14 Jul 2021 15:40:57 -0400 Subject: [PATCH 19/34] Added more details based on Mark's comments --- .../vscode-dapr-extension.md | 25 ++++++------------- .../vscode-manual-configuration.md | 6 ----- 2 files changed, 7 insertions(+), 24 deletions(-) diff --git a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md index 855d2c4a3..802f292f3 100644 --- a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md +++ b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md @@ -7,7 +7,7 @@ description: "How to develop and run Dapr applications with the Dapr extension" --- -Dapr offers a *preview* [Dapr Visual Studio Code extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-dapr) for local development and debugging of your Dapr applications. +Dapr offers a *preview* [Dapr Visual Studio Code extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-dapr) for local development which enables users a variety of features related to better managing their Dapr applications and debugging of your Dapr applications for all supported Dapr languages which are .NET, Go, PHP, Python and Java. Open in VSCode @@ -20,9 +20,9 @@ The Dapr extension helps you debug your applications with Dapr using Visual Stud Using the `Dapr: Scaffold Dapr Tasks` [Command Palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) operation, you can update your existing `task.json` and `launch.json` files to launch and configure the Dapr sidecar when you begin debugging. 1. Make sure you have a launch configuration set for your app. ([Learn more](https://code.visualstudio.com/Docs/editor/debugging)) -1. Open the Command Palette with `Ctrl+Shift+P` -1. Select `Dapr: Scaffold Dapr Tasks` -1. Run your app and the Dapr sidecar with `F5` or via the Run view. +2. Open the Command Palette with `Ctrl+Shift+P` +3. Select `Dapr: Scaffold Dapr Tasks` +4. Run your app and the Dapr sidecar with `F5` or via the Run view. ### Scaffold Dapr components @@ -31,9 +31,9 @@ When adding Dapr to your application, you may want to have a dedicated component To create a dedicated components folder with the default `statestore`, `pubsub`, and `zipkin` components, use the `Dapr: Scaffold Dapr Components` [Command Palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) operation. 1. Open your application directory in Visual Studio Code -1. Open the Command Palette with `Ctrl+Shift+P` -1. Select `Dapr: Scaffold Dapr Components` -1. Run your application with `dapr run --components-path ./components -- ...` +2. Open the Command Palette with `Ctrl+Shift+P` +3. Select `Dapr: Scaffold Dapr Components` +4. Run your application with `dapr run --components-path ./components -- ...` ### View running Dapr applications @@ -54,17 +54,6 @@ Within the Applications view, users can right-click and publish messages to a ru Users can also publish messages to all running applications.
Screenshot of the Dapr VSCode extension publish option - -## Telemetry - -### Data collection - -The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described [in the repository](https://github.com/microsoft/vscode-dapr). There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft's privacy statement. Microsoft's privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and privacy statement. Your use of the software operates as your consent to these practices. - -### Disabling Telemetry - -If you don’t wish to send usage data to Microsoft, you can set the `telemetry.enableTelemetry` setting to `false`. Learn more in the VSCode [FAQ](https://code.visualstudio.com/docs/supporting/faq#_how-to-disable-telemetry-reporting). - ## Additional resources ### Debugging multiple Dapr applications at the same time diff --git a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-manual-configuration.md b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-manual-configuration.md index b1a03835a..ad57dc7de 100644 --- a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-manual-configuration.md +++ b/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-manual-configuration.md @@ -16,12 +16,6 @@ When developing Dapr applications, you typically use the Dapr cli to start your dapr run --app-id nodeapp --app-port 3000 --dapr-http-port 3500 app.js ``` -This will generate the components yaml files (if they don't exist) so that your service can interact with the local redis container. This is great when you are just getting started but what if you want to attach a debugger to your service and step through the code? This is where you can use the dapr runtime (daprd) to help facilitate this. - -{{% alert title="Note" color="primary" %}} -The dapr runtime (daprd) will not automatically generate the components yaml files for Redis. These will need to be created manually or you will need to run the dapr cli (dapr) once in order to have them created automatically. -{{% /alert %}} - One approach to attaching the debugger to your service is to first run daprd with the correct arguments from the command line and then launch your code and attach the debugger. While this is a perfectly acceptable solution, it does require a few extra steps and some instruction to developers who might want to clone your repo and hit the "play" button to begin debugging. Using the [tasks.json](https://code.visualstudio.com/Docs/editor/tasks) and [launch.json](https://code.visualstudio.com/Docs/editor/debugging) files in Visual Studio Code, you can simplify the process and request that VS Code kick off the daprd process prior to launching the debugger. From 8e4e85717af6609f8b8d9c58a01ed7660299752a Mon Sep 17 00:00:00 2001 From: Lorenzo Montanari Date: Wed, 14 Jul 2021 12:12:12 +0200 Subject: [PATCH 20/34] Removed a duplicated line in Kubernetes section --- .../debugging/debug-k8s/debug-dapr-services.md | 1 - 1 file changed, 1 deletion(-) diff --git a/daprdocs/content/en/developing-applications/debugging/debug-k8s/debug-dapr-services.md b/daprdocs/content/en/developing-applications/debugging/debug-k8s/debug-dapr-services.md index bc430b939..17f71eab5 100644 --- a/daprdocs/content/en/developing-applications/debugging/debug-k8s/debug-dapr-services.md +++ b/daprdocs/content/en/developing-applications/debugging/debug-k8s/debug-dapr-services.md @@ -30,7 +30,6 @@ cd dapr make release GOOS=linux GOARCH=amd64 DEBUG=1 ``` ->On Windows download [MingGW](https://sourceforge.net/projects/mingw/files/MinGW/Extension/make/mingw32-make-3.80-3/) and use `ming32-make.exe` instead of `make`. >On Windows download [MingGW](https://sourceforge.net/projects/mingw/files/MinGW/Extension/make/mingw32-make-3.80-3/) and use `ming32-make.exe` instead of `make`. In the above command, 'DEBUG' is specified to '1' to disable compiler optimization. 'GOOS=linux' and 'GOARCH=amd64' are also necessary since the binaries will be packaged into Linux-based Docker image in the next step. From 20c028454825d116a8a91fc9af8c8e856018a8be Mon Sep 17 00:00:00 2001 From: Nick Greenfield Date: Tue, 29 Jun 2021 15:12:41 -0700 Subject: [PATCH 21/34] Add Go SDK submodule and docs --- .gitmodules | 3 +++ daprdocs/config.toml | 8 ++++++++ sdkdocs/go | 1 + 3 files changed, 12 insertions(+) create mode 160000 sdkdocs/go diff --git a/.gitmodules b/.gitmodules index 3d8a47fd8..7a3fdb882 100644 --- a/.gitmodules +++ b/.gitmodules @@ -14,3 +14,6 @@ path = translations/docs-zh url = https://github.com/dapr/docs-zh.git branch = v1.0_content +[submodule "sdkdocs/go"] + path = sdkdocs/go + url = git@github.com:dapr/go-sdk.git diff --git a/daprdocs/config.toml b/daprdocs/config.toml index 711f151c5..f3d77ee81 100644 --- a/daprdocs/config.toml +++ b/daprdocs/config.toml @@ -71,6 +71,14 @@ id = "UA-149338238-3" source = "../sdkdocs/dotnet/daprdocs/content/en/dotnet-sdk-contributing" target = "content/contributing/" lang = "en" + [[module.mounts]] + source = "../sdkdocs/go/daprdocs/content/en/go-sdk-docs" + target = "content/developing-applications/sdks/go" + lang = "en" + [[module.mounts]] + source = "../sdkdocs/go/daprdocs/content/en/go-sdk-contributing" + target = "content/contributing/" + lang = "en" [[module.mounts]] source = "../translations/docs-zh/content/zh-hans" diff --git a/sdkdocs/go b/sdkdocs/go new file mode 160000 index 000000000..df8589712 --- /dev/null +++ b/sdkdocs/go @@ -0,0 +1 @@ +Subproject commit df8589712fb18d577e8979df27bb880a6b692ebf From 486c40185712827702d287a7c00e92a31bf6fffb Mon Sep 17 00:00:00 2001 From: Nick Greenfield Date: Thu, 1 Jul 2021 12:58:08 -0700 Subject: [PATCH 22/34] Update go-sdk to latest commit on main --- sdkdocs/go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdkdocs/go b/sdkdocs/go index df8589712..a9c6bcb4f 160000 --- a/sdkdocs/go +++ b/sdkdocs/go @@ -1 +1 @@ -Subproject commit df8589712fb18d577e8979df27bb880a6b692ebf +Subproject commit a9c6bcb4f44d38403854387b7ab8713fd6e992e9 From 31d83d1205727c2b247e2a743ca0856cde31fa66 Mon Sep 17 00:00:00 2001 From: Nick Greenfield Date: Thu, 1 Jul 2021 13:39:56 -0700 Subject: [PATCH 23/34] Use https for git submodule url --- .gitmodules | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitmodules b/.gitmodules index 7a3fdb882..c2f4ff29d 100644 --- a/.gitmodules +++ b/.gitmodules @@ -16,4 +16,4 @@ branch = v1.0_content [submodule "sdkdocs/go"] path = sdkdocs/go - url = git@github.com:dapr/go-sdk.git + url = https://github.com/dapr/go-sdk.git From 4a502bf58ffcbda370ee93e2d2448b5457b67705 Mon Sep 17 00:00:00 2001 From: Nick Greenfield Date: Mon, 12 Jul 2021 09:53:33 -0700 Subject: [PATCH 24/34] Update go-sdk submodule --- sdkdocs/go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdkdocs/go b/sdkdocs/go index a9c6bcb4f..189b10cc8 160000 --- a/sdkdocs/go +++ b/sdkdocs/go @@ -1 +1 @@ -Subproject commit a9c6bcb4f44d38403854387b7ab8713fd6e992e9 +Subproject commit 189b10cc8fd44f81c9397b8256a149fb19636f27 From 8e283cdef9cf74d9ea6b55ac584f8b7a023c24b5 Mon Sep 17 00:00:00 2001 From: Nick Greenfield Date: Tue, 13 Jul 2021 11:20:12 -0700 Subject: [PATCH 25/34] Update to latest commit for Go SDK repo --- sdkdocs/go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdkdocs/go b/sdkdocs/go index 189b10cc8..fc67f725e 160000 --- a/sdkdocs/go +++ b/sdkdocs/go @@ -1 +1 @@ -Subproject commit 189b10cc8fd44f81c9397b8256a149fb19636f27 +Subproject commit fc67f725e0b5bb14ce903940fe889a76b59fceef From 74052cf633a78d972ccb38c46d68fd4ef0227ddc Mon Sep 17 00:00:00 2001 From: Nick Greenfield Date: Tue, 13 Jul 2021 11:30:35 -0700 Subject: [PATCH 26/34] Link to correct Go SDK page in dapr docs --- daprdocs/content/en/_index.md | 2 +- daprdocs/content/en/developing-applications/sdks/_index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/daprdocs/content/en/_index.md b/daprdocs/content/en/_index.md index 0db703ac4..da87a5014 100644 --- a/daprdocs/content/en/_index.md +++ b/daprdocs/content/en/_index.md @@ -101,7 +101,7 @@ Welcome to the Dapr documentation site!
- + Go logo
diff --git a/daprdocs/content/en/developing-applications/sdks/_index.md b/daprdocs/content/en/developing-applications/sdks/_index.md index 2ad84d08b..88848a8c7 100644 --- a/daprdocs/content/en/developing-applications/sdks/_index.md +++ b/daprdocs/content/en/developing-applications/sdks/_index.md @@ -34,7 +34,7 @@ The Dapr SDKs are the easiest way for you to get Dapr into your application. Cho | [.NET]({{< ref dotnet >}}) | Stable | ✔ | [ASP.NET Core]({{< ref dotnet-aspnet >}}) | ✔ | | [Python]({{< ref python >}}) | Stable | ✔ | [gRPC]({{< ref python-grpc.md >}}) | [FastAPI]({{< ref python-fastapi.md >}})
[Flask]({{< ref python-flask.md >}}) | | [Java](https://github.com/dapr/java-sdk) | Stable | ✔ | Spring Boot | ✔ | -| [Go](https://github.com/dapr/go-sdk) | Stable | ✔ | ✔ | | +| [Go]({{< ref go >}}) | Stable | ✔ | ✔ | | | [PHP]({{< ref php >}}) | Stable | ✔ | ✔ | ✔ | | [C++](https://github.com/dapr/cpp-sdk) | In development | ✔ | | | [Rust](https://github.com/dapr/rust-sdk) | In development | ✔ | | | From 40fd8cb5287a1217931b3914ae55333c4bc030d0 Mon Sep 17 00:00:00 2001 From: Nick Greenfield Date: Wed, 14 Jul 2021 15:40:53 -0700 Subject: [PATCH 27/34] Add Bridge to Kubernetes linke from Kubernetes overview page --- .../en/operations/hosting/kubernetes/kubernetes-overview.md | 1 + 1 file changed, 1 insertion(+) diff --git a/daprdocs/content/en/operations/hosting/kubernetes/kubernetes-overview.md b/daprdocs/content/en/operations/hosting/kubernetes/kubernetes-overview.md index d6e9cde72..36e5efe72 100644 --- a/daprdocs/content/en/operations/hosting/kubernetes/kubernetes-overview.md +++ b/daprdocs/content/en/operations/hosting/kubernetes/kubernetes-overview.md @@ -50,3 +50,4 @@ Dapr is tested and supported on the following versions of Kubernetes. - [Upgrade Dapr on a Kubernetes cluster]({{< ref kubernetes-upgrade >}}) - [Production guidelines for Dapr on Kubernetes]({{< ref kubernetes-production.md >}}) - [Dapr Kubernetes Quickstart](https://github.com/dapr/quickstarts/tree/master/hello-kubernetes) +- [Use Bridge to Kubernetes to debug Dapr apps locally, while connected to your Kubernetes cluster]({{< ref bridge-to-kubernetes >}}) From 669fa54b10ede7895f335800cc86b00348dfdb05 Mon Sep 17 00:00:00 2001 From: jasonviviano <83607984+jasonviviano@users.noreply.github.com> Date: Thu, 15 Jul 2021 10:37:03 -0400 Subject: [PATCH 28/34] Fixed vscode link and updated information on manual. --- .../ides/{visual-studio-code => vscode}/_index.md | 0 .../vscode-dapr-extension.md | 0 .../vscode-manual-configuration.md | 8 ++++---- .../vscode-remote-dev-containers.md | 4 ++-- 4 files changed, 6 insertions(+), 6 deletions(-) rename daprdocs/content/en/developing-applications/ides/{visual-studio-code => vscode}/_index.md (100%) rename daprdocs/content/en/developing-applications/ides/{visual-studio-code => vscode}/vscode-dapr-extension.md (100%) rename daprdocs/content/en/developing-applications/ides/{visual-studio-code => vscode}/vscode-manual-configuration.md (83%) rename daprdocs/content/en/developing-applications/ides/{visual-studio-code => vscode}/vscode-remote-dev-containers.md (85%) diff --git a/daprdocs/content/en/developing-applications/ides/visual-studio-code/_index.md b/daprdocs/content/en/developing-applications/ides/vscode/_index.md similarity index 100% rename from daprdocs/content/en/developing-applications/ides/visual-studio-code/_index.md rename to daprdocs/content/en/developing-applications/ides/vscode/_index.md diff --git a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md b/daprdocs/content/en/developing-applications/ides/vscode/vscode-dapr-extension.md similarity index 100% rename from daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-dapr-extension.md rename to daprdocs/content/en/developing-applications/ides/vscode/vscode-dapr-extension.md diff --git a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-manual-configuration.md b/daprdocs/content/en/developing-applications/ides/vscode/vscode-manual-configuration.md similarity index 83% rename from daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-manual-configuration.md rename to daprdocs/content/en/developing-applications/ides/vscode/vscode-manual-configuration.md index ad57dc7de..c2585e180 100644 --- a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-manual-configuration.md +++ b/daprdocs/content/en/developing-applications/ides/vscode/vscode-manual-configuration.md @@ -22,7 +22,7 @@ Using the [tasks.json](https://code.visualstudio.com/Docs/editor/tasks) and [lau #### Modifying launch.json configurations to include a preLaunchTask -In your [launch.json](https://code.visualstudio.com/Docs/editor/debugging) file add a [preLaunchTask](https://code.visualstudio.com/Docs/editor/debugging#_launchjson-attributes) for each configuration that you want daprd launched. The [preLaunchTask](https://code.visualstudio.com/Docs/editor/debugging#_launchjson-attributes) will reference tasks that you define in your tasks.json file. Here is an example for both Node and .NET Core. Notice the [preLaunchTasks](https://code.visualstudio.com/Docs/editor/debugging#_launchjson-attributes) referenced: daprd-web and daprd-leaderboard. +In your [launch.json](https://code.visualstudio.com/Docs/editor/debugging) file add a [preLaunchTask](https://code.visualstudio.com/Docs/editor/debugging#_launchjson-attributes) for each configuration that you want daprd launched. The [preLaunchTask](https://code.visualstudio.com/Docs/editor/debugging#_launchjson-attributes) references tasks that you define in your tasks.json file. Here is an example for both Node and .NET Core. Notice the [preLaunchTasks](https://code.visualstudio.com/Docs/editor/debugging#_launchjson-attributes) referenced: daprd-web and daprd-leaderboard. ```json { @@ -64,17 +64,17 @@ In your [launch.json](https://code.visualstudio.com/Docs/editor/debugging) file #### Adding daprd tasks to tasks.json -You will need to define a task and problem matcher for daprd in your [tasks.json](https://code.visualstudio.com/Docs/editor/tasks) file. Here are two examples (both referenced via the [preLaunchTask](https://code.visualstudio.com/Docs/editor/debugging#_launchjson-attributes) members above). Notice that in the case of the .NET Core daprd task (daprd-leaderboard) there is also a [dependsOn](https://code.visualstudio.com/Docs/editor/tasks#_compound-tasks) member that references the build task to ensure the latest code is being run/debugged. The [problemMatcher](https://code.visualstudio.com/Docs/editor/tasks#_defining-a-problem-matcher) is used so that VSCode can understand when the daprd process is up and running. +You need to define a task and problem matcher for daprd in your [tasks.json](https://code.visualstudio.com/Docs/editor/tasks) file. Here are two examples (both referenced via the [preLaunchTask](https://code.visualstudio.com/Docs/editor/debugging#_launchjson-attributes) members above). Notice that in the case of the .NET Core daprd task (daprd-leaderboard) there is also a [dependsOn](https://code.visualstudio.com/Docs/editor/tasks#_compound-tasks) member that references the build task to ensure the latest code is being run/debugged. The [problemMatcher](https://code.visualstudio.com/Docs/editor/tasks#_defining-a-problem-matcher) is used so that VSCode can understand when the daprd process is up and running. Let's take a quick look at the args that are being passed to the daprd command. -* -app-id -- the id (how you will locate it via service invocation) of your microservice +* -app-id -- the id (how you locate it via service invocation) of your microservice * -app-port -- the port number that your application code is listening on * -dapr-http-port -- the http port for the dapr api * -dapr-grpc-port -- the grpc port for the dapr api * -placement-host-address -- the location of the placement service (this should be running in docker as it was created when you installed dapr and ran ```dapr init```) ->Note: You will need to ensure that you specify different http/grpc (-dapr-http-port and -dapr-grpc-port) ports for each daprd task that you create, otherwise you will run into port conflicts when you attempt to launch the second configuration. +>Note: You need to ensure that you specify different http/grpc (-dapr-http-port and -dapr-grpc-port) ports for each daprd task that you create, otherwise you run into port conflicts when you attempt to launch the second configuration. ```json { diff --git a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-remote-dev-containers.md b/daprdocs/content/en/developing-applications/ides/vscode/vscode-remote-dev-containers.md similarity index 85% rename from daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-remote-dev-containers.md rename to daprdocs/content/en/developing-applications/ides/vscode/vscode-remote-dev-containers.md index d3409a88e..3235d30b1 100644 --- a/daprdocs/content/en/developing-applications/ides/visual-studio-code/vscode-remote-dev-containers.md +++ b/daprdocs/content/en/developing-applications/ides/vscode/vscode-remote-dev-containers.md @@ -1,6 +1,6 @@ --- type: docs -title: "Visual Studio Code remote dev containers" +title: "Developing Dapr applications with remote dev containers" linkTitle: "Remote dev containers" weight: 20000 description: "How to setup a remote dev container environment with Dapr" @@ -8,7 +8,7 @@ description: "How to setup a remote dev container environment with Dapr" The Visual Studio Code [Remote Containers extension](https://code.visualstudio.com/docs/remote/containers) lets you use a Docker container as a full-featured development environment without installing any additional frameworks or packages to your local filesystem. -Dapr has pre-built Docker remote containers for each of the language SDKs. You can pick the one of your choice for a ready made environment. Note these pre-built containers automatically update to the latest Dapr release. +Dapr has pre-built Docker remote containers for NodeJS and C#. You can pick the one of your choice for a ready made environment. Note these pre-built containers automatically update to the latest Dapr release. ### Setup a remote dev container From 0b41e17c31e8d0d469320af99afbcd7ceab2fdd0 Mon Sep 17 00:00:00 2001 From: Long Dai Date: Fri, 16 Jul 2021 01:05:21 -0700 Subject: [PATCH 29/34] fix some typo Signed-off-by: Long Dai --- .../w3c-tracing/w3c-tracing-overview.md | 2 +- .../building-blocks/pubsub/pubsub-scopes.md | 2 +- .../en/developing-applications/ides/intellij.md | 2 +- .../integrations/gRPC-integration.md | 2 +- .../en/operations/configuration/invoke-allowlist.md | 4 ++-- .../en/operations/configuration/secret-scope.md | 2 +- .../hosting/self-hosted/self-hosted-with-docker.md | 2 +- .../en/operations/monitoring/metrics/grafana.md | 2 +- .../en/operations/troubleshooting/common_issues.md | 2 +- .../components-reference/supported-bindings/http.md | 6 +++--- .../supported-bindings/zeebe-command.md | 2 +- .../supported-middleware/middleware-opa.md | 2 +- .../supported-pubsub/setup-rabbitmq.md | 2 +- .../supported-secret-stores/envvar-secret-store.md | 2 +- .../supported-secret-stores/hashicorp-vault.md | 2 +- .../setup-azure-tablestorage.md | 2 +- .../supported-state-stores/setup-mongodb.md | 2 +- .../supported-state-stores/setup-zookeeper.md | 2 +- daprdocs/static/docs/azm-config-map.yaml | 12 ++++++------ 19 files changed, 27 insertions(+), 27 deletions(-) diff --git a/daprdocs/content/en/developing-applications/building-blocks/observability/w3c-tracing/w3c-tracing-overview.md b/daprdocs/content/en/developing-applications/building-blocks/observability/w3c-tracing/w3c-tracing-overview.md index 56ca62057..db89c0cd5 100644 --- a/daprdocs/content/en/developing-applications/building-blocks/observability/w3c-tracing/w3c-tracing-overview.md +++ b/daprdocs/content/en/developing-applications/building-blocks/observability/w3c-tracing/w3c-tracing-overview.md @@ -72,7 +72,7 @@ In these scenarios Dapr does some of the work for you and you need to either cre To understand how to extract the trace headers from a response and add the trace headers into a request, see the [how to use trace context]({{< ref w3c-tracing >}}) article. 2. You have chosen to generate your own trace context headers. -This is much more unusual. There may be occassions where you specifically chose to add W3C trace headers into a service call, for example if you have an existing application that does not currently use Dapr. In this case Dapr still propagates the trace context headers for you. If you decide to generate trace headers yourself, there are three ways this can be done : +This is much more unusual. There may be occasions where you specifically chose to add W3C trace headers into a service call, for example if you have an existing application that does not currently use Dapr. In this case Dapr still propagates the trace context headers for you. If you decide to generate trace headers yourself, there are three ways this can be done : 1. You can use the industry standard OpenCensus/OpenTelemetry SDKs to generate trace headers and pass these trace headers to a Dapr enabled service. This is the preferred recommendation. diff --git a/daprdocs/content/en/developing-applications/building-blocks/pubsub/pubsub-scopes.md b/daprdocs/content/en/developing-applications/building-blocks/pubsub/pubsub-scopes.md index 9b12cf5c9..e3a055d20 100644 --- a/daprdocs/content/en/developing-applications/building-blocks/pubsub/pubsub-scopes.md +++ b/daprdocs/content/en/developing-applications/building-blocks/pubsub/pubsub-scopes.md @@ -32,7 +32,7 @@ To use this topic scoping three metadata properties can be set for a pub/sub com - `spec.metadata.allowedTopics` - A comma-separated list of allowed topics for all applications. - If `allowedTopics` is not set (default behavior), all topics are valid. `subscriptionScopes` and `publishingScopes` still take place if present. - - `publishingScopes` or `subscriptionScopes` can be used in conjuction with `allowedTopics` to add granular limitations + - `publishingScopes` or `subscriptionScopes` can be used in conjunction with `allowedTopics` to add granular limitations These metadata properties can be used for all pub/sub components. The following examples use Redis as pub/sub component. diff --git a/daprdocs/content/en/developing-applications/ides/intellij.md b/daprdocs/content/en/developing-applications/ides/intellij.md index 80bc755e5..1bd3bf6e7 100644 --- a/daprdocs/content/en/developing-applications/ides/intellij.md +++ b/daprdocs/content/en/developing-applications/ides/intellij.md @@ -80,7 +80,7 @@ Add a new `` entry: ``` -Optionally, you may also create a new entry for a sidecar tool that can be reused accross many projects: +Optionally, you may also create a new entry for a sidecar tool that can be reused across many projects: ```xml diff --git a/daprdocs/content/en/developing-applications/integrations/gRPC-integration.md b/daprdocs/content/en/developing-applications/integrations/gRPC-integration.md index 4386cb529..c48bc0f73 100644 --- a/daprdocs/content/en/developing-applications/integrations/gRPC-integration.md +++ b/daprdocs/content/en/developing-applications/integrations/gRPC-integration.md @@ -177,7 +177,7 @@ func (s *server) ListInputBindings(ctx context.Context, in *empty.Empty) (*pb.Li }, nil } -// This method gets invoked every time a new event is fired from a registerd binding. The message carries the binding name, a payload and optional metadata +// This method gets invoked every time a new event is fired from a registered binding. The message carries the binding name, a payload and optional metadata func (s *server) OnBindingEvent(ctx context.Context, in *pb.BindingEventRequest) (*pb.BindingEventResponse, error) { fmt.Println("Invoked from binding") return &pb.BindingEventResponse{}, nil diff --git a/daprdocs/content/en/operations/configuration/invoke-allowlist.md b/daprdocs/content/en/operations/configuration/invoke-allowlist.md index e685e238f..bdae45310 100644 --- a/daprdocs/content/en/operations/configuration/invoke-allowlist.md +++ b/daprdocs/content/en/operations/configuration/invoke-allowlist.md @@ -8,7 +8,7 @@ description: "Restrict what operations *calling* applications can perform, via s Access control enables the configuration of policies that restrict what operations *calling* applications can perform, via service invocation, on the *called* application. To limit access to a called applications from specific operations and HTTP verbs from the calling applications, you can define an access control policy specification in configuration. -An access control policy is specified in configuration and be applied to Dapr sidecar for the *called* application. Example access policies are shown below and access to the called app is based on the matched policy action. You can provide a default global action for all calling applications and if no access control policy is specified, the default behavior is to allow all calling applicatons to access to the called app. +An access control policy is specified in configuration and be applied to Dapr sidecar for the *called* application. Example access policies are shown below and access to the called app is based on the matched policy action. You can provide a default global action for all calling applications and if no access control policy is specified, the default behavior is to allow all calling applications to access to the called app. Watch this [video](https://youtu.be/j99RN_nxExA?t=1108) on how to apply access control list for service invocation. @@ -194,7 +194,7 @@ spec: ## Hello world examples These examples show how to apply access control to the [hello world](https://github.com/dapr/quickstarts#quickstarts) quickstart samples where a python app invokes a node.js app. -Access control lists rely on the Dapr [Sentry service]({{< ref "security-concept.md" >}}) to generate the TLS certificates with a SPIFFE id for authentication, which means the Sentry service either has to be running locally or deployed to your hosting enviroment such as a Kubernetes cluster. +Access control lists rely on the Dapr [Sentry service]({{< ref "security-concept.md" >}}) to generate the TLS certificates with a SPIFFE id for authentication, which means the Sentry service either has to be running locally or deployed to your hosting environment such as a Kubernetes cluster. The nodeappconfig example below shows how to **deny** access to the `neworder` method from the `pythonapp`, where the python app is in the `myDomain` trust domain and `default` namespace. The nodeapp is in the `public` trust domain. diff --git a/daprdocs/content/en/operations/configuration/secret-scope.md b/daprdocs/content/en/operations/configuration/secret-scope.md index 99603718e..a937f56e5 100644 --- a/daprdocs/content/en/operations/configuration/secret-scope.md +++ b/daprdocs/content/en/operations/configuration/secret-scope.md @@ -96,7 +96,7 @@ spec: This example defines configuration for secret store named vault. The default access to the secret store is `deny`, whereas some secrets are accessible by the application based on the `allowedSecrets` list. Follow [these instructions]({{< ref configuration-overview.md >}}) to apply configuration to the sidecar. -### Scenario 3: Deny access to certain senstive secrets in a secret store +### Scenario 3: Deny access to certain sensitive secrets in a secret store Define the following `config.yaml`: diff --git a/daprdocs/content/en/operations/hosting/self-hosted/self-hosted-with-docker.md b/daprdocs/content/en/operations/hosting/self-hosted/self-hosted-with-docker.md index b69b48ac0..4dcd439b4 100644 --- a/daprdocs/content/en/operations/hosting/self-hosted/self-hosted-with-docker.md +++ b/daprdocs/content/en/operations/hosting/self-hosted/self-hosted-with-docker.md @@ -99,7 +99,7 @@ Each container will receive a unique IP on that network and be able to communica [Docker Compose](https://docs.docker.com/compose/) can be used to define multi-container application configurations. If you wish to run multiple apps with Dapr sidecars locally without Kubernetes then it is recommended to use a Docker Compose definition (`docker-compose.yml`). -The syntax and tooling of Docker Compose is outside the scope of this article, however, it is recommended you refer to the [offical Docker documentation](https://docs.docker.com/compose/) for further details. +The syntax and tooling of Docker Compose is outside the scope of this article, however, it is recommended you refer to the [official Docker documentation](https://docs.docker.com/compose/) for further details. In order to run your applications using Dapr and Docker Compose you'll need to define the sidecar pattern in your `docker-compose.yml`. For example: diff --git a/daprdocs/content/en/operations/monitoring/metrics/grafana.md b/daprdocs/content/en/operations/monitoring/metrics/grafana.md index 8dd5c2c32..0b64a7316 100644 --- a/daprdocs/content/en/operations/monitoring/metrics/grafana.md +++ b/daprdocs/content/en/operations/monitoring/metrics/grafana.md @@ -156,7 +156,7 @@ First you need to connect Prometheus as a data source to Grafana. 1. Find the dashboard that you imported and enjoy - Screenshot of Dapr service dashbaord + Screenshot of Dapr service dashboard {{% alert title="Tip" color="primary" %}} Hover your mouse over the `i` in the corner to the description of each chart: diff --git a/daprdocs/content/en/operations/troubleshooting/common_issues.md b/daprdocs/content/en/operations/troubleshooting/common_issues.md index 1a7718858..9a802effa 100644 --- a/daprdocs/content/en/operations/troubleshooting/common_issues.md +++ b/daprdocs/content/en/operations/troubleshooting/common_issues.md @@ -223,6 +223,6 @@ In order for mDNS to function properly, ensure `Micorosft Content Filter` is ina - Type `mdatp system-extension network-filter disable` and hit enter. - Enter your account password. -Microsoft Content Filter is disbaled when the output is "Success". +Microsoft Content Filter is disabled when the output is "Success". > Some organizations will re-enable the filter from time to time. If you repeatedly encounter app-id values missing, first check to see if the filter has been re-enabled before doing more extensive troubleshooting. diff --git a/daprdocs/content/en/reference/components-reference/supported-bindings/http.md b/daprdocs/content/en/reference/components-reference/supported-bindings/http.md index 474c4e9c5..f1d32550f 100644 --- a/daprdocs/content/en/reference/components-reference/supported-bindings/http.md +++ b/daprdocs/content/en/reference/components-reference/supported-bindings/http.md @@ -31,9 +31,9 @@ spec: ## Binding support -This component supports **output binding** with the folowing [HTTP methods/verbs](https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html): +This component supports **output binding** with the following [HTTP methods/verbs](https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html): -- `create` : For backward compatability and treated like a post +- `create` : For backward compatibility and treated like a post - `get` : Read data/records - `head` : Identical to get except that the server does not return a response body - `post` : Typically used to create records or send commands @@ -133,7 +133,7 @@ To send data to the HTTP endpoint, invoke the HTTP binding with a `POST`, `PUT`, {{% alert title="Note" color="primary" %}} Any metadata field that starts with a capital letter is passed as a request header. -For example, the default content type is `application/json; charset=utf-8`. This can be overriden be setting the `Content-Type` metadata field. +For example, the default content type is `application/json; charset=utf-8`. This can be overridden be setting the `Content-Type` metadata field. {{% /alert %}} ```json diff --git a/daprdocs/content/en/reference/components-reference/supported-bindings/zeebe-command.md b/daprdocs/content/en/reference/components-reference/supported-bindings/zeebe-command.md index 48cb639e7..9947f7963 100644 --- a/daprdocs/content/en/reference/components-reference/supported-bindings/zeebe-command.md +++ b/daprdocs/content/en/reference/components-reference/supported-bindings/zeebe-command.md @@ -497,7 +497,7 @@ To perform a `fail-job` operation, invoke the Zeebe command binding with a `POST "data": { "jobKey": 2251799813685739, "retries": 5, - "errorMessage": "some error occured" + "errorMessage": "some error occurred" }, "metadata": {}, "operation": "fail-job" diff --git a/daprdocs/content/en/reference/components-reference/supported-middleware/middleware-opa.md b/daprdocs/content/en/reference/components-reference/supported-middleware/middleware-opa.md index 1c10e6026..54b042284 100644 --- a/daprdocs/content/en/reference/components-reference/supported-middleware/middleware-opa.md +++ b/daprdocs/content/en/reference/components-reference/supported-middleware/middleware-opa.md @@ -99,7 +99,7 @@ This middleware supplies a [`HTTPRequest`](#httprequest) as input. ### HTTPRequest -The `HTTPRequest` input contains all the revelant information about an incoming HTTP Request except it's body. +The `HTTPRequest` input contains all the relevant information about an incoming HTTP Request except it's body. ```go type Input struct { diff --git a/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rabbitmq.md b/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rabbitmq.md index b16a9392e..99191d4bc 100644 --- a/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rabbitmq.md +++ b/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rabbitmq.md @@ -51,7 +51,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr | deletedWhenUnused | N | Whether or not the queue should be configured to [auto-delete](https://www.rabbitmq.com/queues.html) Defaults to `"true"` | `"true"`, `"false"` | autoAck | N | Whether or not the queue consumer should [auto-ack](https://www.rabbitmq.com/confirms.html) messages. Defaults to `"false"` | `"true"`, `"false"` | deliveryMode | N | Persistence mode when publishing messages. Defaults to `"0"`. RabbitMQ treats `"2"` as persistent, all other numbers as non-persistent | `"0"`, `"2"` -| requeueInFailure | N | Whether or not to requeue when sending a [negative acknolwedgement](https://www.rabbitmq.com/nack.html) in case of a failure. Defaults to `"false"` | `"true"`, `"false"` +| requeueInFailure | N | Whether or not to requeue when sending a [negative acknowledgement](https://www.rabbitmq.com/nack.html) in case of a failure. Defaults to `"false"` | `"true"`, `"false"` | prefetchCount | N | Number of messages to [prefetch](https://www.rabbitmq.com/consumer-prefetch.html). Consider changing this to a non-zero value for production environments. Defaults to `"0"`, which means that all available messages will be pre-fetched. | `"2"` | reconnectWait | N | How long to wait (in seconds) before reconnecting if a connection failure occurs | `"0"` | concurrencyMode | N | `parallel` is the default, and allows processing multiple messages in parallel (limited by the `app-max-concurrency` annotation, if configured). Set to `single` to disable parallel processing. In most situations there's no reason to change this. | `parallel`, `single` diff --git a/daprdocs/content/en/reference/components-reference/supported-secret-stores/envvar-secret-store.md b/daprdocs/content/en/reference/components-reference/supported-secret-stores/envvar-secret-store.md index bbb09d9cb..f5073bdbc 100644 --- a/daprdocs/content/en/reference/components-reference/supported-secret-stores/envvar-secret-store.md +++ b/daprdocs/content/en/reference/components-reference/supported-secret-stores/envvar-secret-store.md @@ -30,6 +30,6 @@ spec: ``` ## Related Links - [Secrets building block]({{< ref secrets >}}) -- [How-To: Retreive a secret]({{< ref "howto-secrets.md" >}}) +- [How-To: Retrieve a secret]({{< ref "howto-secrets.md" >}}) - [How-To: Reference secrets in Dapr components]({{< ref component-secrets.md >}}) - [Secrets API reference]({{< ref secrets_api.md >}}) \ No newline at end of file diff --git a/daprdocs/content/en/reference/components-reference/supported-secret-stores/hashicorp-vault.md b/daprdocs/content/en/reference/components-reference/supported-secret-stores/hashicorp-vault.md index 180e2d882..c342ba908 100644 --- a/daprdocs/content/en/reference/components-reference/supported-secret-stores/hashicorp-vault.md +++ b/daprdocs/content/en/reference/components-reference/supported-secret-stores/hashicorp-vault.md @@ -56,7 +56,7 @@ The above example uses secrets as plain strings. It is recommended to use a loca | tlsServerName | N | TLS config server name | `"tls-server"` | | vaultTokenMountPath | Y | Path to file containing token | `"path/to/file"` | | vaultToken | Y | [Token](https://learn.hashicorp.com/tutorials/vault/tokens) for authentication within Vault. | `"tokenValue"` | -| vaultKVPrefix | N | The prefix in vault. Defautls to `"dapr"` | `"dapr"`, `"myprefix"` | +| vaultKVPrefix | N | The prefix in vault. Defaults to `"dapr"` | `"dapr"`, `"myprefix"` | ## Setup Hashicorp Vault instance diff --git a/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-azure-tablestorage.md b/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-azure-tablestorage.md index afa4a20c5..42f881cb4 100644 --- a/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-azure-tablestorage.md +++ b/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-azure-tablestorage.md @@ -79,7 +79,7 @@ will create the following record in a table: ## Concurrency -Azure Table Storage state concurrency is achieved by using `ETag`s according to [the official documenation]( https://docs.microsoft.com/en-us/azure/storage/common/storage-concurrency#managing-concurrency-in-table-storage). +Azure Table Storage state concurrency is achieved by using `ETag`s according to [the official documentation]( https://docs.microsoft.com/en-us/azure/storage/common/storage-concurrency#managing-concurrency-in-table-storage). ## Related links diff --git a/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-mongodb.md b/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-mongodb.md index 255b604f3..ea9759464 100644 --- a/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-mongodb.md +++ b/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-mongodb.md @@ -63,7 +63,7 @@ If you wish to use MongoDB as an actor store, append the following to the yaml. | collectionName | N | The name of the collection to use. Defaults to `"daprCollection"` | `"daprCollection"` | writeconcern | N | The write concern to use | `"majority"` | readconcern | N | The read concern to use | `"majority"`, `"local"`,`"available"`, `"linearizable"`, `"snapshot"` -| operationTimeout | N | The timeout for the operation. Defautls to `"5s"` | `"5s"` +| operationTimeout | N | The timeout for the operation. Defaults to `"5s"` | `"5s"` ## Setup MongoDB diff --git a/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-zookeeper.md b/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-zookeeper.md index 0a4d98c17..6e4ef0d42 100644 --- a/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-zookeeper.md +++ b/daprdocs/content/en/reference/components-reference/supported-state-stores/setup-zookeeper.md @@ -44,7 +44,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr | servers | Y | Comma delimited list of servers | `"zookeeper.default.svc.cluster.local:2181"` | sessionTimeout | Y | The session timeout value | `"5s"` | maxBufferSize | N | The maximum size of buffer. Defaults to `"1048576"` | `"1048576"` -| maxConnBufferSize | N | The maximum size of connection buffer. Defautls to `"1048576`" | `"1048576"` +| maxConnBufferSize | N | The maximum size of connection buffer. Defaults to `"1048576`" | `"1048576"` | keyPrefixPath | N | The key prefix path in Zookeeper. No default | `"dapr"` ## Setup Zookeeper diff --git a/daprdocs/static/docs/azm-config-map.yaml b/daprdocs/static/docs/azm-config-map.yaml index 3b1adb133..3a35e8e3d 100644 --- a/daprdocs/static/docs/azm-config-map.yaml +++ b/daprdocs/static/docs/azm-config-map.yaml @@ -12,12 +12,12 @@ data: # Any errors related to config map settings can be found in the KubeMonAgentEvents table in the Log Analytics workspace that the cluster is sending data to. [log_collection_settings] [log_collection_settings.stdout] - # In the absense of this configmap, default value for enabled is true + # In the absence of this configmap, default value for enabled is true enabled = true # exclude_namespaces setting holds good only if enabled is set to true # kube-system log collection is disabled by default in the absence of 'log_collection_settings.stdout' setting. If you want to enable kube-system, remove it from the following setting. # If you want to continue to disable kube-system log collection keep this namespace in the following setting and add any other namespace you want to disable log collection to the array. - # In the absense of this configmap, default value for exclude_namespaces = ["kube-system"] + # In the absence of this configmap, default value for exclude_namespaces = ["kube-system"] exclude_namespaces = ["kube-system"] [log_collection_settings.stderr] # Default value for enabled is true @@ -25,17 +25,17 @@ data: # exclude_namespaces setting holds good only if enabled is set to true # kube-system log collection is disabled by default in the absence of 'log_collection_settings.stderr' setting. If you want to enable kube-system, remove it from the following setting. # If you want to continue to disable kube-system log collection keep this namespace in the following setting and add any other namespace you want to disable log collection to the array. - # In the absense of this cofigmap, default value for exclude_namespaces = ["kube-system"] + # In the absence of this cofigmap, default value for exclude_namespaces = ["kube-system"] exclude_namespaces = ["kube-system"] [log_collection_settings.env_var] - # In the absense of this configmap, default value for enabled is true + # In the absence of this configmap, default value for enabled is true enabled = true [log_collection_settings.enrich_container_logs] - # In the absense of this configmap, default value for enrich_container_logs is false + # In the absence of this configmap, default value for enrich_container_logs is false enabled = true # When this is enabled (enabled = true), every container log entry (both stdout & stderr) will be enriched with container Name & container Image [log_collection_settings.collect_all_kube_events] - # In the absense of this configmap, default value for collect_all_kube_events is false + # In the absence of this configmap, default value for collect_all_kube_events is false # When the setting is set to false, only the kube events with !normal event type will be collected enabled = false # When this is enabled (enabled = true), all kube events including normal events will be collected From 565378441f4e68a0044f9bbdf6a7660073b57cbb Mon Sep 17 00:00:00 2001 From: Nick Greenfield Date: Fri, 16 Jul 2021 15:29:29 -0700 Subject: [PATCH 30/34] Ensure MiniKube start command works by removing Kubernetes version and authorization params --- .../en/operations/hosting/kubernetes/cluster/setup-minikube.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/daprdocs/content/en/operations/hosting/kubernetes/cluster/setup-minikube.md b/daprdocs/content/en/operations/hosting/kubernetes/cluster/setup-minikube.md index 8222d7f0b..ef1d0110d 100644 --- a/daprdocs/content/en/operations/hosting/kubernetes/cluster/setup-minikube.md +++ b/daprdocs/content/en/operations/hosting/kubernetes/cluster/setup-minikube.md @@ -31,7 +31,7 @@ minikube config set vm-driver [driver_name] Use 1.13.x or newer version of Kubernetes with `--kubernetes-version` ```bash -minikube start --cpus=4 --memory=4096 --kubernetes-version=1.16.2 --extra-config=apiserver.authorization-mode=RBAC +minikube start --cpus=4 --memory=4096 ``` 3. Enable dashboard and ingress addons From 2bd4b10085e7bc7f0260377aba3fa10b921fc305 Mon Sep 17 00:00:00 2001 From: greenie-msft <56556602+greenie-msft@users.noreply.github.com> Date: Wed, 21 Jul 2021 12:26:02 -0700 Subject: [PATCH 31/34] Clarify path to secrets file in getting started guides (#1585) * Clarify path to secrets file in getting started guides * Clarify path to local secret store Co-authored-by: Ori Zohar Co-authored-by: Aaron Crawfis --- .../building-blocks/secrets/howto-secrets.md | 3 +++ daprdocs/content/en/getting-started/get-started-component.md | 2 +- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/daprdocs/content/en/developing-applications/building-blocks/secrets/howto-secrets.md b/daprdocs/content/en/developing-applications/building-blocks/secrets/howto-secrets.md index de8e1d221..4ada756ba 100644 --- a/daprdocs/content/en/developing-applications/building-blocks/secrets/howto-secrets.md +++ b/daprdocs/content/en/developing-applications/building-blocks/secrets/howto-secrets.md @@ -42,6 +42,9 @@ spec: Make sure to replace `` with the path to the JSON file you just created. +>Note: the path to the secret store JSON is relative to where you call `dapr run` from. + + To configure a different kind of secret store see the guidance on [how to configure a secret store]({{}}) and review [supported secret stores]({{}}) to see specific details required for different secret store solutions. ## Get a secret diff --git a/daprdocs/content/en/getting-started/get-started-component.md b/daprdocs/content/en/getting-started/get-started-component.md index 6781bac40..a8e05dc5a 100644 --- a/daprdocs/content/en/getting-started/get-started-component.md +++ b/daprdocs/content/en/getting-started/get-started-component.md @@ -55,7 +55,7 @@ spec: value: ":" ``` -You can see that the above file definition has a `type: secretstores.local.file` which tells Dapr to use the local file component as a secret store. The metadata fields provide component specific information needed to work with this component (in this case, the path to the secret store JSON) +You can see that the above file definition has a `type: secretstores.local.file` which tells Dapr to use the local file component as a secret store. The metadata fields provide component specific information needed to work with this component (in this case, the path to the secret store JSON is relative to where you call `dapr run` from.) ## Step 3: Run the Dapr sidecar From b01c969335ee5772999915243bdaccd225dc4aa0 Mon Sep 17 00:00:00 2001 From: sk593 Date: Thu, 22 Jul 2021 15:02:20 -0500 Subject: [PATCH 32/34] added arguments and annotations spec --- .../howto-invoke-discover-services.md | 2 +- .../configuration/configuration-overview.md | 2 +- .../configuration/increase-request-size.md | 2 +- .../kubernetes/kubernetes-annotations.md | 38 ------------- .../hosting/kubernetes/kubernetes-overview.md | 2 +- .../kubernetes/kubernetes-production.md | 2 +- .../self-hosted/self-hosted-overview.md | 2 +- .../troubleshooting/common_issues.md | 2 +- .../arguments-annotations-overview.md | 54 +++++++++++++++++++ .../content/en/reference/cli/cli-overview.md | 2 +- daprdocs/content/en/reference/cli/dapr-run.md | 2 +- 11 files changed, 63 insertions(+), 47 deletions(-) delete mode 100644 daprdocs/content/en/operations/hosting/kubernetes/kubernetes-annotations.md create mode 100644 daprdocs/content/en/reference/arguments-annotations-overview.md diff --git a/daprdocs/content/en/developing-applications/building-blocks/service-invocation/howto-invoke-discover-services.md b/daprdocs/content/en/developing-applications/building-blocks/service-invocation/howto-invoke-discover-services.md index 91022eb00..0c21d7dbb 100644 --- a/daprdocs/content/en/developing-applications/building-blocks/service-invocation/howto-invoke-discover-services.md +++ b/daprdocs/content/en/developing-applications/building-blocks/service-invocation/howto-invoke-discover-services.md @@ -57,7 +57,7 @@ spec: dapr.io/app-port: "5000" ... ``` -*If your app uses an SSL connection, you can tell Dapr to invoke your app over an insecure SSL connection with the `app-ssl: "true"` annotation (full list [here]({{< ref kubernetes-annotations.md >}}))* +*If your app uses an SSL connection, you can tell Dapr to invoke your app over an insecure SSL connection with the `app-ssl: "true"` annotation (full list [here]({{< ref arguments-annotations-overview.md >}}))* {{% /codetab %}} diff --git a/daprdocs/content/en/operations/configuration/configuration-overview.md b/daprdocs/content/en/operations/configuration/configuration-overview.md index e027eda25..5059a8d58 100644 --- a/daprdocs/content/en/operations/configuration/configuration-overview.md +++ b/daprdocs/content/en/operations/configuration/configuration-overview.md @@ -37,7 +37,7 @@ A Dapr sidecar can apply a specific configuration by using a ```dapr.io/config`` dapr.io/app-port: "3000" dapr.io/config: "myappconfig" ``` -Note: There are more [Kubernetes annotations]({{< ref "kubernetes-annotations.md" >}}) available to configure the Dapr sidecar on activation by sidecar Injector system service. +Note: There are more [Kubernetes annotations]({{< ref "arguments-annotations-overview.md" >}}) available to configure the Dapr sidecar on activation by sidecar Injector system service. ### Sidecar configuration settings diff --git a/daprdocs/content/en/operations/configuration/increase-request-size.md b/daprdocs/content/en/operations/configuration/increase-request-size.md index a71eff13f..118dfaa3a 100644 --- a/daprdocs/content/en/operations/configuration/increase-request-size.md +++ b/daprdocs/content/en/operations/configuration/increase-request-size.md @@ -57,4 +57,4 @@ spec: {{< /tabs >}} ## Related links -- [Dapr Kubernetes pod annotations spec]({{< ref kubernetes-annotations.md >}}) +- [Dapr Kubernetes pod annotations spec]({{< ref arguments-annotations-overview.md >}}) diff --git a/daprdocs/content/en/operations/hosting/kubernetes/kubernetes-annotations.md b/daprdocs/content/en/operations/hosting/kubernetes/kubernetes-annotations.md deleted file mode 100644 index 454434820..000000000 --- a/daprdocs/content/en/operations/hosting/kubernetes/kubernetes-annotations.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -type: docs -title: "Dapr Kubernetes pod annotations spec" -linkTitle: "Kubernetes annotations" -weight: 50000 -description: "The available annotations available when configuring Dapr in your Kubernetes environment" ---- - -The following table shows all the supported pod Spec annotations supported by Dapr. - -| Annotation | Description | -|---------------------------------------------------|-------------| -| `dapr.io/enabled` | Setting this paramater to `true` injects the Dapr sidecar into the pod -| `dapr.io/app-port` | This parameter tells Dapr which port your application is listening on -| `dapr.io/app-id` | The unique ID of the application. Used for service discovery, state encapsulation and the pub/sub consumer ID -| `dapr.io/log-level` | Sets the log level for the Dapr sidecar. Allowed values are `debug`, `info`, `warn`, `error`. Default is `info` -| `dapr.io/config` | Tells Dapr which Configuration CRD to use -| `dapr.io/log-as-json` | Setting this parameter to `true` outputs logs in JSON format. Default is `false` -| `dapr.io/enable-profiling` | Setting this paramater to `true` starts the Dapr profiling server on port `7777`. Default is `false` -| `dapr.io/api-token-secret` | Tells Dapr which Kubernetes secret to use for token based API authentication. By default this is not set. -| `dapr.io/app-protocol` | Tells Dapr which protocol your application is using. Valid options are `http` and `grpc`. Default is `http` -| `dapr.io/app-max-concurrency` | Limit the concurrency of your application. A valid value is any number larger than `0` -| `dapr.io/app-ssl` | Tells Dapr to invoke the app over an insecure SSL connection. Applies to both HTTP and gRPC. Traffic between your app and the Dapr sidecar is encrypted with a certificate issued by a non-trusted certificate authority, which is considered insecure. Default is `false`. -| `dapr.io/metrics-port` | Sets the port for the sidecar metrics server. Default is `9090` -| `dapr.io/sidecar-cpu-limit` | Maximum amount of CPU that the Dapr sidecar can use. See valid values [here](https://kubernetes.io/docs/tasks/administer-cluster/manage-resources/quota-memory-cpu-namespace/). By default this is not set -| `dapr.io/sidecar-memory-limit` | Maximum amount of Memory that the Dapr sidecar can use. See valid values [here](https://kubernetes.io/docs/tasks/administer-cluster/manage-resources/quota-memory-cpu-namespace/). By default this is not set -| `dapr.io/sidecar-cpu-request` | Amount of CPU that the Dapr sidecar requests. See valid values [here](https://kubernetes.io/docs/tasks/administer-cluster/manage-resources/quota-memory-cpu-namespace/). By default this is not set -| `dapr.io/sidecar-memory-request` | Amount of Memory that the Dapr sidecar requests .See valid values [here](https://kubernetes.io/docs/tasks/administer-cluster/manage-resources/quota-memory-cpu-namespace/). By default this is not set -| `dapr.io/sidecar-liveness-probe-delay-seconds` | Number of seconds after the sidecar container has started before liveness probe is initiated. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `3` -| `dapr.io/sidecar-liveness-probe-timeout-seconds` | Number of seconds after which the sidecar liveness probe times out. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `3` -| `dapr.io/sidecar-liveness-probe-period-seconds` | How often (in seconds) to perform the sidecar liveness probe. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `6` -| `dapr.io/sidecar-liveness-probe-threshold` | When the sidecar liveness probe fails, Kubernetes will try N times before giving up. In this case, the Pod will be marked Unhealthy. Read more about `failureThreshold` [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `3` -| `dapr.io/sidecar-readiness-probe-delay-seconds` | Number of seconds after the sidecar container has started before readiness probe is initiated. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `3` -| `dapr.io/sidecar-readiness-probe-timeout-seconds` | Number of seconds after which the sidecar readiness probe times out. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `3` -| `dapr.io/sidecar-readiness-probe-period-seconds` | How often (in seconds) to perform the sidecar readiness probe. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `6` -| `dapr.io/sidecar-readiness-probe-threshold` | When the sidecar readiness probe fails, Kubernetes will try N times before giving up. In this case, the Pod will be marked Unready. Read more about `failureThreshold` [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `3` -| `dapr.io/http-max-request-size` | Increasing max size of request body http and grpc servers parameter in MB to handle uploading of big files. Default is `4` MB -| `dapr.io/env` | List of environment variable to be injected into the sidecar. Strings consisting of key=value pairs separated by a comma. diff --git a/daprdocs/content/en/operations/hosting/kubernetes/kubernetes-overview.md b/daprdocs/content/en/operations/hosting/kubernetes/kubernetes-overview.md index 36e5efe72..397bc1d7a 100644 --- a/daprdocs/content/en/operations/hosting/kubernetes/kubernetes-overview.md +++ b/daprdocs/content/en/operations/hosting/kubernetes/kubernetes-overview.md @@ -22,7 +22,7 @@ Read [this guide]({{< ref kubernetes-deploy.md >}}) to learn how to deploy Dapr ## Adding Dapr to a Kubernetes deployment -Deploying and running a Dapr enabled application into your Kubernetes cluster is as simple as adding a few annotations to the deployment schemes. To give your service an `id` and `port` known to Dapr, turn on tracing through configuration and launch the Dapr sidecar container, you annotate your Kubernetes deployment like this. For more information check [dapr annotations]({{< ref kubernetes-annotations.md >}}) +Deploying and running a Dapr enabled application into your Kubernetes cluster is as simple as adding a few annotations to the deployment schemes. To give your service an `id` and `port` known to Dapr, turn on tracing through configuration and launch the Dapr sidecar container, you annotate your Kubernetes deployment like this. For more information check [dapr annotations]({{< ref arguments-annotations-overview.md >}}) ```yml annotations: diff --git a/daprdocs/content/en/operations/hosting/kubernetes/kubernetes-production.md b/daprdocs/content/en/operations/hosting/kubernetes/kubernetes-production.md index a3d2695b5..1a4f2b875 100644 --- a/daprdocs/content/en/operations/hosting/kubernetes/kubernetes-production.md +++ b/daprdocs/content/en/operations/hosting/kubernetes/kubernetes-production.md @@ -35,7 +35,7 @@ The following Dapr control plane deployments are optional: ## Sidecar resource settings -To set the resource assignments for the Dapr sidecar, see the annotations [here]({{< ref "kubernetes-annotations.md" >}}). +To set the resource assignments for the Dapr sidecar, see the annotations [here]({{< ref "arguments-annotations-overview.md" >}}). The specific annotations related to resource constraints are: - `dapr.io/sidecar-cpu-limit` diff --git a/daprdocs/content/en/operations/hosting/self-hosted/self-hosted-overview.md b/daprdocs/content/en/operations/hosting/self-hosted/self-hosted-overview.md index 9077cc9ee..49a417b9f 100644 --- a/daprdocs/content/en/operations/hosting/self-hosted/self-hosted-overview.md +++ b/daprdocs/content/en/operations/hosting/self-hosted/self-hosted-overview.md @@ -23,7 +23,7 @@ The `dapr-placement` service is responsible for managing the actor distribution ## Launching applications with Dapr -You can use the [`dapr run` CLI command]({{< ref dapr-run.md >}}) to a Dapr sidecar process along with your application. +You can use the [`dapr run` CLI command]({{< ref dapr-run.md >}}) to a Dapr sidecar process along with your application. Additional arguments and flags can be found [here]({{< ref arguments-annotations-overview.md >}}). ## Name resolution diff --git a/daprdocs/content/en/operations/troubleshooting/common_issues.md b/daprdocs/content/en/operations/troubleshooting/common_issues.md index 9a802effa..230c1d135 100644 --- a/daprdocs/content/en/operations/troubleshooting/common_issues.md +++ b/daprdocs/content/en/operations/troubleshooting/common_issues.md @@ -91,7 +91,7 @@ The most common cause of this failure is that a component (such as a state store To diagnose the root cause: -- Significantly increase the liveness probe delay - [link]({{< ref "kubernetes-annotations.md" >}}) +- Significantly increase the liveness probe delay - [link]({{< ref "arguments-annotations-overview.md" >}}) - Set the log level of the sidecar to debug - [link]({{< ref "logs-troubleshooting.md#setting-the-sidecar-log-level" >}}) - Watch the logs for meaningful information - [link]({{< ref "logs-troubleshooting.md#viewing-logs-on-kubernetes" >}}) diff --git a/daprdocs/content/en/reference/arguments-annotations-overview.md b/daprdocs/content/en/reference/arguments-annotations-overview.md new file mode 100644 index 000000000..bbc66814a --- /dev/null +++ b/daprdocs/content/en/reference/arguments-annotations-overview.md @@ -0,0 +1,54 @@ +--- +type: docs +title: "Dapr arguments and annotations for daprd, CLI, and Kubernetes" +linkTitle: "Arguments and annotations" +description: "The arguments and annotations available when configuring Dapr in different environments" +weight: 300 +aliases: + - "/operations/hosting/kubernetes/kubernetes-annotations/" +--- + +The following table shows all the annotations supported by Dapr. This table is meant to help users understand the equivalent options for running Dapr sidecars in different contexts--via the [CLI]({{< ref cli-overview.md >}}) directly, via daprd, or on [Kubernetes]({{< ref kubernetes-overview.md >}}) via annotations. + +| daprd | dapr CLI | CLI shorthand | K8s annotations | Description +|----- | ------- | -----------| ----------| ------------ | ------------ | +| `--allowed-origins` | not supported | | not supported | Allowed HTTP origins (default "*") | +| `--app-id` | `--app-id` | `-i` | `dapr.io/app-id` | The unique ID of the application. Used for service discovery, state encapsulation and the pub/sub consumer ID | +| `--app-port` | `--app-port` | `-p` | `dapr.io/app-port` | This parameter tells Dapr which port your application is listening on | +| `--app-ssl` | `--app-ssl` | | `dapr.io/app-ssl` | Sets the URI scheme of the app to https and attempts an SSL connection | +| `--components-path` | `--components-path` | `-d` | not supported | Path for components directory. If empty, components will not be loaded. | +| `--config` | `--config` | `-c` | `dapr.io/config` | Tells Dapr which Configuration CRD to use | +| `--control-plane-address` | not supported | | not supported | Address for a Dapr control plane | +| `--dapr-grpc-port` | `--dapr-grpc-port` | | not supported | gRPC port for the Dapr API to listen on (default "50001") | +| `--dapr-http-port` | `--dapr-http-port` | | not supported | The HTTP port for the Dapr API | +|` --dapr-http-max-request-size` | --dapr-http-max-request-size | | `dapr.io/http-max-request-size` | Increasing max size of request body http and grpc servers parameter in MB to handle uploading of big files. Default is `4` MB | +| not supported | `--image` | | not supported +| `--internal-grpc-port` | not supported | | not supported | gRPC port for the Dapr Internal API to listen on | +| `--enable-metrics` | not supported | | configuration spec | Enable prometheus metric (default true) | +| `--enable-mtls` | not supported | | configuration spec | Enables automatic mTLS for daprd to daprd communication channels | +| `--enable-profiling` | `--enable-profiling` | | `dapr.io/enable-profiling` | Enable profiling | +| `--log-as-json` | not supported | | `dapr.io/log-as-json` | Setting this parameter to `true` outputs logs in JSON format. Default is `false` | +| `--log-level` | `--log-level` | | `dapr.io/log-level` | Sets the log level for the Dapr sidecar. Allowed values are `debug`, `info`, `warn`, `error`. Default is `info` | +| `--app-max-concurrency` | `--app-max-concurrency` | | `dapr.io/app-max-concurrency` | Limit the concurrency of your application. A valid value is any number larger than `0` +| `--metrics-port` | `--metrics-port` | | `dapr.io/metrics-port` | Sets the port for the sidecar metrics server. Default is `9090` | +| `--mode` | not supported | | not supported | Runtime mode for Dapr (default "standalone") | +| `--placement-address` | `--placement-address` | | not supported | Addresses for Dapr Actor Placement servers | +| `--profiling-port` | `--profiling-port` | | not supported | The port for the profile server (default "7777") | +| `--app-protocol` | `--app-protocol` | `-P` | `dapr.io/app-protocol` | Tells Dapr which protocol your application is using. Valid options are `http` and `grpc`. Default is `http` | +| `--sentry-address` | `--sentry-address` | | not supported | Address for the Sentry CA service | +| `--version` | `--version` | `-v` | not supported | Prints the runtime version | +| not supported | not supported | | `dapr.io/enabled` | Setting this paramater to true injects the Dapr sidecar into the pod | +| not supported | not supported | | `dapr.io/api-token-secret` | Tells Dapr which Kubernetes secret to use for token based API authentication. By default this is not set | +| not supported | not supported | | `dapr.io/sidecar-cpu-limit` | Maximum amount of CPU that the Dapr sidecar can use. See valid values [here](https://kubernetes.io/docs/tasks/administer-cluster/manage-resources/quota-memory-cpu-namespace/). By default this is not set +| not supported | not supported | | `dapr.io/sidecar-memory-limit` | Maximum amount of Memory that the Dapr sidecar can use. See valid values [here](https://kubernetes.io/docs/tasks/administer-cluster/manage-resources/quota-memory-cpu-namespace/). By default this is not set +| not supported | not supported | | `dapr.io/sidecar-cpu-request` | Amount of CPU that the Dapr sidecar requests. See valid values [here](https://kubernetes.io/docs/tasks/administer-cluster/manage-resources/quota-memory-cpu-namespace/). By default this is not set +| not supported | not supported | | `dapr.io/sidecar-memory-request` | Amount of Memory that the Dapr sidecar requests .See valid values [here](https://kubernetes.io/docs/tasks/administer-cluster/manage-resources/quota-memory-cpu-namespace/). By default this is not set +| not supported | not supported | | `dapr.io/sidecar-liveness-probe-delay-seconds` | Number of seconds after the sidecar container has started before liveness probe is initiated. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `3` +| not supported | not supported | | `dapr.io/sidecar-liveness-probe-timeout-seconds` | Number of seconds after which the sidecar liveness probe times out. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `3` +| not supported | not supported | | `dapr.io/sidecar-liveness-probe-period-seconds` | How often (in seconds) to perform the sidecar liveness probe. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `6` +| not supported | not supported | | `dapr.io/sidecar-liveness-probe-threshold` | When the sidecar liveness probe fails, Kubernetes will try N times before giving up. In this case, the Pod will be marked Unhealthy. Read more about `failureThreshold` [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `3` +| not supported | not supported | | `dapr.io/sidecar-readiness-probe-delay-seconds` | Number of seconds after the sidecar container has started before readiness probe is initiated. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `3` +| not supported | not supported | | `dapr.io/sidecar-readiness-probe-timeout-seconds` | Number of seconds after which the sidecar readiness probe times out. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `3` +| not supported | not supported | | `dapr.io/sidecar-readiness-probe-period-seconds` | How often (in seconds) to perform the sidecar readiness probe. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `6` +| not supported | not supported | | `dapr.io/sidecar-readiness-probe-threshold` | When the sidecar readiness probe fails, Kubernetes will try N times before giving up. In this case, the Pod will be marked Unready. Read more about `failureThreshold` [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `3` +| not supported | not supported | | `dapr.io/env` | List of environment variable to be injected into the sidecar. Strings consisting of key=value pairs separated by a comma. \ No newline at end of file diff --git a/daprdocs/content/en/reference/cli/cli-overview.md b/daprdocs/content/en/reference/cli/cli-overview.md index 12497fed6..661dc7a22 100644 --- a/daprdocs/content/en/reference/cli/cli-overview.md +++ b/daprdocs/content/en/reference/cli/cli-overview.md @@ -50,7 +50,7 @@ Use "dapr [command] --help" for more information about a command. ## Command Reference -You can learn more about each Dapr command from the links below. +You can learn more about each Dapr command from the links below. A full list comparing daprd, CLI, and Kubernetes arguments/annotations can be found [here]({{< ref "arguments-annotations-overview.md" >}}). - [`dapr completion`]({{< ref dapr-completion.md >}}) - [`dapr components`]({{< ref dapr-components.md >}}) diff --git a/daprdocs/content/en/reference/cli/dapr-run.md b/daprdocs/content/en/reference/cli/dapr-run.md index fb48c9c7e..cfeedee1e 100644 --- a/daprdocs/content/en/reference/cli/dapr-run.md +++ b/daprdocs/content/en/reference/cli/dapr-run.md @@ -7,7 +7,7 @@ description: "Detailed information on the run CLI command" ## Description -Run Dapr and (optionally) your application side by side. +Run Dapr and (optionally) your application side by side. A full list comparing daprd arguments, CLI arguments, and Kubernetes annotations can be found [here]({{< ref arguments-annotations-overview.md >}}). ## Supported platforms From 8c18cc399c9167596a4090dcedb96fa0e260ecee Mon Sep 17 00:00:00 2001 From: Shruthi Kumar Date: Thu, 22 Jul 2021 17:52:20 -0500 Subject: [PATCH 33/34] Update daprdocs/content/en/reference/arguments-annotations-overview.md Co-authored-by: Ori Zohar --- .../content/en/reference/arguments-annotations-overview.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/daprdocs/content/en/reference/arguments-annotations-overview.md b/daprdocs/content/en/reference/arguments-annotations-overview.md index bbc66814a..a428b73cc 100644 --- a/daprdocs/content/en/reference/arguments-annotations-overview.md +++ b/daprdocs/content/en/reference/arguments-annotations-overview.md @@ -8,7 +8,7 @@ aliases: - "/operations/hosting/kubernetes/kubernetes-annotations/" --- -The following table shows all the annotations supported by Dapr. This table is meant to help users understand the equivalent options for running Dapr sidecars in different contexts--via the [CLI]({{< ref cli-overview.md >}}) directly, via daprd, or on [Kubernetes]({{< ref kubernetes-overview.md >}}) via annotations. +This table is meant to help users understand the equivalent options for running Dapr sidecars in different contexts--via the [CLI]({{< ref cli-overview.md >}}) directly, via daprd, or on [Kubernetes]({{< ref kubernetes-overview.md >}}) via annotations. | daprd | dapr CLI | CLI shorthand | K8s annotations | Description |----- | ------- | -----------| ----------| ------------ | ------------ | @@ -51,4 +51,4 @@ The following table shows all the annotations supported by Dapr. This table is m | not supported | not supported | | `dapr.io/sidecar-readiness-probe-timeout-seconds` | Number of seconds after which the sidecar readiness probe times out. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `3` | not supported | not supported | | `dapr.io/sidecar-readiness-probe-period-seconds` | How often (in seconds) to perform the sidecar readiness probe. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `6` | not supported | not supported | | `dapr.io/sidecar-readiness-probe-threshold` | When the sidecar readiness probe fails, Kubernetes will try N times before giving up. In this case, the Pod will be marked Unready. Read more about `failureThreshold` [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `3` -| not supported | not supported | | `dapr.io/env` | List of environment variable to be injected into the sidecar. Strings consisting of key=value pairs separated by a comma. \ No newline at end of file +| not supported | not supported | | `dapr.io/env` | List of environment variable to be injected into the sidecar. Strings consisting of key=value pairs separated by a comma. From 5b4cebb068941ed4b8bff84345441aad3f8c7539 Mon Sep 17 00:00:00 2001 From: sk593 Date: Thu, 22 Jul 2021 17:54:04 -0500 Subject: [PATCH 34/34] removed link --- daprdocs/content/en/reference/cli/cli-overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/daprdocs/content/en/reference/cli/cli-overview.md b/daprdocs/content/en/reference/cli/cli-overview.md index 661dc7a22..a7192bddb 100644 --- a/daprdocs/content/en/reference/cli/cli-overview.md +++ b/daprdocs/content/en/reference/cli/cli-overview.md @@ -50,7 +50,7 @@ Use "dapr [command] --help" for more information about a command. ## Command Reference -You can learn more about each Dapr command from the links below. A full list comparing daprd, CLI, and Kubernetes arguments/annotations can be found [here]({{< ref "arguments-annotations-overview.md" >}}). +You can learn more about each Dapr command from the links below. - [`dapr completion`]({{< ref dapr-completion.md >}}) - [`dapr components`]({{< ref dapr-components.md >}})