From bb25bc522781d5421fdb7b4ff4c3d5a794a7e94a Mon Sep 17 00:00:00 2001 From: Aaron Crawfis Date: Fri, 2 Jul 2021 12:41:42 -0700 Subject: [PATCH 01/10] 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 a9a95068b0e7106601a97a74c62fbccd93433b9d Mon Sep 17 00:00:00 2001 From: Nick Greenfield Date: Mon, 12 Jul 2021 16:50:53 -0700 Subject: [PATCH 02/10] 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 8e4e85717af6609f8b8d9c58a01ed7660299752a Mon Sep 17 00:00:00 2001 From: Lorenzo Montanari Date: Wed, 14 Jul 2021 12:12:12 +0200 Subject: [PATCH 03/10] 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 04/10] 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 05/10] 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 06/10] 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 07/10] 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 08/10] 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 09/10] 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 10/10] 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 >}})