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

Minor updates to how-to guide on gateways #851

Closed
wants to merge 8 commits into from
Closed

Minor updates to how-to guide on gateways #851

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
0ba0ece
Add how-to guide on local dev recipes (#822)
Reshrahim Oct 12, 2023
40049f3
Standardize pre-reqs for all how-tos (#836)
Reshrahim Oct 12, 2023
bb5e327
Merge branch 'edge' into v0.26
Reshrahim Oct 13, 2023
b85ad26
Merge branch 'v0.26' of https://github.com/radius-project/docs into v…
Reshrahim Oct 16, 2023
1c62b20
Minor tweaks to gateway howt
Reshrahim Oct 16, 2023
89fcea8
Merge branch 'v0.26' into re/gateways
Reshrahim Oct 16, 2023
0b60acb
revert k8s step
Reshrahim Oct 16, 2023
606b10b
Merge branch 're/gateways' of https://github.com/radius-project/docs …
Reshrahim Oct 16, 2023
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
4 changes: 2 additions & 2 deletions docs/content/guides/author-apps/networking/howto-gateways/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ This guide will walk you through how to setup a gateway for routing internet tra
- [Radius Bicep VSCode extension]({{< ref "installation#step-2-install-the-radius-bicep-vs-code-extension" >}})
- [Radius environment]({{< ref "installation#step-3-initialize-the-radius-control-plane-and-the-radius-environment" >}})

## Step 1: Define a container
## Step 1: View the container
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm without explicitly telling the user to run rad init and select "yes" to scaffold an application I think "Define a container" works better, along with "in a new file".

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The pre-requisite step Radius environment does cover the step to select yes and set up the application. Either we go with that or make env creation a separate step here

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

closing as we decided to make how-tos standalone and not operate with the assumption of user scaffolding an application via rad init


Begin by defining the service you wish to expose to the internet in a new file named `app.bicep`. This example uses the Radius demo container:
Begin by defining the service you wish to expose to the internet. Open `app.bicep` in you current working directory. This example uses the Radius demo container:

{{< rad file="snippets/app.bicep" embed=true marker="//FRONTEND" >}}

Expand Down
6 changes: 3 additions & 3 deletions docs/content/guides/author-apps/networking/howto-gateways/snippets/app.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ import radius as rad
@description('The application ID being deployed. Injected automtically by the rad CLI')
param application string

resource frontend 'Applications.Core/containers@2023-10-01-preview' = {
name: 'frontend'
resource demo 'Applications.Core/containers@2023-10-01-preview' = {
name: 'demo'
properties: {
application: application
container: {
Expand All @@ -28,7 +28,7 @@ resource gateway 'Applications.Core/gateways@2023-10-01-preview' = {
routes: [
{
path: '/'
destination: 'http://${frontend.name}:3000'
destination: 'http://${demo.name}:3000'
}
]
}
Expand Down
Loading