Merged main into live

mijacobs · mijacobs · commit 18c949450fd6 · 2024-10-25T01:01:58.000Z
diff --git a/bridge/articles/bridge-to-kubernetes-aks.md b/bridge/articles/bridge-to-kubernetes-aks.md
@@ -11,6 +11,8 @@ description: Use Bridge to Kubernetes to run and debug locally in a single pod w
 
 # Use Bridge to Kubernetes with AKS
 
+[!INCLUDE [Bridge to Kubernetes deprecation note](./includes/deprecation.md)]
+
 In this tutorial, you use a specific AKS sample microservices web app to learn how to use Bridge to Kubernetes to debug locally in a single pod that's part of an Azure Kubernetes Service (AKS) cluster.
 
 ## Before you begin
diff --git a/bridge/articles/bridge-to-kubernetes-sample.md b/bridge/articles/bridge-to-kubernetes-sample.md
@@ -10,6 +10,8 @@ description: Try a sample application that uses Bridge to Kubernetes to develop,
 ---
 # Use Bridge to Kubernetes with a sample
 
+[!INCLUDE [Bridge to Kubernetes deprecation note](./includes/deprecation.md)]
+
 This sample illustrates how Bridge to Kubernetes can be used to develop a microservice version of a simple TODO application on any Kubernetes cluster. This sample, using Visual Studio Code, has been adapted from code provided by [TodoMVC](https://todomvc.com). In this example, we use MiniKube to host the application, but these steps should work with any Kubernetes cluster.
 
 The TODO application sample is composed of a frontend and a backend that provides persistent storage. This extended sample adds a statistics component and breaks the application into a number of microservices, specifically:
diff --git a/bridge/articles/bridge-to-kubernetes-vs-code.md b/bridge/articles/bridge-to-kubernetes-vs-code.md
@@ -11,6 +11,8 @@ description: Use Bridge to Kubernetes to redirect traffic between your Kubernete
 
 # Use Bridge to Kubernetes (VS Code)
 
+[!INCLUDE [Bridge to Kubernetes deprecation note](./includes/deprecation.md)]
+
 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. In this guide, you will learn how to use Bridge to Kubernetes to redirect traffic between your Kubernetes cluster and code running on your development computer.
 
 ## Before you begin
diff --git a/bridge/articles/bridge-to-kubernetes-vs.md b/bridge/articles/bridge-to-kubernetes-vs.md
@@ -12,6 +12,8 @@ ms.date: 06/20/2024
 
 # Tutorial: Run and debug locally with Bridge to Kubernetes on Visual Studio
 
+[!INCLUDE [Bridge to Kubernetes deprecation note](./includes/deprecation.md)]
+
 In this tutorial, you'll learn how to redirect traffic between your Kubernetes cluster and your development computer.
 This tutorial uses Bridge to Kubernetes and Visual Studio for debugging a service.
 To use Visual Studio Code, see [Run and debug locally with Bridge to Kubernetes with VS Code](bridge-to-kubernetes-vs-code.md).
diff --git a/bridge/articles/configure-bridge-to-kubernetes.md b/bridge/articles/configure-bridge-to-kubernetes.md
@@ -12,6 +12,8 @@ ms.subservice: bridge
 
 # Configure Bridge to Kubernetes
 
+[!INCLUDE [Bridge to Kubernetes deprecation note](./includes/deprecation.md)]
+
 You can configure the local Bridge to Kubernetes process using two methods. You can annotate services on your cluster and you can supply local configuration.
 
 ## Kubernetes configuration
diff --git a/bridge/articles/includes/deprecation.md b/bridge/articles/includes/deprecation.md
@@ -0,0 +1,9 @@
+---
+author: ghogen
+ms.topic: include
+ms.date: 10/23/2024
+ms.author: ghogen
+---
+
+> [!NOTE]
+> Microsoft plans to no longer actively maintain the Bridge to Kubernetes project. Over the next few months, we will transition the project to an archival state. In the meantime, the project is still available to use and [download](https://github.com/Azure/Bridge-To-Kubernetes?tab=readme-ov-file#documentation). During this period, we hope to explore and recommend community projects that provide similar benefits to Bridge to Kubernetes for your future use. If you have questions, please contact us on our [issues board at GitHub](https://github.com/Azure/Bridge-To-Kubernetes/issues).
diff --git a/bridge/articles/kubernetes-environment-variables.md b/bridge/articles/kubernetes-environment-variables.md
@@ -10,6 +10,8 @@ ms.subservice: bridge
 ---
 # Kubernetes service environment variables
 
+[!INCLUDE [Bridge to Kubernetes deprecation note](./includes/deprecation.md)]
+
 When you communicate with another service in the same Kubernetes cluster, for example with an HTTP request, you typically use the hardcoded service name in the URL for the request, but that won't work in some scenarios with Bridge to Kubernetes. This article describes how to use the Kubernetes service environment variables to specify the connection URL.
 
 ## Avoid redirection failures
diff --git a/bridge/articles/managed-identity.md b/bridge/articles/managed-identity.md
@@ -10,6 +10,8 @@ ms.author: ghogen
 ---
 # Use managed identity with Bridge to Kubernetes
 
+[!INCLUDE [Bridge to Kubernetes deprecation note](./includes/deprecation.md)]
+
 If your AKS cluster uses [managed identity](/azure/active-directory/managed-identities-azure-resources/overview) security features to secure access to secrets and resources, Bridge to Kubernetes needs some special configuration to ensure it can work with these features. A Microsoft Entra token needs to be downloaded to the local machine to ensure that local execution and debugging is properly secured, and this requires some special configuration in Bridge to Kubernetes. This article shows how to configure Bridge to Kubernetes to work with services that use managed identity.
 
 ## How to configure your service to use managed identity
diff --git a/bridge/articles/overview-bridge-to-kubernetes.md b/bridge/articles/overview-bridge-to-kubernetes.md
@@ -11,6 +11,8 @@ ms.author: ghogen
 ---
 # How Bridge to Kubernetes works
 
+[!INCLUDE [Bridge to Kubernetes deprecation note](./includes/deprecation.md)]
+
 *Bridge to Kubernetes* is an iterative development tool for authoring microservice applications that target Kubernetes. The Bridge to Kubernetes extension is available for Visual Studio and Visual Studio Code (VS Code).
 
 Bridge to Kubernetes allows you to run and debug code on your development computer. That computer is still connected to your Kubernetes cluster with the rest of your application or services. If you have a large microservices architecture with many interdependent services and databases, replicating those dependencies on your development computer can be difficult. Building and deploying code to your Kubernetes cluster for each code change can be slow, time-consuming, and difficult.
diff --git a/bridge/articles/parallel-services.md b/bridge/articles/parallel-services.md
@@ -10,6 +10,8 @@ ms.topic: how-to
 ---
 # Debug multiple services (VS Code)
 
+[!INCLUDE [Bridge to Kubernetes deprecation note](./includes/deprecation.md)]
+
 Bridge to Kubernetes provides the ability to debug your Kubernetes services in a local environment, as described in [Use Bridge to Kubernetes (VS Code)](bridge-to-kubernetes-vs-code.md). With Bridge to Kubernetes, you redirect traffic to a locally running instance of a service and can debug using VS Code's debugger. However, in some scenarios, you want to work with more than one service and debug into them all at the same time. You can debug multiple services in parallel by following these steps.
 
 ## To debug multiple services at the same time
diff --git a/docs/profiling/isolate-performance-issue.md b/docs/profiling/isolate-performance-issue.md
@@ -1,7 +1,7 @@
 ---
 title: "Isolate a performance issue"
 description: "Learn how to use .NET Counters and the Instrumentation tools to identify, isolate, and resolve performance issues."
-ms.date: 09/20/2024
+ms.date: 10/24/2024
 ms.topic: conceptual
 dev_langs:
   - "CSharp"
@@ -117,30 +117,9 @@ public ActionResult<string> QueryCustomerDB()
 }
 ```
 
-With a little research, we discover that this code is calling an async API without using await. This is the [sync-over-async](https://devblogs.microsoft.com/pfxteam/should-i-expose-synchronous-wrappers-for-asynchronous-methods/) code pattern, which is a common cause of threadpool starvation, and may block threads.
+We do a little research. Alternatively, we can save time and let [Copilot](../ide/visual-studio-github-copilot-extension.md) do the research for us.
 
-To resolve, use await.
-
-```csharp
-public async Task<ActionResult<string>> QueryCustomerDB()
-{
-    Customer c = await QueryCustomerFromDbAsync("Dana");
-    return "success:taskasyncwait";
-}
-```
-
-> [!TIP]
-> Alternatively, we can save time and let Copilot [do the research](#get-copilot-to-research-the-issue) for us.
-
-If you see performance issues related to database queries, you can use the [Database tool](../profiling/analyze-database.md) to investigate whether certain calls are slower. This data might indicate an opportunity to optimize queries. For a tutorial that shows how to use the Database tool to investigate a performance issue, see [Case study: Beginner's guide to optimizing code](../profiling/optimize-code-using-profiling-tools.md). The Database tool supports .NET Core with either ADO.NET or Entity Framework Core.
-
-To get visualizations in Visual Studio for individual thread behavior, you can use the [Parallel Stacks](../debugger/get-started-debugging-multithreaded-apps.md#ParallelStacks) window while debugging. This window shows individual threads along with information about threads that are waiting, threads they're waiting on, and [deadlocks](../debugger/using-the-parallel-stacks-window.md#stack-frame-icons).
-
-For additional information on thread pool starvation, see [Detecting threadpool starvation](/dotnet/core/diagnostics/debug-threadpool-starvation#detecting-threadpool-starvation).
-
-## Get Copilot to research the issue
-
-If we're using [Copilot](../ide/visual-studio-github-copilot-extension.md), we can ask Copilot to research performance issues for us. Select **Ask Copilot** from the context menu and type the following question:
+If we're using [Copilot](../ide/visual-studio-github-copilot-extension.md), select **Ask Copilot** from the context menu and type the following question:
 
 ```cmd
 Can you identify a performance issue in the QueryCustomerDB method?
@@ -149,7 +128,9 @@ Can you identify a performance issue in the QueryCustomerDB method?
 > [!TIP]
 > You can use slash commands such as [/optimize](../ide/copilot-chat-context.md#slash-commands) to help form good questions for Copilot.
 
-In this example, Copilot gives the following code suggestion, the same answer we previously identified by research, along with an explanation.
+Copilot tells us that this code is calling an async API without using await. This is the [sync-over-async](https://devblogs.microsoft.com/pfxteam/should-i-expose-synchronous-wrappers-for-asynchronous-methods/) code pattern, which is a common cause of threadpool starvation, and may block threads.
+
+To resolve, use await. In this example, Copilot gives the following code suggestion along with the explanation.
 
 ```csharp
 public async Task<ActionResult<string>> QueryCustomerDB()
@@ -159,6 +140,12 @@ public async Task<ActionResult<string>> QueryCustomerDB()
 }
 ```
 
+If you see performance issues related to database queries, you can use the [Database tool](../profiling/analyze-database.md) to investigate whether certain calls are slower. This data might indicate an opportunity to optimize queries. For a tutorial that shows how to use the Database tool to investigate a performance issue, see [Case study: Beginner's guide to optimizing code](../profiling/optimize-code-using-profiling-tools.md). The Database tool supports .NET Core with either ADO.NET or Entity Framework Core.
+
+To get visualizations in Visual Studio for individual thread behavior, you can use the [Parallel Stacks](../debugger/get-started-debugging-multithreaded-apps.md#ParallelStacks) window while debugging. This window shows individual threads along with information about threads that are waiting, threads they're waiting on, and [deadlocks](../debugger/using-the-parallel-stacks-window.md#stack-frame-icons).
+
+For additional information on thread pool starvation, see [Detecting threadpool starvation](/dotnet/core/diagnostics/debug-threadpool-starvation#detecting-threadpool-starvation).
+
 ## Next steps
 
 The following articles and blog posts provide more information to help you learn to use the Visual Studio performance tools effectively.
diff --git a/docs/profiling/optimize-code-using-profiling-tools.md b/docs/profiling/optimize-code-using-profiling-tools.md
@@ -1,7 +1,7 @@
 ---
 title: "Beginner's guide to optimizing code"
 description: "Learn how to optimize code and reduce compute costs using Visual Studio profiling tools such as the CPU Usage tool, the .NET Object Allocation tool, and the Database tool."
-ms.date: 09/20/2024
+ms.date: 10/24/2024
 ms.topic: conceptual
 ms.custom: "profiling-seo"
 dev_langs:
@@ -137,28 +137,9 @@ foreach (var blog in db.Blogs.Select(b => new { b.Url, b.Posts }).ToList())
 
 This code uses `foreach` loops to search the database for any blogs with "Fred Smith" as the author. Looking at it, you can see that a lot of objects are getting generated in memory: a new object array for each blog in the database, associated strings for each URL, and values for properties contained in the posts, such as blog ID.
 
-We do a little research and find some common recommendations for how to optimize LINQ queries and come up with this code.
+We do a little research and find some common recommendations for how to optimize LINQ queries. Alternatively, we can save time and let [Copilot](../ide/visual-studio-github-copilot-extension.md) do the research for us.
 
-> [!TIP]
-> Alternatively, we can save time and let Copilot [do the research](#optimize-code-with-copilot) for us.
-
-```csharp
-foreach (var x in db.Posts.Where(p => p.Author.Contains("Fred Smith")).Select(b => b.Title).ToList())
-{
-  Console.WriteLine("Post: " + x);
-}
-```
-
-In this code, we made several changes to help optimize the query:
-
-- Added the `Where` clause and eliminate one of the `foreach` loops.
-- Projected only the Title property in the `Select` statement, which is all we need in this example.
-
-Next, we retest using the profiling tools.
-
-### Optimize code with Copilot
-
-If we're using [Copilot](../ide/visual-studio-github-copilot-extension.md), we can ask Copilot to research performance issues for us. Select **Ask Copilot** from the context menu and type the following question:
+If we're using Copilot, we select **Ask Copilot** from the context menu and type the following question:
 
 ```cmd
 Can you make the LINQ query in this method faster?
@@ -167,7 +148,7 @@ Can you make the LINQ query in this method faster?
 > [!TIP]
 > You can use slash commands such as [/optimize](../ide/copilot-chat-context.md#slash-commands) to help form good questions for Copilot.
 
-In this example, Copilot gives the following suggested code changes, similar to our optimized query, along with an explanation.
+In this example, Copilot gives the following suggested code changes, along with an explanation.
 
 ```csharp
 public void GetBlogTitleX()
@@ -184,6 +165,13 @@ public void GetBlogTitleX()
 }
 ```
 
+This code includes several changes to help optimize the query:
+
+- Added the `Where` clause and eliminated one of the `foreach` loops.
+- Projected only the Title property in the `Select` statement, which is all we need in this example.
+
+Next, we retest using the profiling tools.
+
 ## Results
 
 After updating the code, we re-run the CPU Usage tool to collect a trace. The **Call Tree** view shows that `GetBlogTitleX` is running only 1754 ms, using 37% of the app's CPU total, a significant improvement from 59%.
