diff --git a/.github/config/en-custom.txt b/.github/config/en-custom.txt index ef599bfe3..4a2d92d24 100644 --- a/.github/config/en-custom.txt +++ b/.github/config/en-custom.txt @@ -1261,7 +1261,10 @@ postgresenvSecrets RecipeConfigPropertiesEnvSecrets SecretReference ProviderConfigPropertiesSecrets +upstreamed irsa +bicepconfig +Bicepconfig postgres ReadOnly DeployTimeConstant \ No newline at end of file diff --git a/.github/scripts/validate_bicep.py b/.github/scripts/validate_bicep.py index fc57dfb4b..75e369ddf 100644 --- a/.github/scripts/validate_bicep.py +++ b/.github/scripts/validate_bicep.py @@ -45,6 +45,11 @@ def validate_file(f): ) stderr = result.stderr.decode("utf-8") exitcode = result.returncode + + warning_prefix = "WARNING: The following experimental Bicep features" + if stderr.startswith(warning_prefix) and "Error" not in stderr: + stderr = "" + exitcode = 0 if exitcode != 0: failures.append(f) diff --git a/.github/workflows/validate-bicep.yaml b/.github/workflows/validate-bicep.yaml index 5c5b503bc..bc9d4d7b8 100644 --- a/.github/workflows/validate-bicep.yaml +++ b/.github/workflows/validate-bicep.yaml @@ -20,19 +20,21 @@ on: branches: - edge - v* + push: + branches: + - edge + - v* jobs: build: name: Validate Bicep Code runs-on: ubuntu-latest steps: - - name: Check out repo - uses: actions/checkout@v4 - - name: Parse release version and set environment variables - run: python ./.github/scripts/get_docs_version.py - - name: Download rad-bicep + - name: Setup and verify bicep CLI run: | - oras pull ghcr.io/radius-project/radius/bicep/rad-bicep/linux-x64:latest - chmod +x rad-bicep + curl -Lo rad-bicep https://github.com/Azure/bicep/releases/latest/download/bicep-linux-x64 + chmod +x ./rad-bicep ./rad-bicep --version + - name: Check out repo + uses: actions/checkout@v4 - name: Verify Bicep files run: python ./.github/scripts/validate_bicep.py diff --git a/bicepconfig.json b/bicepconfig.json new file mode 100644 index 000000000..d772ad944 --- /dev/null +++ b/bicepconfig.json @@ -0,0 +1,12 @@ +// The bicepconfig.json file is needed so the bicep files in the repo can be compiled with the correct setup +{ + "experimentalFeaturesEnabled": { + "extensibility": true, + "extensionRegistry": true, + "dynamicTypeLoading": true + }, + "extensions": { + "radius": "br:biceptypes.azurecr.io/radius:latest", + "aws": "br:biceptypes.azurecr.io/aws:latest" + } +} \ No newline at end of file diff --git a/docs/content/concepts/faq/index.md b/docs/content/concepts/faq/index.md index 20d83a04a..cd25d1cc4 100644 --- a/docs/content/concepts/faq/index.md +++ b/docs/content/concepts/faq/index.md @@ -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. diff --git a/docs/content/contributing/overview/index.md b/docs/content/contributing/overview/index.md index 8b7f84d98..ce9e38d48 100644 --- a/docs/content/contributing/overview/index.md +++ b/docs/content/contributing/overview/index.md @@ -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) | diff --git a/docs/content/getting-started/index.md b/docs/content/getting-started/index.md index eacfdae70..942df2189 100644 --- a/docs/content/getting-started/index.md +++ b/docs/content/getting-started/index.md @@ -69,7 +69,7 @@ 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 init` also creates a [`bicepconfig.json`]({{< ref "/guides/tooling/bicepconfig/overview" >}}) file in your application's directory that has the necessary setup to use Radius with the official Bicep compiler. {{< rad file="snippets/app.bicep" embed=true markdownConfig="{linenos=table,linenostart=1}" >}} diff --git a/docs/content/getting-started/snippets/app-with-redis-snippets.bicep b/docs/content/getting-started/snippets/app-with-redis-snippets.bicep index bbc49d237..5024d37af 100644 --- a/docs/content/getting-started/snippets/app-with-redis-snippets.bicep +++ b/docs/content/getting-started/snippets/app-with-redis-snippets.bicep @@ -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 diff --git a/docs/content/getting-started/snippets/app-with-redis.bicep b/docs/content/getting-started/snippets/app-with-redis.bicep index 352ae5c22..f819a8630 100644 --- a/docs/content/getting-started/snippets/app-with-redis.bicep +++ b/docs/content/getting-started/snippets/app-with-redis.bicep @@ -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 diff --git a/docs/content/getting-started/snippets/app.bicep b/docs/content/getting-started/snippets/app.bicep index 5f976ec14..e6089ac49 100644 --- a/docs/content/getting-started/snippets/app.bicep +++ b/docs/content/getting-started/snippets/app.bicep @@ -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 diff --git a/docs/content/guides/author-apps/application/overview/snippets/blank.bicep b/docs/content/guides/author-apps/application/overview/snippets/blank.bicep index bd50b2da0..d6623dbf5 100644 --- a/docs/content/guides/author-apps/application/overview/snippets/blank.bicep +++ b/docs/content/guides/author-apps/application/overview/snippets/blank.bicep @@ -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 diff --git a/docs/content/guides/author-apps/aws/howto-aws-resources/index.md b/docs/content/guides/author-apps/aws/howto-aws-resources/index.md index ff3100364..6757a20e4 100644 --- a/docs/content/guides/author-apps/aws/howto-aws-resources/index.md +++ b/docs/content/guides/author-apps/aws/howto-aws-resources/index.md @@ -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]({{< ref "installation#step-2-install-the-vs-code-extension" >}}) ## Step 1: Create an EKS Cluster @@ -52,7 +52,15 @@ Follow the prompts to install the [control plane services]({{< ref "/concepts/te - **Add AWS provider** - An [AWS cloud provider]({{< ref "/guides/operations/providers/aws-provider" >}}) allows you to deploy and manage AWS resources as part of your application. Follow the how-to guides to [configure the AWS provider]({{< ref "/guides/operations/providers/aws-provider/howto-aws-provider" >}}) with the preferred identity. - **Environment name** - The name of the environment to create. You can specify any name with lowercase letters, such as `myawsenv`. -## Step 3: Create a Bicep file to model AWS Simple Storage Service (S3) +Select 'No' when asked to setup application in the current directory. + +## Step 3: Create a `bicepconfig.json` in your application's directory + +{{< read file= "/shared-content/installation/bicepconfig/manual.md" >}} + +More information on how to setup a `bicepconfig.json` can be found [here]({{< ref "/guides/tooling/bicepconfig/overview" >}}) + +## Step 4: Create a Bicep file to model AWS Simple Storage Service (S3) Create a new file called `app.bicep` and add the following bicep code to model an AWS S3 Bucket: @@ -60,7 +68,7 @@ Create a new file called `app.bicep` and add the following bicep code to model a Radius uses the [AWS Cloud Control API](https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/what-is-cloudcontrolapi.html) to interact with AWS resources. This means that you can model your AWS resources in Bicep and Radius will be able to deploy and manage them. You can find the list of supported AWS resources in the [AWS resource library]({{< ref "guides/author-apps/aws/overview#resource-library" >}}). -## Step 4: Add a Radius container to interact with the AWS S3 Bucket +## Step 5: Add a Radius container to interact with the AWS S3 Bucket Open the `app.bicep` and append the following Radius resources: @@ -72,7 +80,7 @@ Your final `app.bicep` file should look like this This creates a container that will be deployed to your Kubernetes cluster. This container will interact with the AWS S3 Bucket you created in the previous step. -## Step 5: Deploy the application +## Step 6: Deploy the application 1. Deploy your application to your environment: @@ -95,7 +103,7 @@ This creates a container that will be deployed to your Kubernetes cluster. This {{< image src="s3app.png" alt="Screenshot of the sample application to interact with s3 bucket " width=900 >}} -## Step 6: Cleanup +## Step 7: Cleanup 1. When you're done with testing, you can use the rad CLI to [delete an environment]({{< ref rad_env_delete.md >}}) to delete all Radius resources running on the EKS Cluster. diff --git a/docs/content/guides/author-apps/aws/howto-aws-resources/snippets/app.bicep b/docs/content/guides/author-apps/aws/howto-aws-resources/snippets/app.bicep index 0673c98a5..818e482b7 100644 --- a/docs/content/guides/author-apps/aws/howto-aws-resources/snippets/app.bicep +++ b/docs/content/guides/author-apps/aws/howto-aws-resources/snippets/app.bicep @@ -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' diff --git a/docs/content/guides/author-apps/aws/howto-aws-resources/snippets/s3.bicep b/docs/content/guides/author-apps/aws/howto-aws-resources/snippets/s3.bicep index 522038b3f..65567867a 100644 --- a/docs/content/guides/author-apps/aws/howto-aws-resources/snippets/s3.bicep +++ b/docs/content/guides/author-apps/aws/howto-aws-resources/snippets/s3.bicep @@ -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)}' diff --git a/docs/content/guides/author-apps/aws/howto-aws-resources/snippets/s3app.bicep b/docs/content/guides/author-apps/aws/howto-aws-resources/snippets/s3app.bicep index 53f425470..59c154e54 100644 --- a/docs/content/guides/author-apps/aws/howto-aws-resources/snippets/s3app.bicep +++ b/docs/content/guides/author-apps/aws/howto-aws-resources/snippets/s3app.bicep @@ -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' diff --git a/docs/content/guides/author-apps/aws/overview/snippets/aws.bicep b/docs/content/guides/author-apps/aws/overview/snippets/aws.bicep index c1db7cbd4..8dfcfda1e 100644 --- a/docs/content/guides/author-apps/aws/overview/snippets/aws.bicep +++ b/docs/content/guides/author-apps/aws/overview/snippets/aws.bicep @@ -1,6 +1,6 @@ -import aws as aws +extension aws -import radius as radius +extension radius param environment string diff --git a/docs/content/guides/author-apps/azure/howto-azure-resources/index.md b/docs/content/guides/author-apps/azure/howto-azure-resources/index.md index a9608a548..e610a4ed9 100644 --- a/docs/content/guides/author-apps/azure/howto-azure-resources/index.md +++ b/docs/content/guides/author-apps/azure/howto-azure-resources/index.md @@ -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]({{< 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) @@ -32,19 +32,27 @@ Begin by running [`rad init --full`]({{< ref rad_init >}}). Make sure to configu rad init --full ``` -## Step 2: Define a Radius Environment +Select 'No' when asked to setup application in the current directory. + +## Step 2: Create a `bicepconfig.json` in your application's directory + +{{< read file= "/shared-content/installation/bicepconfig/manual.md" >}} + +More information on how to setup a `bicepconfig.json` can be found [here]({{< ref "/guides/tooling/bicepconfig/overview" >}}) + +## Step 3: Define a Radius Environment Create a file named `app.bicep` and define a Radius Environment with [identity property]({{< ref "/guides/deploy-apps/environments/overview" >}}) set. This configures your environment to use your Azure AD workload identity installation with your cluster's OIDC endpoint: {{< rad file="snippets/container-wi.bicep" embed=true marker="//ENVIRONMENT">}} -## Step 3: Define an app and a container +## Step 4: Define an app and a container Add a Radius Application, a Radius [container]({{< ref "guides/author-apps/containers" >}}), and an Azure Key Vault to your `app.bicep` file. Note the connection from the container to the Key Vault, with an iam property set for the Azure AD RBAC role: {{< rad file="snippets/container-wi.bicep" embed=true marker="//CONTAINER" >}} -## Step 4: Deploy the app and container +## Step 5: Deploy the app and container Deploy your app by specifying the OIDC issuer URL. To retrieve the OIDC issuer URL, follow the [Azure Workload Identity installation guide](https://azure.github.io/azure-workload-identity/docs/installation.html). @@ -52,7 +60,7 @@ Deploy your app by specifying the OIDC issuer URL. To retrieve the OIDC issuer U rad deploy ./app.bicep -p oidcIssuer= ``` -## Step 5: Verify access to the Key Vault +## Step 6: Verify access to the Key Vault 1. Once deployment completes, read the logs from your running container resource: diff --git a/docs/content/guides/author-apps/azure/howto-azure-resources/snippets/container-wi.bicep b/docs/content/guides/author-apps/azure/howto-azure-resources/snippets/container-wi.bicep index e57420aad..a6aa33097 100644 --- a/docs/content/guides/author-apps/azure/howto-azure-resources/snippets/container-wi.bicep +++ b/docs/content/guides/author-apps/azure/howto-azure-resources/snippets/container-wi.bicep @@ -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 diff --git a/docs/content/guides/author-apps/azure/overview/snippets/azure-connection.bicep b/docs/content/guides/author-apps/azure/overview/snippets/azure-connection.bicep index ac9a22a43..51b857e96 100644 --- a/docs/content/guides/author-apps/azure/overview/snippets/azure-connection.bicep +++ b/docs/content/guides/author-apps/azure/overview/snippets/azure-connection.bicep @@ -1,4 +1,4 @@ -import radius as radius +extension radius param environment string diff --git a/docs/content/guides/author-apps/containers/howto-connect-dependencies/index.md b/docs/content/guides/author-apps/containers/howto-connect-dependencies/index.md index ed13989f6..b39de88ac 100644 --- a/docs/content/guides/author-apps/containers/howto-connect-dependencies/index.md +++ b/docs/content/guides/author-apps/containers/howto-connect-dependencies/index.md @@ -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]({{< ref "installation#step-2-install-the-vs-code-extension" >}}) - [Radius environment]({{< ref "installation#step-3-initialize-radius" >}}) ## Step 1: View the container definition diff --git a/docs/content/guides/author-apps/containers/howto-connect-dependencies/snippets/app-with-redis.bicep b/docs/content/guides/author-apps/containers/howto-connect-dependencies/snippets/app-with-redis.bicep index f1f91549d..04f9dd16c 100644 --- a/docs/content/guides/author-apps/containers/howto-connect-dependencies/snippets/app-with-redis.bicep +++ b/docs/content/guides/author-apps/containers/howto-connect-dependencies/snippets/app-with-redis.bicep @@ -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 diff --git a/docs/content/guides/author-apps/containers/howto-connect-dependencies/snippets/app.bicep b/docs/content/guides/author-apps/containers/howto-connect-dependencies/snippets/app.bicep index 82919de41..ee5b94ed0 100644 --- a/docs/content/guides/author-apps/containers/howto-connect-dependencies/snippets/app.bicep +++ b/docs/content/guides/author-apps/containers/howto-connect-dependencies/snippets/app.bicep @@ -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 diff --git a/docs/content/guides/author-apps/containers/howto-keyvault-volume/index.md b/docs/content/guides/author-apps/containers/howto-keyvault-volume/index.md index 927fda410..628b41751 100644 --- a/docs/content/guides/author-apps/containers/howto-keyvault-volume/index.md +++ b/docs/content/guides/author-apps/containers/howto-keyvault-volume/index.md @@ -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]({{< 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/) @@ -33,25 +33,33 @@ Begin by running [`rad init --full`]({{< ref rad_init >}}). Make sure to configu rad init --full ``` -## Step 2: Define a Radius Environment +Select 'No' when asked to setup application in the current directory. + +## Step 2: Create a `bicepconfig.json` in your application's directory + +{{< read file= "/shared-content/installation/bicepconfig/manual.md" >}} + +More information on how to setup a `bicepconfig.json` can be found [here]({{< ref "/guides/tooling/bicepconfig/overview" >}}) + +## Step 3: Define a Radius Environment Create a file named `app.bicep` and define a Radius Environment with the identity property set: {{< rad file="snippets/keyvault-wi.bicep" embed=true marker="//ENVIRONMENT">}} -## Step 3: Define an app, Key Vault, and volume +## Step 4: Define an app, Key Vault, and volume Add a Radius Application, an Azure Key Vault, and a Radius volume which uses the Key Vault to your `app.bicep` file: {{< rad file="snippets/keyvault-wi.bicep" embed=true marker="//APP" >}} -## Step 4: Define an app, Key Vault, and volume +## Step 5: Define an app, Key Vault, and volume Now add a Radius [container]({{< ref "guides/author-apps/containers" >}}) with a volume mount for the Radius volume: {{< rad file="snippets/keyvault-wi.bicep" embed=true marker="//CONTAINER" >}} -## Step 5: Deploy the app +## Step 6: Deploy the app Deploy your app, specifying the OIDC issuer URL. To retrieve the OIDC issuer URL, follow the [Azure Workload Identity installation guide](https://azure.github.io/azure-workload-identity/docs/installation.html). @@ -59,7 +67,7 @@ Deploy your app, specifying the OIDC issuer URL. To retrieve the OIDC issuer URL rad deploy ./app.bicep -p oidcIssuer= ``` -## Step 5: Verify access to the mounted Azure Key Vault +## Step 7: Verify access to the mounted Azure Key Vault 1. Once deployment completes, read the logs from your running container resource: diff --git a/docs/content/guides/author-apps/containers/howto-keyvault-volume/snippets/keyvault-wi.bicep b/docs/content/guides/author-apps/containers/howto-keyvault-volume/snippets/keyvault-wi.bicep index 774c42e21..b7b7a921f 100644 --- a/docs/content/guides/author-apps/containers/howto-keyvault-volume/snippets/keyvault-wi.bicep +++ b/docs/content/guides/author-apps/containers/howto-keyvault-volume/snippets/keyvault-wi.bicep @@ -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 diff --git a/docs/content/guides/author-apps/containers/howto-volumes/index.md b/docs/content/guides/author-apps/containers/howto-volumes/index.md index e510b0818..40b8b60be 100644 --- a/docs/content/guides/author-apps/containers/howto-volumes/index.md +++ b/docs/content/guides/author-apps/containers/howto-volumes/index.md @@ -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]({{< 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 diff --git a/docs/content/guides/author-apps/containers/howto-volumes/snippets/1-app.bicep b/docs/content/guides/author-apps/containers/howto-volumes/snippets/1-app.bicep index 898371cb6..2a6056ffc 100644 --- a/docs/content/guides/author-apps/containers/howto-volumes/snippets/1-app.bicep +++ b/docs/content/guides/author-apps/containers/howto-volumes/snippets/1-app.bicep @@ -1,4 +1,4 @@ -import radius as rad +extension radius param environment string diff --git a/docs/content/guides/author-apps/containers/howto-volumes/snippets/2-app.bicep b/docs/content/guides/author-apps/containers/howto-volumes/snippets/2-app.bicep index 5bb5398d3..b225dcf77 100644 --- a/docs/content/guides/author-apps/containers/howto-volumes/snippets/2-app.bicep +++ b/docs/content/guides/author-apps/containers/howto-volumes/snippets/2-app.bicep @@ -1,4 +1,4 @@ -import radius as rad +extension radius param environment string diff --git a/docs/content/guides/author-apps/custom/howto-extenders/index.md b/docs/content/guides/author-apps/custom/howto-extenders/index.md index 7f593c5d8..99742ef36 100644 --- a/docs/content/guides/author-apps/custom/howto-extenders/index.md +++ b/docs/content/guides/author-apps/custom/howto-extenders/index.md @@ -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]({{< ref "installation#step-2-install-the-vs-code-extension" >}}) - [Radius environment]({{< ref "installation#step-3-initialize-radius" >}}) ## Step 1: Register an extender Recipe diff --git a/docs/content/guides/author-apps/custom/howto-extenders/snippets/app-container.bicep b/docs/content/guides/author-apps/custom/howto-extenders/snippets/app-container.bicep index f32c6baff..6f946c74d 100644 --- a/docs/content/guides/author-apps/custom/howto-extenders/snippets/app-container.bicep +++ b/docs/content/guides/author-apps/custom/howto-extenders/snippets/app-container.bicep @@ -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 @@ -28,7 +28,7 @@ resource demo 'Applications.Core/containers@2023-10-01-preview' = { POSTGRESQL_HOST: extender.properties.host POSTGRESQL_PORT: extender.properties.port POSTGRESQL_USERNAME: extender.properties.username - POSTGRESQL_PASSWORD: extender.secrets('password') + POSTGRESQL_PASSWORD: extender.listSecrets().password } ports: { web: { diff --git a/docs/content/guides/author-apps/custom/howto-extenders/snippets/app.bicep b/docs/content/guides/author-apps/custom/howto-extenders/snippets/app.bicep index cefd772b1..a3bd4a435 100644 --- a/docs/content/guides/author-apps/custom/howto-extenders/snippets/app.bicep +++ b/docs/content/guides/author-apps/custom/howto-extenders/snippets/app.bicep @@ -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 diff --git a/docs/content/guides/author-apps/dapr/how-to-dapr-building-block/index.md b/docs/content/guides/author-apps/dapr/how-to-dapr-building-block/index.md index e430c5068..906c99125 100644 --- a/docs/content/guides/author-apps/dapr/how-to-dapr-building-block/index.md +++ b/docs/content/guides/author-apps/dapr/how-to-dapr-building-block/index.md @@ -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]({{< 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/) diff --git a/docs/content/guides/author-apps/dapr/how-to-dapr-building-block/snippets/app-sidecar.bicep b/docs/content/guides/author-apps/dapr/how-to-dapr-building-block/snippets/app-sidecar.bicep index 56e581cfa..afbc9deb7 100644 --- a/docs/content/guides/author-apps/dapr/how-to-dapr-building-block/snippets/app-sidecar.bicep +++ b/docs/content/guides/author-apps/dapr/how-to-dapr-building-block/snippets/app-sidecar.bicep @@ -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 diff --git a/docs/content/guides/author-apps/dapr/how-to-dapr-building-block/snippets/app-statestore.bicep b/docs/content/guides/author-apps/dapr/how-to-dapr-building-block/snippets/app-statestore.bicep index 0bc148317..b26010fa6 100644 --- a/docs/content/guides/author-apps/dapr/how-to-dapr-building-block/snippets/app-statestore.bicep +++ b/docs/content/guides/author-apps/dapr/how-to-dapr-building-block/snippets/app-statestore.bicep @@ -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 diff --git a/docs/content/guides/author-apps/dapr/how-to-dapr-sidecar/snippets/app-sidecar.bicep b/docs/content/guides/author-apps/dapr/how-to-dapr-sidecar/snippets/app-sidecar.bicep index 90e3ccc1e..e5407de9a 100644 --- a/docs/content/guides/author-apps/dapr/how-to-dapr-sidecar/snippets/app-sidecar.bicep +++ b/docs/content/guides/author-apps/dapr/how-to-dapr-sidecar/snippets/app-sidecar.bicep @@ -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 diff --git a/docs/content/guides/author-apps/dapr/how-to-dapr-sidecar/snippets/app.bicep b/docs/content/guides/author-apps/dapr/how-to-dapr-sidecar/snippets/app.bicep index c767459ed..c4b628010 100644 --- a/docs/content/guides/author-apps/dapr/how-to-dapr-sidecar/snippets/app.bicep +++ b/docs/content/guides/author-apps/dapr/how-to-dapr-sidecar/snippets/app.bicep @@ -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 diff --git a/docs/content/guides/author-apps/dapr/overview/snippets/dapr-componentname.bicep b/docs/content/guides/author-apps/dapr/overview/snippets/dapr-componentname.bicep index 11a12eec0..cd4f9b7d2 100644 --- a/docs/content/guides/author-apps/dapr/overview/snippets/dapr-componentname.bicep +++ b/docs/content/guides/author-apps/dapr/overview/snippets/dapr-componentname.bicep @@ -1,4 +1,4 @@ -import radius as rad +extension radius param environment string diff --git a/docs/content/guides/author-apps/dapr/overview/snippets/service-invocation.bicep b/docs/content/guides/author-apps/dapr/overview/snippets/service-invocation.bicep index 572a6afc4..1728853a6 100644 --- a/docs/content/guides/author-apps/dapr/overview/snippets/service-invocation.bicep +++ b/docs/content/guides/author-apps/dapr/overview/snippets/service-invocation.bicep @@ -1,4 +1,4 @@ -import radius as rad +extension radius resource app 'Applications.Core/applications@2023-10-01-preview' existing = { diff --git a/docs/content/guides/author-apps/dapr/overview/snippets/sidecar.bicep b/docs/content/guides/author-apps/dapr/overview/snippets/sidecar.bicep index 9d5065ba9..04a80a4c3 100644 --- a/docs/content/guides/author-apps/dapr/overview/snippets/sidecar.bicep +++ b/docs/content/guides/author-apps/dapr/overview/snippets/sidecar.bicep @@ -1,4 +1,4 @@ -import radius as radius +extension radius param environment string diff --git a/docs/content/guides/author-apps/dapr/overview/snippets/statestore.bicep b/docs/content/guides/author-apps/dapr/overview/snippets/statestore.bicep index fe7cfbfdf..38908a7e2 100644 --- a/docs/content/guides/author-apps/dapr/overview/snippets/statestore.bicep +++ b/docs/content/guides/author-apps/dapr/overview/snippets/statestore.bicep @@ -1,4 +1,4 @@ -import radius as radius +extension radius param environment string diff --git a/docs/content/guides/author-apps/kubernetes/how-to-access-secrets/snippets/secrets-container.bicep b/docs/content/guides/author-apps/kubernetes/how-to-access-secrets/snippets/secrets-container.bicep index cf50f3d4b..225ed1d51 100644 --- a/docs/content/guides/author-apps/kubernetes/how-to-access-secrets/snippets/secrets-container.bicep +++ b/docs/content/guides/author-apps/kubernetes/how-to-access-secrets/snippets/secrets-container.bicep @@ -1,4 +1,4 @@ -import radius as radius +extension radius @description('Specifies the environment for resources.') param environment string diff --git a/docs/content/guides/author-apps/kubernetes/how-to-access-secrets/snippets/secrets-patch.bicep b/docs/content/guides/author-apps/kubernetes/how-to-access-secrets/snippets/secrets-patch.bicep index f832dcfca..9d8eff55d 100644 --- a/docs/content/guides/author-apps/kubernetes/how-to-access-secrets/snippets/secrets-patch.bicep +++ b/docs/content/guides/author-apps/kubernetes/how-to-access-secrets/snippets/secrets-patch.bicep @@ -1,4 +1,4 @@ -import radius as radius +extension radius @description('Specifies the environment for resources.') param environment string diff --git a/docs/content/guides/author-apps/kubernetes/how-to-kubernetes-resource/snippets/app-kubernetes.bicep b/docs/content/guides/author-apps/kubernetes/how-to-kubernetes-resource/snippets/app-kubernetes.bicep index 60333de0d..bae91823e 100644 --- a/docs/content/guides/author-apps/kubernetes/how-to-kubernetes-resource/snippets/app-kubernetes.bicep +++ b/docs/content/guides/author-apps/kubernetes/how-to-kubernetes-resource/snippets/app-kubernetes.bicep @@ -2,7 +2,7 @@ @description('Specifies Kubernetes namespace for the user.') param namespace string = 'default-demo' -import kubernetes as kubernetes{ +extension kubernetes with { kubeConfig: '' namespace: namespace } @@ -10,7 +10,7 @@ import kubernetes as 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 diff --git a/docs/content/guides/author-apps/kubernetes/how-to-patch-pod/snippets/patch-container.bicep b/docs/content/guides/author-apps/kubernetes/how-to-patch-pod/snippets/patch-container.bicep index cf50f3d4b..225ed1d51 100644 --- a/docs/content/guides/author-apps/kubernetes/how-to-patch-pod/snippets/patch-container.bicep +++ b/docs/content/guides/author-apps/kubernetes/how-to-patch-pod/snippets/patch-container.bicep @@ -1,4 +1,4 @@ -import radius as radius +extension radius @description('Specifies the environment for resources.') param environment string diff --git a/docs/content/guides/author-apps/kubernetes/how-to-patch-pod/snippets/patch-runtime.bicep b/docs/content/guides/author-apps/kubernetes/how-to-patch-pod/snippets/patch-runtime.bicep index 692541563..a90ac38d7 100644 --- a/docs/content/guides/author-apps/kubernetes/how-to-patch-pod/snippets/patch-runtime.bicep +++ b/docs/content/guides/author-apps/kubernetes/how-to-patch-pod/snippets/patch-runtime.bicep @@ -1,4 +1,4 @@ -import radius as radius +extension radius @description('Specifies the environment for resources.') param environment string diff --git a/docs/content/guides/author-apps/kubernetes/overview/snippets/kubernetes-connection.bicep b/docs/content/guides/author-apps/kubernetes/overview/snippets/kubernetes-connection.bicep index 5b5d30747..5de98a196 100644 --- a/docs/content/guides/author-apps/kubernetes/overview/snippets/kubernetes-connection.bicep +++ b/docs/content/guides/author-apps/kubernetes/overview/snippets/kubernetes-connection.bicep @@ -1,8 +1,8 @@ -import kubernetes as kubernetes { +extension kubernetes with { kubeConfig: '' namespace: 'default' } -import radius as radius +extension radius param environment string diff --git a/docs/content/guides/author-apps/kubernetes/overview/snippets/kubernetes-resource.bicep b/docs/content/guides/author-apps/kubernetes/overview/snippets/kubernetes-resource.bicep index 13824d447..9000378ac 100644 --- a/docs/content/guides/author-apps/kubernetes/overview/snippets/kubernetes-resource.bicep +++ b/docs/content/guides/author-apps/kubernetes/overview/snippets/kubernetes-resource.bicep @@ -1,4 +1,4 @@ -import kubernetes as kubernetes { +extension kubernetes with { kubeConfig: '****' namespace: 'default' } diff --git a/docs/content/guides/author-apps/networking/howto-gateways/index.md b/docs/content/guides/author-apps/networking/howto-gateways/index.md index 82d2448cd..aa053a75a 100644 --- a/docs/content/guides/author-apps/networking/howto-gateways/index.md +++ b/docs/content/guides/author-apps/networking/howto-gateways/index.md @@ -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]({{< ref "installation#step-2-install-the-vs-code-extension" >}}) - [Radius environment]({{< ref "installation#step-3-initialize-radius" >}}) ## Step 1: Define a container diff --git a/docs/content/guides/author-apps/networking/howto-gateways/snippets/app.bicep b/docs/content/guides/author-apps/networking/howto-gateways/snippets/app.bicep index 8b90d49c5..b66ab9d99 100644 --- a/docs/content/guides/author-apps/networking/howto-gateways/snippets/app.bicep +++ b/docs/content/guides/author-apps/networking/howto-gateways/snippets/app.bicep @@ -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 diff --git a/docs/content/guides/author-apps/networking/howto-service-networking/index.md b/docs/content/guides/author-apps/networking/howto-service-networking/index.md index ca2b9cf25..ab69526d7 100644 --- a/docs/content/guides/author-apps/networking/howto-service-networking/index.md +++ b/docs/content/guides/author-apps/networking/howto-service-networking/index.md @@ -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]({{< ref "installation#step-2-install-the-vs-code-extension" >}}) - [Radius environment]({{< ref "installation#step-3-initialize-radius" >}}) ## Step 1: Define the services diff --git a/docs/content/guides/author-apps/networking/howto-service-networking/snippets/1-app.bicep b/docs/content/guides/author-apps/networking/howto-service-networking/snippets/1-app.bicep index 9bbe002fd..9a9beb278 100644 --- a/docs/content/guides/author-apps/networking/howto-service-networking/snippets/1-app.bicep +++ b/docs/content/guides/author-apps/networking/howto-service-networking/snippets/1-app.bicep @@ -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 diff --git a/docs/content/guides/author-apps/networking/howto-service-networking/snippets/2-app.bicep b/docs/content/guides/author-apps/networking/howto-service-networking/snippets/2-app.bicep index 4d9fe4353..eaef68374 100644 --- a/docs/content/guides/author-apps/networking/howto-service-networking/snippets/2-app.bicep +++ b/docs/content/guides/author-apps/networking/howto-service-networking/snippets/2-app.bicep @@ -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 diff --git a/docs/content/guides/author-apps/networking/howto-tls/index.md b/docs/content/guides/author-apps/networking/howto-tls/index.md index 2c68a3679..d03221824 100644 --- a/docs/content/guides/author-apps/networking/howto-tls/index.md +++ b/docs/content/guides/author-apps/networking/howto-tls/index.md @@ -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]({{< 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. diff --git a/docs/content/guides/author-apps/networking/howto-tls/snippets/app-existing.bicep b/docs/content/guides/author-apps/networking/howto-tls/snippets/app-existing.bicep index e848fde02..aec3ebe1e 100644 --- a/docs/content/guides/author-apps/networking/howto-tls/snippets/app-existing.bicep +++ b/docs/content/guides/author-apps/networking/howto-tls/snippets/app-existing.bicep @@ -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 diff --git a/docs/content/guides/author-apps/networking/howto-tls/snippets/app-new.bicep b/docs/content/guides/author-apps/networking/howto-tls/snippets/app-new.bicep index e01e5aa17..2cf807f1f 100644 --- a/docs/content/guides/author-apps/networking/howto-tls/snippets/app-new.bicep +++ b/docs/content/guides/author-apps/networking/howto-tls/snippets/app-new.bicep @@ -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 diff --git a/docs/content/guides/author-apps/portable-resources/howto-author-portable-resources/index.md b/docs/content/guides/author-apps/portable-resources/howto-author-portable-resources/index.md index e895a5068..415983eeb 100644 --- a/docs/content/guides/author-apps/portable-resources/howto-author-portable-resources/index.md +++ b/docs/content/guides/author-apps/portable-resources/howto-author-portable-resources/index.md @@ -16,7 +16,7 @@ Before you get started, you'll need to make sure you have the following tools an - [rad CLI]({{< ref "installation#step-1-install-the-rad-cli" >}}) - [Radius environment]({{< ref "installation#step-3-initialize-radius" >}}) -- [Radius Bicep VSCode extension]({{< ref "installation#step-2-install-the-vs-code-extension" >}}) +- [Bicep VSCode extension]({{< ref "installation#step-2-install-the-vs-code-extension" >}}) ## Step 1: Add a portable resource diff --git a/docs/content/guides/author-apps/portable-resources/howto-author-portable-resources/snippets/app-redis-manual.bicep b/docs/content/guides/author-apps/portable-resources/howto-author-portable-resources/snippets/app-redis-manual.bicep index 8384f763c..64d3664ae 100644 --- a/docs/content/guides/author-apps/portable-resources/howto-author-portable-resources/snippets/app-redis-manual.bicep +++ b/docs/content/guides/author-apps/portable-resources/howto-author-portable-resources/snippets/app-redis-manual.bicep @@ -1,5 +1,5 @@ //MANUAL -import radius as radius +extension radius @description('Specifies the environment for resources.') param environment string @@ -32,7 +32,7 @@ resource container 'Applications.Core/containers@2023-10-01-preview' = { image: 'ghcr.io/radius-project/samples/demo:latest' env: { // Manually access Redis connection information - REDIS_CONNECTION: redis.connectionString() + REDIS_CONNECTION: redis.listSecrets().connectionString } ports: { web: { diff --git a/docs/content/guides/author-apps/portable-resources/howto-author-portable-resources/snippets/app-redis-recipe.bicep b/docs/content/guides/author-apps/portable-resources/howto-author-portable-resources/snippets/app-redis-recipe.bicep index c4bea58dc..aa6a8237b 100644 --- a/docs/content/guides/author-apps/portable-resources/howto-author-portable-resources/snippets/app-redis-recipe.bicep +++ b/docs/content/guides/author-apps/portable-resources/howto-author-portable-resources/snippets/app-redis-recipe.bicep @@ -1,5 +1,5 @@ //RECIPE -import radius as radius +extension radius @description('Specifies the environment for resources.') param environment string diff --git a/docs/content/guides/author-apps/secrets/howto-new-secretstore/index.md b/docs/content/guides/author-apps/secrets/howto-new-secretstore/index.md index 9589ceee6..c9499ce58 100644 --- a/docs/content/guides/author-apps/secrets/howto-new-secretstore/index.md +++ b/docs/content/guides/author-apps/secrets/howto-new-secretstore/index.md @@ -16,7 +16,7 @@ By default, Radius leverages the hosting platform's secrets management solution - [rad CLI]({{< ref "installation#step-1-install-the-rad-cli" >}}) - [kubectl CLI](https://kubernetes.io/docs/tasks/tools/install-kubectl/) -- [Radius Bicep VSCode extension]({{< ref "installation#step-2-install-the-radius-bicep-vs-code-extension" >}}) +- [Bicep VSCode extension]({{< ref "installation#step-2-install-the-vs-code-extension" >}}) - [Radius environment]({{< ref "installation#step-3-initialize-the-radius-control-plane-and-the-radius-environment" >}}) ## Step 1: Add a Secret Store diff --git a/docs/content/guides/author-apps/secrets/howto-new-secretstore/snippets/secretstore.bicep b/docs/content/guides/author-apps/secrets/howto-new-secretstore/snippets/secretstore.bicep index 274580b63..1487310a3 100644 --- a/docs/content/guides/author-apps/secrets/howto-new-secretstore/snippets/secretstore.bicep +++ b/docs/content/guides/author-apps/secrets/howto-new-secretstore/snippets/secretstore.bicep @@ -1,4 +1,4 @@ -import radius as radius +extension radius @description('The app ID of your Radius Application. Set automatically by the rad CLI.') param application string diff --git a/docs/content/guides/author-apps/secrets/overview/snippets/secretstore.bicep b/docs/content/guides/author-apps/secrets/overview/snippets/secretstore.bicep index 728b04cf1..933c7c77f 100644 --- a/docs/content/guides/author-apps/secrets/overview/snippets/secretstore.bicep +++ b/docs/content/guides/author-apps/secrets/overview/snippets/secretstore.bicep @@ -1,4 +1,4 @@ -import radius as radius +extension radius @description('The ID of your Radius Environment. Injected automatically by the rad CLI.') param environment string diff --git a/docs/content/guides/deploy-apps/environments/howto-environment/index.md b/docs/content/guides/deploy-apps/environments/howto-environment/index.md index 9c5dcbf98..361eb92ef 100644 --- a/docs/content/guides/deploy-apps/environments/howto-environment/index.md +++ b/docs/content/guides/deploy-apps/environments/howto-environment/index.md @@ -16,7 +16,7 @@ Radius Environments can be setup with the rad CLI via two paths: interactive or - [Setup a supported Kubernetes cluster]({{< ref "/guides/operations/kubernetes/overview#supported-clusters" >}}) - [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]({{< ref "installation#step-2-install-the-vs-code-extension" >}}) ## Create a development environment @@ -25,7 +25,7 @@ Radius Environments can be setup with the rad CLI via two paths: interactive or rad init ``` - Select `Yes` to setup the app.bicep in the current directory + Select `Yes` to setup the application in the current directory. This will create `app.bicep` and [`bicepconfig.json`]({{< ref "/guides/tooling/bicepconfig/overview" >}}) files ``` Initializing Radius... diff --git a/docs/content/guides/deploy-apps/environments/overview/snippets/environment.bicep b/docs/content/guides/deploy-apps/environments/overview/snippets/environment.bicep index 5f0c9ce4b..489bd361c 100644 --- a/docs/content/guides/deploy-apps/environments/overview/snippets/environment.bicep +++ b/docs/content/guides/deploy-apps/environments/overview/snippets/environment.bicep @@ -1,4 +1,4 @@ -import radius as rad +extension radius //ENV resource environment 'Applications.Core/environments@2023-10-01-preview' = { diff --git a/docs/content/guides/deploy-apps/howto-deploy/howto-deploy-cicd/index.md b/docs/content/guides/deploy-apps/howto-deploy/howto-deploy-cicd/index.md index a4f032565..76a3f3440 100644 --- a/docs/content/guides/deploy-apps/howto-deploy/howto-deploy-cicd/index.md +++ b/docs/content/guides/deploy-apps/howto-deploy/howto-deploy-cicd/index.md @@ -28,6 +28,22 @@ Make sure you have the following files checked into your repository under `iac/` {{< rad file="snippets/app.bicep" embed="true" >}} +### [`bicepconfig.json`]({{< ref "/guides/tooling/bicepconfig/overview" >}}) + +```json +{ + "experimentalFeaturesEnabled": { + "extensibility": true, + "extensionRegistry": true, + "dynamicTypeLoading": true + }, + "extensions": { + "radius": "br:biceptypes.azurecr.io/radius:", + "aws": "br:biceptypes.azurecr.io/aws:" + } +} +``` + ## Step 2: Create your workflow file Create a new file named `deploy-radius.yml` under `.github/workflows/` and paste the following: diff --git a/docs/content/guides/deploy-apps/howto-deploy/howto-deploy-cicd/snippets/app.bicep b/docs/content/guides/deploy-apps/howto-deploy/howto-deploy-cicd/snippets/app.bicep index 145ebd9a4..f470df55e 100644 --- a/docs/content/guides/deploy-apps/howto-deploy/howto-deploy-cicd/snippets/app.bicep +++ b/docs/content/guides/deploy-apps/howto-deploy/howto-deploy-cicd/snippets/app.bicep @@ -1,4 +1,4 @@ -import radius as rad +extension radius param environment string diff --git a/docs/content/guides/deploy-apps/howto-deploy/howto-deploy-cicd/snippets/env.bicep b/docs/content/guides/deploy-apps/howto-deploy/howto-deploy-cicd/snippets/env.bicep index 20e71840e..bdd8cea61 100644 --- a/docs/content/guides/deploy-apps/howto-deploy/howto-deploy-cicd/snippets/env.bicep +++ b/docs/content/guides/deploy-apps/howto-deploy/howto-deploy-cicd/snippets/env.bicep @@ -1,4 +1,4 @@ -import radius as rad +extension radius resource environment 'Applications.Core/environments@2023-10-01-preview' = { name: 'myenv' diff --git a/docs/content/guides/operations/kubernetes/kubernetes-metadata/snippets/env.bicep b/docs/content/guides/operations/kubernetes/kubernetes-metadata/snippets/env.bicep index 06fc79a92..9795c81ea 100644 --- a/docs/content/guides/operations/kubernetes/kubernetes-metadata/snippets/env.bicep +++ b/docs/content/guides/operations/kubernetes/kubernetes-metadata/snippets/env.bicep @@ -1,4 +1,4 @@ -import radius as radius +extension radius //ENV resource env 'Applications.Core/environments@2023-10-01-preview' = { diff --git a/docs/content/guides/operations/kubernetes/kubernetes-upgrade/index.md b/docs/content/guides/operations/kubernetes/kubernetes-upgrade/index.md index dc942e341..b582d3be3 100644 --- a/docs/content/guides/operations/kubernetes/kubernetes-upgrade/index.md +++ b/docs/content/guides/operations/kubernetes/kubernetes-upgrade/index.md @@ -29,7 +29,7 @@ rad uninstall kubernetes {{< read file= "/shared-content/installation/rad-cli/install-rad-cli.md" >}} -## Step 4: Install the Radius-Bicep VS Code extension +## Step 4: Install the Bicep VS Code extension {{< read file= "/shared-content/installation/vscode-bicep/install-vscode-bicep.md" >}} diff --git a/docs/content/guides/recipes/howto-author-recipes/index.md b/docs/content/guides/recipes/howto-author-recipes/index.md index c6eb30ddc..fe918eb8d 100644 --- a/docs/content/guides/recipes/howto-author-recipes/index.md +++ b/docs/content/guides/recipes/howto-author-recipes/index.md @@ -13,7 +13,7 @@ tags: ["recipes"] Before you get started, you'll need to make sure you have the following tools and resources: - [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]({{< ref "installation#step-2-install-the-vs-code-extension" >}}) - [Radius environment]({{< ref "installation#step-3-initialize-radius" >}}) - [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) diff --git a/docs/content/guides/recipes/howto-author-recipes/snippets/environment.bicep b/docs/content/guides/recipes/howto-author-recipes/snippets/environment.bicep index 8413972d3..0661b9686 100644 --- a/docs/content/guides/recipes/howto-author-recipes/snippets/environment.bicep +++ b/docs/content/guides/recipes/howto-author-recipes/snippets/environment.bicep @@ -1,4 +1,4 @@ -import radius as radius +extension radius resource env 'Applications.Core/environments@2023-10-01-preview' = { name: 'prod' diff --git a/docs/content/guides/recipes/howto-author-recipes/snippets/redis-kubernetes.bicep b/docs/content/guides/recipes/howto-author-recipes/snippets/redis-kubernetes.bicep index b8d1d2469..5280bb153 100644 --- a/docs/content/guides/recipes/howto-author-recipes/snippets/redis-kubernetes.bicep +++ b/docs/content/guides/recipes/howto-author-recipes/snippets/redis-kubernetes.bicep @@ -8,7 +8,7 @@ param port int = 6379 param context object // Import Kubernetes resources into Bicep -import kubernetes as kubernetes { +extension kubernetes with { kubeConfig: '' namespace: context.runtime.kubernetes.namespace } diff --git a/docs/content/guides/recipes/howto-author-recipes/snippets/redis.bicep b/docs/content/guides/recipes/howto-author-recipes/snippets/redis.bicep index 389e33c9f..ccbfc08bb 100644 --- a/docs/content/guides/recipes/howto-author-recipes/snippets/redis.bicep +++ b/docs/content/guides/recipes/howto-author-recipes/snippets/redis.bicep @@ -1,4 +1,4 @@ -import radius as rad +extension radius param environment string diff --git a/docs/content/guides/recipes/howto-dev-recipes/index.md b/docs/content/guides/recipes/howto-dev-recipes/index.md index 69714be45..50217dd6e 100644 --- a/docs/content/guides/recipes/howto-dev-recipes/index.md +++ b/docs/content/guides/recipes/howto-dev-recipes/index.md @@ -13,7 +13,7 @@ Local development environments created by the rad init command include a set of ## 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]({{< ref "installation#step-2-install-the-vs-code-extension" >}}) - [Setup a supported Kubernetes cluster]({{< ref "/guides/operations/kubernetes/overview#supported-clusters" >}}) ## Step 1: Initialize a Radius environment @@ -55,7 +55,13 @@ Local development environments created by the rad init command include a set of When a Recipe is named "default" it will be used automatically when a resource doesn't specify a Recipe name. This makes it easy for applications to fully defer to the Environment for how to manage infrastructure. -## Step 2: Define your application +## Step 2: Create a `bicepconfig.json` in your application's directory + +{{< read file= "/shared-content/installation/bicepconfig/manual.md" >}} + +More information on how to setup a `bicepconfig.json` can be found [here]({{< ref "/guides/tooling/bicepconfig/overview" >}}) + +## Step 3: Define your application Create a file named `app.bicep` with the following set of resources: @@ -63,7 +69,7 @@ Create a file named `app.bicep` with the following set of resources: Note that no Recipe name is specified within 'db', so it will be using the default Recipe for Redis in your environment. -## Step 3: Deploy your application +## Step 4: Deploy your application 1. Run [`rad run`]({{< ref rad_run >}}) to deploy your application: @@ -93,7 +99,7 @@ Note that no Recipe name is specified within 'db', so it will be using the defau Your application is now deployed and running in your Kubernetes cluster. -## Step 4: Verify Redis containers are deployed +## Step 5: Verify Redis containers are deployed 1. Visit [`http://localhost:3000`](http://localhost:3000) in your browser. diff --git a/docs/content/guides/recipes/howto-dev-recipes/snippets/app.bicep b/docs/content/guides/recipes/howto-dev-recipes/snippets/app.bicep index 9cc09ef03..0951be2a1 100644 --- a/docs/content/guides/recipes/howto-dev-recipes/snippets/app.bicep +++ b/docs/content/guides/recipes/howto-dev-recipes/snippets/app.bicep @@ -1,4 +1,4 @@ -import radius as radius +extension radius @description('The ID of your Radius environment. Automatically injected by the rad CLI.') param environment string diff --git a/docs/content/guides/recipes/overview/snippets/recipe-link-example.bicep b/docs/content/guides/recipes/overview/snippets/recipe-link-example.bicep index e776370c6..476da4775 100644 --- a/docs/content/guides/recipes/overview/snippets/recipe-link-example.bicep +++ b/docs/content/guides/recipes/overview/snippets/recipe-link-example.bicep @@ -1,4 +1,4 @@ -import radius as rad +extension radius param environment string param application string diff --git a/docs/content/guides/recipes/terraform/howto-custom-provider/snippets/env-complete.bicep b/docs/content/guides/recipes/terraform/howto-custom-provider/snippets/env-complete.bicep index 5d163c92c..8e49cb3af 100644 --- a/docs/content/guides/recipes/terraform/howto-custom-provider/snippets/env-complete.bicep +++ b/docs/content/guides/recipes/terraform/howto-custom-provider/snippets/env-complete.bicep @@ -1,5 +1,5 @@ //SECRETSTORE -import radius as radius +extension radius @description('username for postgres db') @secure() diff --git a/docs/content/guides/recipes/terraform/howto-custom-provider/snippets/env.bicep b/docs/content/guides/recipes/terraform/howto-custom-provider/snippets/env.bicep index baa2814bd..b238d6d5a 100644 --- a/docs/content/guides/recipes/terraform/howto-custom-provider/snippets/env.bicep +++ b/docs/content/guides/recipes/terraform/howto-custom-provider/snippets/env.bicep @@ -1,5 +1,5 @@ //SECRETSTORE -import radius as radius +extension radius @description('username for PostgreSQL db') @secure() diff --git a/docs/content/guides/recipes/terraform/howto-private-registry/index.md b/docs/content/guides/recipes/terraform/howto-private-registry/index.md index 6a37c3a21..3bc857c6b 100644 --- a/docs/content/guides/recipes/terraform/howto-private-registry/index.md +++ b/docs/content/guides/recipes/terraform/howto-private-registry/index.md @@ -18,7 +18,7 @@ This how-to guide will describe how to: Before you get started, you'll need to make sure you have the following tools and resources: - [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]({{< ref "installation#step-2-install-the-vs-code-extension" >}}) - [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) - [Radius initialized with `rad init`]({{< ref howto-environment >}}) diff --git a/docs/content/guides/recipes/terraform/howto-private-registry/snippets/env-complete.bicep b/docs/content/guides/recipes/terraform/howto-private-registry/snippets/env-complete.bicep index 49f7822a0..a6b70b803 100644 --- a/docs/content/guides/recipes/terraform/howto-private-registry/snippets/env-complete.bicep +++ b/docs/content/guides/recipes/terraform/howto-private-registry/snippets/env-complete.bicep @@ -1,5 +1,5 @@ //SECRETSTORE -import radius as radius +extension radius @description('Required value, refers to the personal access token or password of the git platform') @secure() diff --git a/docs/content/guides/recipes/terraform/howto-private-registry/snippets/env.bicep b/docs/content/guides/recipes/terraform/howto-private-registry/snippets/env.bicep index 78fa42ebe..e0217cdd6 100644 --- a/docs/content/guides/recipes/terraform/howto-private-registry/snippets/env.bicep +++ b/docs/content/guides/recipes/terraform/howto-private-registry/snippets/env.bicep @@ -1,5 +1,5 @@ //SECRETSTORE -import radius as radius +extension radius @description('Required value, refers to the personal access token or password of the git platform') @secure() diff --git a/docs/content/guides/tooling/bicepconfig/_index.md b/docs/content/guides/tooling/bicepconfig/_index.md new file mode 100644 index 000000000..70644d6e3 --- /dev/null +++ b/docs/content/guides/tooling/bicepconfig/_index.md @@ -0,0 +1,7 @@ +--- +type: docs +title: "Bicep configuration file" +linkTitle: "Bicep config" +description: "Documentation on the Bicep configuration file" +weight: 300 +--- \ No newline at end of file diff --git a/docs/content/guides/tooling/bicepconfig/overview/index.md b/docs/content/guides/tooling/bicepconfig/overview/index.md new file mode 100644 index 000000000..5a90ceacc --- /dev/null +++ b/docs/content/guides/tooling/bicepconfig/overview/index.md @@ -0,0 +1,36 @@ +--- +type: docs +title: "Overview: Bicep configuration" +linkTitle: "Overview" +description: "Setup the Bicep configuration file to author and deploy Radius-types" +weight: 100 +categories: "Overview" +tags: ["Bicep"] +--- + +To use the features provided by the official Bicep compiler with Radius, certain configurations need to be defined. These are defined in a `bicepconfig.json` file that lives in your application's directory. + +## What is a `bicepconfig.json`? + +The `bicepconfig.json` allows the Bicep compiler to consume and use Radius-types stored in an OCI registry. There are two extensions that are enabled by default in the `bicepconfig.json` so that you can use Radius and AWS resources. The "radius" extension contains the schema information for all Radius-maintained resources, and the "aws" extension contains the schema information for AWS resources. You can optionally add any other settings that are relevant to your application. There are two ways to generate a `bicepconfig.json` with Radius. + +## Automatically generate a `bicepconfig.json` via `rad init` + +{{< read file= "/shared-content/installation/bicepconfig/rad-init.md" >}} + +## Manually create a `bicepconfig.json` + +{{< read file= "/shared-content/installation/bicepconfig/manual.md" >}} + +## Author and deploy Radius-types + +{{< alert title="Replace import statements with extension" color="warning" >}} Radius is now merged with the official Bicep. If you have bicep files with the following import statements, please replace them as needed. + + 1. `import radius as radius` should become `extension radius` to use Radius types + 1. `import aws as aws` should become `extension aws` to use AWS types + 1. `import kubernetes as kubernetes {}` should become `extension kubernetes with {} as kubernetes` to use Kubernetes types +{{< /alert >}} + +Once you have a `bicepconfig.json` file in your application's directory, you can author and deploy Radius-types. + +{{< rad file="snippets/app.bicep" embed=true >}} \ No newline at end of file diff --git a/docs/content/guides/tooling/bicepconfig/overview/snippets/app.bicep b/docs/content/guides/tooling/bicepconfig/overview/snippets/app.bicep new file mode 100644 index 000000000..d6623dbf5 --- /dev/null +++ b/docs/content/guides/tooling/bicepconfig/overview/snippets/app.bicep @@ -0,0 +1,11 @@ +extension radius + +@description('The environment ID of your Radius Application. Set automatically by the rad CLI.') +param environment string + +resource myapp 'Applications.Core/applications@2023-10-01-preview' = { + name: 'my-application' + properties: { + environment: environment + } +} diff --git a/docs/content/guides/tooling/dashboard/_index.md b/docs/content/guides/tooling/dashboard/_index.md index a9e78650d..699794ba9 100644 --- a/docs/content/guides/tooling/dashboard/_index.md +++ b/docs/content/guides/tooling/dashboard/_index.md @@ -3,5 +3,5 @@ type: docs title: "Radius dashboard" linkTitle: "Dashboard" description: "Documentation on the Radius dashboard" -weight: 100 +weight: 400 --- diff --git a/docs/content/guides/tooling/rad-cli/overview/index.md b/docs/content/guides/tooling/rad-cli/overview/index.md index e3b52efab..ff3fad377 100644 --- a/docs/content/guides/tooling/rad-cli/overview/index.md +++ b/docs/content/guides/tooling/rad-cli/overview/index.md @@ -92,7 +92,7 @@ For more information, refer to the [`config.yaml` reference documentation]({{< r ### `rad-bicep` compiler -The rad CLI uses the rad-bicep compiler to compile Bicep files to JSON templates. The rad-bicep compiler is stored as `/bin/rad-bicep` within your configuration directory. +The rad CLI uses the Bicep compiler to compile Bicep files to JSON templates. The Bicep compiler is stored as `/bin/rad-bicep` within your configuration directory. ## Reference documentation diff --git a/docs/content/guides/tooling/vscode/howto-vscode-bicep/index.md b/docs/content/guides/tooling/vscode/howto-vscode-bicep/index.md index 448ce5d12..d42344343 100644 --- a/docs/content/guides/tooling/vscode/howto-vscode-bicep/index.md +++ b/docs/content/guides/tooling/vscode/howto-vscode-bicep/index.md @@ -1,7 +1,7 @@ --- type: docs -title: "How-To: Install the Radius-Bicep VSCode extension" -linkTitle: "Radius Bicep Extension" +title: "How-To: Install the Bicep VSCode extension" +linkTitle: "Bicep Extension" description: "Learn how to use Radius in Visual Studio Code" weight: 200 categories: "How-To" diff --git a/docs/content/guides/tooling/vscode/howto-vscode-bicep/vsix-install.png b/docs/content/guides/tooling/vscode/howto-vscode-bicep/vsix-install.png deleted file mode 100644 index edd7e9102..000000000 Binary files a/docs/content/guides/tooling/vscode/howto-vscode-bicep/vsix-install.png and /dev/null differ diff --git a/docs/content/guides/tooling/vscode/howto-vscode-bicep/wsl-extension.png b/docs/content/guides/tooling/vscode/howto-vscode-bicep/wsl-extension.png deleted file mode 100644 index a8d9c136c..000000000 Binary files a/docs/content/guides/tooling/vscode/howto-vscode-bicep/wsl-extension.png and /dev/null differ diff --git a/docs/content/guides/tooling/vscode/overview/index.md b/docs/content/guides/tooling/vscode/overview/index.md index d30af41b8..f4f0e5f95 100644 --- a/docs/content/guides/tooling/vscode/overview/index.md +++ b/docs/content/guides/tooling/vscode/overview/index.md @@ -10,20 +10,18 @@ tags: ["VSCode"] When using Visual Studio Code with Radius there are a set of extensions you can install to help author, validate, and manage your Radius Applications and environments. -## Radius Bicep extension - -The Radius Bicep extension provides formatting, intellisense, and validation for Bicep templates. +{{< alert title="Disable the Radius Bicep extension" color="warning" >}} +Previously, Radius made use of the Radius Bicep extension, a temporary extension used to model Radius and AWS resource types. The Radius Bicep extension has been deprecated and we have upstreamed our extensibility updates to the official Bicep. If you have the Radius Bicep extension installed you will need to disable or uninstall it before installing the Bicep extension. +{{< /alert >}} -{{< image src="vscode-bicep.png" alt="Screenshot of the Radius Bicep extension showing available Radius resource types" width=600px >}} -

+## Bicep extension -{{< button text="Radius Bicep guide" page="howto-vscode-bicep" >}} +The Bicep extension provides formatting, intellisense, and validation for Bicep templates. -{{< alert title="Note" color="secondary" >}} -The Radius Bicep extension is a temporary extension that exists to model Radius and AWS resource types. Radius Bicep extension will be deprecated once we upstream our extensibility updates to the official Bicep. Stay tuned for updates. +{{< image src="vscode-bicep.png" alt="Screenshot of the Bicep extension showing available Radius resource types" width=600px >}} +

-**The Radius Bicep extension is not compatible with the official Bicep extension.** If you have the official Bicep extension installed you will need to disable or uninstall it before installing the Radius Bicep extension. -{{< /alert >}} +{{< button text="Bicep guide" page="howto-vscode-bicep" >}} ## Terraform extension diff --git a/docs/content/guides/tooling/vscode/overview/vscode-bicep.png b/docs/content/guides/tooling/vscode/overview/vscode-bicep.png index 679f6d416..0e4c60f84 100644 Binary files a/docs/content/guides/tooling/vscode/overview/vscode-bicep.png and b/docs/content/guides/tooling/vscode/overview/vscode-bicep.png differ diff --git a/docs/content/reference/limitations.md b/docs/content/reference/limitations.md index 9f470d7bc..15de00680 100644 --- a/docs/content/reference/limitations.md +++ b/docs/content/reference/limitations.md @@ -75,10 +75,10 @@ The Bicep deployment engine currently does not output Kubernetes resource (UCP) To fix this, you can manually build and output UCP IDs, which will cause the infrastructure to be linked to the resource: ```bicep -import kubernetes as k8s { +extension kubernetes with { kubeConfig: '' namespace: 'default' -} +} as k8s resource deployment 'apps/Deployment@v1' = {...} @@ -95,16 +95,6 @@ output values object = { ## Bicep & Deployment Engine -### Currently using a forked version of Bicep - -Radius is currently using a forked version of Bicep compiler to support Radius specific features. This is a point-in-time limitation that will be addressed in the future as the Radius team works with the Bicep team and the community to upstream the extensibility updates. This results in the following limitations: - -- The "Bicep" VS Code extension must be disabled in favor of the "Radius Bicep" extension -- The forked Bicep compiler will be out of date compared to the most recent Bicep public build -- `az bicep` and `bicep` are not supported with Radius. Use `rad deploy` instead. - -To use the forked build of Bicep directly, you can reference `~/.rad/bin/rad-bicep` (Linux/macOS) or `%HOMEPATH%\.rad\bin\rad-bicep.exe` (Windows). - ### `environment()` Bicep function collides with `param environment string` We currently use `param environment string` to pass in the Radius environmentId into your Bicep template. This collides with the Bicep `environment()` function. @@ -112,7 +102,7 @@ We currently use `param environment string` to pass in the Radius environmentId To access `environment()`, prefix it with `az.`. For example: ```bicep -import radius as rad +extension radius param environment string @@ -121,9 +111,9 @@ var stgSuffixes = az.environment().suffixes.storage This will be addressed in a future release when we change how the environmentId is passed into the file. -### Radius Bicep AWS limitations +### Bicep AWS limitations -Some of the [AWS resource types](/resource-schema/aws) are 'non-idempotent', this means that this resource type is assigned a primary identifier at deployment time and is currently not supported by Radius Bicep. +Some of the [AWS resource types](/resource-schema/aws) are 'non-idempotent', this means that this resource type is assigned a primary identifier at deployment time and is currently not supported by Bicep. We are currently building support for non-idempotent resources in Radius. Please like and comment on this [this issue](https://github.com/radius-project/radius/issues/6227) if you are interested in the same. diff --git a/docs/content/reference/resource-schema/cache/redis/snippets/redis-manual.bicep b/docs/content/reference/resource-schema/cache/redis/snippets/redis-manual.bicep index ace56121b..19b0e0c9f 100644 --- a/docs/content/reference/resource-schema/cache/redis/snippets/redis-manual.bicep +++ b/docs/content/reference/resource-schema/cache/redis/snippets/redis-manual.bicep @@ -1,4 +1,4 @@ -import radius as radius +extension radius @description('The ID of your Radius Environment. Automatically injected by the rad CLI.') param environment string diff --git a/docs/content/reference/resource-schema/cache/redis/snippets/redis-recipe.bicep b/docs/content/reference/resource-schema/cache/redis/snippets/redis-recipe.bicep index c41b30c84..e335f3840 100644 --- a/docs/content/reference/resource-schema/cache/redis/snippets/redis-recipe.bicep +++ b/docs/content/reference/resource-schema/cache/redis/snippets/redis-recipe.bicep @@ -1,4 +1,4 @@ -import radius as radius +extension radius @description('The ID of your Radius Environment. Automatically injected by the rad CLI.') param environment string diff --git a/docs/content/reference/resource-schema/core-schema/application-schema/snippets/app.bicep b/docs/content/reference/resource-schema/core-schema/application-schema/snippets/app.bicep index 939ed03d5..f84259f50 100644 --- a/docs/content/reference/resource-schema/core-schema/application-schema/snippets/app.bicep +++ b/docs/content/reference/resource-schema/core-schema/application-schema/snippets/app.bicep @@ -1,4 +1,4 @@ -import radius as radius +extension radius param environment string diff --git a/docs/content/reference/resource-schema/core-schema/container-schema/snippets/container.bicep b/docs/content/reference/resource-schema/core-schema/container-schema/snippets/container.bicep index 291167f14..2ce1dfb56 100644 --- a/docs/content/reference/resource-schema/core-schema/container-schema/snippets/container.bicep +++ b/docs/content/reference/resource-schema/core-schema/container-schema/snippets/container.bicep @@ -1,4 +1,4 @@ -import radius as radius +extension radius param environment string @@ -24,7 +24,7 @@ resource frontend 'Applications.Core/containers@2023-10-01-preview' = { image: 'registry/container:tag' env:{ DEPLOYMENT_ENV: 'prod' - DB_CONNECTION: db.connectionString() + DB_CONNECTION: db.listSecrets().connectionString } ports: { http: { diff --git a/docs/content/reference/resource-schema/core-schema/environment-schema/snippets/environment.bicep b/docs/content/reference/resource-schema/core-schema/environment-schema/snippets/environment.bicep index 8beb4ed1a..3ce9bed42 100644 --- a/docs/content/reference/resource-schema/core-schema/environment-schema/snippets/environment.bicep +++ b/docs/content/reference/resource-schema/core-schema/environment-schema/snippets/environment.bicep @@ -1,4 +1,4 @@ -import radius as rad +extension radius param oidcIssuer string diff --git a/docs/content/reference/resource-schema/core-schema/extender/snippets/extender-manual.bicep b/docs/content/reference/resource-schema/core-schema/extender/snippets/extender-manual.bicep index 9a3c03b78..7bd90a8be 100644 --- a/docs/content/reference/resource-schema/core-schema/extender/snippets/extender-manual.bicep +++ b/docs/content/reference/resource-schema/core-schema/extender/snippets/extender-manual.bicep @@ -1,4 +1,4 @@ -import radius as radius +extension radius param environment string @@ -33,8 +33,8 @@ resource publisher 'Applications.Core/containers@2023-10-01-preview' = { image: 'ghcr.io/radius-project/magpiego:latest' env: { TWILIO_NUMBER: twilio.properties.fromNumber - TWILIO_SID: twilio.secrets('accountSid') - TWILIO_ACCOUNT: twilio.secrets('authToken') + TWILIO_SID: twilio.listSecrets().accountSid + TWILIO_ACCOUNT: twilio.listSecrets().authToken } } } diff --git a/docs/content/reference/resource-schema/core-schema/extender/snippets/extender-recipe.bicep b/docs/content/reference/resource-schema/core-schema/extender/snippets/extender-recipe.bicep index 8b436cbe9..e5c7bac07 100644 --- a/docs/content/reference/resource-schema/core-schema/extender/snippets/extender-recipe.bicep +++ b/docs/content/reference/resource-schema/core-schema/extender/snippets/extender-recipe.bicep @@ -1,4 +1,4 @@ -import radius as radius +extension radius param application string param environment string @@ -24,8 +24,8 @@ resource publisher 'Applications.Core/containers@2023-10-01-preview' = { image: 'ghcr.io/radius-project/magpiego:latest' env: { TWILIO_NUMBER: twilio.properties.fromNumber - TWILIO_SID: twilio.secrets('accountSid') - TWILIO_ACCOUNT: twilio.secrets('authToken') + TWILIO_SID: twilio.listSecrets().accountSid + TWILIO_ACCOUNT: twilio.listSecrets().authToken } } } diff --git a/docs/content/reference/resource-schema/core-schema/gateway/snippets/gateway.bicep b/docs/content/reference/resource-schema/core-schema/gateway/snippets/gateway.bicep index 063e0cab5..b6776f703 100644 --- a/docs/content/reference/resource-schema/core-schema/gateway/snippets/gateway.bicep +++ b/docs/content/reference/resource-schema/core-schema/gateway/snippets/gateway.bicep @@ -1,4 +1,4 @@ -import radius as radius +extension radius param environment string diff --git a/docs/content/reference/resource-schema/core-schema/secretstore/snippets/secretstore.bicep b/docs/content/reference/resource-schema/core-schema/secretstore/snippets/secretstore.bicep index 07d51231f..d9a9511ad 100644 --- a/docs/content/reference/resource-schema/core-schema/secretstore/snippets/secretstore.bicep +++ b/docs/content/reference/resource-schema/core-schema/secretstore/snippets/secretstore.bicep @@ -1,4 +1,4 @@ -import radius as radius +extension radius @description('Specifies the location for resources.') param location string = 'global' diff --git a/docs/content/reference/resource-schema/core-schema/volumes/volume-azure-keyvault/snippets/volume-keyvault.bicep b/docs/content/reference/resource-schema/core-schema/volumes/volume-azure-keyvault/snippets/volume-keyvault.bicep index 9618054c6..fc3552f64 100644 --- a/docs/content/reference/resource-schema/core-schema/volumes/volume-azure-keyvault/snippets/volume-keyvault.bicep +++ b/docs/content/reference/resource-schema/core-schema/volumes/volume-azure-keyvault/snippets/volume-keyvault.bicep @@ -1,4 +1,4 @@ -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 @@ -47,7 +47,7 @@ resource volume 'Applications.Core/volumes@2023-10-01-preview' = { version: '1' // optional, defaults to latest version alias: 'certificatealias' // optional, defaults to certificate name (mycertificate) encoding: 'base64' // optional, defaults to utf-8, only available when value is privatekey - value: 'privatekey' // required + certType: 'privatekey' // required format: 'pem' // optional, defaults to pfx } } diff --git a/docs/content/reference/resource-schema/dapr-schema/dapr-extension/snippets/dapr.bicep b/docs/content/reference/resource-schema/dapr-schema/dapr-extension/snippets/dapr.bicep index ee9035afa..203bc4146 100644 --- a/docs/content/reference/resource-schema/dapr-schema/dapr-extension/snippets/dapr.bicep +++ b/docs/content/reference/resource-schema/dapr-schema/dapr-extension/snippets/dapr.bicep @@ -1,4 +1,4 @@ -import radius as radius +extension radius @description('The ID of your Radius Environment. Automatically injected by the rad CLI.') param environment string diff --git a/docs/content/reference/resource-schema/dapr-schema/dapr-pubsub/snippets/dapr-pubsub-manual.bicep b/docs/content/reference/resource-schema/dapr-schema/dapr-pubsub/snippets/dapr-pubsub-manual.bicep index 203d26d5a..620f011d4 100644 --- a/docs/content/reference/resource-schema/dapr-schema/dapr-pubsub/snippets/dapr-pubsub-manual.bicep +++ b/docs/content/reference/resource-schema/dapr-schema/dapr-pubsub/snippets/dapr-pubsub-manual.bicep @@ -1,4 +1,4 @@ -import radius as radius +extension radius @description('The ID of your Radius Environment. Automatically injected by the rad CLI.') param environment string diff --git a/docs/content/reference/resource-schema/dapr-schema/dapr-pubsub/snippets/dapr-pubsub-recipe.bicep b/docs/content/reference/resource-schema/dapr-schema/dapr-pubsub/snippets/dapr-pubsub-recipe.bicep index 0b7131a55..20571a9dc 100644 --- a/docs/content/reference/resource-schema/dapr-schema/dapr-pubsub/snippets/dapr-pubsub-recipe.bicep +++ b/docs/content/reference/resource-schema/dapr-schema/dapr-pubsub/snippets/dapr-pubsub-recipe.bicep @@ -1,4 +1,4 @@ -import radius as radius +extension radius @description('The ID of your Radius Environment. Automatically injected by the rad CLI.') param environment string diff --git a/docs/content/reference/resource-schema/dapr-schema/dapr-secretstore/snippets/dapr-secretstore-manual.bicep b/docs/content/reference/resource-schema/dapr-schema/dapr-secretstore/snippets/dapr-secretstore-manual.bicep index 9aeefc246..1786b4418 100644 --- a/docs/content/reference/resource-schema/dapr-schema/dapr-secretstore/snippets/dapr-secretstore-manual.bicep +++ b/docs/content/reference/resource-schema/dapr-schema/dapr-secretstore/snippets/dapr-secretstore-manual.bicep @@ -1,4 +1,4 @@ -import radius as radius +extension radius @description('The ID of your Radius Environment. Automatically injected by the rad CLI.') param environment string diff --git a/docs/content/reference/resource-schema/dapr-schema/dapr-secretstore/snippets/dapr-secretstore-recipe.bicep b/docs/content/reference/resource-schema/dapr-schema/dapr-secretstore/snippets/dapr-secretstore-recipe.bicep index 73168cca9..056cb17b5 100644 --- a/docs/content/reference/resource-schema/dapr-schema/dapr-secretstore/snippets/dapr-secretstore-recipe.bicep +++ b/docs/content/reference/resource-schema/dapr-schema/dapr-secretstore/snippets/dapr-secretstore-recipe.bicep @@ -1,4 +1,4 @@ -import radius as radius +extension radius @description('The ID of your Radius Environment. Automatically injected by the rad CLI.') param environment string diff --git a/docs/content/reference/resource-schema/dapr-schema/dapr-statestore/snippets/dapr-statestore-manual.bicep b/docs/content/reference/resource-schema/dapr-schema/dapr-statestore/snippets/dapr-statestore-manual.bicep index eab0d2522..4cb6ae0c6 100644 --- a/docs/content/reference/resource-schema/dapr-schema/dapr-statestore/snippets/dapr-statestore-manual.bicep +++ b/docs/content/reference/resource-schema/dapr-schema/dapr-statestore/snippets/dapr-statestore-manual.bicep @@ -1,4 +1,4 @@ -import radius as radius +extension radius @description('The app ID of your Radius Application. Set automatically by the rad CLI.') param application string diff --git a/docs/content/reference/resource-schema/dapr-schema/dapr-statestore/snippets/dapr-statestore-recipe.bicep b/docs/content/reference/resource-schema/dapr-schema/dapr-statestore/snippets/dapr-statestore-recipe.bicep index 7726cc1c6..0fee12a23 100644 --- a/docs/content/reference/resource-schema/dapr-schema/dapr-statestore/snippets/dapr-statestore-recipe.bicep +++ b/docs/content/reference/resource-schema/dapr-schema/dapr-statestore/snippets/dapr-statestore-recipe.bicep @@ -1,4 +1,4 @@ -import radius as radius +extension radius @description('The app ID of your Radius Application. Set automatically by the rad CLI.') param application string diff --git a/docs/content/reference/resource-schema/databases/microsoft-sql/snippets/sql-manual.bicep b/docs/content/reference/resource-schema/databases/microsoft-sql/snippets/sql-manual.bicep index e9e4ec3a4..60e2bd6c1 100644 --- a/docs/content/reference/resource-schema/databases/microsoft-sql/snippets/sql-manual.bicep +++ b/docs/content/reference/resource-schema/databases/microsoft-sql/snippets/sql-manual.bicep @@ -1,4 +1,4 @@ -import radius as radius +extension radius @description('The ID of your Radius Environment. Automatically injected by the rad CLI.') param environment string diff --git a/docs/content/reference/resource-schema/databases/microsoft-sql/snippets/sql-recipe.bicep b/docs/content/reference/resource-schema/databases/microsoft-sql/snippets/sql-recipe.bicep index d21031988..dba15e1a3 100644 --- a/docs/content/reference/resource-schema/databases/microsoft-sql/snippets/sql-recipe.bicep +++ b/docs/content/reference/resource-schema/databases/microsoft-sql/snippets/sql-recipe.bicep @@ -1,4 +1,4 @@ -import radius as radius +extension radius @description('The ID of your Radius Environment. Automatically injected by the rad CLI.') param environment string diff --git a/docs/content/reference/resource-schema/databases/mongodb/snippets/mongo-manual.bicep b/docs/content/reference/resource-schema/databases/mongodb/snippets/mongo-manual.bicep index 5aec98987..08e322dc9 100644 --- a/docs/content/reference/resource-schema/databases/mongodb/snippets/mongo-manual.bicep +++ b/docs/content/reference/resource-schema/databases/mongodb/snippets/mongo-manual.bicep @@ -1,4 +1,4 @@ -import radius as radius +extension radius @description('The ID of your Radius Environment. Automatically injected by the rad CLI.') param environment string diff --git a/docs/content/reference/resource-schema/databases/mongodb/snippets/mongo-recipe.bicep b/docs/content/reference/resource-schema/databases/mongodb/snippets/mongo-recipe.bicep index 0ac2b6129..cd09b6f8b 100644 --- a/docs/content/reference/resource-schema/databases/mongodb/snippets/mongo-recipe.bicep +++ b/docs/content/reference/resource-schema/databases/mongodb/snippets/mongo-recipe.bicep @@ -1,4 +1,4 @@ -import radius as radius +extension radius @description('The ID of your Radius Environment. Automatically injected by the rad CLI.') param environment string diff --git a/docs/content/reference/resource-schema/messaging/rabbitmq/snippets/rabbitmq-manual.bicep b/docs/content/reference/resource-schema/messaging/rabbitmq/snippets/rabbitmq-manual.bicep index 34047afaa..67cba9033 100644 --- a/docs/content/reference/resource-schema/messaging/rabbitmq/snippets/rabbitmq-manual.bicep +++ b/docs/content/reference/resource-schema/messaging/rabbitmq/snippets/rabbitmq-manual.bicep @@ -1,4 +1,4 @@ -import radius as radius +extension radius @description('The ID of your Radius Environment. Automatically injected by the rad CLI.') param environment string diff --git a/docs/content/reference/resource-schema/messaging/rabbitmq/snippets/rabbitmq-recipe.bicep b/docs/content/reference/resource-schema/messaging/rabbitmq/snippets/rabbitmq-recipe.bicep index 523469033..acc9bc39a 100644 --- a/docs/content/reference/resource-schema/messaging/rabbitmq/snippets/rabbitmq-recipe.bicep +++ b/docs/content/reference/resource-schema/messaging/rabbitmq/snippets/rabbitmq-recipe.bicep @@ -1,4 +1,4 @@ -import radius as radius +extension radius @description('The ID of your Radius Environment. Automatically injected by the rad CLI.') param environment string diff --git a/docs/content/tutorials/new-app/index.md b/docs/content/tutorials/new-app/index.md index 24e8920f1..1b16d1331 100644 --- a/docs/content/tutorials/new-app/index.md +++ b/docs/content/tutorials/new-app/index.md @@ -23,7 +23,7 @@ By the end of the tutorial, you will have created and deployed a new Radius Appl - [Supported Kubernetes cluster]({{< ref "/guides/operations/kubernetes/overview" >}}) - [rad CLI]({{< ref "installation#step-1-install-the-rad-cli" >}}) -- [Radius Bicep VSCode extension]({{< ref "installation#step-2-install-the-radius-bicep-vs-code-extension" >}}) +- [Bicep VSCode extension]({{< ref "installation#step-2-install-the-vs-code-extension" >}}) ## Step 1: Initialize a Radius Environment and Application @@ -42,7 +42,7 @@ By the end of the tutorial, you will have created and deployed a new Radius Appl rad init ``` - When asked if you want to create a new application select "Yes". This will create a new file named `app.bicep` in your directory where your application will be defined. + When asked if you want to create a new application select "Yes". This will create a new file named `app.bicep` in your directory where your application will be defined. It will also create a [`bicepconfig.json`]({{< ref "/guides/tooling/bicepconfig/overview" >}}) file that will contain the necessary setup to use Radius types with Bicep. {{< alert title="💡 Development Environments" color="info" >}} By default `rad init` gets you up and running with a local, development-focused environment where most of the environment configuration is handled for you, including Recipes (_more on that soon_). If you would like to fully customize your environment, you can run `rad init --full` diff --git a/docs/content/tutorials/new-app/snippets/1-app.bicep b/docs/content/tutorials/new-app/snippets/1-app.bicep index 4ea1ff698..0fd6cc3e2 100644 --- a/docs/content/tutorials/new-app/snippets/1-app.bicep +++ b/docs/content/tutorials/new-app/snippets/1-app.bicep @@ -1,5 +1,5 @@ // Import the set of Radius resources (Applications.*) into Bicep -import radius as radius +extension radius @description('The ID of your Radius Application. Set automatically by the rad CLI.') param application string diff --git a/docs/content/tutorials/new-app/snippets/2-app-mongo.bicep b/docs/content/tutorials/new-app/snippets/2-app-mongo.bicep index 141268a39..44924ab8d 100644 --- a/docs/content/tutorials/new-app/snippets/2-app-mongo.bicep +++ b/docs/content/tutorials/new-app/snippets/2-app-mongo.bicep @@ -1,5 +1,5 @@ // Import the set of Radius resources (Applications.*) into Bicep -import radius as radius +extension radius @description('The ID of your Radius Application. Set automatically by the rad CLI.') param application string diff --git a/docs/content/tutorials/new-app/snippets/3-app-backend.bicep b/docs/content/tutorials/new-app/snippets/3-app-backend.bicep index e3ad8d405..0e34c79d0 100644 --- a/docs/content/tutorials/new-app/snippets/3-app-backend.bicep +++ b/docs/content/tutorials/new-app/snippets/3-app-backend.bicep @@ -1,5 +1,5 @@ // Import the set of Radius resources (Applications.*) into Bicep -import radius as radius +extension radius @description('The ID of your Radius Application. Set automatically by the rad CLI.') param application string diff --git a/docs/content/tutorials/new-app/snippets/4-app-gateway.bicep b/docs/content/tutorials/new-app/snippets/4-app-gateway.bicep index 0d075265a..60443e24e 100644 --- a/docs/content/tutorials/new-app/snippets/4-app-gateway.bicep +++ b/docs/content/tutorials/new-app/snippets/4-app-gateway.bicep @@ -1,5 +1,5 @@ // Import the set of Radius resources (Applications.*) into Bicep -import radius as radius +extension radius @description('The ID of your Radius Application. Set automatically by the rad CLI.') param application string diff --git a/docs/content/tutorials/tutorial-dapr/index.md b/docs/content/tutorials/tutorial-dapr/index.md index 37962f7e5..abbad640d 100644 --- a/docs/content/tutorials/tutorial-dapr/index.md +++ b/docs/content/tutorials/tutorial-dapr/index.md @@ -19,7 +19,7 @@ For more details on the app and access to the source code, visit the `samples/da ## 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]({{< ref "installation#step-2-install-the-vs-code-extension" >}}) - [Radius environment]({{< ref "installation#step-3-initialize-radius" >}}) - [Setup a supported Kubernetes cluster](https://docs.radapp.io/guides/operations/kubernetes/overview/#supported-clusters) - [Dapr installed on your Kubernetes cluster](https://docs.dapr.io/operations/hosting/kubernetes/kubernetes-deploy/) diff --git a/docs/content/tutorials/tutorial-dapr/snippets/dapr.bicep b/docs/content/tutorials/tutorial-dapr/snippets/dapr.bicep index 3a0777c8b..ae0a8c95b 100644 --- a/docs/content/tutorials/tutorial-dapr/snippets/dapr.bicep +++ b/docs/content/tutorials/tutorial-dapr/snippets/dapr.bicep @@ -1,5 +1,5 @@ //BACKEND -import radius as radius +extension radius @description('Specifies the environment for resources.') param environment string diff --git a/docs/content/tutorials/tutorial-recipe/index.md b/docs/content/tutorials/tutorial-recipe/index.md index fe2deabd2..d25dd0cae 100644 --- a/docs/content/tutorials/tutorial-recipe/index.md +++ b/docs/content/tutorials/tutorial-recipe/index.md @@ -33,7 +33,7 @@ Developers don't need to specify what cloud resources they're using in their app ## 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]({{< ref "installation#step-2-install-the-vs-code-extension" >}}) - [Setup a supported Kubernetes cluster]({{< ref "/guides/operations/kubernetes/overview#supported-clusters" >}}) ## Step 1: Initialize a Radius Environment diff --git a/docs/content/tutorials/tutorial-recipe/snippets/app-aws.bicep b/docs/content/tutorials/tutorial-recipe/snippets/app-aws.bicep index f2df05dbf..c736cf647 100644 --- a/docs/content/tutorials/tutorial-recipe/snippets/app-aws.bicep +++ b/docs/content/tutorials/tutorial-recipe/snippets/app-aws.bicep @@ -1,4 +1,4 @@ -import radius as radius +extension radius @description('The ID of your Radius Environment. Automatically injected by the rad CLI.') param environment string diff --git a/docs/content/tutorials/tutorial-recipe/snippets/app-azure.bicep b/docs/content/tutorials/tutorial-recipe/snippets/app-azure.bicep index 5fa999d14..ecd318f50 100644 --- a/docs/content/tutorials/tutorial-recipe/snippets/app-azure.bicep +++ b/docs/content/tutorials/tutorial-recipe/snippets/app-azure.bicep @@ -1,4 +1,4 @@ -import radius as radius +extension radius @description('The ID of your Radius Environment. Automatically injected by the rad CLI.') param environment string diff --git a/docs/content/tutorials/tutorial-recipe/snippets/app.bicep b/docs/content/tutorials/tutorial-recipe/snippets/app.bicep index 7901b942c..24e53c743 100644 --- a/docs/content/tutorials/tutorial-recipe/snippets/app.bicep +++ b/docs/content/tutorials/tutorial-recipe/snippets/app.bicep @@ -1,4 +1,4 @@ -import radius as radius +extension radius @description('The ID of your Radius Environment. Automatically injected by the rad CLI.') param environment string diff --git a/docs/shared-content/installation/bicepconfig/manual.md b/docs/shared-content/installation/bicepconfig/manual.md new file mode 100644 index 000000000..df9c5c154 --- /dev/null +++ b/docs/shared-content/installation/bicepconfig/manual.md @@ -0,0 +1,15 @@ +1. Create a `bicepconfig.json` in your application's directory. `release-version` should correspond to the current release version in the form of `major.minor` (e.g. `0.36`). + +```json +{ + "experimentalFeaturesEnabled": { + "extensibility": true, + "extensionRegistry": true, + "dynamicTypeLoading": true + }, + "extensions": { + "radius": "br:biceptypes.azurecr.io/radius:", + "aws": "br:biceptypes.azurecr.io/aws:" + } +} +``` \ No newline at end of file diff --git a/docs/shared-content/installation/bicepconfig/rad-init.md b/docs/shared-content/installation/bicepconfig/rad-init.md new file mode 100644 index 000000000..e1ac3b39a --- /dev/null +++ b/docs/shared-content/installation/bicepconfig/rad-init.md @@ -0,0 +1,16 @@ +1. Install Radius CLI + +1. Create a new directory for your app and navigate into it: + + ```bash + mkdir first-app + cd first-app + ``` + +1. Initialize Radius. Select `Yes` when asked to setup application in the current directory. + + ```bash + rad init + ``` + +This will automatically generate a `bicepconfig.json` with the correct setup in your application's directory. \ No newline at end of file diff --git a/docs/shared-content/installation/install-radius/initialize-radius.md b/docs/shared-content/installation/install-radius/initialize-radius.md index 4f12ce4cf..ea9146d22 100644 --- a/docs/shared-content/installation/install-radius/initialize-radius.md +++ b/docs/shared-content/installation/install-radius/initialize-radius.md @@ -17,7 +17,7 @@ Initializing Radius installs the Radius control-plane and creates a Radius Envir rad init ``` - Select `Yes` to setup the app.bicep in the current directory + Select `Yes` to setup the application in the current directory. This will create `app.bicep` and [`bicepconfig.json`]({{< ref "/guides/tooling/bicepconfig/overview" >}}) files ``` Initializing Radius... diff --git a/docs/shared-content/installation/rad-cli/install-rad-cli.md b/docs/shared-content/installation/rad-cli/install-rad-cli.md index e4e7df894..5f3dfea9e 100644 --- a/docs/shared-content/installation/rad-cli/install-rad-cli.md +++ b/docs/shared-content/installation/rad-cli/install-rad-cli.md @@ -90,5 +90,5 @@ Verify the rad CLI is installed correctly by running `rad version`. Example output: ``` RELEASE VERSION BICEP COMMIT -{{< param chart_version >}} {{< param version >}} 0.11.13 2e60bfb46de73ec5cc70485d53e67f8eaa914ba7 +{{< param chart_version >}} {{< param version >}} 0.28.1 2e60bfb46de73ec5cc70485d53e67f8eaa914ba7 ``` \ No newline at end of file diff --git a/docs/shared-content/installation/vscode-bicep/images/radius-bicep.png b/docs/shared-content/installation/vscode-bicep/images/radius-bicep.png deleted file mode 100644 index 2e3776cf1..000000000 Binary files a/docs/shared-content/installation/vscode-bicep/images/radius-bicep.png and /dev/null differ diff --git a/docs/shared-content/installation/vscode-bicep/images/vsix-install.png b/docs/shared-content/installation/vscode-bicep/images/vsix-install.png deleted file mode 100644 index edd7e9102..000000000 Binary files a/docs/shared-content/installation/vscode-bicep/images/vsix-install.png and /dev/null differ diff --git a/docs/shared-content/installation/vscode-bicep/images/wsl-extension.png b/docs/shared-content/installation/vscode-bicep/images/wsl-extension.png deleted file mode 100644 index a8d9c136c..000000000 Binary files a/docs/shared-content/installation/vscode-bicep/images/wsl-extension.png and /dev/null differ diff --git a/docs/shared-content/installation/vscode-bicep/install-vscode-bicep.md b/docs/shared-content/installation/vscode-bicep/install-vscode-bicep.md index e5af7e5f0..b453c8e9b 100644 --- a/docs/shared-content/installation/vscode-bicep/install-vscode-bicep.md +++ b/docs/shared-content/installation/vscode-bicep/install-vscode-bicep.md @@ -1,33 +1,7 @@ -Visual Studio Code offers the best authoring experience for Radius and Bicep. Download and install the Radius Bicep extension to easily author and validate Bicep templates: +Visual Studio Code offers the best authoring experience for Radius and Bicep. Download and install the Bicep extension to easily author and validate Bicep templates: -{{< alert title="Disable the official Bicep extension" color="warning" >}} -You can only have one VSCode Bicep extension installed at a time. To build on Radius, you will need to uninstall the official Bicep and use only the Radius Bicep extension. +{{< alert title="Disable the Radius Bicep extension" color="warning" >}} +We previously released a version of the official Bicep extension specific to Radius called the Radius Bicep extension. We have since updated Radius to be compatible with the official Bicep extension. You can only have one VSCode Bicep extension installed at a time to build on Radius. If you have the Radius Bicep extension installed, you will need to uninstall it and use only the official Bicep extension. {{< /alert >}} -{{< latest >}} -1. To install the Radius Bicep extension, search for Radius Bicep in the Extensions tab in VSCode or in the [Visual Studio marketplace](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.rad-vscode-bicep&ssr=false#overview) - Screenshot of Radius Bicep extension in VSCode Marketplace

- -1. Select Install - -To verify you've installed the extension, open any file with the .bicep file extension and start [authoring Radius application]({{< ref author-apps >}}) to verify the auto-complete and other validation features. -{{< /latest >}} -{{< edge >}} -1. Visit the [GitHub Actions runs](https://github.com/radius-project/bicep/actions/workflows/radius-build.yml?query=event%3Apush+branch%3Abicep-extensibility) -1. Click on the latest successful run -1. Scroll down to Artifacts and download `release` -1. Extract the archive and Install the `rad-vscode-bicep.vsix` file: - In VSCode, manually install the extension using the *Install from VSIX* command in the Extensions view command drop-down. - - Screenshot of installing a vsix extension
- - You can also import this extension on the [command-line](https://code.visualstudio.com/docs/editor/extension-gallery#_install-from-a-vsix) with: - - ```bash - code --install-extension rad-vscode-bicep.vsix - ``` - If you're on macOS, make sure to [setup the `code` alias](https://code.visualstudio.com/docs/setup/mac#_launching-from-the-command-line). - -1. If running on Windows Subsystem for Linux (WSL), make sure to install the extension in WSL as well:
- Screenshot of installing a vsix extension in WSL -{{< /edge >}} +To install the Bicep extension, refer to their [installation documentation](https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/install#visual-studio-code-and-bicep-extension) \ No newline at end of file diff --git a/holding-pen/reference-apps/aws-rds/snippets/app.bicep b/holding-pen/reference-apps/aws-rds/snippets/app.bicep index c0dc30ef4..1fcfcee96 100644 --- a/holding-pen/reference-apps/aws-rds/snippets/app.bicep +++ b/holding-pen/reference-apps/aws-rds/snippets/app.bicep @@ -1,5 +1,5 @@ -import radius as radius -import aws as aws +extension radius +extension aws param environment string diff --git a/holding-pen/reference-apps/aws-sqs/snippets/app.bicep b/holding-pen/reference-apps/aws-sqs/snippets/app.bicep index 9b6bc7a8e..c25cf1aa8 100644 --- a/holding-pen/reference-apps/aws-sqs/snippets/app.bicep +++ b/holding-pen/reference-apps/aws-sqs/snippets/app.bicep @@ -1,5 +1,5 @@ -import aws as aws -import radius as radius +extension aws +extension radius param environment string param queue_name string