Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updating doc to use DE from existing installation #7964

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

updating doc to use DE from existing installation #7964

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e2160cc
updating doc to use existing DE
nithyatsu Sep 25, 2024
0cb2e2f
wip
nithyatsu Oct 3, 2024
9521bd7
Merge branch 'main' into update_doc
nithyatsu Oct 3, 2024
e85197a
Update docs/contributing/contributing-code/contributing-code-control-…
nithyatsu Oct 14, 2024
bc22011
Update docs/contributing/contributing-code/contributing-code-control-…
nithyatsu Oct 14, 2024
489772a
Merge branch 'main' into update_doc
nithyatsu Oct 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .vscode/launch.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,6 @@
"Launch UCP",
"Launch Applications RP",
"Launch Controller",
"Launch Deployment Engine",
],
"stopAll": true
}
Expand Down
40 changes: 6 additions & 34 deletions ...ntributing-code/contributing-code-control-plane/running-controlplane-locally.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 - <https://dotnet.microsoft.com/en-us/download/dotnet/6.0>.
5. Install C# VS Code extension - <https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csharp>.
6. (Optional) Configure any cloud provider credentials you want to use for developing Radius.
2. Clone the `radius-project/radius` repo.
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`
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Loading