-
Notifications
You must be signed in to change notification settings - Fork 101
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.
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
nithyatsu
wants to merge
5
commits into
radius-project:main
Choose a base branch
from
nithyatsu:update_doc
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+35
−9
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -26,12 +26,13 @@ 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 8.0 SDK - <https://dotnet.microsoft.com/en-us/download/dotnet/8.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. | ||
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. If you have access to `radius-project/deployment-engine` repo, | ||
1. Clone the `radius-project/radius` and `radius-project/deployment-engine` repo next to each other. | ||
2. Run `git submodule update --init` in the `deployment-engine` repo. | ||
3. Install .NET 8.0 SDK - <https://dotnet.microsoft.com/en-us/download/dotnet/8.0>. | ||
4. Install C# VS Code extension - <https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csharp>. | ||
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. | ||
|
@@ -105,17 +106,42 @@ Run this command to create the namespace that will be used to store data. | |
kubectl create namespace radius-testing | ||
``` | ||
|
||
## Setup Step 3: Create Resource Group and Environment | ||
## Setup Step 4: Run Deployment Engine as docker container | ||
|
||
> 💡 This step is required only if you are an external contributor and do not have access to `radius-project/deployment-engine` repo. | ||
> | ||
`docker run -e RADIUSBACKENDURL=http://host.docker.internal:9000/apis/api.ucp.dev/v1alpha3 -p 5017:8080 ghcr.io/radius-project/deployment-engine:latest` | ||
|
||
`host.docker.internal` is a special DNS name provided by Docker that allows containers to access services running on the host machine | ||
|
||
## Setup Step 5: 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. | ||
|
||
In VS Code: | ||
|
||
- Open the Debug tab in VS Code | ||
- Select `Launch Control Plane (all)` from the drop-down | ||
- If you have access to `radius-project/deployment-engine` repo | ||
- Select `Launch Control Plane (all)` from the drop-down | ||
- If you are an external contributor, open launch.json and comment out `Launch Deployment Engine` in `Launch Control Plane (all)`. The debug setup will use the Deployment Engine running as docker container. | ||
``` | ||
"compounds": [ | ||
{ | ||
"name": "Launch Control Plane (all)", | ||
"configurations": [ | ||
"Launch UCP", | ||
"Launch Applications RP", | ||
"Launch Dynamic RP", | ||
"Launch Controller", | ||
// "Launch Deployment Engine" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is only if we are running Deployment Engine as a container, right? Should we specify that or delete this line all together? |
||
], | ||
"stopAll": true | ||
} | ||
], | ||
``` | ||
- Press Debug | ||
|
||
Wait for all 3 of these to start. | ||
Wait for all the services to start. | ||
|
||
Then at the command line run: | ||
|
||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.