Skip to content

Commit

Permalink
update bicep references
Browse files Browse the repository at this point in the history
Signed-off-by: sk593 <[email protected]>
  • Loading branch information
sk593 committed Jul 12, 2024
1 parent 5896c5d commit c50a594
Show file tree
Hide file tree
Showing 118 changed files with 185 additions and 175 deletions.
2 changes: 1 addition & 1 deletion docs/content/concepts/faq/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ Teams looking to leverage existing Helm charts can use the [Radius annotations a

Similar to how you can define Azure resources in Bicep, you can define Radius resources in Bicep.

Radius currently uses a temporary fork of Bicep to add support for the Radius resources, but work is underway to merge extensibility support into the main Bicep repo and eliminate the need for a fork.
Radius uses Bicep to add support for Radius resources. We previously used a temporary fork of Bicep, but have since deprecated it in favor of the main Bicep repo.

Teams building or migrating applications on Radius can use Bicep to model their application and deploy to Kubernetes today, as well as future platforms, including serverless platforms.

Expand Down
1 change: 0 additions & 1 deletion docs/content/contributing/overview/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,3 @@ Check out the following table to learn where and how you can contribute:
| **Radius** | Main repository that contains source code for [`rad` CLI](https://github.com/radius-project/radius/blob/main/docs/contributing/contributing-code/contributing-code-cli/README.md), [control plane](https://github.com/radius-project/radius/blob/main/docs/contributing/contributing-code/contributing-code-control-plane/README.md) and other components of Radius | [radius-project/radius](https://github.com/radius-project/radius/blob/main/CONTRIBUTING.md)|
| **Recipes** | Commonly used [Recipe]({{< ref "guides/recipes/overview">}}) templates for Radius Environments | [radius-project/recipes](https://github.com/radius-project/recipes/blob/main/CONTRIBUTING.md) |
| **Dashboard** | The frontend experience for Radius |[radius-project/dashboard](https://github.com/radius-project/dashboard/blob/main/CONTRIBUTING.md) |
| **Bicep** | Temporary fork of the [Bicep repo](https://github.com/azure/bicep) used to inject the Radius types into the Bicep language. Contains both the Bicep CLI and the Bicep VS Code extension. | [radius-project/bicep](https://github.com/radius-project/bicep/blob/radius-compiler/CONTRIBUTING.md) |
6 changes: 4 additions & 2 deletions docs/content/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,11 +69,13 @@ Initializing Radius...
Initialization complete! Have a RAD time 😎
```

In addition to starting Radius services in your Kubernetes cluster, this initialization command creates a default application (`app.bicep`) as your starting point. It contains a single container definition (`demo`).
In addition to starting Radius services in your Kubernetes cluster, this initialization command creates a default application (`app.bicep`) as your starting point. It contains a single container definition (`demo`).

{{< rad file="snippets/app.bicep" embed=true markdownConfig="{linenos=table,linenostart=1}" >}}

> This file will run the `ghcr.io/radius-project/samples/demo:latest` image. This image is published by the Radius team to a public registry, you do not need to create it.
> This file will run the `ghcr.io/radius-project/samples/demo:latest` image. This image is published by the Radius team to a public registry, you do not need to create it. `rad init` also creates a `bicepconfig.json` file in your application's directory that has the necessary setup to use Radius with the official Bicep compiler.
{{< rad file="snippets/bicepconfig.json" embed=true markdownConfig="{linenos=table,linenostart=1}" >}}

## 4. Run the app

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Import the set of Radius resources (Applications.*) into Bicep
import radius as radius
extension radius

@description('The app ID of your Radius Application. Set automatically by the rad CLI.')
param application string
Expand Down
2 changes: 1 addition & 1 deletion docs/content/getting-started/snippets/app-with-redis.bicep
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Import the set of Radius resources (Applications.*) into Bicep
import radius as radius
extension radius

@description('The app ID of your Radius Application. Set automatically by the rad CLI.')
param application string
Expand Down
2 changes: 1 addition & 1 deletion docs/content/getting-started/snippets/app.bicep
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Import the set of Radius resources (Applications.*) into Bicep
import radius as radius
extension radius

@description('The app ID of your Radius Application. Set automatically by the rad CLI.')
param application string
Expand Down
11 changes: 11 additions & 0 deletions docs/content/getting-started/snippets/bicepconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"experimentalFeaturesEnabled": {
"extensibility": true,
"extensionRegistry": true,
"dynamicTypeLoading": true
},
"extensions": {
"radius": "br:biceptypes.azurecr.io/radius:<release-version>",
"aws": "br:biceptypes.azurecr.io/aws:<release-version>"
}
}
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import radius as radius
extension radius

@description('The environment ID of your Radius Application. Set automatically by the rad CLI.')
param environment string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ This how-to guide will show you:
- [eksctl CLI](https://docs.aws.amazon.com/eks/latest/userguide/eksctl.html)
- [kubectl CLI](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
- [rad CLI]({{< ref "installation#step-1-install-the-rad-cli" >}})
- [Radius Bicep VSCode extension]({{< ref "installation#step-2-install-the-radius-bicep-extension" >}})
- [Bicep VSCode extension and Bicep configuration file]({{< ref "installation#step-2-install-the-radius-bicep-extension" >}})

## Step 1: Create an EKS Cluster

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import aws as aws
extension aws

import radius as radius
extension radius

@description('The name of your S3 bucket.The AWS S3 Bucket name must follow the [following naming conventions](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html).')
param bucket string ='mys3bucket'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import aws as aws
extension aws

@description('The name of your S3 bucket.The AWS S3 Bucket name must follow the naming conventions described at https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html')
param bucket string ='mys3bucket-${uniqueString(resourceGroup().id)}'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import aws as aws
extension aws

import radius as radius
extension radius

@description('The name of your S3 bucket.The AWS S3 Bucket name must follow the [following naming conventions](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html).')
param bucket string ='mys3bucket'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import aws as aws
extension aws

import radius as radius
extension radius

param environment string

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The steps below will showcase a "rad-ified" version of the existing [Azure AD wo
## Prerequisites

- [rad CLI]({{< ref "installation#step-1-install-the-rad-cli" >}})
- [Radius Bicep VSCode extension]({{< ref "installation#step-2-install-the-vs-code-extension" >}})
- [Bicep VSCode extension and Bicep configuration file]({{< ref "installation#step-2-install-the-vs-code-extension" >}})
- [Setup a supported Kubernetes cluster]({{< ref "/guides/operations/kubernetes/overview#supported-clusters" >}})
- [Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/installation.html) installed in your cluster, including the [Mutating Admission Webhook](https://azure.github.io/azure-workload-identity/docs/installation/mutating-admission-webhook.html)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//ENVIRONMENT
import radius as radius
extension radius

@description('The Azure region to deploy Azure resource(s) into. Defaults to the region of the target Azure resource group.')
param azLocation string = resourceGroup().location
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import radius as radius
extension radius

param environment string

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This how-to guide will teach how to connect to your dependencies via [connection
## Prerequisites

- [rad CLI]({{< ref "installation#step-1-install-the-rad-cli" >}})
- [Radius Bicep VSCode extension]({{< ref "installation#step-2-install-the-vs-code-extension" >}})
- [Bicep VSCode extension and Bicep configuration file]({{< ref "installation#step-2-install-the-vs-code-extension" >}})
- [Radius environment]({{< ref "installation#step-3-initialize-radius" >}})

## Step 1: View the container definition
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Import the set of Radius resources (Applications.*) into Bicep
import radius as radius
extension radius

@description('The app ID of your Radius Application. Set automatically by the rad CLI.')
param application string
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import radius as rad
extension radius

@description('The app ID of your Radius application. Set automatically by the rad CLI.')
param application string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This how-to guide will provide an overview of how to:
## Prerequisites

- [rad CLI]({{< ref "installation#step-1-install-the-rad-cli" >}})
- [Radius Bicep VSCode extension]({{< ref "installation#step-2-install-the-vs-code-extension" >}})
- [Bicep VSCode extension and Bicep configuration file]({{< ref "installation#step-2-install-the-vs-code-extension" >}})
- [Supported Kubernetes cluster]({{< ref "guides/operations/kubernetes" >}})
- [Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/installation.html) installed on your cluster
- [Azure Keyvault Provider](https://azure.github.io/secrets-store-csi-driver-provider-azure/docs/getting-started/installation/)
Expand Down Expand Up @@ -59,7 +59,7 @@ Deploy your app, specifying the OIDC issuer URL. To retrieve the OIDC issuer URL
rad deploy ./app.bicep -p oidcIssuer=<OIDC_ISSUER_URL>
```

## Step 5: Verify access to the mounted Azure Key Vault
## Step 6: Verify access to the mounted Azure Key Vault

1. Once deployment completes, read the logs from your running container resource:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//ENVIRONMENT
import radius as rad
extension radius

@description('The Azure region to deploy Azure resource(s) into. Defaults to the region of the target Azure resource group.')
param azLocation string = resourceGroup().location
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This how-to guide will provide an overview of how to:
## Prerequisites

- [rad CLI]({{< ref "installation#step-1-install-the-rad-cli" >}})
- [Radius Bicep VSCode extension]({{< ref "installation#step-2-install-the-vs-code-extension" >}})
- [Bicep VSCode extension and Bicep configuration file]({{< ref "installation#step-2-install-the-vs-code-extension" >}})
- [Radius environment]({{< ref "installation#step-3-initialize-radius" >}})

## Step 1: Define an app and a container
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import radius as rad
extension radius

param environment string

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import radius as rad
extension radius

param environment string

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This guide will walk you through how to use an [extender]({{< ref "/guides/autho
## Prerequisites

- [rad CLI]({{< ref "installation#step-1-install-the-rad-cli" >}})
- [Radius Bicep VSCode extension]({{< ref "installation#step-2-install-the-vs-code-extension" >}})
- [Bicep VSCode extension and Bicep configuration file]({{< ref "installation#step-2-install-the-vs-code-extension" >}})
- [Radius environment]({{< ref "installation#step-3-initialize-radius" >}})

## Step 1: Register an extender Recipe
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import radius as rad
extension radius

@description('The ID of your Radius environment. Set automatically by the rad CLI.')
param environment string
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import radius as rad
extension radius

@description('The ID of your Radius environment. Set automatically by the rad CLI.')
param environment string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This how-to guide will provide an overview of how to:
## Prerequisites

- [rad CLI]({{< ref "installation#step-1-install-the-rad-cli" >}})
- [Radius Bicep VSCode extension]({{< ref "installation#step-2-install-the-vs-code-extension" >}})
- [Bicep VSCode extension and Bicep configuration file]({{< ref "installation#step-2-install-the-vs-code-extension" >}})
- [Radius environment]({{< ref "installation#step-3-initialize-radius" >}})
- [Radius local-dev Recipes]({{< ref howto-dev-recipes >}})
- [Dapr installed on your Kubernetes cluster](https://docs.dapr.io/operations/hosting/kubernetes/kubernetes-deploy/)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import radius as radius
extension radius

@description('The ID of your Radius Application. Automatically injected by the rad CLI.')
param application string
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import radius as radius
extension radius

@description('The ID of your Radius Application. Automatically injected by the rad CLI.')
param application string
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import radius as radius
extension radius

@description('The ID of your Radius Application. Automatically injected by the rad CLI.')
param application string
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import radius as radius
extension radius

@description('The ID of your Radius Application. Automatically injected by the rad CLI.')
param application string
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import radius as rad
extension radius

param environment string

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import radius as rad
extension radius


resource app 'Applications.Core/applications@2023-10-01-preview' existing = {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import radius as radius
extension radius

param environment string

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import radius as radius
extension radius

param environment string

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import radius as radius
extension radius

@description('Specifies the environment for resources.')
param environment string
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import radius as radius
extension radius

@description('Specifies the environment for resources.')
param environment string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
@description('Specifies Kubernetes namespace for the user.')
param namespace string = 'default-demo'

import kubernetes as kubernetes{
extension kubernetes{
kubeConfig: ''
namespace: namespace
}
//KUBERNETES

//APPLICATION
// Import the set of Radius resources (Applications.*) into Bicep
import radius as radius
extension radius

@description('The app ID of your Radius Application. Set automatically by the rad CLI.')
param application string
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import radius as radius
extension radius

@description('Specifies the environment for resources.')
param environment string
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import radius as radius
extension radius

@description('Specifies the environment for resources.')
param environment string
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import kubernetes as kubernetes {
extension kubernetes {
kubeConfig: ''
namespace: 'default'
}
import radius as radius
extension radius

param environment string

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import kubernetes as kubernetes {
extension kubernetes {
kubeConfig: '****'
namespace: 'default'
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This guide will walk you through how to setup a gateway for routing internet tra
## Prerequisites

- [rad CLI]({{< ref "installation#step-1-install-the-rad-cli" >}})
- [Radius Bicep VSCode extension]({{< ref "installation#step-2-install-the-vs-code-extension" >}})
- [Bicep VSCode extension and Bicep configuration file]({{< ref "installation#step-2-install-the-vs-code-extension" >}})
- [Radius environment]({{< ref "installation#step-3-initialize-radius" >}})

## Step 1: Define a container
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//FRONTEND
import radius as rad
extension radius

@description('The application ID being deployed. Injected automtically by the rad CLI')
param application string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This guide will show you how two services can communicate with each other. In th
## Prerequisites

- [rad CLI]({{< ref "installation#step-1-install-the-rad-cli" >}})
- [Radius Bicep VSCode extension]({{< ref "installation#step-2-install-the-vs-code-extension" >}})
- [Bicep VSCode extension and Bicep configuration file]({{< ref "installation#step-2-install-the-vs-code-extension" >}})
- [Radius environment]({{< ref "installation#step-3-initialize-radius" >}})

## Step 1: Define the services
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import radius as rad
extension radius

@description('The application ID of the Radius environment. Automatically set by the rad CLI.')
param application string
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import radius as rad
extension radius

@description('The application ID of the Radius environment. Automatically set by the rad CLI.')
param application string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This guide will show you how to add TLS and HTTPS to an application with a gatew
## Prerequisites

- [rad CLI]({{< ref "installation#step-1-install-the-rad-cli" >}})
- [Radius Bicep VSCode extension]({{< ref "installation#step-2-install-the-vs-code-extension" >}})
- [Bicep VSCode extension and Bicep configuration file]({{< ref "installation#step-2-install-the-vs-code-extension" >}})
- [Radius environment]({{< ref "installation#step-3-initialize-radius" >}})
- Domain name + DNS A-record pointing to your Kubernetes cluster
- If running Radius on an Azure Kubernetes Service (AKS) cluster you can optionally use a [DNS label](https://learn.microsoft.com/azure/virtual-network/ip-services/public-ip-addresses#dns-name-label) to create a DNS A-record pointing to your cluster.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//FRONTEND
import radius as rad
extension radius

@description('The application ID being deployed. Injected automtically by the rad CLI')
param application string
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//FRONTEND
import radius as rad
extension radius

@description('The application ID being deployed. Injected automtically by the rad CLI')
param application string
Expand Down
Loading

0 comments on commit c50a594

Please sign in to comment.