From 053fc7a34b1e4fcb2586083b26013e6760fc94fd Mon Sep 17 00:00:00 2001 From: nithyatsu Date: Wed, 25 Sep 2024 12:36:31 -0700 Subject: [PATCH] updating doc to use existing DE Signed-off-by: nithyatsu --- .vscode/launch.json | 17 -------- .../running-controlplane-locally.md | 40 +++---------------- 2 files changed, 6 insertions(+), 51 deletions(-) diff --git a/.vscode/launch.json b/.vscode/launch.json index daf179be569..8a495910361 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -71,22 +71,6 @@ "RADIUS_ENV": "self-hosted" } }, - { - "name": "Launch Deployment Engine", - "type": "coreclr", - "request": "launch", - "preLaunchTask": "Build Deployment Engine", - "program": "${workspaceFolder}/../deployment-engine/src/DeploymentEngine/bin/Debug/net6.0/arm-de.dll", - "args": [], - "cwd": "${workspaceFolder}/../deployment-engine/src/DeploymentEngine", - "stopAtEntry": false, - "env": { - "ASPNETCORE_URLS": "http://localhost:5017", - "ASPNETCORE_ENVIRONMENT": "Development", - "KUBERNETESBICEPEXTENSIBILITYURL": "http://localhost:5017/api", - "RADIUSBACKENDURI": "http://localhost:9000", - }, - }, { "name": "Debug Bicep generator integration tests", "type": "node", @@ -110,7 +94,6 @@ "Launch UCP", "Launch Applications RP", "Launch Controller", - "Launch Deployment Engine", ], "stopAll": true } diff --git a/docs/contributing/contributing-code/contributing-code-control-plane/running-controlplane-locally.md b/docs/contributing/contributing-code/contributing-code-control-plane/running-controlplane-locally.md index e8b96354b33..8f58d4b60cf 100644 --- a/docs/contributing/contributing-code/contributing-code-control-plane/running-controlplane-locally.md +++ b/docs/contributing/contributing-code/contributing-code-control-plane/running-controlplane-locally.md @@ -27,13 +27,9 @@ If you need to manually test APIs you can reach them at the following endpoints ## Prerequisites 1. Create a Kubernetes cluster, or set your current context to a cluster you want to use. The debug configuration will use your current cluster for storing data. -2. Clone the `radius-project/radius` and `radius-project/deployment-engine` repo next to each other. -3. Run `git submodule update --init` in the `deployment-engine` repo. -4. Install .NET 6.0 SDK - . -5. Install C# VS Code extension - . -6. (Optional) Configure any cloud provider credentials you want to use for developing Radius. +2. Clone the `radius-project/radius` +3. (Optional) Configure any cloud provider credentials you want to use for developing Radius. -> 💡 The Bicep deployment engine uses .NET. However you don't need to know C# or .NET to develop locally with Radius. > 💡 Radius will use your locally configured Azure or AWS credentials. If you are able to use the `az` or `aws` CLI then you don't need to do any additional setup. ## Setup Step 1: Run `rad init` @@ -105,6 +101,10 @@ Run this command to create the namespace that will be used to store data. kubectl create namespace radius-testing ``` +## Setup Step 4: port-forward Deployment Engine + +kubectl port-forward --namespace=radius-system svc/bicep-de 5017:6443 + ## Setup Step 3: Create Resource Group and Environment At this point Radius is working but you don't have a resource group or environment. You can launch Radius and then use the CLI to create these. @@ -135,32 +135,4 @@ Now you can launch the Radius locally through the VSCode menu. - Press Debug - You're up and running! -## Troubleshooting - -### I got an error saying I need to clone the deployment engine - -> The radius-project/deployment-engine is not cloned as a sibling to the Radius repo. Please clone the radius-project/deployment-engine repo next to the Radius repo and try again. - -You should be to successfully the following commands from the Radius repository root: - -```sh -ls ../deployment-engine/src -ls ../deployment-engine/submodules/bicep-extensibility/src -``` - -If these commands fail, please re-read the prerequisites related to cloning the deployment engine. - -### I got an error related to missing dotnet or missing .NET SDK - -Make sure that `dotnet` is on your path. If you just installed .NET then you might need to reopen VS Code and your terminal. - -If `dotnet` is on your path you should be able to run the following commands: - -```sh -dotnet --list-runtimes -dotnet --list-sdks -``` - -Make sure you see a `6.0` entry in `--list-runtimes` for `Microsoft.AspNetCore.App` and a `6.0` or newer entry for `--list-sdks`. -If you run into issues here, please re-read the prerequisites related to installing .NET.