Radius

https://docs.radapp.io
Admin
Radius is a cloud-native application platform that enables developers and IT operators to build,...
Tokens:156,250
Snippets:2,242
Trust Score:7.5
Update:4 months ago
Show doc for...
Tokens:
Raw
### Tabs Shortcode Example

Source: https://docs.radapp.io/contributing/docs/contributing-docs

An example demonstrating how to use the `tabs` shortcode to create tabs for different operating systems (Windows, Linux, MacOS) with their respective installation commands.

```html
{{< tabs Windows Linux MacOS>}}

{{% codetab %}}
```powershell
powershell -Command "iwr -useb https://raw.githubusercontent.com/dapr/cli/master/install/install.ps1 | iex"
```
{{% /codetab %}}

{{% codetab %}}
```bash
wget -q https://raw.githubusercontent.com/dapr/cli/master/install/install.sh -O - | /bin/bash
```
{{% /codetab %}}

{{% codetab %}}
```bash
brew install dapr/tap/dapr-cli
```
{{% /codetab %}}

{{< /tabs >}}

```

--------------------------------

### rad install Help Options

Source: https://docs.radapp.io/reference/cli/rad_install

Displays the help options for the 'rad install' command.

```bash
rad install --help
```

--------------------------------

### Radius Configuration File Example

Source: https://docs.radapp.io/guides/operations/workspaces/overview

An example of the `config.yaml` file structure, defining multiple workspaces and their connections.

```yaml
workspaces:
  default: dev
  items:
    dev:
      connection:
        context: DevCluster
        kind: kubernetes
      environment: /planes/radius/local/resourcegroups/dev/providers/applications.core/environments/dev
      scope: /planes/radius/local/resourceGroups/dev
    prod:
      connection:
        context: ProdCluster
        kind: kubernetes
      environment: /planes/radius/local/resourcegroups/prod/providers/applications.core/environments/prod
      scope: /planes/radius/local/resourcegroups/prod
```

--------------------------------

### rad install Synopsis

Source: https://docs.radapp.io/reference/cli/rad_install

Shows the synopsis for the 'rad install' command, indicating its purpose to install Radius for a given platform.

```bash
rad install [platform]
```

--------------------------------

### Install Kibana

Source: https://docs.radapp.io/guides/operations/control-plane/logs/fluentd

Installs Kibana version 7.17.3 into the 'radius-monitoring' namespace using Helm.

```bash
helm install kibana elastic/kibana --version 7.17.3 -n radius-monitoring
```

--------------------------------

### Install Prometheus with Helm

Source: https://docs.radapp.io/guides/operations/control-plane/metrics/prometheus

Installs Prometheus using the Prometheus Community Helm chart. Ensure Helm repositories are updated before installation.

```bash
helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
helm repo update
helm install radius-prom prometheus-community/prometheus -n radius-monitoring
```

--------------------------------

### Example of switching environments

Source: https://docs.radapp.io/reference/cli/rad_environment_switch

Demonstrates how to switch to a specific environment named 'newEnvironment'.

```bash
rad env switch newEnvironment

```

--------------------------------

### Create Kind Cluster and Install Radius

Source: https://docs.radapp.io/guides/operations/kubernetes/overview

Create a Kind cluster using a custom configuration file and then install Radius with its control plane and environment.

```bash
# Create the kind cluster
kind create cluster --config kind-config.yaml

# Verify that the nodes are ready
# (You should see 2 nodes listed with status Ready)
kubectl get nodes

# Install Radius
rad install kubernetes --set rp.publicEndpointOverride=localhost:8080
rad init
```

--------------------------------

### Example Frontend Deployment with Radius Annotation

Source: https://docs.radapp.io/reference/samples/add-radius

This is an example of how the `deploy/frontend-deployment.yaml` file should look after adding the Radius annotation. This ensures Radius can manage the deployment.

```yaml
apiVersion: apps/v1 #  for k8s versions before 1.9.0 use apps/v1beta2  and before 1.8.0 use extensions/v1beta1
kind: Deployment
metadata:
   name: frontend
   annotations:
      radapp.io/enabled: 'true'
spec:
selector:
   matchLabels:
      app: guestbook
      tier: frontend
replicas: 3
template:
   metadata:
      labels:
      app: guestbook
      tier: frontend
   spec:
      containers:
      - name: php-redis
      image: ghcr.io/radius-project/samples/gb-frontend:v4
      resources:
         requests:
            cpu: 100m
            memory: 100Mi
      env:
      - name: GET_HOSTS_FROM
         value: dns
         # If your cluster config does not include a dns service, then to
         # instead access environment variables to find service host
         # info, comment out the 'value: dns' line above, and uncomment the
         # line below:
         # value: env
      ports:
      - containerPort: 80

```

--------------------------------

### Example Radius Pods Output

Source: https://docs.radapp.io/installation

This is an example of the expected output when verifying Radius pods are running.

```text
NAME                READY   STATUS    RESTARTS   AGE
applications-rp      1/1     Running   0          1m
bicep-de             1/1     Running   0          1m
controller           1/1     Running   0          1m
dashboard            1/1     Running   0          1m 
dynamic-rp           1/1     Running   0          1m
ucp                  1/1     Running   0          1m
```

--------------------------------

### Install npm Packages for Docs

Source: https://docs.radapp.io/contributing/docs/contributing-docs

Install the necessary Node.js packages for the documentation site. This command should be run from the 'docs' directory.

```bash
npm install

```

--------------------------------

### Start Local Hugo Server

Source: https://docs.radapp.io/contributing/docs/contributing-docs

Start a local Hugo server to preview the documentation site. Ensure you are in the 'docs' directory. Access the site via http://localhost:1313/.

```bash
hugo server

```

--------------------------------

### Install Radius CLI on Linux/WSL

Source: https://docs.radapp.io/guides/operations/kubernetes/kubernetes-upgrade

Installs the Radius CLI on Linux or WSL using wget.

```bash
wget -q "https://raw.githubusercontent.com/radius-project/radius/main/deploy/install.sh" -O - | /bin/bash
```

--------------------------------

### Install Grafana Helm Chart

Source: https://docs.radapp.io/guides/operations/control-plane/metrics/grafana

Installs the Grafana Helm chart in the 'radius-monitoring' namespace.

```bash
helm install grafana grafana/grafana -n radius-monitoring
```

--------------------------------

### Sample Radius Initialization Output

Source: https://docs.radapp.io/quick-start

This is an example of the output you can expect after running 'rad initialize'.

```text
Initializing Radius...

✅ Install Radius v0.59
    - Kubernetes cluster: k3d-k3s-default
    - Kubernetes namespace: radius-system
✅ Create new environment default
    - Kubernetes namespace: default
    - Recipe pack: local-dev
✅ Scaffold application todolist
✅ Update local configuration

Initialization complete! Have a RAD time 😎

```

--------------------------------

### Install Radius in a specified Kubernetes context

Source: https://docs.radapp.io/reference/cli/rad_install_kubernetes

Installs Radius with default settings in a specified Kubernetes context.

```bash
rad install kubernetes --kubecontext mycluster
```

--------------------------------

### Initialize Radius Installation

Source: https://docs.radapp.io/quick-start

Install Radius in your current directory. Ensure your Kubernetes cluster is set as the current context.

```bash
rad initialize
```

--------------------------------

### Install Radius on k3d

Source: https://docs.radapp.io/guides/operations/kubernetes/overview

Install the Radius control plane and initialize a new environment on a k3d cluster. This command overrides the default public endpoint.

```bash
rad install kubernetes --set rp.publicEndpointOverride=localhost:8081
rad init
```

--------------------------------

### Example: Show Production Resource Group

Source: https://docs.radapp.io/reference/cli/rad_group_show

An example demonstrating how to use the 'rad group show' command to view the details of a resource group named 'rgprod'.

```bash
rad group show rgprod
```

--------------------------------

### Install Radius CLI with Windows WinGet

Source: https://docs.radapp.io/guides/operations/kubernetes/kubernetes-upgrade

Installs the Radius CLI on Windows using the WinGet package manager.

```bash
winget install --exact --id Radius.Radius
```

--------------------------------

### Install Radius using a specified Helm chart file

Source: https://docs.radapp.io/reference/cli/rad_install_kubernetes

Installs Radius using a Helm chart located at a specified file path.

```bash
rad install kubernetes --chart /root/radius/deploy/Chart
```

--------------------------------

### Example Image Embedding

Source: https://docs.radapp.io/contributing/docs/contributing-docs

Example of embedding the 'radius-overview.png' image on the 'overview.md' page with specified width and alt text.

```go-html-template
{{< image src="radius-overview.png" width=1000 alt="Overview diagram of Dapr and its building blocks" >}}
```

--------------------------------

### Install Zsh Completion on Linux

Source: https://docs.radapp.io/reference/cli/rad_completion

Installs zsh completion on Linux systems. It shows how to load completion into the current shell and set it up for autoloading.

```zsh
source <(rad completion zsh)
rad completion zsh > "${fpath[1]}/_rad"
```

--------------------------------

### Install Bash Completion on Linux

Source: https://docs.radapp.io/reference/cli/rad_completion

Installs bash completion on Linux systems. It demonstrates loading completion into the current shell and setting it up to load from .bash_profile.

```bash
source <(rad completion bash)
rad completion bash > ~/.rad/completion.bash.inc
printf "
## rad shell completion
source '$HOME/.rad/completion.bash.inc'
" >> $HOME/.bash_profile
source $HOME/.bash_profile
```

--------------------------------

### rad install Inherited Options

Source: https://docs.radapp.io/reference/cli/rad_install

Lists inherited options for the 'rad install' command, including configuration file path and output format.

```bash
rad install --config "$HOME/.rad/config.yaml" --output "table"
```

--------------------------------

### Install Radius with custom registry and tag

Source: https://docs.radapp.io/reference/cli/rad_install_kubernetes

Installs Radius, specifying both a custom container registry and a specific image version tag. Images will be pulled using the combined registry and tag.

```bash
rad install kubernetes --set global.imageRegistry=myregistry.azurecr.io,global.imageTag=0.48
```

--------------------------------

### List All Resource Groups

Source: https://docs.radapp.io/guides/operations/groups/overview

This command lists all the resource groups currently configured in your Radius installation. It helps in getting an overview of existing groups.

```bash
rad group list
```

--------------------------------

### Create Application Directory

Source: https://docs.radapp.io/guides/recipes/howto-dev-recipes

Begin by creating a new directory for your application and navigating into it.

```bash
mkdir recipes
cd recipes
```

--------------------------------

### Install Radius with Customizations via rad CLI

Source: https://docs.radapp.io/guides/operations/kubernetes/install

Install Radius with tracing enabled and a public endpoint override using the `--set` flag for Helm configuration options.

```bash
rad install kubernetes --set global.zipkin.url=http://jaeger-collector.radius-monitoring.svc.cluster.local:9411/api/v2/spans,rp.publicEndpointOverride=localhost:8081
```

--------------------------------

### Dapr State Store Component YAML Output

Source: https://docs.radapp.io/guides/author-apps/dapr/how-to-dapr-secrets

This is an example of the output from 'kubectl get component ... -o yaml', showing the metadata for the Dapr state store. Note that 'redisUsername' is currently stored in plain text.

```yaml
apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
  name: demo-statestore
  namespace: default-demo-secret
spec:
  metadata:
  - name: redisHost
    value: <HOST>
  - name: redisUsername
    # The Redis username is stored in plain text
    value: default
  type: state.redis
  version: v1

```

--------------------------------

### Opt-out of Dashboard Installation

Source: https://docs.radapp.io/guides/tooling/dashboard/overview

Use this command to prevent the dashboard from being installed during Radius initialization or Kubernetes installation.

```bash
rad install kubernetes --reinstall --set dashboard.enabled=false
```

--------------------------------

### Create Application Directory

Source: https://docs.radapp.io/reference/samples/dapr

Begin by creating a new directory for your application.

```bash
mkdir dapr
cd dapr
```

--------------------------------

### Install Radius without Contour ingress controller

Source: https://docs.radapp.io/reference/cli/rad_install_kubernetes

Installs Radius, skipping the installation of the Contour ingress controller.

```bash
rad install kubernetes --skip-contour-install
```

--------------------------------

### Clone Samples Repository and Navigate

Source: https://docs.radapp.io/reference/samples/helm

Clone the Radius samples repository locally and then navigate into the demo application directory.

```bash
git clone https://github.com/radius-project/samples.git
cd ./samples/samples/demo
```

--------------------------------

### Install Radius with Helm

Source: https://docs.radapp.io/guides/operations/kubernetes/install

Install or upgrade the Radius Helm chart to the specified version, creating the namespace if it doesn't exist and waiting for the installation to complete.

```bash
helm upgrade radius radius/radius --install --create-namespace --namespace radius-system --version 0.59.0 --wait --timeout 15m0s
```

--------------------------------

### Install Radius with Azure Workload Identity Enabled

Source: https://docs.radapp.io/guides/operations/providers/azure-provider/howto-azure-provider-wi

Install Radius on your Kubernetes cluster with Azure Workload Identity enabled using `rad install kubernetes` and the appropriate Helm chart values.

```bash
rad install kubernetes --set global.azureWorkloadIdentity.enabled=true
```

--------------------------------

### Install Radius

Source: https://docs.radapp.io/guides/operations/groups/howto-resourcegroups

Ensure Radius is installed on your Kubernetes cluster before managing resource groups.

```bash
rad install kubernetes
```

--------------------------------

### Example: Switch to a Specific Resource Group in a Workspace

Source: https://docs.radapp.io/reference/cli/rad_group_switch

Demonstrates how to switch the default resource group to 'rgprod' within the 'wsprod' workspace.

```bash
rad group switch rgprod -w wsprod
```

--------------------------------

### Create and Navigate to App Directory

Source: https://docs.radapp.io/guides/tooling/bicepconfig/overview

This snippet shows the commands to create a new directory for your application and navigate into it.

```bash
mkdir first-app
cd first-app
```

--------------------------------

### Navigate to Demo Directory

Source: https://docs.radapp.io/reference/samples/helm

Use this command to change your current directory to the demo application folder within the cloned samples repository.

```bash
cd ./samples/demo
```

--------------------------------

### Set Custom Installation Directory for rad CLI

Source: https://docs.radapp.io/guides/tooling/rad-cli/overview

Specifies a custom directory for installing the rad CLI binary using the RADIUS_INSTALL_DIR environment variable. Useful for installing to non-standard locations like the home directory.

```bash
# Install to home directory
export RADIUS_INSTALL_DIR=~/

```

--------------------------------

### Register a recipe with a single parameter

Source: https://docs.radapp.io/reference/cli/rad_recipe_register

This example shows how to register a recipe while specifying a single parameter, 'throughput', directly on the command line.

```bash
rad recipe register cosmosdb -e env_name -w workspace --template-kind bicep --template-path template_path --resource-type Applications.Datastores/mongoDatabases --parameters throughput=400
```

--------------------------------

### Install Radius CLI on Windows PowerShell

Source: https://docs.radapp.io/guides/operations/kubernetes/kubernetes-upgrade

Installs the Radius CLI on Windows using PowerShell.

```powershell
iwr -useb "https://raw.githubusercontent.com/radius-project/radius/main/deploy/install.ps1" | iex
```

--------------------------------

### Initialize Radius

Source: https://docs.radapp.io/guides/author-apps/containers/volume-keyvault

Begin by initializing Radius. Ensure you configure an Azure cloud provider during this process.

```bash
rad init --full

```

--------------------------------

### Register a recipe with basic details

Source: https://docs.radapp.io/reference/cli/rad_recipe_register

This command registers a recipe named 'cosmosdb' to a specified environment and workspace, providing template details and resource type.

```bash
rad recipe register cosmosdb -e env_name -w workspace --template-kind bicep --template-path template_path --resource-type Applications.Datastores/mongoDatabases
```

--------------------------------

### Create a resource from a file

Source: https://docs.radapp.io/reference/cli/rad_resource_create

Use this command to create a resource by specifying its type, name, and the path to an input file containing resource details.

```bash
rad resource create 'Applications.Core/containers' mycontainer -f /path/to/input.json
```

--------------------------------

### Install Radius with a specific version tag

Source: https://docs.radapp.io/reference/cli/rad_install_kubernetes

Installs Radius, setting a specific version tag for all its components.

```bash
rad install kubernetes --set global.imageTag=0.48
```

--------------------------------

### GitHub Actions Workflow Setup (deploy-radius.yml)

Source: https://docs.radapp.io/guides/deploy-apps/howto-deploy/howto-deploy-cicd

Initializes a GitHub Actions workflow to deploy a Radius application. Includes checking out the repository and setting up kubectl.

```yaml
name: Deploy Radius app
on:
  push:
    branches:
      - main
env:
  RADIUS_INSTALL_DIR: ./

jobs:
  deploy:
    name: Deploy app
    runs-on: ubuntu-latest
    steps:
    - name: Check out repo
      uses: actions/checkout@v4
    - name: Setup kubectl
      uses: azure/setup-kubectl@v1
```

--------------------------------

### Install Radius CLI on Linux/WSL with Curl

Source: https://docs.radapp.io/guides/operations/kubernetes/kubernetes-upgrade

Installs the Radius CLI on Linux or WSL using curl.

```bash
curl -fsSL "https://raw.githubusercontent.com/radius-project/radius/main/deploy/install.sh" | /bin/bash
```

--------------------------------

### List Resources by Type

Source: https://docs.radapp.io/reference/cli/rad_resource_list

Lists all resources of a specified type in the default environment. Use this command to view all resources of a particular kind, such as containers or gateways.

```bash
rad resource list Applications.Core/containers
rad resource list Applications.Core/gateways
```

--------------------------------

### Create Kubernetes Namespace

Source: https://docs.radapp.io/reference/samples/add-radius

Create a new Kubernetes namespace named 'demo' to host the Guestbook application. This isolates the application's resources within the cluster.

```bash
kubectl create namespace demo
```

--------------------------------

### Example Response: Resource Groups

Source: https://docs.radapp.io/guides/operations/control-plane/howto-postman

This is an example of the JSON response when retrieving resource groups from the Radius API.

```json
{
    "value": [
        {
            "id": "/planes/radius/local/resourcegroups/default",
            "location": "global",
            "name": "default",
            "tags": {},
            "type": "System.Resources/resourceGroups"
        }
    ]
}

```

--------------------------------

### Install Radius CLI and Initialize Environment in GitHub Actions

Source: https://docs.radapp.io/guides/deploy-apps/howto-deploy/howto-deploy-cicd

Downloads the latest `rad` CLI and Bicep, then initializes a Radius workspace and environment. Note: A temporary environment is created as a prerequisite for Bicep environment deployment.

```bash
    - name: Download rad CLI and bicep
      run: |
        wget -q "https://raw.githubusercontent.com/radius-project/radius/main/deploy/install.sh" -O - | /bin/bash
        ./rad bicep download
        ./rad --version
    - name: Initialize Radius Environment
      run: |
        ./rad group create default
        ./rad workspace create kubernetes default --group default
        ./rad env create temp
        ./rad env switch temp
```

--------------------------------

### Show Recipe Details with Environment and Group

Source: https://docs.radapp.io/reference/cli/rad_recipe_show

Displays the details of a specific recipe, specifying the environment and resource group.

```bash
rad recipe show redis-dev --resource-type Applications.Datastores/redisCaches --group dev --environment dev
```

--------------------------------

### Validate Prometheus Installation

Source: https://docs.radapp.io/guides/operations/control-plane/metrics/prometheus

Checks the status of Prometheus pods within the monitoring namespace to confirm a successful installation.

```bash
kubectl get pods -n radius-monitoring
```

--------------------------------

### Example Response: Radius Environments

Source: https://docs.radapp.io/guides/operations/control-plane/howto-postman

This is an example of the JSON response when listing Radius Environments within a resource group.

```json
{
    "value": [
        {
            "id": "/planes/radius/local/resourcegroups/default/providers/Applications.Core/environments/default",
            "location": "global",
            "name": "default",
            "properties": {
                "compute": {
                    "kind": "kubernetes",
                    "namespace": "default"
                },
                "provisioningState": "Succeeded",
                "recipes": {...}
            },
            "systemData": {...},
            "tags": {},
            "type": "Applications.Core/environments"
        }
    ]
}

```

--------------------------------

### Recipe Pack CLI Help Options

Source: https://docs.radapp.io/reference/cli/rad_recipe-pack

Displays the help options for the 'rad recipe-pack' command, including specific flags for help and workspace selection.

```bash
  -h, --help               help for recipe-pack
  -w, --workspace string   The workspace name

```

--------------------------------

### Install Radius with custom Terraform log level

Source: https://docs.radapp.io/reference/cli/rad_install_kubernetes

Installs Radius, setting a custom log level for Terraform operations.

```bash
rad install kubernetes --set global.terraform.loglevel=DEBUG
```

--------------------------------

### Initialize Git Repository and Add Remote

Source: https://docs.radapp.io/guides/deploy-apps/gitops/howto-flux

Initialize a new Git repository in your application directory and add a remote origin pointing to your Git repository URL.

```bash
git init
git add .
git remote add origin <your-repo-url>
```

--------------------------------

### Install Specific Radius Version

Source: https://docs.radapp.io/guides/operations/kubernetes/kubernetes-rollback

Install a specific version of Radius using either a local chart or Helm directly.

```bash
# Install a specific version using a local chart
rad install kubernetes --chart /path/to/radius-chart-<version>
```

```bash
# Or use Helm directly to install a specific version
helm install radius oci://ghcr.io/radius-project/helm-chart --version <chart-version> -n radius-system --create-namespace
```

--------------------------------

### rad upgrade Help Options

Source: https://docs.radapp.io/reference/cli/rad_upgrade

Displays the help information for the 'rad upgrade' command, including its synopsis and available options.

```bash
rad upgrade --help
```

--------------------------------

### YouTube Video Embed Example

Source: https://docs.radapp.io/contributing/docs/contributing-docs

An example of the `youtube` shortcode, showing how to embed a specific YouTube video using its ID.

```html
{{< youtube dQw4w9WgXcQ >}}

```

--------------------------------

### Install Powershell Completion on Windows

Source: https://docs.radapp.io/reference/cli/rad_completion

Installs powershell completion on Windows. It ensures the profile file exists and appends the completion script to it.

```powershell
if (!(Test-Path -Path $PROFILE )) { New-Item -Type File -Path $PROFILE -Force }
rad completion powershell >> $PROFILE
```

--------------------------------

### Manual SQL Database Provisioning

Source: https://docs.radapp.io/reference/resource-schema/databases/microsoft-sql

Defines a SQL database resource with manual provisioning, specifying existing underlying resources and connection details. Use this when the database is pre-provisioned.

```bicep
resource db 'Applications.Datastores/sqlDatabases@2023-10-01-preview' = {
  name: 'db'
  properties: {
    environment: environment
    application: app.id
    resourceProvisioning: 'manual'
    resources:[
      {
        id: sqldb::dbinner.id
      }
    ]
    server: sqldb.properties.fullyQualifiedDomainName
    database: sqldb::dbinner.name
    port: port
    username: username
    secrets:{
      password: password
      connectionString: 'Data Source=tcp:${sqldb.properties.fullyQualifiedDomainName},${port};Initial Catalog=${sqldb::dbinner.name};User Id=${username};Password=${password};Encrypt=True;TrustServerCertificate=True'
    }
  }
}
```

--------------------------------

### Install Zsh Completion on macOS

Source: https://docs.radapp.io/reference/cli/rad_completion

Installs zsh completion on macOS using Homebrew. It sets up the completion script to be autoloaded on startup.

```zsh
brew install zsh-completions
rad completion zsh > "${fpath[1]}/_rad"
source ~/.zshrc
```

--------------------------------

### Install Radius with Jaeger Integration

Source: https://docs.radapp.io/guides/operations/control-plane/traces/jaeger

Installs the Radius control plane, configuring it to send tracing data to the Jaeger collector endpoint.

```bash
rad install kubernetes --set  global.zipkin.url=http://jaeger-collector.radius-monitoring.svc.cluster.local:9411/api/v2/spans

```

--------------------------------

### Recipe-based SQL Database Provisioning

Source: https://docs.radapp.io/reference/resource-schema/databases/microsoft-sql

Defines a SQL database resource using a specified recipe for automatic provisioning. Use this when Radius should manage the underlying infrastructure.

```bicep
resource db 'Applications.Datastores/sqlDatabases@2023-10-01-preview' = {
  name: 'db'
  properties: {
    environment: environment
    application: app.id
    recipe: {
      // Name a specific Recipe to use
      name: 'azure-sqldb'
      // Optionally set recipe parameters if needed (specific to the Recipe)
      parameters: {
        server: '*******'
      }
    }
  }
}
```

--------------------------------

### Install Radius with Zipkin Configuration

Source: https://docs.radapp.io/guides/operations/control-plane/traces/zipkin

Installs the Radius control plane, configuring it to send tracing data to the specified Zipkin endpoint.

```bash
rad install kubernetes --set  global.zipkin.url=http://zipkin.radius-monitoring.svc.cluster.local:9411/api/v2/spans
```

--------------------------------

### Example Radius Application Resource ID

Source: https://docs.radapp.io/reference/api/resource-ids

An example of a Resource ID for a Radius Application named 'my-app' running on the local cluster.

```text
/planes/radius/local/resourceGroups/my-group/providers/Applications.Core/applications/my-app
```

--------------------------------

### Rad Application CLI Help Options

Source: https://docs.radapp.io/reference/cli/rad_application

Displays help information for the 'rad application' command.

```bash
rad application --help
```

--------------------------------

### Show Recipe Details

Source: https://docs.radapp.io/reference/cli/rad_recipe_show

Displays the details of a specific recipe, including its resource type.

```bash
rad recipe show redis-prod --resource-type Applications.Datastores/redisCaches
```

--------------------------------

### Install Radius with Helm chart overrides

Source: https://docs.radapp.io/reference/cli/rad_install_kubernetes

Installs Radius with custom Helm chart values specified using the --set flag.

```bash
rad install kubernetes --set key=value
```

--------------------------------

### Provision RabbitMQ using a Recipe

Source: https://docs.radapp.io/reference/resource-schema/messaging/rabbitmq

This snippet shows how to define a RabbitMQ resource using a predefined recipe. It specifies the environment, application, and the name of the recipe to use, along with optional parameters for the recipe.

```bicep
resource rabbitmq 'Applications.Messaging/rabbitmqQueues@2023-10-01-preview' = {
  name: 'rabbitmq'
  properties: {
    environment: environment
    application: app.id
    recipe: {
      // Name a specific Recipe to use
      name: 'rabbit'
      // Optionally set recipe parameters if needed (specific to the Recipe)
      parameters: {
        queue: '*****'
      }
    }
  }
}
```

--------------------------------

### Check Kubernetes Resources

Source: https://docs.radapp.io/reference/samples/helm

Use `kubectl get all` to verify that all Kubernetes resources, including pods, services, deployments, and recipes, are running and in the expected state.

```bash
> kubectl get all -n demo
NAME                                       READY   STATUS    RESTARTS   AGE
pod/redis-r5tcrra3d7uh6-7bcd8b8d8d-jmgn4   2/2     Running   0          20m
pod/webapp-76db7964d8-plc2s                1/1     Running   0          37s

NAME                          TYPE        CLUSTER-IP     EXTERNAL-IP   PORT(S)    AGE
service/redis-r5tcrra3d7uh6   ClusterIP   10.43.104.63   <none>        6379/TCP   20m

NAME                                       READY   UP-TO-DATE   AVAILABLE   AGE
deployment.apps/redis-r5tcrra3d7uh6   1/1     1            1           20m
deployment.apps/webapp                1/1     1            1           20m

NAME                                             DESIRED   CURRENT   READY   AGE
replicaset.apps/redis-r5tcrra3d7uh6-7bcd8b8d8d   1         1         1       20m
replicaset.apps/webapp-79d5dfb99                 0         0         0       20m
replicaset.apps/webapp-76db7964d8                1         1         1       37s
replicaset.apps/webapp-687dcf5cdf                0         0         0       38s

NAME                  TYPE                                  SECRET   STATUS
recipe.radapp.io/db   Applications.Datastores/redisCaches            Ready

```

--------------------------------

### Sample Response for List Planes (200 OK)

Source: https://docs.radapp.io/reference/api/api-ucp

Provides an example of a successful response when listing planes, detailing plane properties such as ID, name, type, location, resource providers, and kind.

```json
{
  "value": [
    {
      "id": "/planes/radius/local",
      "name": "local",
      "type": "System.Radius/planes",
      "location": "global",
      "properties": {
        "resourceProviders": {
          "Applications.Datastores": "http://applications-rp.radius-system:5444",
          "Applications.Core": "http://applications-rp.radius-system:5443",
          "Microsoft.Resources": "http://bicep-de.radius-system:6443"
},
        "kind": "UCPNative"
}
}
]

}
```

--------------------------------

### Install Doscys Theme npm Packages

Source: https://docs.radapp.io/contributing/docs/contributing-docs

Install Node.js packages specifically for the Docsy theme. This command requires navigating into the 'themes/docsy' directory.

```bash
cd themes/docsy
npm install
cd ..

```
Tokens:
Raw